@storm-software/eslint 0.100.0 → 0.107.0

package/dist/preset.js

@@ -0,0 +1,375 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+import eslint from "@eslint/js";
+import next from "@next/eslint-plugin-next";
+import nxPlugin from "@nx/eslint-plugin/nx.js";
+import { formatLogMessage, writeDebug, writeError, writeFatal, writeInfo } from "@storm-software/config-tools";
+import { defu } from "defu";
+import json from "eslint-plugin-json";
+import markdown from "eslint-plugin-markdown";
+import prettierConfig from "eslint-plugin-prettier/recommended";
+import reactPlugin from "eslint-plugin-react";
+import reactCompiler from "eslint-plugin-react-compiler";
+import reactHooks from "eslint-plugin-react-hooks";
+import tsdoc from "eslint-plugin-tsdoc";
+import unicorn from "eslint-plugin-unicorn";
+import yml from "eslint-plugin-yml";
+import globalsObj from "globals";
+import tsEslint from "typescript-eslint";
+import { getStormRulesConfig } from "./rules/storm";
+import tsdocRules from "./rules/ts-docs";
+import banner from "./utils/banner-plugin";
+import { CODE_BLOCK, TS_FILE } from "./utils/constants";
+import { formatConfig } from "./utils/format-config";
+import { ignores } from "./utils/ignores";
+function getStormConfig(options = {
+  rules: {},
+  ignores: [],
+  globals: {},
+  useUnicorn: true,
+  markdown: {},
+  react: {},
+  nx: {},
+  useReactCompiler: false,
+  logLevel: "info",
+  cspellConfigFile: ".vscode/cspell.json"
+}, ...userConfigs) {
+  const tsconfig = options.tsconfig;
+  const parserOptions = options.parserOptions;
+  const typescriptEslintConfigType = options.typescriptEslintConfigType || "eslintRecommended";
+  const useUnicorn = options.useUnicorn ?? true;
+  const react = options.react ?? {};
+  const nx = options.nx ?? {};
+  const useReactCompiler = options.useReactCompiler ?? false;
+  const logLevel = options.logLevel ?? "info";
+  const globals = options.globals ?? {};
+  const cspellConfigFile = options.cspellConfigFile || ".vscode/cspell.json";
+  try {
+    const configs = [
+      // Prettier
+      prettierConfig,
+      // Import
+      // https://www.npmjs.com/package/eslint-plugin-import
+      // { plugins: { import: importEslint } },
+      // {
+      //   files: [CODE_FILE],
+      //   rules: importRules
+      // },
+      // Json
+      // https://www.npmjs.com/package/eslint-plugin-json
+      {
+        files: [
+          "**/*.json"
+        ],
+        ...json.configs["recommended"],
+        rules: {
+          "json/json": [
+            "warn",
+            {
+              "allowComments": true
+            }
+          ]
+        }
+      },
+      {
+        files: [
+          "**/executors/**/schema.json",
+          "**/generators/**/schema.json"
+        ],
+        rules: nx !== false ? {
+          "@nx/workspace/valid-schema-description": "error"
+        } : {}
+      },
+      {
+        files: [
+          "**/package.json"
+        ],
+        rules: nx !== false ? {
+          "@nx/dependency-checks": [
+            "error",
+            {
+              buildTargets: [
+                "build"
+              ],
+              ignoredDependencies: [
+                "typescript"
+              ],
+              ignoredFiles: options.ignores,
+              checkMissingDependencies: true,
+              checkObsoleteDependencies: true,
+              checkVersionMismatches: false,
+              includeTransitiveDependencies: true,
+              useLocalPathsForWorkspaceDependencies: true
+            }
+          ]
+        } : {}
+      },
+      // YML
+      // https://www.npmjs.com/package/eslint-plugin-yml
+      ...yml.configs["flat/recommended"],
+      ...yml.configs["flat/prettier"],
+      // CSpell
+      {
+        ...json.configs["recommended"],
+        rules: {
+          ...json.configs["recommended"].rules,
+          "@cspell/spellchecker": [
+            "warn",
+            {
+              configFile: new URL(cspellConfigFile, import.meta.url).toString(),
+              autoFix: true
+            }
+          ]
+        }
+      },
+      // User overrides
+      ...userConfigs
+    ].filter(Boolean);
+    if (nx) {
+      configs.push({
+        plugins: {
+          "@nx": nxPlugin
+        }
+      });
+    }
+    configs.push(eslint.configs.recommended);
+    if (typescriptEslintConfigType !== "none") {
+      if (!(typescriptEslintConfigType in tsEslint.configs)) {
+        console.warn("Invalid TypeScript ESLint configuration type:", typescriptEslintConfigType);
+      } else {
+        configs.push(...Array.isArray(tsEslint.configs[typescriptEslintConfigType]) ? tsEslint.configs[typescriptEslintConfigType] : [
+          tsEslint.configs[typescriptEslintConfigType]
+        ]);
+      }
+    }
+    if (useUnicorn) {
+      configs.push({
+        files: [
+          TS_FILE
+        ],
+        plugins: {
+          unicorn
+        },
+        rules: {
+          ...unicorn.configs["flat/recommended"].rules
+        }
+      });
+    }
+    configs.push({
+      files: [
+        TS_FILE
+      ],
+      plugins: {
+        tsdoc
+      },
+      rules: tsdocRules
+    });
+    configs.push({
+      // ...banner.configs!["recommended"],
+      name: "banner",
+      plugins: {
+        banner
+      },
+      files: [
+        TS_FILE
+      ],
+      rules: {
+        "banner/banner": [
+          "error",
+          {
+            commentType: "block",
+            numNewlines: 2,
+            repositoryName: options.name
+          }
+        ]
+      }
+    });
+    if (react) {
+      const reactConfigs = [
+        {
+          ...reactPlugin.configs?.recommended,
+          plugins: {
+            "react": reactPlugin
+          },
+          files: [
+            "**/*.tsx"
+          ],
+          ignores: [
+            ...ignores,
+            ...options.ignores || []
+          ],
+          ...react
+        },
+        {
+          ...reactHooks.configs?.recommended,
+          plugins: {
+            "react-hooks": reactHooks
+          },
+          files: [
+            TS_FILE
+          ],
+          ignores: [
+            ...ignores,
+            ...options.ignores || []
+          ]
+        }
+      ];
+      if (useReactCompiler) {
+        reactConfigs.push({
+          files: [
+            "**/*.tsx"
+          ],
+          ignores: [
+            ...ignores,
+            ...options.ignores || []
+          ],
+          plugins: {
+            "react-compiler": reactCompiler
+          },
+          rules: {
+            "react-compiler/react-compiler": "error"
+          }
+        });
+      }
+      configs.push(...reactConfigs);
+    }
+    if (options.nextFiles && options.nextFiles.length > 0) {
+      configs.push({
+        ...next.configs["core-web-vitals"],
+        ignores: [
+          ...options.ignores || []
+        ],
+        files: options.nextFiles
+      });
+    }
+    const typescriptConfig = {
+      files: [
+        TS_FILE
+      ],
+      languageOptions: {
+        globals: {
+          ...Object.fromEntries(Object.keys(globalsObj).flatMap((group) => Object.keys(globalsObj[group]).map((key) => [
+            key,
+            "readonly"
+          ]))),
+          ...globalsObj.browser,
+          ...globalsObj.node,
+          ...globals,
+          "window": "readonly"
+        },
+        parserOptions: {
+          projectService: true,
+          ecmaFeatures: {
+            jsx: react !== false
+          }
+        }
+      },
+      rules: {
+        ...getStormRulesConfig({
+          ...options,
+          typescriptEslintConfigType,
+          useUnicorn,
+          useNx: nx !== false
+        }),
+        ...Object.keys(options.rules ?? {}).filter((ruleId) => !useUnicorn || !ruleId.startsWith("unicorn/") || !react || !ruleId.startsWith("react/") && !ruleId.startsWith("react-hooks/")).reduce((ret, ruleId) => {
+          ret[ruleId] = options.rules[ruleId];
+          return ret;
+        }, {})
+      },
+      ignores: [
+        ...ignores,
+        ...options.ignores || []
+      ]
+    };
+    if (parserOptions) {
+      typescriptConfig.languageOptions ??= {};
+      typescriptConfig.languageOptions.parserOptions = parserOptions;
+    }
+    if (tsconfig) {
+      typescriptConfig.languageOptions ??= {};
+      typescriptConfig.languageOptions.parserOptions ??= {};
+      typescriptConfig.languageOptions.parserOptions.project = tsconfig;
+    }
+    configs.push(typescriptConfig);
+    if (options.markdown) {
+      configs.push(...markdown.configs.recommended);
+      configs.push({
+        files: [
+          CODE_BLOCK
+        ],
+        processor: "markdown/markdown",
+        rules: {
+          "unicorn/filename-case": "off",
+          "no-undef": "off",
+          "no-unused-expressions": "off",
+          "padded-blocks": "off",
+          "no-empty-pattern": "off",
+          "no-redeclare": "off",
+          "no-import-assign": "off",
+          ...options.markdown
+        }
+      });
+      configs.push({
+        files: [
+          "**/*.md/*.js",
+          "**/*.md/*.ts"
+        ],
+        rules: {
+          "unicorn/filename-case": "off",
+          "no-undef": "off",
+          "no-unused-expressions": "off",
+          "padded-blocks": "off",
+          "no-empty-pattern": "off",
+          "no-redeclare": "off",
+          "no-import-assign": "off",
+          ...options.markdown
+        }
+      });
+    }
+    const result = formatConfig("Preset", configs.reduce((ret, config) => {
+      delete config.parserOptions;
+      const existingIndex = ret.findIndex((existing) => areFilesEqual(existing.files, config.files));
+      if (existingIndex >= 0) {
+        ret[existingIndex] = defu(ret[existingIndex], config);
+      } else {
+        ret.push(config);
+      }
+      return ret;
+    }, []));
+    writeInfo("\u2699\uFE0F  Completed generated Storm ESLint configuration objects", {
+      logLevel
+    });
+    writeDebug(formatLogMessage(result, {
+      skip: [
+        "globals"
+      ]
+    }), {
+      logLevel
+    });
+    return result;
+  } catch (error) {
+    writeFatal("Error generating Storm ESLint configuration objects", {
+      logLevel
+    });
+    writeError(error, {
+      logLevel
+    });
+    throw error;
+  }
+}
+__name(getStormConfig, "getStormConfig");
+const areFilesEqual = /* @__PURE__ */ __name((files1, files2) => {
+  if (files1 === files2) {
+    return true;
+  } else if (!files1 || !files2) {
+    return false;
+  } else if (typeof files1 === "string" && typeof files2 !== "string" || typeof files1 !== "string" && typeof files2 === "string" || Array.isArray(files1) && !Array.isArray(files2) || !Array.isArray(files1) && Array.isArray(files2)) {
+    return false;
+  } else if (files1.length !== files2.length) {
+    return false;
+  }
+  return files1.every((file, index) => Array.isArray(file) && Array.isArray(files2?.[index]) ? areFilesEqual(file, files2?.[index]) : !Array.isArray(file) && !Array.isArray(files2?.[index]) ? file?.toLowerCase() === files2?.[index]?.toLowerCase() : file === files2);
+}, "areFilesEqual");
+export {
+  getStormConfig
+};

package/package.json

@@ -1,121 +1 @@
-{
-  "name": "@storm-software/eslint",
-  "version": "0.100.0",
-  "type": "module",
-  "description": "⚡ A package containing the base ESLint configuration used by Storm Software across many projects.",
-  "repository": {
-    "type": "github",
-    "url": "https://github.com/storm-software/storm-ops",
-    "directory": "packages/eslint"
-  },
-  "homepage": "https://stormsoftware.com",
-  "bugs": {
-    "url": "https://github.com/storm-software/storm-ops/issues",
-    "email": "support@stormsoftware.com"
-  },
-  "author": {
-    "name": "Storm Software",
-    "email": "contact@stormsoftware.com",
-    "url": "https://stormsoftware.com"
-  },
-  "maintainers": [
-    {
-      "name": "Storm Software",
-      "email": "contact@stormsoftware.com",
-      "url": "https://stormsoftware.com"
-    },
-    {
-      "name": "Pat Sullivan",
-      "email": "admin@stormsoftware.com",
-      "url": "https://patsullivan.org"
-    }
-  ],
-  "license": "Apache-2.0",
-  "private": false,
-  "exports": {
-    ".": {
-      "types": "./dist/preset.d.ts",
-      "import": "./dist/preset.mjs"
-    }
-  },
-  "files": [
-    "dist"
-  ],
-  "keywords": [
-    "storm",
-    "storm-ops",
-    "sullivanpj",
-    "eslint",
-    "eslintconfig",
-    "eslint-config",
-    "monorepo"
-  ],
-  "peerDependencies": {
-    "@nx/eslint": "^20.2.2",
-    "@nx/eslint-plugin": "^20.2.2",
-    "eslint": "9.5.0",
-    "graphql": ">=16.9.0"
-  },
-  "peerDependenciesMeta": {
-    "@nx/eslint": {
-      "optional": true
-    },
-    "@nx/eslint-plugin": {
-      "optional": true
-    },
-    "eslint": {
-      "optional": false
-    },
-    "graphql": {
-      "optional": true
-    }
-  },
-  "dependencies": {
-    "@cspell/eslint-plugin": "8.13.1",
-    "@graphql-eslint/eslint-plugin": "3.20.1",
-    "@next/eslint-plugin-next": "14.2.4",
-    "defu": "6.1.4",
-    "eslint-plugin-es-x": "7.6.0",
-    "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-json": "4.0.0",
-    "eslint-plugin-jsonc": "2.16.0",
-    "eslint-plugin-jsx-a11y": "^6.8.0",
-    "eslint-plugin-markdown": "^5.1.0",
-    "eslint-plugin-markdownlint": "0.6.0",
-    "eslint-plugin-mdx": "3.1.5",
-    "eslint-plugin-n": "17.8.1",
-    "eslint-plugin-prettier": "^5.0.0",
-    "eslint-plugin-promise": "6.2.0",
-    "eslint-plugin-react": "^7.34.3",
-    "eslint-plugin-react-compiler": "0.0.0-experimental-b6997ec-20240909",
-    "eslint-plugin-react-hooks": "^4.6.2",
-    "eslint-plugin-relay": "1.8.3",
-    "eslint-plugin-sonarjs": "1.0.3",
-    "eslint-plugin-storybook": "0.10.1",
-    "eslint-plugin-tsdoc": "0.3.0",
-    "eslint-plugin-unicorn": "54.0.0",
-    "eslint-plugin-yml": "1.14.0",
-    "globals": "^15.8.0",
-    "jsonc-eslint-parser": "2.4.0",
-    "synckit": "0.9.0",
-    "typescript-eslint": "8.10.0",
-    "ws": "8.17.1",
-    "yaml-eslint-parser": "1.2.3"
-  },
-  "devDependencies": {
-    "@eslint/config-inspector": "^0.5.1",
-    "@nx/eslint": "^20.2.2",
-    "@nx/eslint-plugin": "^20.2.2",
-    "@types/eslint": "^8.56.10",
-    "@types/eslint__js": "^8.42.3",
-    "@types/node": "^22.4.0",
-    "eslint": "9.5.0",
-    "eslint-typegen": "^0.2.4",
-    "graphql": ">=16.9.0",
-    "typescript": ">=5.5.3",
-    "unbuild": "^2.0.0"
-  },
-  "publishConfig": {
-    "access": "public"
-  }
-}
+{"name":"@storm-software/eslint","version":"0.107.0","type":"module","description":"⚡ A package containing the base ESLint configuration used by Storm Software across many projects.","repository":{"type":"github","url":"https://github.com/storm-software/storm-ops","directory":"packages/eslint"},"homepage":"https://stormsoftware.com","bugs":"https://github.com/storm-software/storm-ops/issues","author":{"name":"Storm Software","email":"contact@stormsoftware.com","url":"https://stormsoftware.com"},"maintainers":[{"name":"Storm Software","email":"contact@stormsoftware.com","url":"https://stormsoftware.com"},{"name":"Pat Sullivan","email":"admin@stormsoftware.com","url":"https://patsullivan.org"}],"license":"Apache-2.0","private":false,"exports":{".":{"types":"./dist/preset.d.ts","import":"./dist/preset.mjs"}},"files":["dist"],"keywords":["eslint","eslint-config","eslintconfig","monorepo","storm","storm-ops","sullivanpj"],"peerDependencies":{"@nx/eslint":"^20.3.1","@nx/eslint-plugin":"^20.3.1","eslint":"^9.12.0","graphql":">=16.9.0"},"peerDependenciesMeta":{"@nx/eslint":{"optional":true},"@nx/eslint-plugin":{"optional":true},"eslint":{"optional":false},"graphql":{"optional":true}},"dependencies":{"@cspell/eslint-plugin":"8.13.1","@graphql-eslint/eslint-plugin":"3.20.1","@next/eslint-plugin-next":"14.2.4","defu":"6.1.4","eslint-plugin-es-x":"7.6.0","eslint-plugin-import":"^2.29.1","eslint-plugin-json":"4.0.0","eslint-plugin-jsonc":"2.16.0","eslint-plugin-jsx-a11y":"^6.8.0","eslint-plugin-markdown":"^5.1.0","eslint-plugin-markdownlint":"0.6.0","eslint-plugin-mdx":"3.1.5","eslint-plugin-n":"17.8.1","eslint-plugin-prettier":"^5.0.0","eslint-plugin-promise":"6.2.0","eslint-plugin-react":"^7.34.3","eslint-plugin-react-compiler":"0.0.0-experimental-b6997ec-20240909","eslint-plugin-react-hooks":"^5.1.0","eslint-plugin-relay":"1.8.3","eslint-plugin-sonarjs":"1.0.3","eslint-plugin-storybook":"0.11.0","eslint-plugin-tsdoc":"0.4.0","eslint-plugin-unicorn":"56.0.0","eslint-plugin-yml":"1.14.0","globals":"^15.8.0","jsonc-eslint-parser":"2.4.0","synckit":"0.9.0","typescript-eslint":"^8.13.0","ws":"8.17.1","yaml-eslint-parser":"1.2.3"},"devDependencies":{"@eslint/config-inspector":"^0.5.1","@nx/eslint":"^20.3.1","@nx/eslint-plugin":"^20.3.1","@types/eslint":"^9.6.1","@types/eslint__js":"^8.42.3","@types/node":"^22.10.2","eslint":"^9.12.0","eslint-typegen":"^1.0.0","graphql":">=16.9.0","tsup":"8.3.5","typescript":"^5.7.2"},"publishConfig":{"access":"public"}}