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

add @graphiql/plugin-utils, docs to improve plugin development #3328

Closed
wants to merge 10 commits into from

Conversation

acao
Copy link
Member

@acao acao commented Jul 8, 2023

as per conversations since 2019, and a conversation with users at GraphQL Berlin meetup, it's high time we start work on a simple set of utilities to enable graphiql plugin development!

this provides some conventions and abstracts away the details to make shipping plugins more readily poasible from this repo (or from any repo)

(also, as a platform engineer, seeing all the duplicate vite config and pain for users just made me sad, vite's plugin API was designed to eliminate such complexity!)

  • vite plugin to abstract away config details
  • shared tsconfig
  • [x] automatically rename output to match plugin name
  • add docs for creating plugins

in later iterations

  • init script (npx create-graphiql-plugin myplugin)
  • validate package.json
  • extend vite plugin to show graphiql with plugin on vite command

@changeset-bot
Copy link

changeset-bot bot commented Jul 8, 2023

⚠️ No Changeset found

Latest commit: a7c3cca

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions
Copy link
Contributor

github-actions bot commented Jul 8, 2023

The latest changes of this PR are available as canary in npm (based on the declared changesets):

@acao acao force-pushed the graphiql-plugin-utils branch 4 times, most recently from dd1afaa to 50cf36b Compare July 8, 2023 09:04
@acao acao changed the title add @graphiql/plugin-utils to simplify plugin development add @graphiql/plugin-utils, docs to improve plugin development Jul 8, 2023
@acao acao force-pushed the graphiql-plugin-utils branch from 563319d to f0fbb21 Compare July 8, 2023 10:50
@acao acao force-pushed the graphiql-plugin-utils branch from d004e00 to ec9abc7 Compare July 9, 2023 13:53
@acao acao force-pushed the graphiql-plugin-utils branch from 62a274a to e524758 Compare July 9, 2023 14:30
@graphql graphql deleted a comment from dimaMachina Jul 9, 2023
@graphql graphql deleted a comment from dimaMachina Jul 9, 2023
@graphql graphql deleted a comment from dimaMachina Jul 9, 2023
@acao
Copy link
Member Author

acao commented Jul 10, 2023

Note: I've added a few commits to graphiql explorer plugin to this PR to fix an upstream issue, but I plan to backport them to happen independently as a bugfix, and restore copy-demo in a seperate PR

@acao
Copy link
Member Author

acao commented Jul 11, 2023

this PR will be re-created against main branch, and will continue using the index.umd.js pattern :)

acao added a commit that referenced this pull request Jul 13, 2023
acao added a commit that referenced this pull request Jul 13, 2023
acao added a commit that referenced this pull request Jul 13, 2023
@acao acao closed this Jul 13, 2023
@acao
Copy link
Member Author

acao commented Jul 13, 2023

recreated as #3346

acao added a commit that referenced this pull request Jul 13, 2023
acao added a commit that referenced this pull request Jul 14, 2023
acao added a commit that referenced this pull request Jul 14, 2023
acao added a commit that referenced this pull request Jul 16, 2023
acao added a commit that referenced this pull request Jul 16, 2023
acao added a commit that referenced this pull request Jul 22, 2023
acao added a commit that referenced this pull request Aug 1, 2023
acao added a commit that referenced this pull request Aug 4, 2023
acao added a commit that referenced this pull request Aug 12, 2023
acao added a commit that referenced this pull request Dec 11, 2023
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