Add eslint-plugin-n to eslint config for node files

emberjs · Oct 25, 2023 · 9845438 · 9845438
1 parent fb5b968
commit 9845438
Show file tree

Hide file tree

Showing 79 changed files with 201 additions and 88 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -2,5 +2,5 @@
   "files.associations": {
     "turbo.json": "jsonc"
   },
-  "eslint.workingDirectories": ["packages/*", "tests/*"]
+  "eslint.workingDirectories": [{ "mode": "auto" }, "packages/*", "tests/*"]
 }
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -0,0 +1,34 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "pnpm: lint",
+      "type": "shell",
+      "command": "pnpm lint",
+
+      "problemMatcher": {
+        "owner": "pnpm-lint",
+        "fileLocation": ["absolute"],
+        "background": {
+          "activeOnStart": true,
+          "beginsPattern": "^Scope: .* workspace projects$",
+          "endsPattern": "^Summary: .* fails, .* passes$"
+        },
+        "pattern": [
+          {
+            "regexp": "^.+lint: (\\/.+)$",
+            "file": 1
+          },
+          {
+            "regexp": "^.+lint:\\s+(\\d+):(\\d+)\\s+(\\w+)\\s+(.+)$",
+            "line": 1,
+            "column": 2,
+            "severity": 3,
+            "message": 4,
+            "loop": true
+          }
+        ]
+      }
+    }
+  ]
+}
diff --git a/config/eslint/node.cjs b/config/eslint/node.cjs
@@ -1,6 +1,6 @@
 function defaults(config) {
   const result = {
-    files: !config?.useModules ? ['./babel.config.js', './.eslintrc.cjs', './index.js', './addon-main.cjs', './addon-main.js'] : [],
+    files: !config?.useModules ? ['./index.js', './addon-main.cjs', './addon-main.js'] : [],
     parserOptions: {
       sourceType: config?.useModules ? 'module' : 'script',
       ecmaVersion: 2022,
@@ -11,6 +11,36 @@ function defaults(config) {
       es6: true,
     },
     globals: config?.globals || {},
+    plugins: ['n'],
+    extends: 'plugin:n/recommended',
+  };
+
+  if (config?.files) {
+    result.files.push(...config.files);
+  }
+
+  return result;
+}
+
+function config(config) {
+  const result = {
+    files: ['./babel.config.js', './.eslintrc.cjs', './rollup.config.mjs'],
+    parserOptions: {
+      sourceType: config?.useModules ? 'module' : 'script',
+      ecmaVersion: 2022,
+    },
+    env: {
+      browser: false,
+      node: true,
+      es6: true,
+    },
+    globals: config?.globals || {},
+    plugins: ['n'],
+    extends: 'plugin:n/recommended',
+    rules: {
+      // It's ok to use unpublished files here since we don't ship these
+      'n/no-unpublished-require': 'off',
+    },
   };
 
   if (config?.files) {
@@ -21,5 +51,6 @@ function defaults(config) {
 }
 
 module.exports = {
-  defaults
+  defaults,
+  config,
 };
diff --git a/config/eslint/parser.cjs b/config/eslint/parser.cjs
@@ -6,7 +6,7 @@ function defaults() {
       ecmaVersion: 2022,
       sourceType: 'module',
       babelOptions: {
-        // eslint-disable-next-line node/no-unpublished-require
+        // eslint-disable-next-line n/no-unpublished-require
         plugins: [[require.resolve('@babel/plugin-proposal-decorators'), { legacy: true }]],
       },
       requireConfigFile: false,
@@ -15,5 +15,5 @@ function defaults() {
 }
 
 module.exports = {
-  defaults
+  defaults,
 };
diff --git a/config/package.json b/config/package.json
@@ -11,6 +11,7 @@
     "eslint": "^8.52.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-import": "^2.29.0",
+    "eslint-plugin-n": "^16.2.0",
     "eslint-plugin-prettier": "^5.0.1",
     "eslint-plugin-simple-import-sort": "^10.0.0",
     "prettier": "^3.0.3",
@@ -23,4 +24,4 @@
     "extends": "../../package.json"
   },
   "packageManager": "[email protected]"
-}
+}
diff --git a/package.json b/package.json
@@ -11,7 +11,7 @@
     "prepare": "pnpm build",
     "build": "turbo _build --log-order=stream --filter=./packages/*",
     "build:docs": "mkdir -p packages/-ember-data/dist && cd ./docs-generator && node ./compile-docs.js",
-    "lint": "pnpm run -r --workspace-concurrency=-1 --if-present lint",
+    "lint": "FORCE_COLOR=2 pnpm run -r --workspace-concurrency=-1 --if-present --reporter=append-only --no-bail lint",
     "preinstall": "npx only-allow pnpm",
     "check:types": "pnpm run -r --workspace-concurrency=-1 --if-present check:types",
     "test": "pnpm turbo test --concurrency=1",
@@ -139,4 +139,4 @@
       "[email protected]": "patches/[email protected]"
     }
   }
-}
+}
diff --git a/packages/-ember-data/.eslintrc.cjs b/packages/-ember-data/.eslintrc.cjs
@@ -22,5 +22,5 @@ module.exports = {
 
   ignorePatterns: ignore.ignoreRules(),
 
-  overrides: [node.defaults(), typescript.defaults()],
+  overrides: [node.config(), node.defaults(), typescript.defaults()],
 };
diff --git a/packages/-ember-data/package.json b/packages/-ember-data/package.json
@@ -12,7 +12,7 @@
     "test": "tests"
   },
   "scripts": {
-    "lint": "eslint . --quiet --cache --cache-strategy=content --ext .js,.ts,.mjs,.cjs",
+    "lint": "eslint . --quiet --cache --cache-strategy=content --ext .js,.ts,.mjs,.cjs --report-unused-disable-directives",
     "move-dts": "bun ../../scripts/copy-declarations.mjs addon",
     "build:types": "tsc --build",
     "_build": "bun run build:types && bun run move-dts",

diff --git a/packages/active-record/.eslintrc.cjs b/packages/active-record/.eslintrc.cjs
@@ -22,5 +22,5 @@ module.exports = {
 
   ignorePatterns: ignore.ignoreRules(),
 
-  overrides: [node.defaults(), typescript.defaults()],
+  overrides: [node.config(), node.defaults(), typescript.defaults()],
 };
diff --git a/packages/active-record/package.json b/packages/active-record/package.json
@@ -70,7 +70,7 @@
     }
   },
   "scripts": {
-    "lint": "eslint . --quiet --cache --cache-strategy=content --ext .js,.ts,.mjs,.cjs",
+    "lint": "eslint . --quiet --cache --cache-strategy=content --ext .js,.ts,.mjs,.cjs --report-unused-disable-directives",
     "build:types": "tsc --build",
     "build:client": "rollup --config && babel ./addon --out-dir addon --plugins=../private-build-infra/src/transforms/babel-plugin-transform-ext.js",
     "_build": "bun run build:client && bun run build:types",

diff --git a/packages/adapter/.eslintrc.cjs b/packages/adapter/.eslintrc.cjs
@@ -30,5 +30,5 @@ module.exports = {
 
   ignorePatterns: ignore.ignoreRules(),
 
-  overrides: [node.defaults(), typescript.defaults()],
+  overrides: [node.config(), node.defaults(), typescript.defaults()],
 };
diff --git a/packages/adapter/package.json b/packages/adapter/package.json
@@ -14,7 +14,7 @@
   "author": "",
   "directories": {},
   "scripts": {
-    "lint": "eslint . --quiet --cache --cache-strategy=content --ext .js,.ts,.mjs,.cjs",
+    "lint": "eslint . --quiet --cache --cache-strategy=content --ext .js,.ts,.mjs,.cjs --report-unused-disable-directives",
     "build:types": "tsc --build",
     "build:client": "rollup --config && babel ./addon --out-dir addon --plugins=../private-build-infra/src/transforms/babel-plugin-transform-ext.js",
     "_build": "bun run build:client && bun run build:types",

diff --git a/packages/core-types/.eslintrc.cjs b/packages/core-types/.eslintrc.cjs
@@ -22,5 +22,5 @@ module.exports = {
 
   ignorePatterns: ignore.ignoreRules(),
 
-  overrides: [node.defaults(), typescript.defaults()],
+  overrides: [node.config(), node.defaults(), typescript.defaults()],
 };
diff --git a/packages/core-types/package.json b/packages/core-types/package.json
@@ -13,7 +13,7 @@
   "license": "MIT",
   "author": "Chris Thoburn <[email protected]>",
   "scripts": {
-    "lint": "eslint . --quiet --cache --cache-strategy=content --ext .js,.ts,.mjs,.cjs",
+    "lint": "eslint . --quiet --cache --cache-strategy=content --ext .js,.ts,.mjs,.cjs --report-unused-disable-directives",
     "build:types": "tsc --build",
     "build:client": "rollup --config && babel ./addon --out-dir addon --plugins=../private-build-infra/src/transforms/babel-plugin-transform-ext.js",
     "_build": "bun run build:client && bun run build:types",

diff --git a/packages/debug/.eslintrc.cjs b/packages/debug/.eslintrc.cjs
@@ -21,5 +21,5 @@ module.exports = {
 
   ignorePatterns: ignore.ignoreRules(),
 
-  overrides: [node.defaults()],
+  overrides: [node.config(), node.defaults()],
 };
diff --git a/packages/debug/package.json b/packages/debug/package.json
@@ -14,7 +14,7 @@
   "author": "",
   "directories": {},
   "scripts": {
-    "lint": "eslint . --quiet --cache --cache-strategy=content --ext .js,.ts,.mjs,.cjs",
+    "lint": "eslint . --quiet --cache --cache-strategy=content --ext .js,.ts,.mjs,.cjs --report-unused-disable-directives",
     "_syncPnpm": "bun run sync-dependencies-meta-injected"
   },
   "peerDependencies": {

diff --git a/packages/diagnostic/.eslintrc.cjs b/packages/diagnostic/.eslintrc.cjs
@@ -23,8 +23,13 @@ module.exports = {
   ignorePatterns: ignore.ignoreRules(),
 
   overrides: [
+    node.config(),
     node.defaults(),
-    node.defaults({ useModules: true, globals: { Bun: true }, files: ['./server/**'] }),
+    node.defaults({
+      files: ['./server/**'],
+      useModules: true,
+      globals: { Bun: true },
+    }),
     typescript.defaults({
       rules: {
         'no-console': 'off',

diff --git a/packages/diagnostic/package.json b/packages/diagnostic/package.json
@@ -60,7 +60,7 @@
     }
   },
   "scripts": {
-    "lint": "eslint . --quiet --cache --cache-strategy=content --ext .js,.ts,.mjs,.cjs",
+    "lint": "eslint . --quiet --cache --cache-strategy=content --ext .js,.ts,.mjs,.cjs --report-unused-disable-directives",
     "build:tests": "rm -rf dist-test && cp -R test dist-test && mkdir -p dist-test/@warp-drive && cp -R dist dist-test/@warp-drive/diagnostic",
     "build:types": "tsc --build",
     "build:runtime": "rollup --config",
@@ -99,6 +99,7 @@
     "@babel/preset-typescript": "^7.23.2",
     "@babel/runtime": "^7.23.2",
     "@embroider/addon-dev": "^4.1.1",
+    "@embroider/addon-shim": "^1.8.6",
     "@rollup/plugin-babel": "^6.0.4",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@warp-drive/internal-config": "workspace:5.5.0-alpha.11",

diff --git a/packages/diagnostic/server/browsers/index.js b/packages/diagnostic/server/browsers/index.js
@@ -2,8 +2,8 @@ import os from 'os';
 import path from 'path';
 import tmp from 'tmp';
 
-import { debug } from '../utils/debug';
-import { isWin, platformName } from '../utils/platform';
+import { debug } from '../utils/debug.js';
+import { isWin, platformName } from '../utils/platform.js';
 
 export function getHomeDir() {
   return process.env.HOME || process.env.USERPROFILE;

diff --git a/packages/diagnostic/server/bun/socket-handler.js b/packages/diagnostic/server/bun/socket-handler.js
@@ -53,6 +53,11 @@ export function buildHandler(config, state) {
                 await config.cleanup();
                 debug(`Configured cleanup hook completed`);
               }
+              // 1. We expect all cleanup to have happened after
+              //    config.cleanup(), so exiting here should be safe.
+              // 2. We also want to forcibly exit with a success code in this
+              //    case.
+              // eslint-disable-next-line n/no-process-exit
               process.exit(exitCode);
             }
           }

diff --git a/packages/graph/.eslintrc.cjs b/packages/graph/.eslintrc.cjs
@@ -22,5 +22,5 @@ module.exports = {
 
   ignorePatterns: ignore.ignoreRules(),
 
-  overrides: [node.defaults(), typescript.defaults()],
+  overrides: [node.config(), node.defaults(), typescript.defaults()],
 };
diff --git a/packages/graph/package.json b/packages/graph/package.json
@@ -13,7 +13,7 @@
   "license": "MIT",
   "author": "Chris Thoburn <[email protected]>",
   "scripts": {
-    "lint": "eslint . --quiet --cache --cache-strategy=content --ext .js,.ts,.mjs,.cjs",
+    "lint": "eslint . --quiet --cache --cache-strategy=content --ext .js,.ts,.mjs,.cjs --report-unused-disable-directives",
     "build:types": "tsc --build",
     "build:client": "rollup --config && babel ./addon --out-dir addon --plugins=../private-build-infra/src/transforms/babel-plugin-transform-ext.js",
     "_build": "bun run build:client && bun run build:types",

diff --git a/packages/holodeck/.eslintrc.cjs b/packages/holodeck/.eslintrc.cjs
@@ -22,5 +22,5 @@ module.exports = {
 
   ignorePatterns: ignore.ignoreRules(),
 
-  overrides: [node.defaults(), typescript.defaults()],
+  overrides: [node.config(), node.defaults(), typescript.defaults()],
 };
diff --git a/packages/json-api/.eslintrc.cjs b/packages/json-api/.eslintrc.cjs
@@ -22,5 +22,5 @@ module.exports = {
 
   ignorePatterns: ignore.ignoreRules(),
 
-  overrides: [node.defaults(), typescript.defaults()],
+  overrides: [node.config(), node.defaults(), typescript.defaults()],
 };
diff --git a/packages/json-api/package.json b/packages/json-api/package.json
@@ -13,7 +13,7 @@
   "license": "MIT",
   "author": "",
   "scripts": {
-    "lint": "eslint . --quiet --cache --cache-strategy=content --ext .js,.ts,.mjs,.cjs",
+    "lint": "eslint . --quiet --cache --cache-strategy=content --ext .js,.ts,.mjs,.cjs --report-unused-disable-directives",
     "build:types": "tsc --build",
     "build:client": "rollup --config && babel ./addon --out-dir addon --plugins=../private-build-infra/src/transforms/babel-plugin-transform-ext.js",
     "_build": "bun run build:client && bun run build:types",

diff --git a/packages/legacy-compat/.eslintrc.cjs b/packages/legacy-compat/.eslintrc.cjs
@@ -23,7 +23,7 @@ const config = {
 
   ignorePatterns: ignore.ignoreRules(),
 
-  overrides: [node.defaults(), typescript.defaults()],
+  overrides: [node.config(), node.defaults(), typescript.defaults()],
 };
 
 module.exports = config;
diff --git a/packages/legacy-compat/package.json b/packages/legacy-compat/package.json
@@ -40,7 +40,7 @@
     }
   },
   "scripts": {
-    "lint": "eslint . --quiet --cache --cache-strategy=content --ext .js,.ts,.mjs,.cjs",
+    "lint": "eslint . --quiet --cache --cache-strategy=content --ext .js,.ts,.mjs,.cjs --report-unused-disable-directives",
     "build:types": "tsc --build",
     "build:client": "rollup --config && babel ./addon --out-dir addon --plugins=../private-build-infra/src/transforms/babel-plugin-transform-ext.js",
     "_build": "bun run build:client && bun run build:types",

diff --git a/packages/model/.eslintrc.cjs b/packages/model/.eslintrc.cjs
@@ -35,5 +35,5 @@ module.exports = {
 
   ignorePatterns: ignore.ignoreRules(),
 
-  overrides: [node.defaults(), typescript.defaults()],
+  overrides: [node.config(), node.defaults(), typescript.defaults()],
 };
diff --git a/packages/model/package.json b/packages/model/package.json
@@ -14,7 +14,7 @@
   "author": "",
   "directories": {},
   "scripts": {
-    "lint": "eslint . --quiet --cache --cache-strategy=content --ext .js,.ts,.mjs,.cjs",
+    "lint": "eslint . --quiet --cache --cache-strategy=content --ext .js,.ts,.mjs,.cjs --report-unused-disable-directives",
     "move-dts": "bun ../../scripts/copy-declarations.mjs src",
     "build:types": "tsc --build && bun run move-dts",
     "build:client": "rollup --config && babel ./addon --out-dir addon --plugins=../private-build-infra/src/transforms/babel-plugin-transform-ext.js",

diff --git a/packages/model/src/-private/legacy-relationships-support.ts b/packages/model/src/-private/legacy-relationships-support.ts
@@ -667,7 +667,6 @@ function handleCompletedRelationshipRequest(
     // has never been accessed
     if (proxy && !isHasMany) {
       // @ts-expect-error unsure why this is not resolving the boolean but async belongsTo is weird
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
       if (proxy.content && proxy.content.isDestroying) {
         (proxy as PromiseBelongsTo).set('content', null);
       }

diff --git a/packages/model/src/-private/references/belongs-to.ts b/packages/model/src/-private/references/belongs-to.ts
@@ -393,7 +393,6 @@ export default class BelongsToReference {
     const record = this.store.push(jsonApiDoc);
 
     if (DEBUG) {
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-call
       assertPolymorphicType(
         this.belongsToRelationship.identifier,
         this.belongsToRelationship.definition,

diff --git a/packages/model/src/-private/references/has-many.ts b/packages/model/src/-private/references/has-many.ts
@@ -422,7 +422,6 @@ export default class HasManyReference {
         const relationshipMeta = this.hasManyRelationship.definition;
         const identifier = this.hasManyRelationship.identifier;
 
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-call
         assertPolymorphicType(identifier, relationshipMeta, recordIdentifierFor(record), store);
       }
       return recordIdentifierFor(record);