overhaul READMEs and add migratio guide for graphiql@2
#2687
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* add postcss config to allow nesting * avoid processing css from `@graphiql/react` with postcss * add css files for default fonts * add long description with markdown to dev schema * rewrite completion tooltip * move editor css to @graphiql/react * git mv editor components to `@graphiql/react` * adjust editor components after moving to `@graphiql/react` * move styles for auto-inserted leads * make dynamic padding more resilient and add explanatory comment * add extra color to avoid conflicts * colocate markdown and deprecation styles * add changesets * fix spell checking * add changeset for graphiql@2 * don't enter pre-release mode in changeset * more elaborate changeset message
* add icons to `@graphiql/react` * add `UnstyledButton` ui component * implement new design for editors layout * rename `Unstyled` to `UnStyled` for spell checking * remove unused class and whitespace in `className` * make tiny change for deploy preview 🤞 * this will do it, i think? Co-authored-by: Rikki Schulte <[email protected]>
* implement new toolbar design * add `caller` argument for better errors
* implement sidebar in new design * simplify callback
* add icons * don't invoce callback when programmatically change resizable element * implement history in new design * visually separate favourite history items * add save button when editing history label * add changeset * add missing changesets in retrospect * fix typos * fix e2e tests * remove input outline
* move explorer context into folder * move `TypeLink` component to `@graphiql/react` * move `FieldLink` component to `@graphiql/react` * move `DefaultValue` component to `@graphiql/react` * move `Directive` component to `@graphiql/react` * extract `MarkdownContent` component in `@gaphiql/react` * move `Argument` component to `@graphiql/react` * combine and extend changesets
|
thomasheyenbrock
force-pushed
the
feat/migration-guide
branch
2 times, most recently
from
cc7646e
to
b8d342c
Compare
* add icons * add `Button` component to `@graphiql/react` * add explorer section component * redesign `SchemaDocumentation` component * redesign `TypeDocumentation` component * redesign `FieldDocumentation` component * redesign `DocExplorer` component * extend changeset message
* implement new design for tabs * add back `tab` role
* add `Dialog` component to `@graphiql/react` * add a `clear` method to the `Storage` type * add success and failure states to `Button` component * add settings dialog * make sure to show dialog above editor scrollbars
* add `ButtonGroup` component to `@graphiql/react` * dark mode
* add a dialog that shows all available shortkeys * use table in short key dialog * add shortkey for introspection * add link to codemirror keymaps
* fix selector specificity for link styling * leverage nesting * fix hiding the headline on focus * ensure correct focus outlines and remove visited styles
* implement toolbar menu in new design * implement `ToolbarListbox` in new design * better tooltips
* remove deprecated class methods * remove utilities * remove ref forwarding * refactor inner class component to a function component * merge main component with context consumer component * remove component statics * refactor outer component to be a class component * remove comments * add changeset * remove legacy exports
) * add `GraphiQLProvider` to `@graphiql/react` and include `StorageContextProvider` * add `HistoryContextProvider` to `GraphiQLProvider` * add `EditorContextProvider` to `GraphiQLProvider` * add `SchemaContextProvider` to `GraphiQLProvider` * add `ExecutionContextProvider` to `GraphiQLProvider` * move `ExplorerContextProvider` to `GraphiQLProvider` * declare props for `GraphiQLInterface` * reuse prop definitions from editor components * merge props for default state of editor tools * rename prop for toggling headers editor * re-export GraphiQL provider
* add JSDocs for component props and hooks * add JSDocs for context types * add README for `@graphiql/react`
* add plugin api for docs and history * throw error when plugin has no title
thomasheyenbrock
force-pushed
the
graphiql-v2
branch
from
9186b61
to
1b95975
Compare
thomasheyenbrock
force-pushed
the
feat/migration-guide
branch
from
b8d342c
to
98c9a0e
Compare
acao
reviewed
Aug 24, 2022
|
@thomasheyenbrock looks great! just make sure to restore the absolute URLs in README.md files so the urls work on npmjs.org and other npm like sites! |
thomasheyenbrock
force-pushed
the
graphiql-v2
branch
from
1b95975
to
7371157
Compare
|
@thomasheyenbrock ok maybe that was just an issue when we first merged all these repos then. i remember there were dozens of issues related to the relative urls years ago. glad they figured that out! |
acao
approved these changes
Aug 24, 2022
There was a problem hiding this comment.
@thomasheyenbrock let's do this! for the last commit before we squash, go ahead and remove the pre.json file, and manually remove all the pre release tag suffixes, and for the repo's sake, we will make sure to get the yarn.lock diff for that as well. ideally we can automate that some day. so excited! thanks for all your help on this and @jonathanawesome and everyone else!
thomasheyenbrock
added a commit
that referenced
this pull request
Aug 24, 2022
thomasheyenbrock
added a commit
that referenced
this pull request
Aug 24, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
That's it, last PR for v2! (Unless someone finds a bug 😄 )
This refines the repo README, the README for the
graphiqlpackage and adds a migration guide that highlights all the breaking changes and how to upgrade a[email protected]implementation tographiql@2.I removed the section with the architecture diagram from the repo README as it's no longer accurately reflecting the current state. Might still be valuable to have this, open for adding it back in an upgraded version later on!