uploadcare / file-uploader

Stack-agnostic library for uploading, processing, and editing images on-the-fly
https://uploadcare.com/docs/file-uploader/
MIT License
61 stars 12 forks source link

feat: rename export methods #712

Closed egordidenko closed 1 month ago

egordidenko commented 1 month ago

Description

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The recent updates enhance the integration of the Uploadcare library by shifting from generic block registration to a more focused approach on file uploader components. Key function names have been refined for clarity, and import paths have been streamlined to optimize module functionality. These changes ensure that the application effectively utilizes specific features, thus improving performance and maintainability.

Changes

Files Change Summary
README.md Updated import path for Uploadcare and changed from registerBlocks to defineComponents for clearer emphasis on file uploader functionality.
abstract/loadFileUploaderFrom.js, abstract/defineComponents.js Renamed functions to clarify focus on file uploader; updated parameter descriptions for enhanced clarity.
blocks/CloudImageEditorActivity/test.js Replaced registerBlocks with defineComponents to align with the new focus on defining components rather than generic blocks.
index.js, solutions/cloud-image-editor/index.js, solutions/file-uploader/minimal/index.js Changed exports from block-related functions to file uploader functions to reflect the new architecture.
demo/*.html Changed calls from registerBlocks to defineComponents across various demo files, indicating a shift to defining components.

Sequence Diagram(s)

sequenceDiagram
    participant UC as Uploadcare
    participant App as Application
    App->>UC: defineComponents()
    UC-->>App: Components defined

🐰 In the garden where clouds softly drift,
A file uploader blooms, a magical gift.
Blocks took a backseat, as rabbits rejoice,
With new paths of coding, we celebrate choice!
Hops of delight as the features align,
In this world of tech, we dance and we shine! ✨


Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.