@storm-software/eslint 0.137.3 → 0.138.0

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.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)
+[![Version](https://img.shields.io/badge/version-0.137.4-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.ts

@@ -1,6 +1,6 @@
 import { Linter } from 'eslint';
 import { FlatConfigComposer } from 'eslint-flat-config-utils';
-import { O as OptionsConfig, R as RuleOptions, T as TypedFlatConfigItem, A as Awaitable, C as ConfigNames } from './types-kqDn17wa.js';
+import { OptionsConfig, RuleOptions, TypedFlatConfigItem, Awaitable, ConfigNames } from './types.js';
 import '@nx/eslint-plugin/src/utils/runtime-lint-utils';
 import '@stylistic/eslint-plugin';
 import '@typescript-eslint/parser';

package/dist/preset.js

@@ -1,3 +1,11 @@
+import {
+  ensurePackages,
+  interopDefault,
+  isInEditorEnv,
+  isPackageInScope,
+  parserPlain,
+  renameRules
+} from "./chunk-7NZUDX62.js";
 import {
   getTsConfigPath
 } from "./chunk-GXNMSXDL.js";
@@ -36,14 +44,6 @@ import {
   GLOB_XML,
   GLOB_YAML
 } from "./chunk-AIKLBIPC.js";
-import {
-  ensurePackages,
-  interopDefault,
-  isInEditorEnv,
-  isPackageInScope,
-  parserPlain,
-  renameRules
-} from "./chunk-7NZUDX62.js";
 import {
   __name
 } from "./chunk-SHUYVCID.js";
@@ -871,10 +871,8 @@ async function javascript(options = {}) {
           ecmaFeatures: {
             jsx: true
           },
-          ecmaVersion: 2022,
-          sourceType: "module"
-        },
-        sourceType: "module"
+          ecmaVersion: 2022
+        }
       },
       linterOptions: {
         reportUnusedDisableDirectives: true
@@ -2575,7 +2573,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",

package/dist/{types-kqDn17wa.d.ts → types.d.ts}

@@ -16417,6 +16417,12 @@ type TypedFlatConfigItem = Omit<Linter.Config<Linter.RulesRecord & Rules>, "plug
      */
     plugins?: Record<string, any>;
 };
+interface OptionsFiles {
+    /**
+     * Override the `files` option to provide custom globs.
+     */
+    files?: string[];
+}
 type OptionsTypescript = (OptionsTypeScriptWithTypes & OptionsOverrides) | (OptionsTypeScriptParserOptions & OptionsOverrides);
 interface OptionsFormatters {
     /**
@@ -16479,7 +16485,7 @@ interface OptionsComponentExts {
      * Additional extensions for components.
      *
      * @example ['vue']
-     * @default []
+     * @defaultValue []
      */
     componentExts?: string[];
 }
@@ -16487,7 +16493,7 @@ interface OptionsUnicorn {
     /**
      * Include all rules recommended by `eslint-plugin-unicorn`, instead of only ones picked by Anthony.
      *
-     * @default false
+     * @defaultValue false
      */
     allRecommended?: boolean;
 }
@@ -16498,12 +16504,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[];
 }
@@ -16518,6 +16524,12 @@ interface OptionsTypeScriptWithTypes {
      */
     overridesTypeAware?: TypedFlatConfigItem["rules"];
 }
+interface OptionsHasTypeScript {
+    typescript?: boolean;
+}
+interface OptionsStylistic {
+    stylistic?: boolean | StylisticConfig;
+}
 type StylisticConfig = Pick<StylisticCustomizeOptions, "indent" | "quotes" | "jsx" | "semi"> & {
     lineEndings?: "unix" | "windows";
 };
@@ -16528,7 +16540,7 @@ interface OptionsProjectType {
     /**
      * Type of the project. `lib` will enable more strict rules for libraries.
      *
-     * @default 'app'
+     * @defaultValue 'app'
      */
     type?: "app" | "lib";
 }
@@ -16538,15 +16550,18 @@ interface OptionsRegExp {
      */
     level?: "error" | "warn";
 }
+interface OptionsIsInEditor {
+    isInEditor?: boolean;
+}
 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;
 }
@@ -16556,7 +16571,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;
     /**
@@ -16572,7 +16587,7 @@ interface OptionsGraphQL extends OptionsOverrides {
      *
      * @see https://the-guild.dev/graphql/eslint/rules
      *
-     * @default true
+     * @defaultValue true
      */
     schema?: boolean;
     /**
@@ -16580,7 +16595,7 @@ interface OptionsGraphQL extends OptionsOverrides {
      *
      * @see https://the-guild.dev/graphql/eslint/rules
      *
-     * @default true
+     * @defaultValue true
      */
     operations?: boolean;
     /**
@@ -16588,7 +16603,7 @@ interface OptionsGraphQL extends OptionsOverrides {
      *
      * @see https://github.com/relayjs/eslint-plugin-relay
      *
-     * @default true
+     * @defaultValue true
      */
     relay?: boolean;
 }
@@ -16598,7 +16613,7 @@ interface OptionsStorybook extends OptionsOverrides {
      *
      * @see https://storybook.js.org/docs/api/csf
      *
-     * @default "loose"
+     * @defaultValue "loose"
      */
     csf?: "none" | "loose" | "strict";
 }
@@ -16606,49 +16621,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;
 }
@@ -16656,55 +16671,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;
 }
@@ -16726,14 +16741,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";
     /**
@@ -16745,7 +16758,7 @@ interface OptionsCSpell extends OptionsOverrides {
     /**
      * A path to a CSpell configuration file
      *
-     * @default "./.vscode/cspell.json"
+     * @defaultValue "./.vscode/cspell.json"
      */
     configFile?: string;
 }
@@ -16765,7 +16778,7 @@ interface OptionsJavascript {
     /**
      * The style of line endings to use.
      *
-     * @default "unix"
+     * @defaultValue "unix"
      */
     lineEndings?: "unix" | "windows";
 }
@@ -16776,13 +16789,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;
     /**
@@ -16795,7 +16808,7 @@ interface OptionsConfig extends OptionsComponentExts, OptionsJavascript, Options
      * Requires installing:
      * - `@cspell/eslint-plugin`
      *
-     * @default true
+     * @defaultValue true
      */
     cspell?: boolean | OptionsCSpell;
     /**
@@ -16803,7 +16816,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;
     /**
@@ -16815,37 +16828,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;
     /**
@@ -16857,7 +16870,7 @@ interface OptionsConfig extends OptionsComponentExts, OptionsJavascript, Options
      * Requires installing for formatting .astro:
      * - `prettier-plugin-astro`
      *
-     * @default false
+     * @defaultValue false
      */
     astro?: boolean | OptionsOverrides;
     /**
@@ -16865,13 +16878,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;
     /**
@@ -16879,26 +16892,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;
     /**
@@ -16909,7 +16922,7 @@ interface OptionsConfig extends OptionsComponentExts, OptionsJavascript, Options
      * - `eslint-plugin-react-hooks`
      * - `eslint-plugin-react-refresh`
      *
-     * @default false
+     * @defaultValue false
      */
     react?: boolean | OptionsOverrides;
     /**
@@ -16918,7 +16931,7 @@ interface OptionsConfig extends OptionsComponentExts, OptionsJavascript, Options
      * Requires installing:
      * - `eslint-plugin-react-native`
      *
-     * @default false
+     * @defaultValue false
      */
     "react-native"?: boolean | OptionsOverrides;
     /**
@@ -16927,7 +16940,7 @@ interface OptionsConfig extends OptionsComponentExts, OptionsJavascript, Options
      * Requires installing:
      * - `@next/eslint-plugin-next`
      *
-     * @default false
+     * @defaultValue false
      */
     next?: boolean | OptionsNext;
     /**
@@ -16936,7 +16949,7 @@ interface OptionsConfig extends OptionsComponentExts, OptionsJavascript, Options
      * Requires installing:
      * - `@unocss/eslint-plugin`
      *
-     * @default false
+     * @defaultValue false
      */
     unocss?: boolean | OptionsUnoCSS;
     /**
@@ -16947,20 +16960,20 @@ 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;
 }
 
-export type { Awaitable as A, ConfigNames as C, OptionsConfig as O, RuleOptions as R, TypedFlatConfigItem as T };
+export type { Awaitable, ConfigNames, ESLintGlobalsPropValue, OptionsCSpell, OptionsComponentExts, OptionsConfig, OptionsFiles, OptionsFormatters, OptionsGraphQL, OptionsHasTypeScript, OptionsIsInEditor, OptionsJavascript, OptionsNext, OptionsNx, OptionsNxDependencyChecks, OptionsNxEnforceModuleBoundaries, OptionsOverrides, OptionsProjectType, OptionsRegExp, OptionsStorybook, OptionsStylistic, OptionsTypeScriptParserOptions, OptionsTypeScriptWithTypes, OptionsTypescript, OptionsUnicorn, OptionsUnoCSS, RuleOptions, Rules, StylisticConfig, TypedFlatConfigItem };

package/dist/utils/combine.d.ts

@@ -1,5 +1,5 @@
 import { Awaitable } from 'eslint-flat-config-utils';
-import { T as TypedFlatConfigItem } from '../types-kqDn17wa.js';
+import { TypedFlatConfigItem } from '../types.js';
 import '@nx/eslint-plugin/src/utils/runtime-lint-utils';
 import '@stylistic/eslint-plugin';
 import '@typescript-eslint/parser';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storm-software/eslint",
-  "version": "0.137.3",
+  "version": "0.138.0",
   "type": "module",
   "description": "⚡ A package containing the base ESLint configuration used by Storm Software across many projects.",
   "repository": {
@@ -87,6 +87,14 @@
         "default": "./dist/preset.js"
       }
     },
+    "./types": {
+      "import": { "types": "./dist/types.d.ts", "default": "./dist/types.js" },
+      "require": {
+        "types": "./dist/types.d.cts",
+        "default": "./dist/types.cjs"
+      },
+      "default": { "types": "./dist/types.d.ts", "default": "./dist/types.js" }
+    },
     "./rules/*": {
       "import": {
         "types": "./dist/rules/*.d.ts",