@storm-software/eslint 0.137.4 → 0.138.1

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.137.3-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.138.0-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/{chunk-BXVDD33Y.js → chunk-VMGPCABA.js}

@@ -1,6 +1,6 @@
 import {
   getFileBanner
-} from "./chunk-KDHZD7SF.js";
+} from "./chunk-ZUIV57VZ.js";
 import {
   GLOB_SRC
 } from "./chunk-AIKLBIPC.js";
@@ -166,11 +166,11 @@ var bannerRule = ESLintUtils.RuleCreator(() => `https://docs.stormsoftware.com/e
     {
       repositoryName: "",
       commentType: "block",
-      numNewlines: 1,
+      numNewlines: 2,
       lineEndings: "unix"
     }
   ],
-  create(context, [{ banner, repositoryName = "", commentType = "block", numNewlines = 1, lineEndings = "unix" }]) {
+  create(context, [{ banner, repositoryName = "", commentType = "block", numNewlines = 2, lineEndings = "unix" }]) {
     if (!banner) {
       banner = getFileBanner(repositoryName);
     }

package/dist/{chunk-KDHZD7SF.js → chunk-ZUIV57VZ.js}

@@ -6,15 +6,15 @@ import {
 } from "./chunk-SHUYVCID.js";
 
 // src/utils/get-file-banner.ts
-var getFileBanner = /* @__PURE__ */ __name((name = "") => {
-  if (!name) {
-    name = process.env.STORM_NAME || "";
+var getFileBanner = /* @__PURE__ */ __name((repositoryName = "") => {
+  if (!repositoryName) {
+    repositoryName = process.env.STORM_NAME || "";
   }
   let padding = "                               ";
-  for (let i = 0; i < name.length + 2 && padding.length > 4; i++) {
+  for (let i = 0; i < repositoryName.length + 2 && padding.length > 4; i++) {
     padding = padding.slice(0, -1);
   }
-  let titleName = name;
+  let titleName = repositoryName;
   if (titleName) {
     if (titleName?.startsWith("@")) {
       titleName = titleName.slice(1);
@@ -36,10 +36,10 @@ ${padding}\u26A1 Storm Software ${titleName ? `- ${titleName}` : ""}
  our licensing page.
 
  Website:         ${process.env.STORM_HOMEPAGE ?? "https://stormsoftware.com"}
- Repository:      ${process.env.STORM_REPOSITORY ?? `https://github.com/storm-software${name ? `/${name}` : ""}`}
- Documentation:   ${process.env.STORM_DOCS ? process.env.STORM_DOCS : `https://stormsoftware.com/${name ? `projects/${name}/` : ""}docs`}
+ Repository:      ${process.env.STORM_REPOSITORY ?? `https://github.com/storm-software${repositoryName ? `/${repositoryName}` : ""}`}
+ Documentation:   ${process.env.STORM_DOCS ? process.env.STORM_DOCS : `https://stormsoftware.com/${repositoryName ? `projects/${repositoryName}/` : ""}docs`}
  Contact:         ${process.env.STORM_HOMEPAGE ? process.env.STORM_HOMEPAGE.endsWith("/") ? process.env.STORM_HOMEPAGE.slice(-1) : process.env.STORM_HOMEPAGE : "https://stormsoftware.com"}/contact
- License:         ${process.env.STORM_LICENSING ? process.env.STORM_LICENSING : `https://stormsoftware.com/${name ? `projects/${name}/` : ""}license`}
+ License:         ${process.env.STORM_LICENSING ? process.env.STORM_LICENSING : `https://stormsoftware.com/${repositoryName ? `projects/${repositoryName}/` : ""}license`}
 
  ------------------------------------------------------------------- `;
 }, "getFileBanner");

package/dist/preset.d.ts

@@ -27,6 +27,6 @@ declare function getOverrides<K extends keyof OptionsConfig>(options: OptionsCon
  * @param options - The preset options.
  * @param userConfigs - Additional ESLint configurations.
  */
-declare function getStormConfig(options: OptionsConfig & Omit<TypedFlatConfigItem, "files">, ...userConfigs: Awaitable<TypedFlatConfigItem | TypedFlatConfigItem[] | FlatConfigComposer<any, any> | Linter.Config[]>[]): FlatConfigComposer<TypedFlatConfigItem, ConfigNames>;
+declare function getStormConfig(options: OptionsConfig & Omit<TypedFlatConfigItem, "files">, ...userConfigs: Awaitable<TypedFlatConfigItem | TypedFlatConfigItem[] | FlatConfigComposer<object, string> | Linter.Config[]>[]): FlatConfigComposer<TypedFlatConfigItem, ConfigNames>;
 
 export { type ResolvedOptions, getStormConfig as default, defaultPluginRenaming, getOverrides, getStormConfig, resolveSubOptions };

package/dist/preset.js

@@ -11,11 +11,11 @@ import {
 } from "./chunk-GXNMSXDL.js";
 import {
   banner_plugin_default
-} from "./chunk-BXVDD33Y.js";
+} from "./chunk-VMGPCABA.js";
 import {
   joinPaths
 } from "./chunk-G7QVU75O.js";
-import "./chunk-KDHZD7SF.js";
+import "./chunk-ZUIV57VZ.js";
 import {
   GLOB_ASTRO,
   GLOB_ASTRO_TS,
@@ -853,7 +853,7 @@ __name(imports, "imports");
 import defu2 from "defu";
 import globalsLib from "globals";
 async function javascript(options = {}) {
-  const { lineEndings = "unix", overrides = {}, name = "", globals = {} } = options;
+  const { lineEndings = "unix", overrides = {}, repositoryName, globals = {} } = options;
   return [
     {
       name: "storm/javascript/setup",
@@ -871,10 +871,8 @@ async function javascript(options = {}) {
           ecmaFeatures: {
             jsx: true
           },
-          ecmaVersion: 2022,
-          sourceType: "module"
-        },
-        sourceType: "module"
+          ecmaVersion: 2022
+        }
       },
       linterOptions: {
         reportUnusedDisableDirectives: true
@@ -892,8 +890,8 @@ async function javascript(options = {}) {
           "error",
           {
             commentType: "block",
-            numNewlines: 1,
-            repositoryName: name,
+            numNewlines: 2,
+            repositoryName,
             lineEndings
           }
         ]
@@ -2425,6 +2423,7 @@ async function markdown(options = {}) {
       name: "storm/markdown/disables",
       rules: {
         "import/newline-after-import": "off",
+        "banner/banner": "off",
         "no-alert": "off",
         "no-console": "off",
         "no-labels": "off",
@@ -2575,7 +2574,7 @@ __name(node, "node");
 // src/configs/nx.ts
 import defu3 from "defu";
 async function nx(options = {}) {
-  const { depsCheck = false, depsCheckSeverity = "error", moduleBoundaries, ignoredDependencies = [], ignoredFiles = [], checkObsoleteDependencies = true } = options;
+  const { depsCheck = {}, depsCheckSeverity = "error", moduleBoundaries, ignoredDependencies = [], ignoredFiles = [], checkObsoleteDependencies = true } = options;
   return [
     {
       name: "storm/nx/setup",
@@ -3414,7 +3413,7 @@ __name(toml, "toml");
 
 // src/configs/typescript.ts
 async function typescript(options = {}) {
-  const { componentExts = [], overrides = {}, overridesTypeAware = {}, parserOptions = {}, type = "app" } = options;
+  const { componentExts = [], overrides = {}, overridesTypeAware = {}, parserOptions = {}, tsdoc = "warn", type = "app" } = options;
   let tsconfigRootDir = process.cwd();
   if (process.env.STORM_WORKSPACE_ROOT || process.env.NX_WORKSPACE_ROOT_PATH) {
     tsconfigRootDir = process.env.STORM_WORKSPACE_ROOT || process.env.NX_WORKSPACE_ROOT_PATH;
@@ -3472,6 +3471,10 @@ async function typescript(options = {}) {
     interopDefault(import("@typescript-eslint/eslint-plugin")),
     interopDefault(import("@typescript-eslint/parser"))
   ]);
+  let pluginTsdoc;
+  if (tsdoc !== false && tsdoc !== "off") {
+    pluginTsdoc = await interopDefault(import("eslint-plugin-tsdoc"));
+  }
   function makeParser(typeAware, files2, ignores2) {
     return {
       files: files2,
@@ -3662,6 +3665,16 @@ async function typescript(options = {}) {
         ...overrides
       }
     },
+    pluginTsdoc && {
+      files,
+      name: "storm/typescript/rules-tsdoc",
+      plugins: {
+        tsdoc: pluginTsdoc
+      },
+      rules: {
+        "tsdoc/syntax": tsdoc
+      }
+    },
     ...isTypeAware ? [
       {
         files: filesTypeAware,
@@ -3673,7 +3686,7 @@ async function typescript(options = {}) {
         }
       }
     ] : []
-  ];
+  ].filter(Boolean);
 }
 __name(typescript, "typescript");
 
@@ -3853,7 +3866,7 @@ function getOverrides(options, key) {
 }
 __name(getOverrides, "getOverrides");
 function getStormConfig(options, ...userConfigs) {
-  const { name = "", globals = {}, lineEndings = "unix", astro: enableAstro = false, autoRenamePlugins = true, componentExts = [], gitignore: enableGitignore = true, jsx: enableJsx = true, cspell: enableCSpell = true, react: enableReact = false, "react-native": enableReactNative = false, regexp: enableRegexp = true, next: enableNext = false, graphql: enableGraphQL = false, storybook: enableStorybook = false, typescript: enableTypeScript = isPackageExists2("typescript"), unicorn: enableUnicorn = true, unocss: enableUnoCSS = false } = options;
+  const { repositoryName, globals = {}, lineEndings = "unix", astro: enableAstro = false, autoRenamePlugins = true, componentExts = [], gitignore: enableGitignore = true, jsx: enableJsx = true, cspell: enableCSpell = true, react: enableReact = false, "react-native": enableReactNative = false, regexp: enableRegexp = true, next: enableNext = false, graphql: enableGraphQL = false, storybook: enableStorybook = false, typescript: enableTypeScript = isPackageExists2("typescript"), unicorn: enableUnicorn = true, unocss: enableUnoCSS = false } = options;
   let isInEditor = options.isInEditor;
   if (isInEditor == null) {
     isInEditor = isInEditorEnv();
@@ -3886,7 +3899,7 @@ function getStormConfig(options, ...userConfigs) {
     tsconfigPath = getTsConfigPath();
   }
   configs2.push(ignores(options.ignores), javascript({
-    name,
+    repositoryName,
     globals,
     lineEndings,
     isInEditor,
@@ -4009,7 +4022,9 @@ function getStormConfig(options, ...userConfigs) {
     throw new Error('[@storm-software/eslint] The first argument should not contain the "files" property as the options are supposed to be global. Place it in the second or later config instead.');
   }
   const fusedConfig = flatConfigProps.reduce((acc, key) => {
-    if (key in options) acc[key] = options[key];
+    if (key in options) {
+      acc[key] = options[key];
+    }
     return acc;
   }, {});
   if (Object.keys(fusedConfig).length) configs2.push([

package/dist/types.d.ts

@@ -6498,6 +6498,11 @@ Backward pagination arguments
    * @see https://typescript-eslint.io/rules/use-unknown-in-catch-callback-variable
    */
   'ts/use-unknown-in-catch-callback-variable'?: Linter.RuleEntry<[]>
+  /**
+   * Validates that TypeScript documentation comments conform to the TSDoc standard
+   * @see https://tsdoc.org/pages/packages/eslint-plugin-tsdoc
+   */
+  'tsdoc/syntax'?: Linter.RuleEntry<[]>
   /**
    * Require or disallow Unicode byte order mark (BOM)
    * @see https://eslint.org/docs/latest/rules/unicode-bom
@@ -16285,7 +16290,7 @@ type Yoda = []|[("always" | "never")]|[("always" | "never"), {
   onlyEquality?: boolean
 }]
 // Names of all the configs
-type ConfigNames = 'storm/cspell/rules' | 'storm/astro/setup' | 'storm/astro/rules' | 'storm/formatter/setup' | 'storm/imports/rules' | 'storm/graphql/setup' | 'storm/graphql/rules' | 'storm/graphql/relay' | 'storm/javascript/setup' | 'storm/javascript/banner' | 'storm/javascript/rules' | 'storm/jsx/rules' | 'storm/jsdoc/rules' | 'storm/jsonc/setup' | 'storm/jsonc/rules' | 'storm/markdown/setup' | 'storm/markdown/processor' | 'storm/markdown/parser' | 'storm/markdown/disables' | 'storm/mdx/setup' | 'storm/node/rules' | 'storm/nx/setup' | 'storm/nx/schema' | 'storm/nx/dependency-check' | 'storm/nx/module-boundaries' | 'storm/next/rules' | 'storm/prettier/rules' | 'storm/perfectionist/rules' | 'storm/react/setup' | 'storm/react/rules' | 'storm/react-native/rules' | 'storm/sort/package-json' | 'storm/stylistic/rules' | 'storm/secrets/rules' | 'storm/storybook/setup' | 'storm/storybook/rules' | 'storm/storybook/main' | 'storm/test/setup' | 'storm/test/rules' | 'storm/toml/setup' | 'storm/toml/rules' | 'storm/regexp/rules' | 'storm/typescript/setup' | 'storm/typescript/parser' | 'storm/typescript/type-aware-parser' | 'storm/typescript/rules' | 'storm/typescript/rules-type-aware' | 'storm/unicorn/rules' | 'storm/unocss' | 'storm/yaml/setup' | 'storm/yaml/rules'
+type ConfigNames = 'storm/cspell/rules' | 'storm/astro/setup' | 'storm/astro/rules' | 'storm/formatter/setup' | 'storm/imports/rules' | 'storm/graphql/setup' | 'storm/graphql/rules' | 'storm/graphql/relay' | 'storm/javascript/setup' | 'storm/javascript/banner' | 'storm/javascript/rules' | 'storm/jsx/rules' | 'storm/jsdoc/rules' | 'storm/jsonc/setup' | 'storm/jsonc/rules' | 'storm/markdown/setup' | 'storm/markdown/processor' | 'storm/markdown/parser' | 'storm/markdown/disables' | 'storm/mdx/setup' | 'storm/node/rules' | 'storm/nx/setup' | 'storm/nx/schema' | 'storm/nx/dependency-check' | 'storm/nx/module-boundaries' | 'storm/next/rules' | 'storm/prettier/rules' | 'storm/perfectionist/rules' | 'storm/react/setup' | 'storm/react/rules' | 'storm/react-native/rules' | 'storm/sort/package-json' | 'storm/stylistic/rules' | 'storm/secrets/rules' | 'storm/storybook/setup' | 'storm/storybook/rules' | 'storm/storybook/main' | 'storm/test/setup' | 'storm/test/rules' | 'storm/toml/setup' | 'storm/toml/rules' | 'storm/regexp/rules' | 'storm/typescript/setup' | 'storm/typescript/parser' | 'storm/typescript/type-aware-parser' | 'storm/typescript/rules' | 'storm/typescript/rules-tsdoc' | 'storm/typescript/rules-type-aware' | 'storm/unicorn/rules' | 'storm/unocss' | 'storm/yaml/setup' | 'storm/yaml/rules'
 
 /**
  * Vendor types from Prettier so we don't rely on the dependency.
@@ -16485,7 +16490,7 @@ interface OptionsComponentExts {
      * Additional extensions for components.
      *
      * @example ['vue']
-     * @default []
+     * @defaultValue []
      */
     componentExts?: string[];
 }
@@ -16493,7 +16498,7 @@ interface OptionsUnicorn {
     /**
      * Include all rules recommended by `eslint-plugin-unicorn`, instead of only ones picked by Anthony.
      *
-     * @default false
+     * @defaultValue false
      */
     allRecommended?: boolean;
 }
@@ -16504,12 +16509,12 @@ interface OptionsTypeScriptParserOptions {
     parserOptions?: Partial<ParserOptions>;
     /**
      * Glob patterns for files that should be type aware.
-     * @default ['**\/*.{ts,tsx}']
+     * @defaultValue ['**\/*.{ts,tsx}']
      */
     filesTypeAware?: string[];
     /**
      * Glob patterns for files that should not be type aware.
-     * @default ['**\/*.md\/**', '**\/*.astro/*.ts']
+     * @defaultValue ['**\/*.md\/**', '**\/*.astro/*.ts']
      */
     ignoresTypeAware?: string[];
 }
@@ -16523,6 +16528,14 @@ interface OptionsTypeScriptWithTypes {
      * Override type aware rules.
      */
     overridesTypeAware?: TypedFlatConfigItem["rules"];
+    /**
+     * The rule to use for eslint-plugin-tsdoc syntax checking. If set to `false`, it will disable the plugin.
+     *
+     * @see https://github.com/microsoft/tsdoc/tree/master/eslint-plugin
+     *
+     * @defaultValue 'warn'
+     */
+    tsdoc?: "warn" | "error" | "off" | false;
 }
 interface OptionsHasTypeScript {
     typescript?: boolean;
@@ -16540,7 +16553,7 @@ interface OptionsProjectType {
     /**
      * Type of the project. `lib` will enable more strict rules for libraries.
      *
-     * @default 'app'
+     * @defaultValue 'app'
      */
     type?: "app" | "lib";
 }
@@ -16556,12 +16569,12 @@ interface OptionsIsInEditor {
 interface OptionsUnoCSS extends OptionsOverrides {
     /**
      * Enable attributify support.
-     * @default true
+     * @defaultValue true
      */
     attributify?: boolean;
     /**
      * Enable strict mode by throwing errors about blocklisted classes.
-     * @default false
+     * @defaultValue false
      */
     strict?: boolean;
 }
@@ -16571,7 +16584,7 @@ interface OptionsNext extends OptionsOverrides {
      *
      * @see https://nextjs.org/docs/app/api-reference/config/eslint#with-core-web-vitals
      *
-     * @default true
+     * @defaultValue true
      */
     coreWebVitals?: boolean;
     /**
@@ -16587,7 +16600,7 @@ interface OptionsGraphQL extends OptionsOverrides {
      *
      * @see https://the-guild.dev/graphql/eslint/rules
      *
-     * @default true
+     * @defaultValue true
      */
     schema?: boolean;
     /**
@@ -16595,7 +16608,7 @@ interface OptionsGraphQL extends OptionsOverrides {
      *
      * @see https://the-guild.dev/graphql/eslint/rules
      *
-     * @default true
+     * @defaultValue true
      */
     operations?: boolean;
     /**
@@ -16603,7 +16616,7 @@ interface OptionsGraphQL extends OptionsOverrides {
      *
      * @see https://github.com/relayjs/eslint-plugin-relay
      *
-     * @default true
+     * @defaultValue true
      */
     relay?: boolean;
 }
@@ -16613,7 +16626,7 @@ interface OptionsStorybook extends OptionsOverrides {
      *
      * @see https://storybook.js.org/docs/api/csf
      *
-     * @default "loose"
+     * @defaultValue "loose"
      */
     csf?: "none" | "loose" | "strict";
 }
@@ -16621,49 +16634,49 @@ interface OptionsNxDependencyChecks extends OptionsOverrides {
     /**
      * List of build target names
      *
-     * @default ['build-base', 'build']
+     * @defaultValue ['build-base', 'build']
      */
     buildTargets: string[];
     /**
      * Disable to skip checking for missing dependencies
      *
-     * @default true
+     * @defaultValue true
      */
     checkMissingDependencies: boolean;
     /**
      * Disable to skip checking for unused dependencies
      *
-     * @default true
+     * @defaultValue true
      */
     checkObsoleteDependencies: boolean;
     /**
      * Disable to skip checking if version specifier matches installed version
      *
-     * @default true
+     * @defaultValue true
      */
     checkVersionMismatches: boolean;
     /**
      * List of dependencies to ignore for checks
      *
-     * @default []
+     * @defaultValue []
      */
     ignoredDependencies: string[];
     /**
      * List of files to ignore when collecting dependencies. The default value will be set based on the selected executor during the generation.
      *
-     * @default []
+     * @defaultValue []
      */
     ignoredFiles: string[];
     /**
      * Enable to collect dependencies of children projects
      *
-     * @default false
+     * @defaultValue false
      */
     includeTransitiveDependencies: boolean;
     /**
      * Set workspace dependencies as relative file:// paths. Useful for monorepos that link via file:// in package.json files.
      *
-     * @default false
+     * @defaultValue false
      */
     useLocalPathsForWorkspaceDependencies: boolean;
 }
@@ -16671,55 +16684,55 @@ interface OptionsNxEnforceModuleBoundaries extends OptionsOverrides {
     /**
      * List of imports that should be allowed without any checks
      *
-     * @default []
+     * @defaultValue []
      */
     allow: string[];
     /**
      * List of build target names
      *
-     * @default ['build-base', 'build']
+     * @defaultValue ['build-base', 'build']
      */
     buildTargets: string[];
     /**
      * List of dependency constraints between projects
      *
-     * @default true
+     * @defaultValue true
      */
     depConstraints: DepConstraint[];
     /**
      * Enable to restrict the buildable libs from importing non-buildable libraries
      *
-     * @default true
+     * @defaultValue true
      */
     enforceBuildableLibDependency: boolean;
     /**
      * Disable check for self circular dependency when project imports from itself via alias path
      *
-     * @default false
+     * @defaultValue false
      */
     allowCircularSelfDependency: boolean;
     /**
      * List of project pairs that should be skipped from Circular dependencies checks, including the self-circular dependency check. E.g. ['feature-project-a', 'myapp']. Project name can be replaced by catch all * for more generic matches.
      *
-     * @default []
+     * @defaultValue []
      */
     ignoredCircularDependencies: Array<[string, string]>;
     /**
      * List of imports that should be skipped for Imports of lazy-loaded libraries forbidden checks. E.g. ['@myorg/lazy-project/component/*', '@myorg/other-project']
      *
-     * @default []
+     * @defaultValue []
      */
     checkDynamicDependenciesExceptions: string[];
     /**
      * Ban import of dependencies that were not specified in the root or project's package.json
      *
-     * @default false
+     * @defaultValue false
      */
     banTransitiveDependencies: boolean;
     /**
      * Enable to enforce the check for banned external imports in the nested packages. Check [Dependency constraints](https://nx.dev/nx-api/eslint-plugin/documents/enforce-module-boundaries#dependency-constraints) for more information
      *
-     * @default false
+     * @defaultValue false
      */
     checkNestedExternalImports: boolean;
 }
@@ -16741,14 +16754,12 @@ interface OptionsNx extends OptionsOverrides {
      *
      * @remarks
      * If any values are overridden here, the `ignoredDependencies`, `ignoredFiles`, and `checkObsoleteDependencies` options will be ignored.
-     *
-     * @defaultValue `false`
      */
     depsCheck?: OptionsNxDependencyChecks | false;
     /**
      * The severity of the `@nx/dependency-checks` rule
      *
-     * @defaultValue "error"
+     * @defaultValue "warn"
      */
     depsCheckSeverity?: "off" | "warn" | "error";
     /**
@@ -16760,7 +16771,7 @@ interface OptionsCSpell extends OptionsOverrides {
     /**
      * A path to a CSpell configuration file
      *
-     * @default "./.vscode/cspell.json"
+     * @defaultValue "./.vscode/cspell.json"
      */
     configFile?: string;
 }
@@ -16772,7 +16783,7 @@ interface OptionsJavascript {
     /**
      * The name of the repository used in adding the banner comments
      */
-    name: string;
+    repositoryName?: string;
     /**
      * An object containing a list of extra global variables to include in the configuration.
      */
@@ -16780,7 +16791,7 @@ interface OptionsJavascript {
     /**
      * The style of line endings to use.
      *
-     * @default "unix"
+     * @defaultValue "unix"
      */
     lineEndings?: "unix" | "windows";
 }
@@ -16791,13 +16802,13 @@ interface OptionsConfig extends OptionsComponentExts, OptionsJavascript, Options
      * Passing an object to configure the options.
      *
      * @see https://github.com/antfu/eslint-config-flat-gitignore
-     * @default true
+     * @defaultValue true
      */
     gitignore?: boolean | FlatGitignoreOptions;
     /**
      * Disable some opinionated rules to Anthony's preference.
      *
-     * @default false
+     * @defaultValue false
      */
     lessOpinionated?: boolean;
     /**
@@ -16810,7 +16821,7 @@ interface OptionsConfig extends OptionsComponentExts, OptionsJavascript, Options
      * Requires installing:
      * - `@cspell/eslint-plugin`
      *
-     * @default true
+     * @defaultValue true
      */
     cspell?: boolean | OptionsCSpell;
     /**
@@ -16818,7 +16829,7 @@ interface OptionsConfig extends OptionsComponentExts, OptionsJavascript, Options
      *
      * Passing an object to enable TypeScript Language Server support.
      *
-     * @default auto-detect based on the dependencies
+     * @defaultValue auto-detect based on the dependencies
      */
     typescript?: boolean | OptionsTypescript;
     /**
@@ -16830,37 +16841,37 @@ interface OptionsConfig extends OptionsComponentExts, OptionsJavascript, Options
      *
      * Currently only stylistic rules are included.
      *
-     * @default true
+     * @defaultValue true
      */
     jsx?: boolean;
     /**
      * Options for eslint-plugin-unicorn.
      *
-     * @default true
+     * @defaultValue true
      */
     unicorn?: boolean | OptionsUnicorn;
     /**
      * Enable test support.
      *
-     * @default true
+     * @defaultValue true
      */
     test?: boolean | OptionsOverrides;
     /**
      * Enable JSONC support.
      *
-     * @default true
+     * @defaultValue true
      */
     jsonc?: boolean | OptionsOverrides;
     /**
      * Enable YAML support.
      *
-     * @default true
+     * @defaultValue true
      */
     yaml?: boolean | OptionsOverrides;
     /**
      * Enable TOML support.
      *
-     * @default true
+     * @defaultValue true
      */
     toml?: boolean | OptionsOverrides;
     /**
@@ -16872,7 +16883,7 @@ interface OptionsConfig extends OptionsComponentExts, OptionsJavascript, Options
      * Requires installing for formatting .astro:
      * - `prettier-plugin-astro`
      *
-     * @default false
+     * @defaultValue false
      */
     astro?: boolean | OptionsOverrides;
     /**
@@ -16880,13 +16891,13 @@ interface OptionsConfig extends OptionsComponentExts, OptionsJavascript, Options
      *
      * For formatting Markdown content, enable also `formatters.markdown`.
      *
-     * @default true
+     * @defaultValue true
      */
     markdown?: boolean | OptionsOverrides;
     /**
      * Enable linting for mdx files.
      *
-     * @default true
+     * @defaultValue true
      */
     mdx?: boolean | OptionsOverrides;
     /**
@@ -16894,26 +16905,26 @@ interface OptionsConfig extends OptionsComponentExts, OptionsJavascript, Options
      *
      * @see https://eslint.style/
      *
-     * @default false
+     * @defaultValue false
      */
     stylistic?: boolean | (StylisticConfig & OptionsOverrides);
     /**
      * Enable regexp rules.
      *
      * @see https://ota-meshi.github.io/eslint-plugin-regexp/
-     * @default true
+     * @defaultValue true
      */
     regexp?: boolean | (OptionsRegExp & OptionsOverrides);
     /**
      * Enable GraphQL support.
      *
-     * @default false
+     * @defaultValue false
      */
     graphql?: boolean | OptionsGraphQL;
     /**
      * Enable Storybook support.
      *
-     * @default false
+     * @defaultValue false
      */
     storybook?: boolean | OptionsStorybook;
     /**
@@ -16924,7 +16935,7 @@ interface OptionsConfig extends OptionsComponentExts, OptionsJavascript, Options
      * - `eslint-plugin-react-hooks`
      * - `eslint-plugin-react-refresh`
      *
-     * @default false
+     * @defaultValue false
      */
     react?: boolean | OptionsOverrides;
     /**
@@ -16933,7 +16944,7 @@ interface OptionsConfig extends OptionsComponentExts, OptionsJavascript, Options
      * Requires installing:
      * - `eslint-plugin-react-native`
      *
-     * @default false
+     * @defaultValue false
      */
     "react-native"?: boolean | OptionsOverrides;
     /**
@@ -16942,7 +16953,7 @@ interface OptionsConfig extends OptionsComponentExts, OptionsJavascript, Options
      * Requires installing:
      * - `@next/eslint-plugin-next`
      *
-     * @default false
+     * @defaultValue false
      */
     next?: boolean | OptionsNext;
     /**
@@ -16951,7 +16962,7 @@ interface OptionsConfig extends OptionsComponentExts, OptionsJavascript, Options
      * Requires installing:
      * - `@unocss/eslint-plugin`
      *
-     * @default false
+     * @defaultValue false
      */
     unocss?: boolean | OptionsUnoCSS;
     /**
@@ -16962,18 +16973,18 @@ interface OptionsConfig extends OptionsComponentExts, OptionsJavascript, Options
      *
      * When set to `true`, it will enable all formatters.
      *
-     * @default false
+     * @defaultValue false
      */
     formatters?: boolean | OptionsFormatters;
     /**
      * Control to disable some rules in editors.
-     * @default auto-detect based on the process.env
+     * @defaultValue auto-detect based on the process.env
      */
     isInEditor?: boolean;
     /**
      * Automatically rename plugins in the config.
      *
-     * @default true
+     * @defaultValue true
      */
     autoRenamePlugins?: boolean;
 }

package/dist/utils/banner-plugin.js

@@ -1,7 +1,7 @@
 import {
   banner_plugin_default
-} from "../chunk-BXVDD33Y.js";
-import "../chunk-KDHZD7SF.js";
+} from "../chunk-VMGPCABA.js";
+import "../chunk-ZUIV57VZ.js";
 import "../chunk-AIKLBIPC.js";
 import "../chunk-SHUYVCID.js";
 export {

package/dist/utils/get-file-banner.d.ts

@@ -1,9 +1,9 @@
 /**
  * Get a banner header to display at the top of a file
  *
- * @param name - The name to use in the display
+ * @param repositoryName - The name to use in the display
  * @returns The banner header
  */
-declare const getFileBanner: (name?: string) => string;
+declare const getFileBanner: (repositoryName?: string) => string;
 
 export { getFileBanner };

package/dist/utils/get-file-banner.js

@@ -1,6 +1,6 @@
 import {
   getFileBanner
-} from "../chunk-KDHZD7SF.js";
+} from "../chunk-ZUIV57VZ.js";
 import "../chunk-AIKLBIPC.js";
 import "../chunk-SHUYVCID.js";
 export {

package/package.json

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