@storm-software/linting-tools 1.0.0

package/eslint/typescript/index.js

@@ -0,0 +1,577 @@
+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);
+
+// packages/linting-tools/src/eslint/constants.ts
+var RESTRICTED_SYNTAX = [
+  {
+    // ❌ readFile(…, { encoding: … })
+    selector: `CallExpression[callee.name=/readFileSync|readFile|writeFileSync|writeFile/] > .arguments:last-child[type=ObjectExpression][properties.length=1] Property[key.name=encoding]`,
+    message: `Specify encoding as last argument instead of object with encoding key`
+  },
+  {
+    // ❌ readFile(…, {})
+    selector: `CallExpression[callee.name=/readFileSync|readFile|writeFileSync|writeFile/] > .arguments:last-child[type=ObjectExpression][properties.length=0]`,
+    message: "Specify encoding as last argument"
+  },
+  {
+    // ❌ readFileSync(…).toString(…)
+    selector: `CallExpression[callee.name=readFileSync][parent.property.name=toString]`,
+    message: `toString is redundant, specify encoding as last argument`
+  },
+  {
+    // ❌ ….readFile(…, { encoding: … })
+    selector: `CallExpression[callee.type=MemberExpression][callee.property.name=/readFileSync|readFile|writeFileSync|writeFile/] > .arguments:last-child[type=ObjectExpression][properties.length=1] Property[key.name=encoding]`,
+    message: `Specify encoding as last argument instead of object with encoding key`
+  },
+  {
+    // ❌ ….readFile(…, {})
+    selector: `CallExpression[callee.type=MemberExpression][callee.property.name=/readFileSync|readFile|writeFileSync|writeFile/] > .arguments:last-child[type=ObjectExpression][properties.length=0]`,
+    message: "Specify encoding as last argument"
+  },
+  {
+    // ❌ Boolean(…)
+    selector: "CallExpression[callee.name=Boolean][arguments.1.elements.length!=0]",
+    message: "Prefer `!!\u2026` over `Boolean(\u2026)` because TypeScript infers a narrow literal boolean `type: true` instead of `type: boolean`."
+  },
+  {
+    // ❌ process.browser
+    selector: "ExpressionStatement[expression.object.name=process][expression.property.name=browser]",
+    message: "`process.browser` is deprecated, use `!!globalThis.window`"
+  }
+  // {
+  //   // ❌ let { foo: { bar } } = baz
+  //   // ✅ let { bar } = baz.foo
+  //   // ✅ let { foo: { bar } } = await baz
+  //   selector:
+  //     'VariableDeclarator[init.type!=AwaitExpression] > ObjectPattern[properties.length=1][properties.0.value.type=ObjectPattern]',
+  //   message: 'Do not use nested destructuring.',
+  // },
+];
+var REACT_RESTRICTED_SYNTAX = [
+  ...RESTRICTED_SYNTAX,
+  {
+    // ❌ useMemo(…, [])
+    selector: "CallExpression[callee.name=useMemo][arguments.1.type=ArrayExpression][arguments.1.elements.length=0]",
+    message: "`useMemo` with an empty dependency array can't provide a stable reference, use `useRef` instead."
+  }
+];
+var RESTRICTED_GLOBALS = [
+  "stop",
+  { name: "isNaN", message: "Use Number.isNaN instead" }
+];
+var RESTRICTED_MODULES = [
+  { name: "axios", message: "Use `fetch/node-fetch` instead." },
+  { name: "moment", message: "Use `dayjs/date-fns` instead." },
+  { name: "classnames", message: "Use `clsx` instead because it is faster." },
+  {
+    name: "lodash/isString.js",
+    message: "Use `typeof yourVar === 'string'` instead."
+  },
+  { name: "lodash/isArray.js", message: "Use `Array.isArray` instead." },
+  { name: "lodash/flatten.js", message: "Use `Array#flat()` instead." },
+  {
+    name: "lodash/compact.js",
+    message: "Use `Array#filter(Boolean)` instead."
+  },
+  { name: "lodash/identity.js", message: "Use `(value) => value` instead." }
+];
+
+// 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 = {
+  /**
+   * Require return statements in array methods callbacks.
+   *
+   * 🚫 Not fixable -https://eslint.org/docs/rules/array-callback-return
+   */
+  "array-callback-return": ["error", { allowImplicit: true }],
+  /**
+   * Treat `var` statements as if they were block scoped.
+   *
+   * 🚫 Not fixable - https://eslint.org/docs/rules/block-scoped-var
+   */
+  "block-scoped-var": "error",
+  /**
+   * Require curly braces for multiline blocks.
+   *
+   * 🔧 Fixable - https://eslint.org/docs/rules/curly
+   */
+  curly: ["warn", "multi-line"],
+  /**
+   * Require default clauses in switch statements to be last (if used).
+   *
+   * 🚫 Not fixable - https://eslint.org/docs/rules/default-case-last
+   */
+  "default-case-last": "error",
+  /**
+   * Require triple equals (`===` and `!==`).
+   *
+   * 🔧 Fixable - https://eslint.org/docs/rules/eqeqeq
+   */
+  eqeqeq: "error",
+  /**
+   * Require grouped accessor pairs in object literals and classes.
+   *
+   * 🚫 Not fixable - https://eslint.org/docs/rules/grouped-accessor-pairs
+   */
+  "grouped-accessor-pairs": "error",
+  /**
+   * Disallow use of `alert()`.
+   *
+   * 🚫 Not fixable - https://eslint.org/docs/rules/no-alert
+   */
+  "no-alert": "error",
+  /**
+   * Disallow use of `caller`/`callee`.
+   *
+   * 🚫 Not fixable - https://eslint.org/docs/rules/no-caller
+   */
+  "no-caller": "error",
+  /**
+   * Disallow returning value in constructor.
+   *
+   * 🚫 Not fixable - https://eslint.org/docs/rules/no-constructor-return
+   */
+  "no-constructor-return": "error",
+  /**
+   * Disallow using an `else` if the `if` block contains a return.
+   *
+   * 🔧 Fixable - https://eslint.org/docs/rules/no-else-return
+   */
+  "no-else-return": "warn",
+  /**
+   * Disallow `eval()`.
+   *
+   * 🚫 Not fixable - https://eslint.org/docs/rules/no-eval
+   */
+  "no-eval": "error",
+  /**
+   * Disallow extending native objects.
+   *
+   * 🚫 Not fixable - https://eslint.org/docs/rules/no-extend-native
+   */
+  "no-extend-native": "error",
+  /**
+   * Disallow unnecessary function binding.
+   *
+   * 🔧 Fixable - https://eslint.org/docs/rules/no-extra-bind
+   */
+  "no-extra-bind": "error",
+  /**
+   * Disallow unnecessary labels.
+   *
+   * 🔧 Fixable - https://eslint.org/docs/rules/no-extra-label
+   */
+  "no-extra-label": "error",
+  /**
+   * Disallow floating decimals.
+   *
+   * 🔧 Fixable - https://eslint.org/docs/rules/no-floating-decimal
+   */
+  "no-floating-decimal": "error",
+  /**
+   * Make people convert types explicitly e.g. `Boolean(foo)` instead of `!!foo`.
+   *
+   * 🔧 Partially Fixable - https://eslint.org/docs/rules/no-implicit-coercion
+   */
+  "no-implicit-coercion": "error",
+  /**
+   * Disallow use of `eval()`-like methods.
+   *
+   * https://eslint.org/docs/rules/no-implied-eval
+   */
+  "no-implied-eval": "error",
+  /**
+   * Disallow usage of `__iterator__` property.
+   *
+   * 🚫 Not fixable - https://eslint.org/docs/rules/no-iterator
+   */
+  "no-iterator": "error",
+  /**
+   * Disallow use of labels for anything other than loops and switches.
+   *
+   * 🚫 Not fixable - https://eslint.org/docs/rules/no-labels
+   */
+  "no-labels": ["error"],
+  /**
+   * Disallow unnecessary nested blocks.
+   *
+   * 🚫 Not fixable - https://eslint.org/docs/rules/no-lone-blocks
+   */
+  "no-lone-blocks": "error",
+  /**
+   * Disallow `new` for side effects.
+   *
+   * 🚫 Not fixable - https://eslint.org/docs/rules/no-new
+   */
+  "no-new": "error",
+  /**
+   * Disallow function constructors.
+   *
+   * 🚫 Not fixable - https://eslint.org/docs/rules/no-new-func
+   */
+  "no-new-func": "error",
+  /**
+   * Disallow base types wrapper instances, such as `new String('foo')`.
+   *
+   * 🚫 Not fixable - https://eslint.org/docs/rules/no-new-wrappers
+   */
+  "no-new-wrappers": "error",
+  /**
+   * Disallow use of octal escape sequences in string literals.
+   *
+   * 🚫 Not fixable - https://eslint.org/docs/rules/no-octal-escape
+   */
+  "no-octal-escape": "error",
+  /**
+   * Disallow reassignment of function parameters.
+   *
+   * 🚫 Not fixable - https://eslint.org/docs/rules/no-param-reassign
+   */
+  "no-param-reassign": "error",
+  /**
+   * Disallow usage of the deprecated `__proto__` property.
+   *
+   * 🚫 Not fixable - https://eslint.org/docs/rules/no-proto
+   */
+  "no-proto": "error",
+  /**
+   * Disallow assignment in `return` statement.
+   *
+   * 🚫 Not fixable - https://eslint.org/docs/rules/no-return-assign
+   */
+  "no-return-assign": "error",
+  /**
+   * Disallows unnecessary `return await`.
+   *
+   * 🚫 Not fixable - https://eslint.org/docs/rules/no-return-await
+   */
+  "no-return-await": "error",
+  /**
+   * Disallow use of `javascript:` urls.
+   *
+   * 🚫 Not fixable - https://eslint.org/docs/rules/no-script-url
+   */
+  "no-script-url": "error",
+  /**
+   * Disallow comparisons where both sides are exactly the same.
+   *
+   * 🚫 Not fixable - https://eslint.org/docs/rules/no-self-compare
+   */
+  "no-self-compare": "error",
+  /**
+   * Disallow use of comma operator.
+   *
+   * 🚫 Not fixable - https://eslint.org/docs/rules/no-sequences
+   */
+  "no-sequences": "error",
+  /**
+   * Disallow unnecessary `.call()` and `.apply()`.
+   *
+   * 🚫 Not fixable - https://eslint.org/docs/rules/no-useless-call
+   */
+  "no-useless-call": "error",
+  /**
+   * Disallow unnecessary concatenation of strings.
+   *
+   * 🚫 Not fixable - https://eslint.org/docs/rules/no-useless-concat
+   */
+  "no-useless-concat": "error",
+  /**
+   * Disallow redundant return statements.
+   *
+   * 🔧 Fixable - https://eslint.org/docs/rules/no-useless-return
+   */
+  "no-useless-return": "warn",
+  /**
+   * Require using named capture groups in regular expressions.
+   *
+   * 🚫 Not fixable - https://eslint.org/docs/rules/prefer-named-capture-group
+   */
+  "prefer-named-capture-group": "error",
+  /**
+   * Require using Error objects as Promise rejection reasons.
+   *
+   * 🚫 Not fixable - https://eslint.org/docs/rules/prefer-promise-reject-errors
+   */
+  "prefer-promise-reject-errors": ["error", { allowEmptyReject: true }],
+  /**
+   * Disallow use of the RegExp constructor in favor of regular expression
+   * literals.
+   *
+   * 🚫 Not fixable - https://eslint.org/docs/rules/prefer-regex-literals
+   */
+  "prefer-regex-literals": "error",
+  /**
+   * Disallow "Yoda conditions", ensuring the comparison.
+   *
+   * 🔧 Fixable - https://eslint.org/docs/rules/yoda
+   */
+  yoda: "warn"
+};
+var storm_default = config2;
+
+// packages/linting-tools/src/eslint/rules/ts-docs.ts
+var config3 = {
+  /**
+   * 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 = config3;
+
+// packages/linting-tools/src/eslint/rules/unicorn.ts
+var config4 = {
+  /**
+   * 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 = config4;
+
+// packages/linting-tools/src/eslint/typescript/index.ts
+var config5 = {
+  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",
+    ...import_default,
+    ...unicorn_default,
+    ...ts_docs_default,
+    ...storm_default
+  }
+};
+var typescript_default = config5;
+export {
+  typescript_default as default
+};