Merge branch 'master' into add-support-for-include-unused-variables-option

Author: jaydenseric

.eslintrc.json

@@ -1,18 +1,50 @@
 name: CI
 on: [push, workflow_dispatch]
 jobs:
+  prettier:
+    name: Prettier
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-node@v4
+        with:
+          node-version: latest
+      - run: npm install
+      - run: node --run prettier
+  eslint:
+    name: ESLint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-node@v4
+        with:
+          node-version: latest
+      - run: npm install
+      - run: node --run eslint
+  types:
+    name: Types
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-node@v4
+        with:
+          node-version: latest
+      - run: npm install
+      - run: node --run types
   test:
-    name: Test with Node.js v${{ matrix.node }} and ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
+    name: Test
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest]
-        node: ["18", "20", "21"]
+        node: [20, 22, 24]
+    runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v4
-      - name: Setup Node.js v${{ matrix.node }}
-        uses: actions/setup-node@v3
+      - uses: actions/checkout@v5
+      - uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
-      - name: npm install and test
-        run: npm install-test
+      - run: npm install
+      - run: npm run test
+        if: matrix.node < 22
+      - run: node --run test
+        if: matrix.node >= 22

.github/workflows/ci.yml

@@ -1,5 +1,29 @@
 # apollo-upload-client changelog
 
+## Next
+
+### Major
+
+- Updated Node.js support to `^20.9.0 || >=22.0.0`.
+- Use the TypeScript v5.5+ JSDoc tag `@import` to import types in modules.
+- Updated dev dependencies, some of which require newer Node.js versions than previously supported.
+
+### Patch
+
+- Updated the package scripts:
+  - Reordered and renamed scripts.
+  - Replaced `npm run` with `node --run`.
+- Updated GitHub Actions CI config:
+  - Run checks in separate jobs.
+  - Removed custom step names.
+  - Updated `actions/checkout` to v5.
+  - Updated `actions/setup-node` to v4.
+  - Replaced `npm run` with `node --run`.
+  - Run tests with Node.js v20, v22, v24.
+- Enabled the TypeScript compiler options `noUnusedLocals` and `noUnusedParameters`.
+- Migrated to the ESLint v9 CLI and “flat” config.
+- In tests, removed the no longer needed polyfill for the global `File`.
+
 ## 18.0.1
 
 ### Patch
@@ -15,7 +39,6 @@
 - Updated Node.js support to `^18.15.0 || >=20.4.0`.
 - Updated the [`@apollo/client`](https://npm.im/@apollo/client) peer dependency to `^3.8.0`.
 - Updated the [`extract-files`](http://npm.im/extract-files) dependency to v13.
-
   - React Native is no longer supported out of the box.
 
     The class `ReactNativeFile` is no longer exported, or matched by the function `isExtractableFile`.
@@ -64,7 +87,6 @@
   Types published in [`@types/apollo-upload-client`](https://npm.im/@types/apollo-upload-client) should no longer be used.
 
   Projects must configure TypeScript to use types from the ECMAScript modules that have a `// @ts-check` comment:
-
   - [`compilerOptions.allowJs`](https://www.typescriptlang.org/tsconfig#allowJs) should be `true`.
   - [`compilerOptions.maxNodeModuleJsDepth`](https://www.typescriptlang.org/tsconfig#maxNodeModuleJsDepth) should be reasonably large, e.g. `10`.
   - [`compilerOptions.module`](https://www.typescriptlang.org/tsconfig#module) should be `"node16"` or `"nodenext"`.

changelog.md

@@ -1,5 +1,12 @@
 // @ts-check
 
+/**
+ * @import { DefaultContext } from "@apollo/client/core/types.js"
+ * @import {
+ *   Printer
+ * } from "@apollo/client/link/http/selectHttpOptionsAndBody.js"
+ */
+
 import { ApolloLink } from "@apollo/client/link/core/ApolloLink.js";
 import { createSignalIfSupported } from "@apollo/client/link/http/createSignalIfSupported.js";
 import { parseAndCheckHttpResponse } from "@apollo/client/link/http/parseAndCheckHttpResponse.js";
@@ -49,9 +56,8 @@ import isExtractableFile from "./isExtractableFile.mjs";
  *   Customizes how extracted files are appended to the
  *   [`FormData`](https://developer.mozilla.org/en-US/docs/Web/API/FormData)
  *   instance. Defaults to {@linkcode formDataAppendFile}.
- * @param {import("@apollo/client/link/http/selectHttpOptionsAndBody.js").Printer} [options.print]
- *   Prints the GraphQL query or mutation AST to a string for transport.
- *   Defaults to {@linkcode defaultPrinter}.
+ * @param {Printer} [options.print] Prints the GraphQL query or mutation AST to
+ *   a string for transport. Defaults to {@linkcode defaultPrinter}.
  * @param {typeof fetch} [options.fetch] [`fetch`](https://fetch.spec.whatwg.org)
  *   implementation. Defaults to the {@linkcode fetch} global.
  * @param {RequestInit} [options.fetchOptions] `fetch` options; overridden by
@@ -104,7 +110,7 @@ export default function createUploadLink({
   return new ApolloLink((operation) => {
     const context =
       /**
-       * @type {import("@apollo/client/core/types.js").DefaultContext & {
+       * @type {DefaultContext & {
        *   clientAwareness?: {
        *     name?: string,
        *     version?: string,

createUploadLink.mjs

@@ -1,7 +1,5 @@
 // @ts-check
 
-import "./test/polyfillFile.mjs";
-
 import { deepEqual, deepStrictEqual, ok, strictEqual } from "node:assert";
 import { describe, it } from "node:test";
 

createUploadLink.test.mjs

@@ -0,0 +1,74 @@
+// @ts-check
+
+/** @import { Linter } from "eslint" */
+
+import eslintJs from "@eslint/js";
+import eslintPluginOptimalModules from "eslint-plugin-optimal-modules";
+import eslintPluginSimpleImportSort from "eslint-plugin-simple-import-sort";
+import globals from "globals";
+
+/**
+ * Globs for ESM files.
+ * @satisfies {Array<string>}
+ */
+const globsEsm = ["**/**.mjs"];
+
+/**
+ * Globs for CJS files.
+ * @satisfies {Array<string>}
+ */
+const globsCjs = ["**/**.cjs", "**/**.js"];
+
+/**
+ * Globs for all JavaScript files.
+ * @satisfies {Array<string>}
+ */
+const globsJs = [...globsEsm, ...globsCjs];
+
+/**
+ * ESLint configuration.
+ * @satisfies {Array<Linter.Config>}
+ */
+const eslintConfig = [
+  {
+    files: globsJs,
+    ...eslintJs.configs.recommended,
+  },
+  {
+    files: globsJs,
+    rules: {
+      "arrow-body-style": "error",
+      "object-shorthand": "error",
+      strict: "error",
+    },
+  },
+  {
+    files: globsEsm,
+    languageOptions: {
+      globals: {
+        ...globals.nodeBuiltin,
+        ...globals.browser,
+      },
+    },
+    plugins: {
+      "simple-import-sort": eslintPluginSimpleImportSort,
+    },
+    rules: {
+      "simple-import-sort/imports": "error",
+      "simple-import-sort/exports": "error",
+    },
+  },
+  {
+    files: globsEsm,
+    ...eslintPluginOptimalModules.configs.recommended,
+  },
+  {
+    files: globsCjs,
+    languageOptions: {
+      sourceType: "commonjs",
+      globals: globals.node,
+    },
+  },
+];
+
+export default eslintConfig;

eslint.config.mjs

@@ -1,13 +1,14 @@
 // @ts-check
 
+/** @import { ExtractableFile } from "./isExtractableFile.mjs" */
+
 /**
  * The default implementation for the function `createUploadLink` option
  * `formDataAppendFile` that uses the standard {@linkcode FormData.append}
  * method.
  * @param {FormData} formData Form data to append the specified file to.
  * @param {string} fieldName Field name for the file.
- * @param {import("./isExtractableFile.mjs").ExtractableFile} file File to
- *   append.
+ * @param {ExtractableFile} file File to append.
  */
 export default function formDataAppendFile(formData, fieldName, file) {
   "name" in file

formDataAppendFile.mjs

@@ -1,7 +1,5 @@
 // @ts-check
 
-import "./test/polyfillFile.mjs";
-
 import { ok, strictEqual } from "node:assert";
 import { describe, it } from "node:test";
 

formDataAppendFile.test.mjs

@@ -1,10 +1,14 @@
 // @ts-check
 
+/**
+ * @import {
+ *   ExtractableFile as ExtractFilesExtractableFile
+ * } from "extract-files/isExtractableFile.mjs"
+ */
+
 export { default } from "extract-files/isExtractableFile.mjs";
 
 /**
  * An extractable file.
- * @typedef {import(
- *   "extract-files/isExtractableFile.mjs"
- * ).ExtractableFile} ExtractableFile
+ * @typedef {ExtractFilesExtractableFile} ExtractableFile
  */

isExtractableFile.mjs

@@ -3,6 +3,8 @@
     "maxNodeModuleJsDepth": 10,
     "module": "nodenext",
     "noEmit": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
     "strict": true
   },
   "typeAcquisition": {