@asd14/eslint-config 10.3.0 → 12.0.0

package/src/configs/react.js

@@ -0,0 +1,86 @@
+import prettierConfig from "eslint-plugin-prettier/recommended"
+import globals from "globals"
+
+import baseConfig from "../rules/base.js"
+import importConfig from "../rules/import.js"
+import jsdocConfig from "../rules/jsdoc.js"
+import reactHooksConfig from "../rules/react.js"
+import tsConfig from "../rules/typescript.js"
+import unicornConfig from "../rules/unicorn.js"
+
+/** @type {import("eslint").Linter.RulesRecord} */
+const reactSpecificRules = {
+  "no-console": "off",
+  "unicorn/prevent-abbreviations": [
+    "error",
+    {
+      replacements: {
+        i: false,
+        params: false,
+        lib: false,
+        args: {
+          params: true,
+        },
+        props: false,
+        opts: {
+          props: true,
+        },
+        options: {
+          props: true,
+        },
+        fn: false,
+        acc: false,
+      },
+    },
+  ],
+}
+
+/** @satisfies {import("eslint").Linter.Config} */
+export const reactConfig = /** @type {const} */ ({
+  name: "ASD14 config for React source files",
+  ignores: ["node_modules", "dist", "coverage", "build"],
+  languageOptions: {
+    ...tsConfig.languageOptions,
+    ecmaVersion: "latest",
+    sourceType: "module",
+    parserOptions: {
+      projectService: true,
+      ecmaVersion: "latest",
+      ecmaFeatures: {
+        jsx: true,
+      },
+    },
+    globals: {
+      ...globals.serviceworker,
+      ...globals.browser,
+    },
+  },
+  plugins: {
+    ...importConfig.plugins,
+    ...jsdocConfig.plugins,
+    ...reactHooksConfig.plugins,
+    ...tsConfig.plugins,
+    ...unicornConfig.plugins,
+    ...prettierConfig.plugins,
+  },
+  rules: {
+    ...baseConfig.rules,
+    ...importConfig.rules,
+    ...jsdocConfig.rules,
+    ...reactHooksConfig.rules,
+    ...reactSpecificRules,
+    ...tsConfig.rules,
+    ...unicornConfig.rules,
+    ...prettierConfig.rules,
+  },
+  settings: {
+    ...importConfig.settings,
+    ...reactHooksConfig.settings,
+
+    /*
+     * A list of regex strings that, if matched by a path, will not report
+     * the matching module if no exports are found.
+     */
+    "import/ignore": [".(sass|scss|less|css)$"],
+  },
+})

package/src/configs/ts-node.js

@@ -0,0 +1,23 @@
+import { nodeConfig } from "./node.js"
+import tsConfig from "../rules/typescript.js"
+
+/** @satisfies {import("eslint").Linter.Config} */
+export const tsNodeConfig = /** @type {const} */ ({
+  name: "ASD14 config for Typescript + Node.js source files",
+  ignores: ["node_modules", "dist", "coverage", "build"],
+  languageOptions: {
+    ...nodeConfig.languageOptions,
+    ...tsConfig.languageOptions,
+  },
+  plugins: {
+    ...tsConfig.plugins,
+    ...nodeConfig.plugins,
+  },
+  rules: {
+    ...tsConfig.rules,
+    ...nodeConfig.rules,
+  },
+  settings: {
+    ...nodeConfig.settings,
+  },
+})

package/src/index.js

@@ -0,0 +1,6 @@
+export * from "./configs/node-jest.js"
+export * from "./configs/node.js"
+export * from "./configs/nx.js"
+export * from "./configs/react-jest.js"
+export * from "./configs/react.js"
+export * from "./configs/ts-node.js"

package/src/rules/base.js

@@ -0,0 +1,24 @@
+/** @satisfies {import("eslint").Linter.Config} */
+export default /** @type {const} */ ({
+  rules: {
+    // Allow default named exports, ie. `export { asd as default } from "lorem.js"`,
+    // to avoid conflicts with "unicorn/prefer-export-from"
+    "no-restricted-exports": [
+      "error",
+      {
+        restrictDefaultExports: {
+          named: false,
+          namedFrom: false,
+        },
+      },
+    ],
+    "no-underscore-dangle": [
+      "error",
+      {
+        allow: ["_dirname", "_testResult"],
+        allowInArrayDestructuring: true,
+        allowInObjectDestructuring: true,
+      },
+    ],
+  },
+})

package/src/rules/import.js

@@ -0,0 +1,55 @@
+import importPlugin from "eslint-plugin-import"
+
+const importConfig = importPlugin.flatConfigs.recommended
+const importTSConfig = importPlugin.flatConfigs.typescript
+
+/** @satisfies {import("eslint").Linter.Config} */
+export default /** @type {const} */ ({
+  plugins: importConfig.plugins,
+  rules: {
+    ...importConfig.rules,
+    ...importTSConfig.rules,
+    "import/no-extraneous-dependencies": ["error", { includeTypes: true }],
+    "import/no-cycle": ["error", { maxDepth: Infinity }],
+    "import/no-self-import": "error",
+    "import/no-absolute-path": "error",
+    "import/default": "error",
+    "import/export": "error",
+    "import/prefer-default-export": "off",
+    "import/namespace": ["error", { allowComputed: true }],
+    "import/no-duplicates": "error",
+    "import/no-named-as-default": "error",
+    "import/no-named-as-default-member": "error",
+    "import/unambiguous": "off",
+    "import/exports-last": "error",
+    "import/named": "off",
+    "import/no-unresolved": "off",
+    "import/extensions": ["error", "always", { ignorePackages: true }],
+    "import/order": [
+      "error",
+      {
+        groups: [
+          "builtin",
+          "external",
+          "internal",
+          ["index", "sibling", "parent"],
+          "object",
+          "unknown",
+        ],
+        pathGroups: [
+          {
+            pattern: "@self-ui/*",
+            group: "external",
+            position: "after",
+          },
+        ],
+        pathGroupsExcludedImportTypes: ["builtin"],
+        alphabetize: {
+          order: "asc",
+          caseInsensitive: true,
+        },
+      },
+    ],
+  },
+  settings: importTSConfig.settings,
+})

package/src/rules/jsdoc.js

@@ -0,0 +1,49 @@
+import jsdoc from "eslint-plugin-jsdoc"
+
+/** @satisfies {import('eslint').Linter.Config} */
+export default /** @type {const} */ ({
+  plugins: {
+    jsdoc,
+  },
+  rules: {
+    "jsdoc/sort-tags": [
+      "error",
+      {
+        reportIntraTagGroupSpacing: false,
+        reportTagGroupSpacing: false,
+      },
+    ],
+    "jsdoc/tag-lines": [
+      "error",
+      "always",
+      {
+        startLines: 1,
+        endLines: 0,
+        applyToEndTag: false,
+        tags: {
+          returns: {
+            lines: "always",
+          },
+          property: {
+            lines: "any",
+          },
+          param: {
+            lines: "any",
+          },
+          example: {
+            lines: "always",
+          },
+        },
+      },
+    ],
+    "jsdoc/check-indentation": "error",
+    "jsdoc/check-alignment": "error",
+    "jsdoc/no-bad-blocks": "error",
+    "jsdoc/require-asterisk-prefix": ["error", "always"],
+
+    "jsdoc/require-description": "off",
+    "jsdoc/require-property-description": "off",
+    "jsdoc/require-param-description": "off",
+    "jsdoc/require-returns-description": "off",
+  },
+})

package/{rules → src/rules}/react.js

@@ -1,31 +1,29 @@
-module.exports = {
-  plugins: ["react", "react-hooks"],
-
-  /*
-   * Disabled by prettier
-   * https://github.com/prettier/eslint-config-prettier/blob/master/react.js
-   *
-   * "react/jsx-child-element-spacing": "off",
-   * "react/jsx-closing-bracket-location": "off",
-   * "react/jsx-closing-tag-location": "off",
-   * "react/jsx-curly-spacing": "off",
-   * "react/jsx-equals-spacing": "off",
-   * "react/jsx-first-prop-new-line": "off",
-   * "react/jsx-indent": "off",
-   * "react/jsx-indent-props": "off",
-   * "react/jsx-max-props-per-line": "off",
-   * "react/jsx-one-expression-per-line": "off",
-   * "react/jsx-props-no-multi-spaces": "off",
-   * "react/jsx-space-before-closing": "off",
-   * "react/jsx-tag-spacing": "off",
-   * "react/jsx-wrap-multilines": "off"
-   */
+import reactPlugin from "eslint-plugin-react"
+import reactHooksPlugin from "eslint-plugin-react-hooks"
+import reactRefresh from "eslint-plugin-react-refresh"
+
+const reactRecommendedConfig = /** @type {import("eslint").Linter.Config} */ (
+  reactPlugin.configs.flat?.["recommended"]
+)
+
+/** @satisfies {import("eslint").Linter.Config} */
+export default /** @type {const} */ ({
+  plugins: {
+    ...reactRecommendedConfig.plugins,
+    "react-hooks": reactHooksPlugin,
+    "react-refresh": reactRefresh,
+  },
   rules: {
+    ...reactRecommendedConfig.rules,
+
+    // Validate that your components can safely be updated with Fast Refresh.
+    "react-refresh/only-export-components": "error",
+
     // Checks rules of Hooks
     "react-hooks/rules-of-hooks": "error",
 
     // Checks effect dependencies
-    "react-hooks/exhaustive-deps": "warn",
+    "react-hooks/exhaustive-deps": "error",
 
     // Prevent missing displayName in a React component definition
     "react/display-name": "off",
@@ -144,11 +142,19 @@ module.exports = {
     // Prevent invalid characters from appearing in markup
     "react/no-unknown-property": "error",
 
+    "react/function-component-definition": [
+      "error",
+      {
+        namedComponents: "arrow-function",
+        unnamedComponents: "arrow-function",
+      },
+    ],
+
     // Prevent missing props validation in a React component definition
-    "react/prop-types": "error",
+    "react/prop-types": "off",
 
     // Prevent missing React when using JSX
-    "react/react-in-jsx-scope": "error",
+    "react/react-in-jsx-scope": "off",
 
     // Enforce ES5 or ES6 class for returning value in render function
     "react/require-render-return": "error",
@@ -183,7 +189,7 @@ module.exports = {
      * Declaring only one component per file improves readability and
      * reusability of components.
      */
-    "react/no-multi-comp": "error",
+    "react/no-multi-comp": "off",
 
     /*
      * Updating the state after a component update will trigger a second
@@ -234,6 +240,7 @@ module.exports = {
     "react/require-default-props": [
       "error",
       {
+        functions: "defaultArguments",
         forbidDefaultForRequired: true,
       },
     ],
@@ -328,5 +335,12 @@ module.exports = {
 
     // Prevent usage of button elements without an explicit type attribute
     "react/button-has-type": "error",
+
+    "react/jsx-props-no-spreading": "off",
+  },
+  settings: {
+    react: {
+      version: "detect",
+    },
   },
-}
+})

package/src/rules/rtl.js

@@ -0,0 +1,6 @@
+import rtlPlugin from "eslint-plugin-testing-library"
+
+/** @satisfies {import('eslint').Linter.Config} */
+export default /** @type {const} */ ({
+  ...rtlPlugin.configs["flat/react"],
+})

package/src/rules/typescript.js

@@ -0,0 +1,88 @@
+import tsPlugin from "@typescript-eslint/eslint-plugin"
+import tsParser from "@typescript-eslint/parser"
+
+/** @satisfies {import("eslint").Linter.Config} */
+export default /** @type {const} */ ({
+  languageOptions: {
+    parser: tsParser,
+  },
+  plugins: {
+    "@typescript-eslint": /** @type {any} */ (tsPlugin),
+  },
+  rules: {
+    ...tsPlugin.configs["strict-type-checked"]?.rules,
+
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      {
+        args: "all",
+        argsIgnorePattern: "^_",
+        caughtErrors: "all",
+        caughtErrorsIgnorePattern: "^_",
+        destructuredArrayIgnorePattern: "^_",
+        varsIgnorePattern: "^_",
+        ignoreRestSiblings: true,
+      },
+    ],
+
+    //
+    "@typescript-eslint/require-await": "warn",
+
+    // Conflicts with TypeScript's own error where accessing a property that
+    // doesn't exist on a type must be accessed with index notation.
+    "@typescript-eslint/dot-notation": "off",
+
+    "@typescript-eslint/restrict-template-expressions": [
+      "error",
+      {
+        allowBoolean: true,
+        allowNumber: true,
+      },
+    ],
+
+    "@typescript-eslint/no-var-requires": "off",
+    "@typescript-eslint/no-use-before-define": "error",
+
+    "@typescript-eslint/naming-convention": [
+      "error",
+      {
+        selector: "default",
+        leadingUnderscore: "allow",
+        format: ["camelCase", "PascalCase", "UPPER_CASE"],
+      },
+      {
+        selector: "variable",
+        types: ["boolean"],
+        format: ["camelCase", "PascalCase"],
+        prefix: ["is", "has", "can", "does", "should", "will", "did", "was"],
+      },
+      {
+        selector: "variable",
+        types: ["boolean", "number", "string", "array"],
+        modifiers: ["const", "global"],
+        format: ["UPPER_CASE"],
+      },
+      {
+        selector: "typeAlias",
+        format: ["PascalCase"],
+      },
+      {
+        selector: "typeParameter",
+        format: ["PascalCase"],
+      },
+      {
+        selector: [
+          "classProperty",
+          "objectLiteralProperty",
+          "typeProperty",
+          "classMethod",
+          "objectLiteralMethod",
+          "typeMethod",
+          "accessor",
+          "enumMember",
+        ],
+        format: [],
+      },
+    ],
+  },
+})

package/{rules → src/rules}/unicorn.js

@@ -1,40 +1,21 @@
-module.exports = {
-  plugins: ["unicorn"],
+import unicornPlugin from "eslint-plugin-unicorn"
 
-  extends: "plugin:unicorn/recommended",
-
-  /*
-   * Disabled by prettier
-   * https://github.com/prettier/eslint-config-prettier/blob/master/unicorn.js
-   *
-   * "unicorn/number-literal-case": "off"
-   */
+/** @satisfies {import('eslint').Linter.Config} */
+export default /** @type {const} */ ({
+  ...unicornPlugin.configs["flat/recommended"],
   rules: {
-    // Disable until node 16 is lts
-    "unicorn/prefer-node-protocol": "off",
+    /*
+     * Disabled by prettier
+     * https://github.com/prettier/eslint-config-prettier/blob/master/unicorn.js
+     *
+     * "unicorn/number-literal-case": "off"
+     */
 
-    "unicorn/prevent-abbreviations": [
-      "error",
-      {
-        replacements: {
-          i: false,
-          params: false,
-          lib: false,
-          args: {
-            params: true,
-          },
-          props: false,
-          opts: {
-            props: true,
-          },
-          source: {
-            input: true,
-          },
-          fn: false,
-          acc: false,
-        },
-      },
-    ],
+    // Use "node:" protocol when importing Node.js builtin modules
+    "unicorn/prefer-node-protocol": "error",
+
+    // We like functional programming
+    "unicorn/no-array-for-each": "off",
 
     // Move function definitions to the highest possible scope.
     // Too noisy when curring functions
@@ -137,19 +118,16 @@ module.exports = {
     // Enforce throwing TypeError in type checking conditions
     "unicorn/prefer-type-error": "error",
 
+    // Cannot satisfy "consistent-return" with this rule enabled
+    "unicorn/no-useless-undefined": "off",
+
     /*
      * Enforce the use of new for all builtins, except String, Number and
      * Boolean
      */
     "unicorn/new-for-builtins": "error",
 
-    /*
-     * Disallow unsafe regular expressions. Uses safe-regex to disallow
-     * potentially catastrophic exponential-time regular expressions.
-     */
-    "unicorn/no-unsafe-regex": "error",
-
     // Enforce passing a message value when throwing a built-in error
     "unicorn/error-message": "error",
   },
-}
+})

package/src/utils/find-up-sync.js

@@ -0,0 +1,56 @@
+import fs from "node:fs"
+import path from "node:path"
+
+/**
+ * @typedef {Object} FindUpSyncOptions
+ *
+ * @property {string} [cwd] - The current working directory to start from.
+ */
+
+/**
+ * @callback FindUpSyncFn
+ *
+ * @param {string} fileName - The name of the file to find.
+ * @param {FindUpSyncOptions} [options] - Options for the function.
+ * @returns {string} The absolute path to the file.
+ */
+
+/**
+ * Find a file up the directory tree synchronously.
+ *
+ * @type {FindUpSyncFn}
+ *
+ * @throws {Error} If the starting folder does not exist.
+ *
+ * @throws {Error} If the file does not exist up the tree.
+ *
+ * @example
+ *  const filePath = findUpSync("lerna.json");
+ *  //=> "/Users/johndoe/Projects/WootWoot/lerna.json"
+ *
+ */
+const findUpSync = (fileName, options = {}) => {
+  let { cwd } = options
+  cwd = path.resolve(cwd ?? process.cwd())
+
+  if (!fs.statSync(cwd).isDirectory()) {
+    throw new Error(`Path "${cwd}" does not exist or is not a directory`)
+  }
+
+  let { root } = path.parse(cwd)
+
+  while (cwd !== root) {
+    const file_path = path.join(cwd, fileName)
+
+    if (fs.existsSync(file_path)) {
+      return file_path
+    }
+
+    cwd = path.dirname(cwd)
+    root = path.parse(cwd).root
+  }
+
+  throw new Error(`File "${fileName}" does not exist up the tree`)
+}
+
+export { findUpSync }

package/rules/best-practices.js

@@ -1,11 +0,0 @@
-module.exports = {
-  rules: {
-    // Encourages use of dot notation whenever possible
-    "dot-notation": [
-      "error",
-      {
-        allowKeywords: true,
-      },
-    ],
-  },
-}

package/rules/comments.js

@@ -1,46 +0,0 @@
-module.exports = {
-  rules: {
-    /*
-     * Enforce a consistent style of comments across your codebase,
-     * specifically by either requiring or disallowing a capitalized
-     * letter as the first word character in a comment. This rule will not
-     * issue warnings when non-cased letters are used.
-     */
-    "capitalized-comments": "off",
-
-    /*
-     * Enforces consistent position of line comments. Block comments are
-     * not affected by this rule. By default, this rule ignores comments
-     * starting with the following words: eslint, jshint, jslint,
-     * istanbul, global, exported, jscs, falls through.
-     */
-    "line-comment-position": [
-      "error",
-      {
-        position: "above",
-      },
-    ],
-
-    // Disallow usage of configurable warning terms in comments: e.g. todo
-    "no-warning-comments": [
-      0,
-      {
-        location: "start",
-        terms: ["todo", "fixme", "xxx"],
-      },
-    ],
-
-    /*
-     * Enforce consistency of spacing after the start of a comment // or
-     * /*. It also provides several exceptions for various documentation
-     * styles.
-     */
-    "spaced-comment": ["error", "always"],
-
-    /*
-     * This rule aims to enforce a particular style for
-     * multiline comments.
-     */
-    "multiline-comment-style": "off",
-  },
-}