@storm-software/eslint 0.87.2 → 0.87.3

package/README.md

@@ -21,7 +21,7 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages
 
 <h3 align="center">💻 Visit <a href="https://stormsoftware.com" target="_blank">stormsoftware.com</a> to stay up to date with this developer</h3><br />
 
-[![Version](https://img.shields.io/badge/version-0.87.1-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
+[![Version](https://img.shields.io/badge/version-0.87.2-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
 
 <!-- prettier-ignore-start -->
 <!-- markdownlint-disable -->

package/dist/preset.d.mts

@@ -7010,6 +7010,7 @@ type TypeScriptEslintConfigType = "none" | "all" | "base" | "disable-type-checke
 interface GetStormRulesConfigOptions {
     typescriptEslintConfigType?: TypeScriptEslintConfigType;
     useUnicorn?: boolean;
+    useNx?: boolean;
 }
 
 /**
@@ -7040,8 +7041,10 @@ type PresetOptions = GetStormRulesConfigOptions & {
     parserOptions?: Linter.ParserOptions;
     markdown?: false | Linter.RulesRecord;
     react?: false | Linter.RulesRecord;
+    nx?: false | Linter.RulesRecord;
     useReactCompiler?: boolean;
     nextFiles?: string[];
+    logLevel?: "all" | "trace" | "debug" | "info" | "warn" | "error" | "fatal" | "silent";
 };
 /**
  * Get the ESLint configuration for a Storm workspace.

package/dist/preset.d.ts

@@ -7010,6 +7010,7 @@ type TypeScriptEslintConfigType = "none" | "all" | "base" | "disable-type-checke
 interface GetStormRulesConfigOptions {
     typescriptEslintConfigType?: TypeScriptEslintConfigType;
     useUnicorn?: boolean;
+    useNx?: boolean;
 }
 
 /**
@@ -7040,8 +7041,10 @@ type PresetOptions = GetStormRulesConfigOptions & {
     parserOptions?: Linter.ParserOptions;
     markdown?: false | Linter.RulesRecord;
     react?: false | Linter.RulesRecord;
+    nx?: false | Linter.RulesRecord;
     useReactCompiler?: boolean;
     nextFiles?: string[];
+    logLevel?: "all" | "trace" | "debug" | "info" | "warn" | "error" | "fatal" | "silent";
 };
 /**
  * Get the ESLint configuration for a Storm workspace.

package/dist/preset.mjs

@@ -17,7 +17,7 @@ import tsdoc from 'eslint-plugin-tsdoc';
 import unicorn from 'eslint-plugin-unicorn';
 import yml from 'eslint-plugin-yml';
 import globals from 'globals';
-import { writeInfo, writeDebug } from '@storm-software/config-tools';
+import { writeInfo, writeDebug, formatLogMessage, writeFatal, writeError } from '@storm-software/config-tools';
 import { defu } from 'defu';
 import tsEslint$1 from 'typescript-eslint';
 import require$$0 from 'eslint/use-at-your-own-risk';
@@ -1279,26 +1279,7 @@ const getStormRulesConfig = (options) => {
     "unicode-bom": ["error", "never"],
     // require regex literals to be wrapped in parentheses
     "wrap-regex": "off",
-    "class-methods-use-this": "off",
-    /*************************************************************
-     *
-     *  Nx Rules - The following rules are specific to the Nx plugin
-     *
-     **************************************************************/
-    "@nx/enforce-module-boundaries": [
-      "error",
-      {
-        enforceBuildableLibDependency: true,
-        checkDynamicDependenciesExceptions: [".*"],
-        allow: [],
-        depConstraints: [
-          {
-            sourceTag: "*",
-            onlyDependOnLibsWithTags: ["*"]
-          }
-        ]
-      }
-    ]
+    "class-methods-use-this": "off"
   };
   if (options.typescriptEslintConfigType !== "none") {
     rules = {
@@ -1352,6 +1333,30 @@ const getStormRulesConfig = (options) => {
       ]
     };
   }
+  if (options.useNx !== false) {
+    rules = {
+      ...rules,
+      /*************************************************************
+       *
+       *  Nx Rules - The following rules are specific to the Nx plugin
+       *
+       **************************************************************/
+      "@nx/enforce-module-boundaries": [
+        "error",
+        {
+          enforceBuildableLibDependency: true,
+          checkDynamicDependenciesExceptions: [".*"],
+          allow: [],
+          depConstraints: [
+            {
+              sourceTag: "*",
+              onlyDependOnLibsWithTags: ["*"]
+            }
+          ]
+        }
+      ]
+    };
+  }
   if (options.useUnicorn !== false) {
     rules = {
       ...rules,
@@ -12920,267 +12925,288 @@ const ignores = [
 function getStormConfig(options = {
   rules: {},
   ignores: [],
-  tsconfig: "./tsconfig.base.json",
-  parserOptions: {},
   typescriptEslintConfigType: "eslint-recommended",
   useUnicorn: true,
   markdown: {},
   react: {},
-  useReactCompiler: false
+  nx: {},
+  useReactCompiler: false,
+  logLevel: "info"
 }, ...userConfigs) {
-  const tsconfig = options.tsconfig ?? "./tsconfig.base.json";
+  var _a;
+  const tsconfig = options.tsconfig;
+  const parserOptions = options.parserOptions;
   const typescriptEslintConfigType = options.typescriptEslintConfigType || "eslint-recommended";
   const useUnicorn = options.useUnicorn ?? true;
   const react = options.react ?? {};
+  const nx = options.nx ?? {};
   const useReactCompiler = options.useReactCompiler ?? false;
-  const configs = [
-    // Prettier
-    prettierConfig,
-    // Import
-    // https://www.npmjs.com/package/eslint-plugin-import
-    // { plugins: { import: importEslint } },
-    // {
-    //   files: [CODE_FILE],
-    //   rules: importRules
-    // },
-    // bannerConfig,
-    // NX
-    {
-      plugins: { "@nx": nxPlugin }
-    },
-    // 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/workspace/valid-schema-description": "error"
-      }
-    },
-    {
-      files: ["**/package.json"],
-      rules: {
-        "@nx/dependency-checks": [
-          "error",
-          {
-            buildTargets: ["build"],
-            ignoredDependencies: ["typescript"],
-            ignoredFiles: [],
-            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
-    {
-      plugins: {
-        ...plugins
+  const logLevel = options.logLevel ?? "info";
+  try {
+    const configs = [
+      // Prettier
+      prettierConfig,
+      // Import
+      // https://www.npmjs.com/package/eslint-plugin-import
+      // { plugins: { import: importEslint } },
+      // {
+      //   files: [CODE_FILE],
+      //   rules: importRules
+      // },
+      // bannerConfig,
+      // 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"
+        } : {}
       },
-      rules: {
-        ...rules,
-        "@cspell/spellchecker": [
-          "warn",
-          {
-            // configFile: new URL(
-            //   "./.vscode/cspell.json",
-            //   import.meta.url
-            // ).toString(),
-            autoFix: true
-          }
-        ]
-      }
-    },
-    // User overrides
-    ...userConfigs
-  ].filter(Boolean);
-  configs.push(eslint.configs.recommended);
-  if (typescriptEslintConfigType !== "none") {
-    if (!(typescriptEslintConfigType in tsEslint$1.configs)) {
-      console.warn(
-        "Invalid TypeScript ESLint configuration type:",
-        typescriptEslintConfigType
-      );
-    } else {
-      configs.push(
-        ...Array.isArray(tsEslint$1.configs[typescriptEslintConfigType]) ? tsEslint$1.configs[typescriptEslintConfigType] : [tsEslint$1.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: config
-  });
-  configs.push({
-    // ...banner.configs!["recommended"],
-    name: "banner",
-    plugins: { banner: plugin },
-    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"],
-        languageOptions: {
-          parserOptions: {
-            ecmaFeatures: {
-              jsx: true
+        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
             }
-          }
-        },
-        ignores: [...ignores, ...options.ignores || []],
-        ...react
+          ]
+        } : {}
       },
+      // YML
+      // https://www.npmjs.com/package/eslint-plugin-yml
+      ...yml.configs["flat/recommended"],
+      ...yml.configs["flat/prettier"],
+      // CSpell
       {
-        ...reactHooks.configs?.recommended,
-        plugins: { "react-hooks": reactHooks },
-        files: [TS_FILE],
-        ignores: [...ignores, ...options.ignores || []]
-      }
-      // {
-      //   files: ["**/*.{js,mjs,cjs,jsx,mjsx,ts,tsx,mtsx}"],
-      //   ...jsxA11y.flatConfigs?.recommended
-      // }
-    ];
-    if (useReactCompiler) {
-      reactConfigs.push({
-        files: ["**/*.tsx"],
-        ignores: [...ignores, ...options.ignores || []],
         plugins: {
-          "react-compiler": reactCompiler
+          ...plugins
         },
         rules: {
-          "react-compiler/react-compiler": "error"
+          ...rules,
+          "@cspell/spellchecker": [
+            "warn",
+            {
+              // configFile: new URL(
+              //   "./.vscode/cspell.json",
+              //   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$1.configs)) {
+        console.warn(
+          "Invalid TypeScript ESLint configuration type:",
+          typescriptEslintConfigType
+        );
+      } else {
+        configs.push(
+          ...Array.isArray(tsEslint$1.configs[typescriptEslintConfigType]) ? tsEslint$1.configs[typescriptEslintConfigType] : [tsEslint$1.configs[typescriptEslintConfigType]]
+        );
+      }
+    }
+    if (useUnicorn) {
+      configs.push({
+        files: [TS_FILE],
+        plugins: { unicorn },
+        rules: {
+          ...unicorn.configs["flat/recommended"].rules
         }
       });
     }
-    configs.push(...reactConfigs);
-  }
-  if (options.nextFiles && options.nextFiles.length > 0) {
     configs.push({
-      ...next.configs["core-web-vitals"],
-      ignores: [...options.ignores || []],
-      files: options.nextFiles
+      files: [TS_FILE],
+      plugins: { tsdoc },
+      rules: config
     });
-  }
-  configs.push({
-    files: [TS_FILE],
-    languageOptions: {
-      sourceType: "module",
-      ecmaVersion: "latest",
-      globals: {
-        ...Object.fromEntries(
-          Object.keys(globals).flatMap(
-            (group) => Object.keys(globals[group]).map((key) => [
-              key,
-              "readonly"
-            ])
-          )
-        ),
-        ...globals.browser,
-        ...globals.node,
-        "window": "readonly",
-        "Storm": "readonly"
-      },
-      parserOptions: {
-        project: tsconfig,
-        ...options.parserOptions
-      }
-    },
-    rules: {
-      ...getStormRulesConfig({
-        ...options,
-        typescriptEslintConfigType,
-        useUnicorn
-      }),
-      ...options.rules ?? {}
-    },
-    ignores: [...ignores, ...options.ignores || []]
-  });
-  if (options.markdown) {
-    configs.push(...markdown.configs.recommended);
     configs.push({
-      files: [CODE_BLOCK],
-      processor: "markdown/markdown",
+      // ...banner.configs!["recommended"],
+      name: "banner",
+      plugins: { banner: plugin },
+      files: [TS_FILE],
       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
+        "banner/banner": [
+          "error",
+          { commentType: "block", numNewlines: 2, repositoryName: options.name }
+        ]
       }
     });
-    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
+    if (react) {
+      const reactConfigs = [
+        {
+          ...reactPlugin.configs?.recommended,
+          plugins: { "react": reactPlugin },
+          files: ["**/*.tsx"],
+          languageOptions: {
+            parserOptions: {
+              ecmaFeatures: {
+                jsx: true
+              }
+            }
+          },
+          ignores: [...ignores, ...options.ignores || []],
+          ...react
+        },
+        {
+          ...reactHooks.configs?.recommended,
+          plugins: { "react-hooks": reactHooks },
+          files: [TS_FILE],
+          ignores: [...ignores, ...options.ignores || []]
+        }
+        // {
+        //   files: ["**/*.{js,mjs,cjs,jsx,mjsx,ts,tsx,mtsx}"],
+        //   ...jsxA11y.flatConfigs?.recommended
+        // }
+      ];
+      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(globals).flatMap(
+              (group) => Object.keys(globals[group]).map((key) => [
+                key,
+                "readonly"
+              ])
+            )
+          ),
+          ...globals.browser,
+          ...globals.node,
+          "window": "readonly",
+          "Storm": "readonly"
+        }
+      },
+      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 = {});
+      typescriptConfig.languageOptions.parserOptions = parserOptions;
+    }
+    if (tsconfig) {
+      typescriptConfig.languageOptions ?? (typescriptConfig.languageOptions = {});
+      (_a = typescriptConfig.languageOptions).parserOptions ?? (_a.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) => {
+        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;
   }
-  writeInfo("\u2699\uFE0F  Merging generated Storm ESLint configuration objects", {
-    logLevel: "all"
-  });
-  writeDebug(configs, { logLevel: "all" });
-  const result = formatConfig(
-    "Preset",
-    configs.reduce((ret, config) => {
-      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: "all"
-  });
-  writeDebug(result, { logLevel: "all" });
-  return result;
 }
 const areFilesEqual = (files1, files2) => {
   if (files1 === files2) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storm-software/eslint",
-  "version": "0.87.2",
+  "version": "0.87.3",
   "type": "module",
   "description": "⚡ A package containing the base ESLint configuration used by Storm Software across many projects.",
   "repository": {