@msobiecki/eslint-config 8.38.2 → 8.39.0

package/rules/imports.js

@@ -0,0 +1,273 @@
+const importRules = {
+  // Static analysis:
+
+  // ensure imports point to files/modules that can be resolved
+  // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/no-unresolved.md
+  "import/no-unresolved": ["error", { commonjs: true, caseSensitive: true }],
+
+  // ensure named imports coupled with named exports
+  // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/named.md#when-not-to-use-it
+  "import/named": "error",
+
+  // ensure default import coupled with default export
+  // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/default.md#when-not-to-use-it
+  "import/default": "off",
+
+  // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/namespace.md
+  "import/namespace": "off",
+
+  // Helpful warnings:
+
+  // disallow invalid exports, e.g. multiple defaults
+  // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/export.md
+  "import/export": "error",
+
+  // do not allow a default import name to match a named export
+  // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/no-named-as-default.md
+  "import/no-named-as-default": "error",
+
+  // warn on accessing default export property names that are also named exports
+  // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/no-named-as-default-member.md
+  "import/no-named-as-default-member": "error",
+
+  // disallow use of jsdoc-marked-deprecated imports
+  // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/no-deprecated.md
+  "import/no-deprecated": "off",
+
+  // Forbid the use of extraneous packages
+  // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/no-extraneous-dependencies.md
+  // paths are treated both as absolute paths, and relative to process.cwd()
+  "import/no-extraneous-dependencies": [
+    "error",
+    {
+      devDependencies: [
+        "test/**", // tape, common npm pattern
+        "tests/**", // also common npm pattern
+        "spec/**", // mocha, rspec-like pattern
+        "**/__tests__/**", // jest pattern
+        "**/__mocks__/**", // jest pattern
+        "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
+        "**/vue.config.js", // vue-cli config
+        "**/webpack.config.js", // webpack config
+        "**/webpack.config.*.js", // webpack config
+        "**/rollup.config.js", // rollup config
+        "**/rollup.config.*.js", // rollup config
+        "**/gulpfile.js", // gulp config
+        "**/gulpfile.*.js", // gulp config
+        "**/Gruntfile{,.js}", // grunt config
+        "**/protractor.conf.js", // protractor config
+        "**/protractor.conf.*.js", // protractor config
+        "**/karma.conf.js", // karma config
+        "**/.eslintrc.js", // eslint config
+      ],
+      optionalDependencies: false,
+    },
+  ],
+
+  // Forbid mutable exports
+  // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/no-mutable-exports.md
+  "import/no-mutable-exports": "error",
+
+  // Module systems:
+
+  // disallow require()
+  // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/no-commonjs.md
+  "import/no-commonjs": "off",
+
+  // disallow AMD require/define
+  // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/no-amd.md
+  "import/no-amd": "error",
+
+  // No Node.js builtin modules
+  // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/no-nodejs-modules.md
+  // TODO: enable?
+  "import/no-nodejs-modules": "off",
+
+  // Style guide:
+
+  // disallow non-import statements appearing before import statements
+  // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/first.md
+  "import/first": "error",
+
+  // disallow non-import statements appearing before import statements
+  // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/imports-first.md
+  // deprecated: use `import/first`
+  "import/imports-first": "off",
+
+  // disallow duplicate imports
+  // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/no-duplicates.md
+  "import/no-duplicates": "error",
+
+  // disallow namespace imports
+  // TODO: enable?
+  // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/no-namespace.md
+  "import/no-namespace": "off",
+
+  // Ensure consistent use of file extension within the import path
+  // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/extensions.md
+  "import/extensions": [
+    "error",
+    "ignorePackages",
+    {
+      js: "never",
+      mjs: "never",
+      jsx: "never",
+    },
+  ],
+
+  // ensure absolute imports are above relative imports and that unassigned imports are ignored
+  // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/order.md
+  // TODO: enforce a stricter convention in module import order?
+  "import/order": ["error", { groups: [["builtin", "external", "internal"]] }],
+
+  // Require a newline after the last import/require in a group
+  // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/newline-after-import.md
+  "import/newline-after-import": "error",
+
+  // Require modules with a single export to use a default export
+  // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/prefer-default-export.md
+  "import/prefer-default-export": "error",
+
+  // Restrict which files can be imported in a given folder
+  // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/no-restricted-paths.md
+  "import/no-restricted-paths": "off",
+
+  // Forbid modules to have too many dependencies
+  // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/max-dependencies.md
+  "import/max-dependencies": ["off", { max: 10 }],
+
+  // Forbid import of modules using absolute paths
+  // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/no-absolute-path.md
+  "import/no-absolute-path": "error",
+
+  // Forbid require() calls with expressions
+  // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/no-dynamic-require.md
+  "import/no-dynamic-require": "error",
+
+  // prevent importing the submodules of other modules
+  // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/no-internal-modules.md
+  "import/no-internal-modules": [
+    "off",
+    {
+      allow: [],
+    },
+  ],
+
+  // Warn if a module could be mistakenly parsed as a script by a consumer
+  // leveraging Unambiguous JavaScript Grammar
+  // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/unambiguous.md
+  // this should not be enabled until this proposal has at least been *presented* to TC39.
+  // At the moment, it's not a thing.
+  "import/unambiguous": "off",
+
+  // Forbid Webpack loader syntax in imports
+  // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/no-webpack-loader-syntax.md
+  "import/no-webpack-loader-syntax": "error",
+
+  // Prevent unassigned imports
+  // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/no-unassigned-import.md
+  // importing for side effects is perfectly acceptable, if you need side effects.
+  "import/no-unassigned-import": "off",
+
+  // Prevent importing the default as if it were named
+  // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/no-named-default.md
+  "import/no-named-default": "error",
+
+  // Reports if a module's default export is unnamed
+  // https://github.com/import-js/eslint-plugin-import/blob/d9b712ac7fd1fddc391f7b234827925c160d956f/docs/rules/no-anonymous-default-export.md
+  "import/no-anonymous-default-export": [
+    "off",
+    {
+      allowArray: false,
+      allowArrowFunction: false,
+      allowAnonymousClass: false,
+      allowAnonymousFunction: false,
+      allowLiteral: false,
+      allowObject: false,
+    },
+  ],
+
+  // This rule enforces that all exports are declared at the bottom of the file.
+  // https://github.com/import-js/eslint-plugin-import/blob/98acd6afd04dcb6920b81330114e146dc8532ea4/docs/rules/exports-last.md
+  // TODO: enable?
+  "import/exports-last": "off",
+
+  // Reports when named exports are not grouped together in a single export declaration
+  // or when multiple assignments to CommonJS module.exports or exports object are present
+  // in a single file.
+  // https://github.com/import-js/eslint-plugin-import/blob/44a038c06487964394b1e15b64f3bd34e5d40cde/docs/rules/group-exports.md
+  "import/group-exports": "off",
+
+  // forbid default exports. this is a terrible rule, do not use it.
+  // https://github.com/import-js/eslint-plugin-import/blob/44a038c06487964394b1e15b64f3bd34e5d40cde/docs/rules/no-default-export.md
+  "import/no-default-export": "off",
+
+  // Prohibit named exports. this is a terrible rule, do not use it.
+  // https://github.com/import-js/eslint-plugin-import/blob/1ec80fa35fa1819e2d35a70e68fb6a149fb57c5e/docs/rules/no-named-export.md
+  "import/no-named-export": "off",
+
+  // Forbid a module from importing itself
+  // https://github.com/import-js/eslint-plugin-import/blob/44a038c06487964394b1e15b64f3bd34e5d40cde/docs/rules/no-self-import.md
+  "import/no-self-import": "error",
+
+  // Forbid cyclical dependencies between modules
+  // https://github.com/import-js/eslint-plugin-import/blob/d81f48a2506182738409805f5272eff4d77c9348/docs/rules/no-cycle.md
+  "import/no-cycle": ["error", { maxDepth: "∞" }],
+
+  // Ensures that there are no useless path segments
+  // https://github.com/import-js/eslint-plugin-import/blob/ebafcbf59ec9f653b2ac2a0156ca3bcba0a7cf57/docs/rules/no-useless-path-segments.md
+  "import/no-useless-path-segments": ["error", { commonjs: true }],
+
+  // dynamic imports require a leading comment with a webpackChunkName
+  // https://github.com/import-js/eslint-plugin-import/blob/ebafcbf59ec9f653b2ac2a0156ca3bcba0a7cf57/docs/rules/dynamic-import-chunkname.md
+  "import/dynamic-import-chunkname": [
+    "off",
+    {
+      importFunctions: [],
+      webpackChunknameFormat: "[0-9a-zA-Z-_/.]+",
+    },
+  ],
+
+  // Use this rule to prevent imports to folders in relative parent paths.
+  // https://github.com/import-js/eslint-plugin-import/blob/c34f14f67f077acd5a61b3da9c0b0de298d20059/docs/rules/no-relative-parent-imports.md
+  "import/no-relative-parent-imports": "off",
+
+  // Reports modules without any exports, or with unused exports
+  // https://github.com/import-js/eslint-plugin-import/blob/f63dd261809de6883b13b6b5b960e6d7f42a7813/docs/rules/no-unused-modules.md
+  // TODO: enable once it supports CJS
+  "import/no-unused-modules": [
+    "off",
+    {
+      ignoreExports: [],
+      missingExports: true,
+      unusedExports: true,
+    },
+  ],
+
+  // Reports the use of import declarations with CommonJS exports in any module except for the main module.
+  // https://github.com/import-js/eslint-plugin-import/blob/1012eb951767279ce3b540a4ec4f29236104bb5b/docs/rules/no-import-module-exports.md
+  "import/no-import-module-exports": [
+    "error",
+    {
+      exceptions: [],
+    },
+  ],
+
+  // Use this rule to prevent importing packages through relative paths.
+  // https://github.com/import-js/eslint-plugin-import/blob/1012eb951767279ce3b540a4ec4f29236104bb5b/docs/rules/no-relative-packages.md
+  "import/no-relative-packages": "error",
+
+  // enforce a consistent style for type specifiers (inline or top-level)
+  // https://github.com/import-js/eslint-plugin-import/blob/d5fc8b670dc8e6903dbb7b0894452f60c03089f5/docs/rules/consistent-type-specifier-style.md
+  // TODO, semver-major: enable (just in case)
+  "import/consistent-type-specifier-style": ["off", "prefer-inline"],
+
+  // Reports the use of empty named import blocks.
+  // https://github.com/import-js/eslint-plugin-import/blob/d5fc8b670dc8e6903dbb7b0894452f60c03089f5/docs/rules/no-empty-named-blocks.md
+  // TODO, semver-minor: enable
+  "import/no-empty-named-blocks": "off",
+};

package/rules/node.js

@@ -0,0 +1,12 @@
+const nodeRules = {
+  // require all requires be top-level
+  "n/global-require": "error",
+
+  // disallow use of new operator with the require function
+  "n/no-new-require": "error",
+
+  // disallow string concatenation with __dirname and __filename
+  "n/no-path-concat": "error",
+};
+
+export default nodeRules;

package/{__tests__ → tests}/base.test.js

@@ -1,20 +1,25 @@
 import fs from "node:fs";
 import path from "node:path";
-import process from "node:process";
+import { fileURLToPath } from "node:url";
 
 import { ESLint } from "eslint";
 
-describe("check base rules", () => {
-  const eslint = new ESLint({
-    useEslintrc: false,
-    overrideConfigFile: path.resolve(process.cwd(), "presets/base/base.js"),
-  });
+const filename = fileURLToPath(import.meta.url);
+const dirname = path.dirname(filename);
 
-  const testDirectory = path.join(__dirname, "test-cases", "base");
+const configPath = path.resolve(process.cwd(), "eslint.config.js");
+const configModule = await import(configPath);
+
+const eslint = new ESLint({
+  overrideConfigFile: true,
+  overrideConfig: configModule.default ?? configModule,
+});
+
+describe("check base rules", () => {
+  const testDirectory = path.join(dirname, "test-cases", "base");
   const testFiles = fs.readdirSync(testDirectory);
 
-  // eslint-disable-next-line no-restricted-syntax
-  for (const file of testFiles) {
+  testFiles.forEach((file) => {
     const ruleId = path.basename(file, ".js");
 
     test(`${file} should trigger rule: ${ruleId}`, async () => {
@@ -23,5 +28,5 @@ describe("check base rules", () => {
       const triggeredRules = messages.map((m) => m.ruleId).filter(Boolean);
       expect(triggeredRules).toContain(ruleId);
     });
-  }
+  });
 });

package/tests/eslint.config.js

@@ -0,0 +1,13 @@
+import { defineConfig } from "eslint/config";
+
+import {
+  basePreset,
+  bestPracticePreset,
+  jestPreset,
+} from "../eslint.config.js";
+
+export default defineConfig([
+  ...basePreset,
+  ...jestPreset,
+  ...bestPracticePreset,
+]);

package/tests/test-cases/base/array-callback-return.js

@@ -0,0 +1,2 @@
+// ❌ Violates: array-callback-return
+[1, 2, 3].map(() => {});

package/tests/test-cases/base/block-scoped-var.js

@@ -0,0 +1,40 @@
+// ❌ Violates: block-scoped-var
+function doIf() {
+    if (true) {
+        var build = true;
+    }
+
+    console.log(build);
+}
+
+function doIfElse() {
+    if (true) {
+        var build = true;
+    } else {
+        var build = false;
+    }
+}
+
+function doTryCatch() {
+    try {
+        var build = 1;
+    } catch (e) {
+        var f = build;
+    }
+}
+
+function doFor() {
+    for (var x = 1; x < 10; x++) {
+        var y = f(x);
+    }
+    console.log(y);
+}
+
+class C {
+    static {
+        if (something) {
+            var build = true;
+        }
+        build = false;
+    }
+}

package/tests/test-cases/base/consistent-return.js

@@ -0,0 +1,4 @@
+// ❌ Violates: consistent-return
+const getValue = (flag) => {
+  if (flag) return 42;
+};

package/tests/test-cases/base/curly.js

@@ -0,0 +1,9 @@
+// ❌ Violates: curly
+if (foo) foo++;
+
+while (bar)
+    baz();
+
+if (foo) {
+    baz();
+} else qux();

package/tests/test-cases/base/default-case.js

@@ -0,0 +1,7 @@
+// ❌ Violates: default-case
+switch (color) {
+  case "red": {
+    paint(1);
+    break;
+  }
+}

package/tests/test-cases/base/guard-for-in.js

@@ -0,0 +1,4 @@
+// ❌ Violates: guard-for-in
+for (const key in obj) {
+  console.log(key);
+}

package/tests/test-cases/base/no-alert.js

@@ -0,0 +1,2 @@
+// ❌ Violates: no-alert
+alert("Warning!");

package/tests/test-cases/base/no-else-return.js

@@ -0,0 +1,38 @@
+function foo1() {
+    if (x) {
+        return y;
+    } else {
+        return z;
+    }
+}
+
+function foo2() {
+    if (x) {
+        return y;
+    } else {
+        const t = "foo";
+    }
+}
+
+function foo3() {
+    if (error) {
+        return 'It failed';
+    } else {
+        if (loading) {
+            return "It's still loading";
+        }
+    }
+}
+
+// Two warnings for nested occurrences
+function foo4() {
+    if (x) {
+        if (y) {
+            return y;
+        } else {
+            return x;
+        }
+    } else {
+        return z;
+    }
+}

package/tests/test-cases/base/no-empty-function.js

@@ -0,0 +1,44 @@
+// ❌ Violates: no-empty-function
+function foo() {}
+
+const bar = function() {};
+
+const bar1 = () => {};
+
+function* baz() {}
+
+const bar2 = function*() {};
+
+const obj = {
+    foo() {},
+
+    *foo() {},
+
+    foo() {},
+
+    *foo() {},
+
+    get foo() {},
+
+    set foo(value) {}
+};
+
+class A {
+    constructor() {}
+
+    foo() {}
+
+    *foo() {}
+
+    get foo() {}
+
+    set foo(value) {}
+
+    static foo() {}
+
+    static *foo() {}
+
+    static get foo() {}
+
+    static set foo(value) {}
+}

package/tests/test-cases/base/no-extend-native.js

@@ -0,0 +1,2 @@
+// ❌ Violates: no-extend-native
+Array.prototype.foo = function () {};

package/tests/test-cases/base/no-fallthrough.js

@@ -0,0 +1,9 @@
+// ❌ Violates: no-fallthrough
+switch (n) {
+  case 1: {
+    doThing();
+  }
+  case 2: {
+    doOtherThing();
+  }
+}

package/tests/test-cases/base/no-new.js

@@ -0,0 +1,2 @@
+// ❌ Violates: no-new
+new Thing();

package/tests/test-cases/base/no-param-reassign.js

@@ -0,0 +1,4 @@
+// ❌ Violates: no-param-reassign
+const update = (object) => {
+  object = {};
+};

package/tests/test-cases/base/no-proto.js

@@ -0,0 +1,2 @@
+// ❌ Violates: no-proto
+const p = {}.__proto__;

package/tests/test-cases/base/no-redeclare.js

@@ -0,0 +1,15 @@
+// ❌ Violates: no-redeclare
+var a = 3;
+var a = 10;
+
+class C {
+    foo() {
+        var b = 3;
+        var b = 10;
+    }
+
+    static {
+        var c = 3;
+        var c = 10;
+    }
+}

package/tests/test-cases/base/no-return-assign.js

@@ -0,0 +1,4 @@
+// ❌ Violates: no-return-assign
+const f = () => {
+  return (x = 1);
+};

package/tests/test-cases/base/no-script-url.js

@@ -0,0 +1,2 @@
+// ❌ Violates: no-script-url
+location.href = "javascript:alert(1)";

package/tests/test-cases/base/no-self-compare.js

@@ -0,0 +1,3 @@
+// ❌ Violates: no-self-compare
+if (x === x) {
+}

package/tests/test-cases/base/no-sequences.js

@@ -0,0 +1,2 @@
+// ❌ Violates: no-sequences
+const baz = () => ((bar = 123), 10);

package/tests/test-cases/base/no-useless-concat.js

@@ -0,0 +1,8 @@
+// ❌ Violates: no-useless-concat
+const a = `some` + `string`;
+
+// these are the same as "10"
+const b = '1' + '0';
+const c = '1' + `0`;
+const d = `1` + '0';
+const e = `1` + `0`;

package/{__tests__ → tests}/test-cases/base/no-var.js

@@ -1,2 +1,2 @@
 // ❌ Violates: no-var
-var count = 5;
+var count = 5;

package/tests/test-cases/base/no-void.js

@@ -0,0 +1,4 @@
+// ❌ Violates: no-void
+void (function () {
+  console.log("bad");
+})();

package/tests/test-cases/base/radix.js

@@ -0,0 +1,2 @@
+// ❌ Violates: radix
+Number.parseInt("08");

package/tests/test-cases/base/yoda.js

@@ -0,0 +1,29 @@
+// ❌ Violates: yoda
+if ("red" === color) {
+    // ...
+}
+
+if (`red` === color) {
+    // ...
+}
+
+if (`red` === `${color}`) {
+    // ...
+}
+
+if (true == flag) {
+    // ...
+}
+
+if (5 > count) {
+    // ...
+}
+
+if (-1 < str.indexOf(substr)) {
+    // ...
+}
+
+if (0 <= x && x < 1) {
+    // ...
+}
+

package/utils/get-ts-config.js

@@ -1,11 +1,18 @@
-const fs = require("node:fs");
-const path = require("node:path");
+import fs from "node:fs";
+import path from "node:path";
 
-const getTsConfig = () => {
-  if (fs.existsSync("tsconfig.json")) return path.resolve("tsconfig.json");
-  return fs.existsSync("../tsconfig.json")
-    ? path.resolve("../tsconfig.json")
-    : undefined;
-};
+/**
+ * Get tsconfig path if exists
+ * @returns {string|undefined} tsconfig path or undefined
+ */
+export default function getTsConfig() {
+  if (fs.existsSync("tsconfig.json")) {
+    return path.resolve("tsconfig.json");
+  }
 
-module.exports = getTsConfig;
+  if (fs.existsSync("../tsconfig.json")) {
+    return path.resolve("../tsconfig.json");
+  }
+
+  return;
+}

package/.eslintrc.json

@@ -1,3 +0,0 @@
-{
-  "extends": ["./index.js", "./best-practice.js"]
-}

package/__tests__/.eslintrc.json

@@ -1,3 +0,0 @@
-{
-  "extends": ["../jest.js"]
-}