@storm-software/linting-tools 1.30.0 → 1.30.2

package/src/eslint/graphql/{index.js → index.ts}

@@ -1,12 +1,6 @@
-import { fileURLToPath as _fileURLToPath } from 'url';
-import _path from 'node:path';
-import { createRequire as topLevelCreateRequire } from 'module';
-const require = topLevelCreateRequire(import.meta.url);
-const __filename = _fileURLToPath(import.meta.url);
-const __dirname = _path.dirname(__filename);
+import { Linter } from "eslint";
 
-// packages/linting-tools/src/eslint/graphql/index.ts
-var config = {
+const config: Linter.Config = {
   root: true,
   overrides: [
     {
@@ -127,7 +121,5 @@ var config = {
     }
   ]
 };
-var graphql_default = config;
-export {
-  graphql_default as default
-};
+
+export default config;

package/src/eslint/index.ts

@@ -0,0 +1,7 @@
+export * from "./graphql";
+export * from "./javascript";
+export * from "./jest";
+export * from "./json";
+export * from "./next";
+export * from "./react";
+export * from "./typescript";

package/src/eslint/javascript/index.ts

@@ -0,0 +1,22 @@
+import { Linter } from "eslint";
+import importRules from "../rules/import";
+import stormRules from "../rules/storm";
+import unicornRules from "../rules/unicorn";
+
+const config: Linter.Config = {
+  root: true,
+  overrides: [
+    {
+      files: ["*.js", "*.jsx"],
+      extends: ["plugin:@nx/javascript"],
+      plugins: ["unicorn", "import"],
+      rules: {
+        ...importRules,
+        ...unicornRules,
+        ...stormRules
+      }
+    }
+  ]
+};
+
+export default config;

package/src/eslint/jest/index.ts

@@ -0,0 +1,16 @@
+import { Linter } from "eslint";
+
+const config: Linter.Config = {
+  root: true,
+  overrides: [
+    {
+      files: ["*.spec.ts", "*.spec.tsx", "*.spec.js", "*.spec.jsx"],
+      env: {
+        jest: true
+      },
+      rules: {}
+    }
+  ]
+};
+
+export default config;

package/src/eslint/json/index.ts

@@ -0,0 +1,37 @@
+import { Linter } from "eslint";
+import { CODE_BLOCK } from "../constants";
+
+const JSONC_FILES = [
+  "tsconfig.json",
+  "tsconfig.base.json",
+  "nx.json",
+  ".vscode/launch.json"
+];
+const config: Linter.Config = {
+  root: true,
+  overrides: [
+    {
+      files: "*.json",
+      excludedFiles: JSONC_FILES,
+      extends: "plugin:jsonc/recommended-with-json"
+    },
+    {
+      files: ["*.jsonc", ...JSONC_FILES],
+      extends: "plugin:jsonc/recommended-with-jsonc"
+    },
+    {
+      files: "*.json5",
+      extends: "plugin:jsonc/recommended-with-json5"
+    },
+    {
+      files: "*.json{,c,5}",
+      excludedFiles: CODE_BLOCK,
+      plugins: ["unicorn"],
+      rules: {
+        "unicorn/filename-case": "error"
+      }
+    }
+  ]
+};
+
+export default config;

package/src/eslint/next/index.ts

@@ -0,0 +1,25 @@
+import { JS_FILES } from "../constants";
+
+const babelOptions = {
+  presets: (() => {
+    try {
+      require.resolve("next/babel");
+      return ["next/babel"];
+    } catch (e) {
+      return [];
+    }
+  })()
+};
+
+const config = {
+  root: true,
+  extends: ["plugin:@next/next/recommended"],
+  overrides: [
+    {
+      files: JS_FILES,
+      parserOptions: { babelOptions }
+    }
+  ]
+};
+
+export default config;

package/src/eslint/react/index.ts

@@ -0,0 +1,25 @@
+import { Linter } from "eslint";
+import reactRules from "../rules/react";
+import jsxA11yRules from "../rules/ts-docs";
+
+const config: Linter.Config = {
+  root: true,
+  extends: [
+    "plugin:react/recommended",
+    "plugin:react-hooks/recommended",
+    "plugin:jsx-a11y/recommended",
+    "plugin:import/react",
+    "prettier"
+  ],
+  settings: {
+    react: {
+      version: "detect"
+    }
+  },
+  rules: {
+    ...jsxA11yRules,
+    ...reactRules
+  }
+};
+
+export default config;

package/src/eslint/rules/import.ts

@@ -0,0 +1,88 @@
+import { Linter } from "eslint";
+
+const config: Linter.RulesRecord = {
+  /**
+   * Disallow non-import statements appearing before import statements.
+   *
+   * 🚫 Not fixable - https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/first.md
+   */
+  "import/first": "error",
+  /**
+   * Require a newline after the last import/require.
+   *
+   * 🔧 Fixable - https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/newline-after-import.md
+   */
+  "import/newline-after-import": "warn",
+  /**
+   * Disallow import of modules using absolute paths.
+   *
+   * 🚫 Not fixable - https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-absolute-path.md
+   */
+  "import/no-absolute-path": "error",
+  /**
+   * Disallow cyclical dependencies between modules.
+   *
+   * 🚫 Not fixable - https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-cycle.md
+   */
+  "import/no-cycle": "error",
+  /**
+   * Disallow default exports.
+   *
+   * 🚫 Not fixable - https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-default-export.md
+   */
+  "import/no-default-export": "error",
+  /**
+   * Disallow the use of extraneous packages.
+   *
+   * 🚫 Not fixable - https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-extraneous-dependencies.md
+   */
+  "import/no-extraneous-dependencies": [
+    "error",
+    { includeInternal: true, includeTypes: true }
+  ],
+  /**
+   * Disallow mutable exports.
+   *
+   * 🚫 Not fixable - https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-mutable-exports.md
+   */
+  "import/no-mutable-exports": "error",
+  /**
+   * Disallow importing packages through relative paths.
+   *
+   * 🚫 Not fixable - https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-relative-packages.md
+   */
+  "import/no-relative-packages": "warn",
+  /**
+   * Disallow a module from importing itself.
+   *
+   * 🚫 Not fixable - https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-self-import.md
+   */
+  "import/no-self-import": "error",
+  /**
+   * Ensures that there are no useless path segments.
+   *
+   * 🚫 Not fixable - https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-useless-path-segments.md
+   */
+  "import/no-useless-path-segments": ["error"],
+  /**
+   * Enforce a module import order convention.
+   *
+   * 🔧 Fixable - https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/order.md
+   */
+  "import/order": [
+    "warn",
+    {
+      groups: [
+        "builtin", // Node.js built-in modules
+        "external", // Packages
+        "internal", // Aliased modules
+        "parent", // Relative parent
+        "sibling", // Relative sibling
+        "index" // Relative index
+      ],
+      "newlines-between": "never"
+    }
+  ]
+};
+
+export default config;

package/src/eslint/rules/jsx-a11y.ts

@@ -0,0 +1,8 @@
+import { Linter } from "eslint";
+
+const config: Linter.RulesRecord = {
+  // This rule has been deprecated, but not yet removed.
+  "jsx-a11y/no-onchange": "off"
+};
+
+export default config;

package/src/eslint/{react/index.js → rules/react.ts}

@@ -1,12 +1,6 @@
-import { fileURLToPath as _fileURLToPath } from 'url';
-import _path from 'node:path';
-import { createRequire as topLevelCreateRequire } from 'module';
-const require = topLevelCreateRequire(import.meta.url);
-const __filename = _fileURLToPath(import.meta.url);
-const __dirname = _path.dirname(__filename);
+import { Linter } from "eslint";
 
-// packages/linting-tools/src/eslint/rules/react.ts
-var config = {
+const config: Linter.RulesRecord = {
   // We recommend using TypeScript over `prop-types`, as `prop-types` can add
   // to a project's build size.
   "react/prop-types": "off",
@@ -105,40 +99,5 @@ var config = {
    */
   "react/self-closing-comp": "warn"
 };
-var react_default = config;
 
-// packages/linting-tools/src/eslint/rules/ts-docs.ts
-var config2 = {
-  /**
-   * Require TSDoc comments conform to the TSDoc specification.
-   *
-   * 🚫 Not fixable - https://github.com/microsoft/tsdoc/tree/master/eslint-plugin
-   */
-  "tsdoc/syntax": "error"
-};
-var ts_docs_default = config2;
-
-// packages/linting-tools/src/eslint/react/index.ts
-var config3 = {
-  root: true,
-  extends: [
-    "plugin:react/recommended",
-    "plugin:react-hooks/recommended",
-    "plugin:jsx-a11y/recommended",
-    "plugin:import/react",
-    "prettier"
-  ],
-  settings: {
-    react: {
-      version: "detect"
-    }
-  },
-  rules: {
-    ...ts_docs_default,
-    ...react_default
-  }
-};
-var react_default2 = config3;
-export {
-  react_default2 as default
-};
+export default config;

package/src/eslint/{javascript/index.js → rules/storm.ts}

@@ -1,105 +1,6 @@
-import { fileURLToPath as _fileURLToPath } from 'url';
-import _path from 'node:path';
-import { createRequire as topLevelCreateRequire } from 'module';
-const require = topLevelCreateRequire(import.meta.url);
-const __filename = _fileURLToPath(import.meta.url);
-const __dirname = _path.dirname(__filename);
+import { Linter } from "eslint";
 
-// packages/linting-tools/src/eslint/rules/import.ts
-var config = {
-  /**
-   * Disallow non-import statements appearing before import statements.
-   *
-   * 🚫 Not fixable - https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/first.md
-   */
-  "import/first": "error",
-  /**
-   * Require a newline after the last import/require.
-   *
-   * 🔧 Fixable - https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/newline-after-import.md
-   */
-  "import/newline-after-import": "warn",
-  /**
-   * Disallow import of modules using absolute paths.
-   *
-   * 🚫 Not fixable - https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-absolute-path.md
-   */
-  "import/no-absolute-path": "error",
-  /**
-   * Disallow cyclical dependencies between modules.
-   *
-   * 🚫 Not fixable - https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-cycle.md
-   */
-  "import/no-cycle": "error",
-  /**
-   * Disallow default exports.
-   *
-   * 🚫 Not fixable - https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-default-export.md
-   */
-  "import/no-default-export": "error",
-  /**
-   * Disallow the use of extraneous packages.
-   *
-   * 🚫 Not fixable - https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-extraneous-dependencies.md
-   */
-  "import/no-extraneous-dependencies": [
-    "error",
-    { includeInternal: true, includeTypes: true }
-  ],
-  /**
-   * Disallow mutable exports.
-   *
-   * 🚫 Not fixable - https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-mutable-exports.md
-   */
-  "import/no-mutable-exports": "error",
-  /**
-   * Disallow importing packages through relative paths.
-   *
-   * 🚫 Not fixable - https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-relative-packages.md
-   */
-  "import/no-relative-packages": "warn",
-  /**
-   * Disallow a module from importing itself.
-   *
-   * 🚫 Not fixable - https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-self-import.md
-   */
-  "import/no-self-import": "error",
-  /**
-   * Ensures that there are no useless path segments.
-   *
-   * 🚫 Not fixable - https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-useless-path-segments.md
-   */
-  "import/no-useless-path-segments": ["error"],
-  /**
-   * Enforce a module import order convention.
-   *
-   * 🔧 Fixable - https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/order.md
-   */
-  "import/order": [
-    "warn",
-    {
-      groups: [
-        "builtin",
-        // Node.js built-in modules
-        "external",
-        // Packages
-        "internal",
-        // Aliased modules
-        "parent",
-        // Relative parent
-        "sibling",
-        // Relative sibling
-        "index"
-        // Relative index
-      ],
-      "newlines-between": "never"
-    }
-  ]
-};
-var import_default = config;
-
-// packages/linting-tools/src/eslint/rules/storm.ts
-var config2 = {
+const config: Linter.RulesRecord = {
   /**
    * Require return statements in array methods callbacks.
    *
@@ -330,47 +231,5 @@ var config2 = {
    */
   yoda: "warn"
 };
-var storm_default = config2;
 
-// packages/linting-tools/src/eslint/rules/unicorn.ts
-var config3 = {
-  /**
-   * Require consistent filename case for all linted files.
-   *
-   * 🚫 Not fixable - https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/filename-case.md
-   */
-  "unicorn/filename-case": [
-    "error",
-    {
-      case: "kebabCase"
-    }
-  ],
-  /**
-   * Require using the `node:` protocol when importing Node.js built-in modules.
-   *
-   * 🔧 Fixable - https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/prefer-node-protocol.md
-   */
-  "unicorn/prefer-node-protocol": "warn"
-};
-var unicorn_default = config3;
-
-// packages/linting-tools/src/eslint/javascript/index.ts
-var config4 = {
-  root: true,
-  overrides: [
-    {
-      files: ["*.js", "*.jsx"],
-      extends: ["plugin:@nx/javascript"],
-      plugins: ["unicorn", "import"],
-      rules: {
-        ...import_default,
-        ...unicorn_default,
-        ...storm_default
-      }
-    }
-  ]
-};
-var javascript_default = config4;
-export {
-  javascript_default as default
-};
+export default config;

package/src/eslint/rules/ts-docs.ts

@@ -0,0 +1,12 @@
+import { Linter } from "eslint";
+
+const config: Linter.RulesRecord = {
+  /**
+   * Require TSDoc comments conform to the TSDoc specification.
+   *
+   * 🚫 Not fixable - https://github.com/microsoft/tsdoc/tree/master/eslint-plugin
+   */
+  "tsdoc/syntax": "error"
+};
+
+export default config;

package/src/eslint/rules/unicorn.ts

@@ -0,0 +1,23 @@
+import { Linter } from "eslint";
+
+const config: Linter.RulesRecord = {
+  /**
+   * Require consistent filename case for all linted files.
+   *
+   * 🚫 Not fixable - https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/filename-case.md
+   */
+  "unicorn/filename-case": [
+    "error",
+    {
+      case: "kebabCase"
+    }
+  ],
+  /**
+   * Require using the `node:` protocol when importing Node.js built-in modules.
+   *
+   * 🔧 Fixable - https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/prefer-node-protocol.md
+   */
+  "unicorn/prefer-node-protocol": "warn"
+};
+
+export default config;

package/src/eslint/typescript/index.ts

@@ -0,0 +1,144 @@
+import { Linter } from "eslint";
+import {
+  RESTRICTED_GLOBALS,
+  RESTRICTED_MODULES,
+  RESTRICTED_SYNTAX
+} from "../constants";
+import importRules from "../rules/import";
+import stormRules from "../rules/storm";
+import tsDocsRules from "../rules/ts-docs";
+import unicornRules from "../rules/unicorn";
+
+const config: Linter.Config = {
+  root: true,
+  overrides: [
+    {
+      files: ["*.ts", "*.tsx"],
+      extends: ["plugin:@nx/typescript"],
+      rules: {}
+    }
+  ],
+  parser: "@typescript-eslint/parser",
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier"
+  ],
+  plugins: ["sonarjs", "unicorn", "promise", "import", "eslint-plugin-tsdoc"],
+  rules: {
+    // Disallows if statements as the only statement in else blocks
+    // https://eslint.org/docs/rules/no-lonely-if
+    "no-lonely-if": "error",
+    // Disallows the use of console
+    // https://eslint.org/docs/rules/no-console
+    "no-console": "error",
+    // Requires method and property shorthand syntax for object literals
+    // https://eslint.org/docs/rules/object-shorthand
+    "object-shorthand": ["error", "always"],
+    // Disallows loops with a body that allows only one iteration
+    // https://eslint.org/docs/rules/no-unreachable-loop
+    "no-unreachable-loop": "error",
+    "sonarjs/no-one-iteration-loop": "off", // similar to 'no-unreachable-loop' but reports less cases
+    "prefer-arrow-callback": ["error", { allowNamedFunctions: true }],
+
+    "sonarjs/no-unused-collection": "error",
+    "sonarjs/no-identical-conditions": "error",
+    "sonarjs/no-inverted-boolean-check": "error",
+    "sonarjs/no-use-of-empty-return-value": "error",
+    "sonarjs/no-gratuitous-expressions": "error",
+    "sonarjs/no-nested-switch": "error",
+    "unicorn/no-lonely-if": "error",
+    "sonarjs/no-collapsible-if": "off", // same as 'unicorn/no-lonely-if'
+    "unicorn/no-array-push-push": "error",
+    "unicorn/no-instanceof-array": "error",
+    "unicorn/no-empty-file": "error",
+    "unicorn/no-useless-fallback-in-spread": "error",
+    "unicorn/prefer-array-find": "error",
+    "unicorn/no-useless-spread": "error",
+    "unicorn/prefer-includes": "error",
+
+    // Disallows specified syntax
+    // https://eslint.org/docs/rules/no-restricted-syntax
+    "no-restricted-syntax": ["error", ...RESTRICTED_SYNTAX],
+    "no-else-return": ["error", { allowElseIf: false }],
+    "promise/no-nesting": "error",
+
+    "import/extensions": ["error", "ignorePackages"], // Bob when bundling requires to have `.js` extension
+    "import/no-default-export": "error",
+    "import/prefer-default-export": "off", // disable opposite of 'import/no-default-export'
+    "unicorn/filename-case": "error",
+
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      {
+        argsIgnorePattern: "^_",
+        varsIgnorePattern: "^_" // allow underscores in destructuring
+      }
+    ],
+
+    // Enforce the style of numeric separators by correctly grouping digits
+    // https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/numeric-separators-style.md
+    "unicorn/numeric-separators-style": "error",
+    // Prefer using the node: protocol when importing Node.js builtin modules
+    // https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/prefer-node-protocol.md
+    "unicorn/prefer-node-protocol": "error",
+    // Reports any imports that come after non-import statements
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/first.md
+    "import/first": "error",
+    // Disallow shorthand type conversions
+    // https://eslint.org/docs/latest/rules/no-implicit-coercion
+    "no-implicit-coercion": [
+      "error",
+      {
+        disallowTemplateShorthand: true,
+        // in TypeScript `!!` is preferable https://www.typescriptlang.org/docs/handbook/2/narrowing.html#truthiness-narrowing
+        boolean: false
+      }
+    ],
+    // Disallow specified modules when loaded by `import` declarations
+    // https://github.com/eslint-community/eslint-plugin-n/blob/master/docs/rules/no-restricted-import.md
+    "n/no-restricted-import": ["error", RESTRICTED_MODULES],
+    // Disallow specified modules when loaded by require
+    // https://github.com/eslint-community/eslint-plugin-n/blob/master/docs/rules/no-restricted-require.md
+    "n/no-restricted-require": ["error", RESTRICTED_MODULES],
+    "no-restricted-modules": "off", // deprecated in favor of corresponding rules from `eslint-plugin-n`
+
+    // Disallow specified global variables
+    // https://eslint.org/docs/latest/rules/no-restricted-globals
+    "no-restricted-globals": ["error", ...RESTRICTED_GLOBALS],
+
+    "@typescript-eslint/no-explicit-any": "error",
+    "prefer-const": ["error", { destructuring: "all" }],
+    "import/no-duplicates": "error",
+    "import/newline-after-import": "off", // prettified by prettier-plugin-sort-imports
+    "prefer-object-has-own": "error",
+    "logical-assignment-operators": [
+      "error",
+      "always",
+      { enforceForIfStatements: true }
+    ],
+    "@typescript-eslint/prefer-optional-chain": "error",
+    yoda: "error",
+    "unicorn/prefer-export-from": ["error", { ignoreUsedVariables: true }],
+    "promise/no-multiple-resolved": "error",
+    "unicorn/prefer-logical-operator-over-ternary": "error",
+    "no-unused-expressions": "off",
+    "@typescript-eslint/no-unused-expressions": "error",
+    "no-negated-condition": "off",
+    "unicorn/no-negated-condition": "error",
+    "unicorn/no-array-for-each": "error",
+    "unicorn/prefer-string-trim-start-end": "error",
+    "no-self-compare": "error",
+    eqeqeq: ["error", "always", { null: "ignore" }],
+    "import/no-useless-path-segments": "error",
+    "require-await": "off",
+    "no-return-await": "off",
+
+    ...importRules,
+    ...unicornRules,
+    ...tsDocsRules,
+    ...stormRules
+  }
+};
+
+export default config;