add "proseWrap": "always" in prettier config to respect `printWidth…

…` for markdown files
graphql · Nov 10, 2022 · 93be85a · 93be85a
1 parent f50342c
commit 93be85a
Show file tree

Hide file tree

Showing 48 changed files with 4,252 additions and 1,397 deletions.
diff --git a/.prettierrc b/.prettierrc
@@ -1,5 +1,6 @@
 {
   "singleQuote": true,
   "trailingComma": "all",
-  "arrowParens": "avoid"
+  "arrowParens": "avoid",
+  "proseWrap": "always"
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
-> **Archived** For up to date changelogs that are automatically generated by [changesets](https://github.com/atlassian/changesets), see CHANGELOG.md files in respective workspaces.
-> For example, the `graphiql` changelog is located at [packages/graphiql/CHANGELOG.md](./packages/graphiql/CHANGELOG.md), and the language server changelog is located at [packages/graphql-language-service-server/CHANGELOG.md](./packages/graphql-language-service-server/CHANGELOG.md)
+> **Archived** For up to date changelogs that are automatically generated by
+> [changesets](https://github.com/atlassian/changesets), see CHANGELOG.md files
+> in respective workspaces. For example, the `graphiql` changelog is located at
+> [packages/graphiql/CHANGELOG.md](./packages/graphiql/CHANGELOG.md), and the
+> language server changelog is located at
+> [packages/graphql-language-service-server/CHANGELOG.md](./packages/graphql-language-service-server/CHANGELOG.md)
 
 ## GraphiQL 0.14.2 - 11 Aug, 2019
 
@@ -17,7 +21,8 @@
 
 - Fix formatting of subscription errors - #636, #722 - @benjie
 - preserve ctrl-f key for macOS - #759 - @pd4d10
-- Fix earlier 'Mode graphql failed to advance stream' on Linux by eating an exotic whitespace character - #735 closed by #932 - @benjie
+- Fix earlier 'Mode graphql failed to advance stream' on Linux by eating an
+  exotic whitespace character - #735 closed by #932 - @benjie
 - Fix: check `this.editor` exists before `this.editor.off` in QueryEditor
 
 ## Codemirror GraphQL - 0.9 - 11 Aug, 2019
@@ -48,14 +53,16 @@
 
 ### Fixes
 
-- Fix 'mode graphql failed to advance stream' error from shift-alt-space, etc - #932 - @benjie
+- Fix 'mode graphql failed to advance stream' error from shift-alt-space, etc -
+  #932 - @benjie
 
 ## GraphQL Language Service Interface 2.1.0 - 11 Aug, 2019
 
 ### Features
 
 - add \_\_typename field suggestion against object type - (#903) @yoshiakis
-- Update sortText logic, so that field sort is schema driven rather than alphabetically sorted - (#884) @ganemone
+- Update sortText logic, so that field sort is schema driven rather than
+  alphabetically sorted - (#884) @ganemone
 
 ### Chores
 
@@ -66,7 +73,8 @@
 ## GraphQL Language Service 2.1.0
 
 - BREAKING: add peer support for graphql 14.x
-- BREAKING: remove incompatible dependencies on graphql 0.11 and below (b/c of gls-utils 2.x)
+- BREAKING: remove incompatible dependencies on graphql 0.11 and below (b/c of
+  gls-utils 2.x)
 
 ## GraphQL Language Service Utils 2.1.0 - 11 Aug, 2019
 
@@ -89,8 +97,10 @@
 
 ### Features
 
-- Hint/popup/etc DOM nodes use container rather than creating children of <body> - #791 - @codestryke
-- Add readOnly prop and pass to `QueryEditor` and `VariableEditor` - #718 - @TheSharpieOne
+- Hint/popup/etc DOM nodes use container rather than creating children of
+  <body> - #791 - @codestryke
+- Add readOnly prop and pass to `QueryEditor` and `VariableEditor` - #718 -
+  @TheSharpieOne
 - Add operationName to introspection query - #664 - @jbblanchet
 - Image Preview Functionality - #789 - @dunnbobcat @asiandrummer
 
@@ -112,7 +122,8 @@
 
 ## Codemirror Graphql Mode 0.8.4 - 11 Aug, 2018
 
-You will now be importing async methods from gls-interface 2.0.0, thus your bundler will require regenerator runtime
+You will now be importing async methods from gls-interface 2.0.0, thus your
+bundler will require regenerator runtime
 
 ## Chores
 
@@ -123,31 +134,41 @@ You will now be importing async methods from gls-interface 2.0.0, thus your bund
 
 ### Chores
 
-- BREAKING: upgrade internal dependencies - gls-parser, gls-types, and gls-utils to 2.0.0 - @lostplan
-- BREAKING: remove incompatible dependencies on graphql 0.11 and below - @lostplan
+- BREAKING: upgrade internal dependencies - gls-parser, gls-types, and gls-utils
+  to 2.0.0 - @lostplan
+- BREAKING: remove incompatible dependencies on graphql 0.11 and below -
+  @lostplan
 
 ## GraphQL Language Service Utils 2.0.0 - 11 Sep, 2018
 
 ### Chores
 
-- BREAKING: deprecate support for graphql-js 0.11.x and below - @lostplan [graphql/graphql-language-service#256](https://github.com/graphql/graphql-language-service/pull/256) [new ref](https://github.com/graphql/graphiql/commit/895e68537fd802b8b6ddf2578a1f76f85982c773) because of [this change](https://github.com/graphql/graphiql/commit/068c57fdb4a147be3c2fc38167e2def74d217a82#diff-696ceb17e38e4a274d4a149d24513b78)
+- BREAKING: deprecate support for graphql-js 0.11.x and below - @lostplan
+  [graphql/graphql-language-service#256](https://github.com/graphql/graphql-language-service/pull/256)
+  [new ref](https://github.com/graphql/graphiql/commit/895e68537fd802b8b6ddf2578a1f76f85982c773)
+  because of
+  [this change](https://github.com/graphql/graphiql/commit/068c57fdb4a147be3c2fc38167e2def74d217a82#diff-696ceb17e38e4a274d4a149d24513b78)
 - BREAKING: GraphQL 14.x support, peer dependency resolutions - #244 - @AGS-
 
 ## GraphQL Language Service Utils 1.2.2 - 11 Sep, 2018
 
 ### Chores
 
-- add graphql-js 0.13 to peer deps of types package (graphql/graphql-language-service#241)
+- add graphql-js 0.13 to peer deps of types package
+  (graphql/graphql-language-service#241)
 
 ## GraphQL Language Service Server 2.0.0 - 11 Sep, 2019
 
 ### Chores
 
-- add graphql-js 0.13 to peer dependencies (graphql/graphql-language-service#241)
-- BREAKING: upgrade internal dependencies - gls-interface, gls-server and gls-utils to 2.0.0 @lostplan
+- add graphql-js 0.13 to peer dependencies
+  (graphql/graphql-language-service#241)
+- BREAKING: upgrade internal dependencies - gls-interface, gls-server and
+  gls-utils to 2.0.0 @lostplan
 
 ## GraphQL Language Service 2.0.0 - 11 Sep, 2018
 
 ### Chores
 
-- BREAKING: upgrade internal dependencies - gls-interface, gls-server and gls-utils to 2.0.0 @Sol
+- BREAKING: upgrade internal dependencies - gls-interface, gls-server and
+  gls-utils to 2.0.0 @Sol
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,8 +1,12 @@
 # Contributing
 
-We welcome contributions and assistance! If you want to know where to start, check out our [Github Projects sorted by name](https://github.com/graphql/graphiql/projects?query=is%3Aopen+sort%3Aname-asc).
+We welcome contributions and assistance! If you want to know where to start,
+check out our
+[Github Projects sorted by name](https://github.com/graphql/graphiql/projects?query=is%3Aopen+sort%3Aname-asc).
 
-If you want to add a new feature, note that GraphiQL is eventually going to support its own extension system, and we are rarely adding new features, so make sure you submit feature requests with that in mind.
+If you want to add a new feature, note that GraphiQL is eventually going to
+support its own extension system, and we are rarely adding new features, so make
+sure you submit feature requests with that in mind.
 
 ## Development
 
@@ -21,15 +25,19 @@ your [pull requests](https://help.github.com/articles/creating-a-pull-request).
 
 ## Commit Message Conventions
 
-Our commit messages are linted by `commitlint` following the angular changelog convention. You may end up losing a commit message or two if you don't follow this rule. We can add a prompt if people ask for it. This was designed for compatibility with various git clients in mind.
+Our commit messages are linted by `commitlint` following the angular changelog
+convention. You may end up losing a commit message or two if you don't follow
+this rule. We can add a prompt if people ask for it. This was designed for
+compatibility with various git clients in mind.
 
 You will need to include a type prefix for all commit messages. For example:
 
 `git commit -m 'fix: fix window undefined error in result viewer'`
 
 ### Type Prefixes
 
-[a list of type prefixes](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional#type-enum) is available:
+[a list of type prefixes](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional#type-enum)
+is available:
 
 ```js
 [
@@ -47,7 +55,8 @@ You will need to include a type prefix for all commit messages. For example:
 ];
 ```
 
-of these, `fix` and `feat` can trigger patch and minor version releases, reflexively. the rest are useful to help track activity.
+of these, `fix` and `feat` can trigger patch and minor version releases,
+reflexively. the rest are useful to help track activity.
 
 another commit message that can trigger a major version bump is this:
 
@@ -67,5 +76,5 @@ Please see [the RELEASING.md document](./RELEASING.md).
 
 ## License
 
-By contributing to GraphiQL, you agree that your contributions will be
-licensed under the LICENSE file in the project root directory.
+By contributing to GraphiQL, you agree that your contributions will be licensed
+under the LICENSE file in the project root directory.
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -1,10 +1,17 @@
 ### Getting Started
 
-Please note that we require a signed GraphQL Specification Membership agreement before landing a contribution. This is checked automatically when you open a PR. If you have not signed the membership agreement (it's free), you will be prompted by the EasyCLA bot. For more details, please see the [GraphQL WG repo](https://github.com/graphql/graphql-wg/tree/main/membership).
+Please note that we require a signed GraphQL Specification Membership agreement
+before landing a contribution. This is checked automatically when you open a PR.
+If you have not signed the membership agreement (it's free), you will be
+prompted by the EasyCLA bot. For more details, please see the
+[GraphQL WG repo](https://github.com/graphql/graphql-wg/tree/main/membership).
 
-1. First, you will need to have the latest git, yarn 1.16 & node 12 or greater installed. OSX, Windows and Linux should all be supported as build environments.
+1. First, you will need to have the latest git, yarn 1.16 & node 12 or greater
+   installed. OSX, Windows and Linux should all be supported as build
+   environments.
 
-**None of these commands will work with `npm`. Please use `yarn` to develop with graphql**.
+**None of these commands will work with `npm`. Please use `yarn` to develop with
+graphql**.
 
 1. Fork this repo by using the "Fork" button in the upper-right
 
@@ -20,7 +27,8 @@ Please note that we require a signed GraphQL Specification Membership agreement
    yarn
    ```
 
-4. Build all interdependencies so the project you are working on can resolve other packages
+4. Build all interdependencies so the project you are working on can resolve
+   other packages
 
    first you'll need
 
@@ -56,27 +64,39 @@ if you have prettier or eslint --fix able issues you see in CI, use yarn format:
 
 `yarn format`
 
-if you see typescript build issues, do a `yarn build` locally and make sure the whole project references tree builds. changing interfaces can end up breaking their implementations.
+if you see typescript build issues, do a `yarn build` locally and make sure the
+whole project references tree builds. changing interfaces can end up breaking
+their implementations.
 
 ### Run tests for GraphiQL:
 
-- `yarn test graphiql` will run all tests for graphiql. you can also run tests from a workspace, but most tooling is at the root.
+- `yarn test graphiql` will run all tests for graphiql. you can also run tests
+  from a workspace, but most tooling is at the root.
 - `yarn test --watch` will run jest with --watch
 - `yarn e2e` at the root will run the end to end suite
-- `yarn start-monaco` will launch webpack dev server for the monaco editor example with github API from the root. this is the fastest way to test changes to `graphql-language-service-interface`, parser, etc.
+- `yarn start-monaco` will launch webpack dev server for the monaco editor
+  example with github API from the root. this is the fastest way to test changes
+  to `graphql-language-service-interface`, parser, etc.
 
-if you want these commands to watch for changes to dependent packages in the repo, then `yarn build --watch` is what you want to run alongside either of these.
+if you want these commands to watch for changes to dependent packages in the
+repo, then `yarn build --watch` is what you want to run alongside either of
+these.
 
 ### Developing for GraphiQL
 
-If you want to develop just for graphiql, you don't even need to execute commands from the package subdirectory at `packages/graphiql`.
+If you want to develop just for graphiql, you don't even need to execute
+commands from the package subdirectory at `packages/graphiql`.
 
 First, you'll need to `yarn build` all the packages from the root.
 
 Then, you can run these commands:
 
-- `yarn start-graphiql` will launch webpack dev server for graphiql from the root
+- `yarn start-graphiql` will launch webpack dev server for graphiql from the
+  root
 
 ### Developing Monaco GraphQL
 
-Follow the [`monaco-graphql` example readme](examples/monaco-graphql-webpack-example/README.md) to set it up, and then you can run `yarn start-monaco` from anywhere in the repository!
+Follow the
+[`monaco-graphql` example readme](examples/monaco-graphql-webpack-example/README.md)
+to set it up, and then you can run `yarn start-monaco` from anywhere in the
+repository!