eslint-config-complete 1.2.0 → 1.2.2

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright The Complete Contributors
+Copyright (c) 2024 The Complete Contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-complete",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "A sharable ESLint config for TypeScript projects.",
   "keywords": [
     "eslint",
@@ -29,10 +29,11 @@
     "src"
   ],
   "scripts": {
+    "docs": "tsx ./scripts/docs.ts",
     "lint": "tsx ./scripts/lint.ts"
   },
   "dependencies": {
-    "@stylistic/eslint-plugin": "^2.7.2",
+    "@stylistic/eslint-plugin": "^2.8.0",
     "confusing-browser-globals": "^1.0.11",
     "eslint-import-resolver-typescript": "^3.6.3",
     "eslint-plugin-complete": "^1.0.0",
@@ -40,6 +41,18 @@
     "eslint-plugin-jsdoc": "^50.2.2",
     "eslint-plugin-n": "^17.10.2",
     "eslint-plugin-unicorn": "^55.0.0",
-    "typescript-eslint": "^8.4.0"
+    "typescript-eslint": "^8.5.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.10.0",
+    "@types/confusing-browser-globals": "^1.0.3",
+    "@types/eslint-config-prettier": "^6.11.3",
+    "@types/eslint__js": "^8.42.3",
+    "@types/node": "^22.5.4",
+    "complete-common": "^1.0.0",
+    "complete-node": "^1.3.0",
+    "eslint-config-prettier": "^9.1.0",
+    "extract-comments": "^1.1.0",
+    "typescript": "5.5.4"
   }
 }

package/src/{baseConfigs → base}/base-eslint.js

@@ -1,7 +1,10 @@
 import confusingBrowserGlobals from "confusing-browser-globals";
 import tseslint from "typescript-eslint";
 
-/** @type {Record<string, import("@typescript-eslint/utils").TSESLint.SharedConfig.RuleEntry>} */
+/**
+ * @see https://eslint.org/docs/latest/rules/#possible-problems
+ * @type {Record<string, import("@typescript-eslint/utils").TSESLint.SharedConfig.RuleEntry>}
+ */
 const POSSIBLE_PROBLEMS = {
   /** The `checkForEach` option is enabled to make the rule stricter. */
   "array-callback-return": [
@@ -87,7 +90,10 @@ const POSSIBLE_PROBLEMS = {
   "valid-typeof": "warn",
 };
 
-/** @type {Record<string, import("@typescript-eslint/utils").TSESLint.SharedConfig.RuleEntry>} */
+/**
+ * @see https://eslint.org/docs/latest/rules/#suggestions
+ * @type {Record<string, import("@typescript-eslint/utils").TSESLint.SharedConfig.RuleEntry>}
+ */
 const SUGGESTIONS = {
   "accessor-pairs": "warn",
   "arrow-body-style": "warn",
@@ -627,12 +633,18 @@ const SUGGESTIONS = {
   yoda: "warn",
 };
 
-/** @type {Record<string, import("@typescript-eslint/utils").TSESLint.SharedConfig.RuleEntry>} */
+/**
+ * @see https://eslint.org/docs/latest/rules/#suggestions
+ * @type {Record<string, import("@typescript-eslint/utils").TSESLint.SharedConfig.RuleEntry>}
+ */
 const LAYOUT_AND_FORMATTING = {
   "unicode-bom": "warn",
 };
 
-/** @type {Record<string, import("@typescript-eslint/utils").TSESLint.SharedConfig.RuleEntry>} */
+/**
+ * @see https://eslint.org/docs/latest/rules/#deprecated
+ * @type {Record<string, import("@typescript-eslint/utils").TSESLint.SharedConfig.RuleEntry>}
+ */
 const DEPRECATED = {
   /** Disabled since the rule is deprecated. */
   "array-bracket-newline": "off",

package/src/{baseConfigs → base}/base-import-x.js

@@ -1,7 +1,10 @@
 import ESLintPluginImportX from "eslint-plugin-import-x";
 import tseslint from "typescript-eslint";
 
-/** @type {Record<string, import("@typescript-eslint/utils").TSESLint.SharedConfig.RuleEntry>} */
+/**
+ * @see https://github.com/un-ts/eslint-plugin-import-x/blob/master/README.md#helpful-warnings
+ * @type {Record<string, import("@typescript-eslint/utils").TSESLint.SharedConfig.RuleEntry>}
+ */
 const HELPFUL_WARNINGS = {
   "import-x/export": "warn",
 
@@ -13,16 +16,13 @@ const HELPFUL_WARNINGS = {
 
   "import-x/no-empty-named-blocks": "warn",
 
-  /**
-   * The options are [copied from
-   * Airbnb](https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/import.js).
-   *
-   * We also add a "scripts" directory entry for "devDependencies".
-   */
+  /** We add common patterns to the "devDependencies" array. */
   "import-x/no-extraneous-dependencies": [
     "warn",
     {
       devDependencies: [
+        // From:
+        // https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/imports.js
         "test/**", // tape, common npm pattern
         "tests/**", // also common npm pattern
         "spec/**", // mocha, rspec-like pattern
@@ -31,8 +31,8 @@ const HELPFUL_WARNINGS = {
         "test.{js,jsx}", // repos with a single test file
         "test-*.{js,jsx}", // repos with multiple top-level test files
         "**/*{.,_}{test,spec}.{js,jsx}", // tests where the extension or filename suffix denotes that it is a test
-        "**/jest.config.js", // jest config
-        "**/jest.setup.js", // jest setup
+        "**/jest.config.{js,cjs,mjs,ts,cts,mts}", // jest config // Modified for extra file extensions.
+        "**/jest.setup.{js,cjs,mjs,ts,cts,mts}", // jest setup // Modified for extra file extensions.
         "**/vue.config.js", // vue-cli config
         "**/webpack.config.js", // webpack config
         "**/webpack.config.*.js", // webpack config
@@ -44,9 +44,14 @@ const HELPFUL_WARNINGS = {
         "**/protractor.conf.js", // protractor config
         "**/protractor.conf.*.js", // protractor config
         "**/karma.conf.js", // karma config
-        "**/.eslintrc.js", // eslint config
+        "**/.eslintrc.{js,cjs,mjs,ts,cts,mts}", // eslint config // Modified for extra file extensions.
 
         "**/scripts/*.{js,cjs,mjs,ts,cts,mts}", // Files inside of a "scripts" directory.
+        "**/tests/*.{js,cjs,mjs,ts,cts,mts}", // Files inside of a "tests" directory.
+        "**/eslint.config.{js,cjs,mjs,ts,cts,mts}", // ESLint config
+        "**/prettier.config.{js,cjs,mjs,ts,cts,mts}", // Prettier config
+        "**/typedoc.config.{js,cjs,mjs,ts,cts,mts}", // TypeDoc config
+        "**/typedoc.config.*.{js,cjs,mjs,ts,cts,mts}", // TypeDoc config
       ],
       optionalDependencies: false,
     },
@@ -61,6 +66,12 @@ const HELPFUL_WARNINGS = {
    */
   "import-x/no-named-as-default-member": "off",
 
+  /**
+   * Temporarily disabled due to [false
+   * positives](https://github.com/un-ts/eslint-plugin-import-x/pull/157).
+   */
+  "import-x/no-rename-default": "off",
+
   /**
    * Disabled since this check is better performed by the [`knip`](https://github.com/webpro/knip)
    * tool.
@@ -68,7 +79,10 @@ const HELPFUL_WARNINGS = {
   "import-x/no-unused-modules": "off",
 };
 
-/** @type {Record<string, import("@typescript-eslint/utils").TSESLint.SharedConfig.RuleEntry>} */
+/**
+ * @see https://github.com/un-ts/eslint-plugin-import-x/blob/master/README.md#module-systems
+ * @type {Record<string, import("@typescript-eslint/utils").TSESLint.SharedConfig.RuleEntry>}
+ */
 const MODULE_SYSTEMS = {
   "import-x/no-amd": "warn",
   "import-x/no-commonjs": "warn",
@@ -81,7 +95,10 @@ const MODULE_SYSTEMS = {
   "import-x/unambiguous": "off",
 };
 
-/** @type {Record<string, import("@typescript-eslint/utils").TSESLint.SharedConfig.RuleEntry>} */
+/**
+ * @see https://github.com/un-ts/eslint-plugin-import-x/blob/master/README.md#static-analysis
+ * @type {Record<string, import("@typescript-eslint/utils").TSESLint.SharedConfig.RuleEntry>}
+ */
 const STATIC_ANALYSIS = {
   /**
    * Disabled because this is [already handled by the TypeScript
@@ -130,7 +147,10 @@ const STATIC_ANALYSIS = {
   "import-x/no-webpack-loader-syntax": "warn",
 };
 
-/** @type {Record<string, import("@typescript-eslint/utils").TSESLint.SharedConfig.RuleEntry>} */
+/**
+ * @see https://github.com/un-ts/eslint-plugin-import-x/blob/master/README.md#style-guide
+ * @type {Record<string, import("@typescript-eslint/utils").TSESLint.SharedConfig.RuleEntry>}
+ */
 const STYLE_GUIDE = {
   "import-x/consistent-type-specifier-style": "warn",
 
@@ -235,9 +255,6 @@ export const baseImportX = tseslint.config(
     // https://github.com/un-ts/eslint-plugin-import-x/issues/150
     // - Second, we extend the upstream TypeScript configuration:
     // https://github.com/un-ts/eslint-plugin-import-x/blob/master/src/config/typescript.ts
-    // - Third, we need to specify "typescript: true" under the resolver, as documented here:
-    // https://github.com/un-ts/eslint-plugin-import-x/issues/29
-    // (Otherwise, the "no-cycle" rule will not work.)
     settings: {
       "import-x/extensions": ALL_EXTENSIONS,
       "import-x/external-module-folders": [
@@ -249,9 +266,6 @@ export const baseImportX = tseslint.config(
       },
       "import-x/resolver": {
         typescript: true,
-        node: {
-          extensions: ALL_EXTENSIONS,
-        },
       },
     },
 
@@ -295,26 +309,4 @@ export const baseImportX = tseslint.config(
       "import-x/no-default-export": "off",
     },
   },
-
-  {
-    files: ["eslint.config.js", "eslint.config.cjs", "eslint.config.mjs"],
-
-    rules: {
-      "import-x/no-extraneous-dependencies": [
-        "warn",
-        {
-          devDependencies: [
-            "eslint.config.js",
-            "eslint.config.cjs",
-            "eslint.config.mjs",
-          ],
-
-          // ESLint configs in monorepos will import from "eslint-config-complete" and
-          // "typescript-eslint", which might be installed as part of `complete-lint` (as a
-          // transitive dependency).
-          whitelist: ["eslint-config-complete", "typescript-eslint"],
-        },
-      ],
-    },
-  },
 );

package/src/{baseConfigs → base}/base-typescript-eslint.js

@@ -140,6 +140,7 @@ export const baseTypeScriptESLint = tseslint.config(
       "@typescript-eslint/no-base-to-string": "warn",
       "@typescript-eslint/no-confusing-non-null-assertion": "warn",
       "@typescript-eslint/no-confusing-void-expression": "warn",
+      "@typescript-eslint/no-deprecated": "warn",
       "@typescript-eslint/no-duplicate-enum-values": "warn",
       "@typescript-eslint/no-duplicate-type-constituents": "warn",
       "@typescript-eslint/no-dynamic-delete": "warn",

package/src/{baseConfigs → base}/base-unicorn.js

@@ -1,7 +1,10 @@
 import ESLintPluginUnicorn from "eslint-plugin-unicorn";
 import tseslint from "typescript-eslint";
 
-/** @type {Record<string, import("@typescript-eslint/utils").TSESLint.SharedConfig.RuleEntry>} */
+/**
+ * @see https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/readme.md#rules
+ * @type {Record<string, import("@typescript-eslint/utils").TSESLint.SharedConfig.RuleEntry>}
+ */
 const NORMAL_RULES = {
   "unicorn/better-regex": "warn",
   "unicorn/catch-error-name": "warn",
@@ -166,7 +169,10 @@ const NORMAL_RULES = {
   "unicorn/throw-new-error": "warn",
 };
 
-/** @type {Record<string, import("@typescript-eslint/utils").TSESLint.SharedConfig.RuleEntry>} */
+/**
+ * @see https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/deprecated-rules.md
+ * @type {Record<string, import("@typescript-eslint/utils").TSESLint.SharedConfig.RuleEntry>}
+ */
 const DEPRECATED_RULES = {
   /** Disabled because this rule is deprecated. */
   "unicorn/import-index": "off",

package/src/base.js

@@ -1,12 +1,12 @@
 import ESLintPluginComplete from "eslint-plugin-complete";
 import tseslint from "typescript-eslint";
-import { baseESLint } from "./baseConfigs/base-eslint.js";
-import { baseImportX } from "./baseConfigs/base-import-x.js";
-import { baseJSDoc } from "./baseConfigs/base-jsdoc.js";
-import { baseN } from "./baseConfigs/base-n.js";
-import { baseStylistic } from "./baseConfigs/base-stylistic.js";
-import { baseTypeScriptESLint } from "./baseConfigs/base-typescript-eslint.js";
-import { baseUnicorn } from "./baseConfigs/base-unicorn.js";
+import { baseESLint } from "./base/base-eslint.js";
+import { baseImportX } from "./base/base-import-x.js";
+import { baseJSDoc } from "./base/base-jsdoc.js";
+import { baseN } from "./base/base-n.js";
+import { baseStylistic } from "./base/base-stylistic.js";
+import { baseTypeScriptESLint } from "./base/base-typescript-eslint.js";
+import { baseUnicorn } from "./base/base-unicorn.js";
 
 // Hot-patch "eslint-plugin-complete" to convert errors to warnings.
 for (const config of ESLintPluginComplete.configs.recommended) {
@@ -49,8 +49,9 @@ export const completeConfigBase = tseslint.config(
   {
     // By default, ESLint ignores "**/node_modules/" and ".git/":
     // https://eslint.org/docs/latest/use/configure/ignore#ignoring-files
-    // We also ignore want to ignore the "dist" directory since it is the idiomatic place for
-    // compiled output in TypeScript.
-    ignores: ["**/dist/"],
+    // We also ignore want to ignore:
+    // - The "dist" directory since it is the idiomatic place for compiled output in TypeScript.
+    // - Minified files.
+    ignores: ["**/dist/", "*.min.js"],
   },
 );

package/src/monorepo.js

@@ -4,30 +4,15 @@ import tseslint from "typescript-eslint";
  * This ESLint config is meant to be used in monorepos that install dependencies at the root (in
  * addition to the `completeBase` config).
  */
-export const completeConfigMonorepo = tseslint.config(
-  {
-    files: ["**/scripts/*.{js,cjs,mjs,ts,cts,mts}"],
-    rules: {
-      // The dependencies that are used in monorepo package scripts are often installed at the root
-      // of the monorepo (instead of as a "devDependency" in the package's "package.json" file).
-      "import-x/no-extraneous-dependencies": "off",
-    },
-  },
-
-  {
-    files: ["eslint.config.mjs"],
-    rules: {
-      // ESLint configs in monorepos often intentionally import from the "src" subdirectory (because
-      // the config files are JavaScript so they cannot use tsconfig-paths).
-      "@typescript-eslint/no-restricted-imports": "off",
-
-      // ESLint configs in monorepos often intentionally import from the "packages" subdirectory
-      // (because the config files are JavaScript so they cannot use tsconfig-paths).
-      "import-x/no-relative-packages": "off",
+export const completeConfigMonorepo = tseslint.config({
+  files: ["eslint.config.mjs"],
+  rules: {
+    // ESLint configs in monorepos often intentionally import from the "src" subdirectory (because
+    // the config files are JavaScript so they cannot use tsconfig-paths).
+    "@typescript-eslint/no-restricted-imports": "off",
 
-      // ESLint configs in monorepos will import from "typescript-eslint" (and potentially other
-      // plugins), which is often installed at root of the monorepo.
-      "import-x/no-extraneous-dependencies": "off",
-    },
+    // ESLint configs in monorepos often intentionally import from the "packages" subdirectory
+    // (because the config files are JavaScript so they cannot use tsconfig-paths).
+    "import-x/no-relative-packages": "off",
   },
-);
+});