Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: graphql space configuration plugin #452

Merged
merged 5 commits into from
Apr 12, 2024
Merged

Conversation

carlbrugger
Copy link
Contributor

@carlbrugger carlbrugger commented Mar 26, 2024

Please explain how to summarize this PR for the Changelog:

Introducing the GraphQL to Flatfile Blueprint plugin. This plugin can be used either to generate Flatfile Blueprint from GraphQL or to configure a Flatfile Space from Graphql. Several options are available to provide the GraphQL to the plugin. It either can be provided from a GraphQL API endpoint, a GraphQL schema file, or a custom callback function.

Tell code reviewer how and what to test:

Getting started instructions available on readme.

Summary by CodeRabbit

  • New Features
    • Introduced the @flatfile/plugin-graphql-schema plugin, facilitating conversion of GraphQL schemas to Flatfile Blueprints for data validation and preparation.
    • Added functionality to generate Flatfile properties, sheets, and workbooks from GraphQL schemas, with customization options for schema generation.
  • Documentation
    • Updated documentation to reflect the new plugin capabilities and usage guidelines.
  • Refactor
    • Renamed the package from @flatfile/plugin-graphql to @flatfile/plugin-graphql-schema and updated the version to 1.0.0.

@carlbrugger carlbrugger force-pushed the feat/graphql-schema branch from 7aee1ef to 07ff399 Compare March 28, 2024 19:16
@carlbrugger carlbrugger force-pushed the feat/graphql-schema branch 2 times, most recently from cbb9120 to 82a6474 Compare April 9, 2024 22:45
@carlbrugger carlbrugger marked this pull request as ready for review April 11, 2024 19:34
Copy link
Contributor

coderabbitai bot commented Apr 11, 2024

Walkthrough

The transition to @flatfile/plugin-graphql-schema version 1.0.0 enhances schema conversion to Flatfile Blueprints. This update streamlines data preparation and validation by supporting various GraphQL sources for conversion.

Changes

File Path Change Summary
.plugins/graphql-schema/CHANGELOG.md Renamed package to @flatfile/plugin-graphql-schema and upgraded version to 1.0.0.
.plugins/graphql-schema/README.md Introduced functionality for converting GraphQL schemas to Flatfile Blueprints.
.plugins/graphql-schema/package.json Added the "@flatfile/plugin-graphql-schema" plugin for GraphQL to Flatfile conversion.
.plugins/graphql-schema/rollup.config.mjs Included a new rollup configuration for the plugin.
.plugins/graphql-schema/src/*.ts Added TypeScript files for field, sheet, and workbook generation.
.changeset/soft-ducks-rest.md Summarized the capabilities of the @flatfile/plugin-graphql-schema plugin.

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 7

plugins/graphql-schema/src/generate.field.ts Show resolved Hide resolved
plugins/graphql-schema/src/generate.field.ts Show resolved Hide resolved
plugins/graphql-schema/src/generate.sheet.ts Show resolved Hide resolved
.changeset/soft-ducks-rest.md Outdated Show resolved Hide resolved
plugins/graphql-schema/README.md Outdated Show resolved Hide resolved
plugins/graphql-schema/src/setup.factory.ts Show resolved Hide resolved
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

plugins/graphql-schema/CHANGELOG.md Show resolved Hide resolved
@carlbrugger carlbrugger requested a review from bangarang April 12, 2024 16:38
carlbrugger and others added 3 commits April 12, 2024 11:46
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Alex Rock <[email protected]>
@carlbrugger carlbrugger force-pushed the feat/graphql-schema branch from b910128 to 82cc57a Compare April 12, 2024 17:03
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 5

.changeset/soft-ducks-rest.md Show resolved Hide resolved
plugins/graphql-schema/README.md Outdated Show resolved Hide resolved
plugins/graphql-schema/README.md Show resolved Hide resolved
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 8

plugins/graphql-schema/README.md Show resolved Hide resolved
plugins/graphql-schema/README.md Show resolved Hide resolved
plugins/graphql-schema/README.md Show resolved Hide resolved
plugins/graphql-schema/README.md Show resolved Hide resolved
plugins/graphql-schema/README.md Show resolved Hide resolved
plugins/graphql-schema/README.md Show resolved Hide resolved
plugins/graphql-schema/README.md Show resolved Hide resolved
plugins/graphql-schema/README.md Show resolved Hide resolved
@carlbrugger carlbrugger merged commit c122112 into main Apr 12, 2024
2 checks passed
@carlbrugger carlbrugger deleted the feat/graphql-schema branch April 12, 2024 18:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants