chore: check spelling too

Author: enisdenjo

Diff for: .github/workflows/ci.yml

@@ -16,6 +16,7 @@ jobs:
         check:
           - format
           - lint
+          - spell
           - type
     name: Check ${{ matrix.check }}
     runs-on: ubuntu-latest

Diff for: README.md

@@ -61,7 +61,7 @@ import { schema } from './previous-step';
 // Create the GraphQL over HTTP Node request handler
 const handler = createHandler({ schema });
 
-// Create a HTTP server using the listner on `/graphql`
+// Create a HTTP server using the listener on `/graphql`
 const server = http.createServer((req, res) => {
   if (req.url.startsWith('/graphql')) {
     handler(req, res);
@@ -560,8 +560,8 @@ const client = createClient({
 
 </details>
 
-<details id="migrating-express-grpahql">
-<summary><a href="#migrating-express-grpahql">🔗</a> Server handler migration from <a href="https://github.com/graphql/express-graphql">express-graphql</a></summary>
+<details id="migrating-express-graphql">
+<summary><a href="#migrating-express-graphql">🔗</a> Server handler migration from <a href="https://github.com/graphql/express-graphql">express-graphql</a></summary>
 
 ```diff
 import express from 'express';
@@ -630,7 +630,7 @@ const handler = createHandler({
   context: async (req, args) => {
     return getDynamicContext(req, args);
   },
-  // or static context by supplying the value direcly
+  // or static context by supplying the value directly
 });
 ```
 

Diff for: cspell.config.js

@@ -0,0 +1,19 @@
+/** @type {import('@cspell/cspell-types').CSpellSettings} */
+const config = {
+  ignorePaths: ['CHANGELOG.md', 'implementations/*/README.md'],
+  words: [
+    'fastify',
+    'deno',
+    'postgraphile',
+    'graphql',
+    'pluggable',
+    'whatwg',
+    'hotchocolate',
+    'instanceof',
+    'privkey',
+    'keyout',
+    'newkey',
+    'isomorphically',
+  ],
+};
+module.exports = config;

Diff for: docs/classes/client.NetworkError.md

@@ -59,7 +59,7 @@ Error.constructor
 
 • **response**: `undefined` \| `Response`
 
-The underlyig response thats considered an error.
+The underlying response thats considered an error.
 
 Will be undefined when no response is received,
 instead an unexpected network error.

Diff for: docs/interfaces/client.ClientOptions.md

@@ -139,7 +139,7 @@ errors are considered fatal and will be reported immediately.
 
 You may implement your own waiting strategy by timing the resolution of the returned promise.
 
-Useful for retrying requests that failed because the service is temporarely unavailable.
+Useful for retrying requests that failed because the service is temporarily unavailable.
 
 `retries` argument counts actual retries, so it will begin with
 0 after the first failed request.

Diff for: docs/interfaces/common.Sink.md

@@ -38,7 +38,7 @@ ___
 
 ▸ **error**(`error`): `void`
 
-An error that has occured. This function "closes" the sink.
+An error that has occurred. This function "closes" the sink.
 
 #### Parameters
 

Diff for: docs/interfaces/handler.HandlerOptions.md

@@ -68,9 +68,9 @@ ___
 • `Optional` **formatError**: [`FormatError`](../modules/handler.md#formaterror)
 
 Format handled errors to your satisfaction. Either GraphQL errors
-or safe request processing errors are meant by "handleded errors".
+or safe request processing errors are meant by "handled errors".
 
-If multiple errors have occured, all of them will be mapped using
+If multiple errors have occurred, all of them will be mapped using
 this formatter.
 
 ___

Diff for: docs/modules/handler.md

@@ -76,7 +76,7 @@ ___
 
 ▸ (`req`): `Promise`<[`Response`](handler.md#response)\>
 
-The ready-to-use handler. Simply plug it in your favourite HTTP framework
+The ready-to-use handler. Simply plug it in your favorite HTTP framework
 and enjoy.
 
 Errors thrown from **any** of the provided options or callbacks (or even due to
@@ -113,7 +113,7 @@ ___
 
 A concrete GraphQL execution context value type.
 
-Mainly used because TypeScript collapes unions
+Mainly used because TypeScript collapses unions
 with `any` or `unknown` to `any` or `unknown`. So,
 we use a custom type to allow definitions such as
 the `context` server option.
@@ -159,7 +159,7 @@ ___
 ▸ **createHandler**<`RequestRaw`, `RequestContext`, `Context`\>(`options`): [`Handler`](handler.md#handler)<`RequestRaw`, `RequestContext`\>
 
 Makes a GraphQL over HTTP spec compliant server handler. The handler can
-be used with your favourite server library.
+be used with your favorite server library.
 
 Beware that the handler resolves only after the whole operation completes.
 

Diff for: package.json

@@ -94,6 +94,7 @@
     "check:format": "prettier --check .",
     "format": "yarn check:format --write",
     "check:lint": "eslint 'src'",
+    "check:spell": "cspell --gitignore **/*.md",
     "check:type": "tsc --noEmit",
     "test": "NODE_OPTIONS=--experimental-vm-modules NODE_NO_WARNINGS=1 jest",
     "build:esm": "tsc -b tsconfig.esm.json && tsx scripts/esm-post-process.ts",
@@ -117,6 +118,7 @@
     "@babel/plugin-proposal-optional-chaining": "^7.21.0",
     "@babel/preset-env": "^7.22.6",
     "@babel/preset-typescript": "^7.22.5",
+    "@cspell/cspell-types": "^6.31.1",
     "@rollup/plugin-terser": "^0.4.3",
     "@rollup/plugin-typescript": "^11.1.2",
     "@semantic-release/changelog": "^6.0.3",
@@ -133,6 +135,7 @@
     "@typescript-eslint/parser": "^5.61.0",
     "@whatwg-node/fetch": "^0.9.7",
     "babel-jest": "^29.6.0",
+    "cspell": "^6.31.1",
     "eslint": "^8.44.0",
     "eslint-config-prettier": "^8.8.0",
     "express": "^4.18.2",

Diff for: src/client.ts

@@ -94,7 +94,7 @@ export interface ClientOptions {
    *
    * You may implement your own waiting strategy by timing the resolution of the returned promise.
    *
-   * Useful for retrying requests that failed because the service is temporarely unavailable.
+   * Useful for retrying requests that failed because the service is temporarily unavailable.
    *
    * `retries` argument counts actual retries, so it will begin with
    * 0 after the first failed request.
@@ -302,7 +302,7 @@ export class NetworkError<
   Response extends ResponseLike = ResponseLike,
 > extends Error {
   /**
-   * The underlyig response thats considered an error.
+   * The underlying response thats considered an error.
    *
    * Will be undefined when no response is received,
    * instead an unexpected network error.

Diff for: src/common.ts

@@ -26,7 +26,7 @@ export interface RequestParams {
 export interface Sink<T = unknown> {
   /** Next value arriving. */
   next(value: T): void;
-  /** An error that has occured. This function "closes" the sink. */
+  /** An error that has occurred. This function "closes" the sink. */
   error(error: unknown): void;
   /** The sink has completed. This function "closes" the sink. */
   complete(): void;

Diff for: src/handler.ts

@@ -140,7 +140,7 @@ export function isResponse(val: unknown): val is Response {
 /**
  * A concrete GraphQL execution context value type.
  *
- * Mainly used because TypeScript collapes unions
+ * Mainly used because TypeScript collapses unions
  * with `any` or `unknown` to `any` or `unknown`. So,
  * we use a custom type to allow definitions such as
  * the `context` server option.
@@ -324,16 +324,16 @@ export interface HandlerOptions<
     | void;
   /**
    * Format handled errors to your satisfaction. Either GraphQL errors
-   * or safe request processing errors are meant by "handleded errors".
+   * or safe request processing errors are meant by "handled errors".
    *
-   * If multiple errors have occured, all of them will be mapped using
+   * If multiple errors have occurred, all of them will be mapped using
    * this formatter.
    */
   formatError?: FormatError;
 }
 
 /**
- * The ready-to-use handler. Simply plug it in your favourite HTTP framework
+ * The ready-to-use handler. Simply plug it in your favorite HTTP framework
  * and enjoy.
  *
  * Errors thrown from **any** of the provided options or callbacks (or even due to
@@ -348,7 +348,7 @@ export type Handler<RequestRaw = unknown, RequestContext = unknown> = (
 
 /**
  * Makes a GraphQL over HTTP spec compliant server handler. The handler can
- * be used with your favourite server library.
+ * be used with your favorite server library.
  *
  * Beware that the handler resolves only after the whole operation completes.
  *

Diff for: tsconfig.json

@@ -19,6 +19,7 @@
     "babel.config.js",
     "jest.config.js",
     ".eslintrc.js",
-    "typedoc.js"
+    "typedoc.js",
+    "cspell.config.js"
   ]
 }