search

FlatFilers / Guides

Flatfile's Documentation
7 stars 20 forks source link

Guide for constraints plugin #1119

Closed carlbrugger closed 2 months ago

carlbrugger commented 3 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The update introduces a new plugin for Blueprint that enhances data processing by enabling the registration of external constraints. This plugin integrates with the commit:created event, providing dynamic validation and error handling capabilities. Users can easily set up validators, callbacks, and handle data changes effectively using this plugin.

Changes

File Path Summary
plugins-docs/transform/external-constraint.mdx Introduces @flatfile/plugin-constraints for registering external constraints in Blueprint. Provides setup for validators/callbacks, package imports, and installation guidance. Includes examples for event listeners and handling data change responses.
Recent Review Details **Configuration used: CodeRabbit UI**
Commits Files that changed from the base of the PR and between 63e6b7e78b4373e3dc1b85c46846986efb52167b and 8f74d68f3d4440e59b877c9bde6fd252c31e99ef.
Files selected for processing (1) * plugins-docs/transform/external-constraint.mdx (1 hunks)
Additional comments not posted (5)
plugins-docs/transform/external-constraint.mdx (5)
`43-50`: Installation instructions are clear and correctly formatted. --- `56-70`: The field setup example is correctly implemented and demonstrates the use of external constraints effectively. --- `76-88`: Import statements and usage instructions are correctly provided for both JavaScript and TypeScript environments. --- `104-138`: The listener setup and error handling are correctly implemented, demonstrating effective use of the externalConstraint function. --- `144-150`: The GitHub repository link is correctly provided and well-presented in a card format.
---
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.` 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 a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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.