@storm-software/eslint 0.52.0 → 0.54.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.51.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)
+[![Version](https://img.shields.io/badge/version-0.53.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/preset.d.mts

@@ -5,14 +5,18 @@ import { Linter } from 'eslint';
 
 
 interface RuleOptions {
+  /**
+   * CSpell spellchecker
+   */
+  '@cspell/spellchecker'?: Linter.RuleEntry<CspellSpellchecker>
   /**
    * Checks dependencies in project's package.json for version mismatches
-   * @see https://github.com/nrwl/nx/blob/19.5.3/docs/generated/packages/eslint-plugin/documents/dependency-checks.md
+   * @see https://github.com/nrwl/nx/blob/19.5.6/docs/generated/packages/eslint-plugin/documents/dependency-checks.md
    */
   '@nx/dependency-checks'?: Linter.RuleEntry<NxDependencyChecks>
   /**
    * Ensure that module boundaries are respected within the monorepo
-   * @see https://github.com/nrwl/nx/blob/19.5.3/docs/generated/packages/eslint-plugin/documents/enforce-module-boundaries.md
+   * @see https://github.com/nrwl/nx/blob/19.5.6/docs/generated/packages/eslint-plugin/documents/enforce-module-boundaries.md
    */
   '@nx/enforce-module-boundaries'?: Linter.RuleEntry<NxEnforceModuleBoundaries>
   /**
@@ -2332,6 +2336,81 @@ interface RuleOptions {
 }
 
 /* ======= Declarations ======= */
+// ----- @cspell/spellchecker -----
+type CspellSpellchecker = []|[{
+  
+  autoFix: boolean
+  
+  checkComments?: boolean
+  
+  checkIdentifiers?: boolean
+  
+  checkJSXText?: boolean
+  
+  checkScope?: [string, boolean][]
+  
+  checkStringTemplates?: boolean
+  
+  checkStrings?: boolean
+  
+  configFile?: string
+  
+  cspell?: {
+    
+    allowCompoundWords?: boolean
+    
+    dictionaries?: (string | string)[]
+    dictionaryDefinitions?: {
+      
+      description?: string
+      
+      name: string
+      
+      noSuggest?: boolean
+      
+      path: string
+      
+      repMap?: [string, string][]
+      
+      type?: ("S" | "W" | "C" | "T")
+      
+      useCompounds?: boolean
+    }[]
+    
+    enabled?: boolean
+    
+    flagWords?: string[]
+    
+    ignoreRegExpList?: (string | string | ("Base64" | "Base64MultiLine" | "Base64SingleLine" | "CStyleComment" | "CStyleHexValue" | "CSSHexValue" | "CommitHash" | "CommitHashLink" | "Email" | "EscapeCharacters" | "HexValues" | "href" | "PhpHereDoc" | "PublicKey" | "RsaCert" | "SshRsa" | "SHA" | "HashStrings" | "SpellCheckerDisable" | "SpellCheckerDisableBlock" | "SpellCheckerDisableLine" | "SpellCheckerDisableNext" | "SpellCheckerIgnoreInDocSetting" | "string" | "UnicodeRef" | "Urls" | "UUID" | "Everything"))[]
+    
+    ignoreWords?: string[]
+    
+    import?: (string | string[])
+    
+    includeRegExpList?: (string | string | ("Base64" | "Base64MultiLine" | "Base64SingleLine" | "CStyleComment" | "CStyleHexValue" | "CSSHexValue" | "CommitHash" | "CommitHashLink" | "Email" | "EscapeCharacters" | "HexValues" | "href" | "PhpHereDoc" | "PublicKey" | "RsaCert" | "SshRsa" | "SHA" | "HashStrings" | "SpellCheckerDisable" | "SpellCheckerDisableBlock" | "SpellCheckerDisableLine" | "SpellCheckerDisableNext" | "SpellCheckerIgnoreInDocSetting" | "string" | "UnicodeRef" | "Urls" | "UUID" | "Everything"))[]
+    
+    language?: string
+    
+    words?: string[]
+  }
+  
+  cspellOptionsRoot?: (string | string)
+  
+  customWordListFile?: (string | {
+    
+    path: string
+  })
+  
+  debugMode?: boolean
+  
+  generateSuggestions: boolean
+  
+  ignoreImportProperties?: boolean
+  
+  ignoreImports?: boolean
+  
+  numSuggestions: number
+}]
 // ----- @nx/dependency-checks -----
 type NxDependencyChecks = []|[{
   buildTargets?: string[]

package/dist/preset.d.ts

@@ -5,14 +5,18 @@ import { Linter } from 'eslint';
 
 
 interface RuleOptions {
+  /**
+   * CSpell spellchecker
+   */
+  '@cspell/spellchecker'?: Linter.RuleEntry<CspellSpellchecker>
   /**
    * Checks dependencies in project's package.json for version mismatches
-   * @see https://github.com/nrwl/nx/blob/19.5.3/docs/generated/packages/eslint-plugin/documents/dependency-checks.md
+   * @see https://github.com/nrwl/nx/blob/19.5.6/docs/generated/packages/eslint-plugin/documents/dependency-checks.md
    */
   '@nx/dependency-checks'?: Linter.RuleEntry<NxDependencyChecks>
   /**
    * Ensure that module boundaries are respected within the monorepo
-   * @see https://github.com/nrwl/nx/blob/19.5.3/docs/generated/packages/eslint-plugin/documents/enforce-module-boundaries.md
+   * @see https://github.com/nrwl/nx/blob/19.5.6/docs/generated/packages/eslint-plugin/documents/enforce-module-boundaries.md
    */
   '@nx/enforce-module-boundaries'?: Linter.RuleEntry<NxEnforceModuleBoundaries>
   /**
@@ -2332,6 +2336,81 @@ interface RuleOptions {
 }
 
 /* ======= Declarations ======= */
+// ----- @cspell/spellchecker -----
+type CspellSpellchecker = []|[{
+  
+  autoFix: boolean
+  
+  checkComments?: boolean
+  
+  checkIdentifiers?: boolean
+  
+  checkJSXText?: boolean
+  
+  checkScope?: [string, boolean][]
+  
+  checkStringTemplates?: boolean
+  
+  checkStrings?: boolean
+  
+  configFile?: string
+  
+  cspell?: {
+    
+    allowCompoundWords?: boolean
+    
+    dictionaries?: (string | string)[]
+    dictionaryDefinitions?: {
+      
+      description?: string
+      
+      name: string
+      
+      noSuggest?: boolean
+      
+      path: string
+      
+      repMap?: [string, string][]
+      
+      type?: ("S" | "W" | "C" | "T")
+      
+      useCompounds?: boolean
+    }[]
+    
+    enabled?: boolean
+    
+    flagWords?: string[]
+    
+    ignoreRegExpList?: (string | string | ("Base64" | "Base64MultiLine" | "Base64SingleLine" | "CStyleComment" | "CStyleHexValue" | "CSSHexValue" | "CommitHash" | "CommitHashLink" | "Email" | "EscapeCharacters" | "HexValues" | "href" | "PhpHereDoc" | "PublicKey" | "RsaCert" | "SshRsa" | "SHA" | "HashStrings" | "SpellCheckerDisable" | "SpellCheckerDisableBlock" | "SpellCheckerDisableLine" | "SpellCheckerDisableNext" | "SpellCheckerIgnoreInDocSetting" | "string" | "UnicodeRef" | "Urls" | "UUID" | "Everything"))[]
+    
+    ignoreWords?: string[]
+    
+    import?: (string | string[])
+    
+    includeRegExpList?: (string | string | ("Base64" | "Base64MultiLine" | "Base64SingleLine" | "CStyleComment" | "CStyleHexValue" | "CSSHexValue" | "CommitHash" | "CommitHashLink" | "Email" | "EscapeCharacters" | "HexValues" | "href" | "PhpHereDoc" | "PublicKey" | "RsaCert" | "SshRsa" | "SHA" | "HashStrings" | "SpellCheckerDisable" | "SpellCheckerDisableBlock" | "SpellCheckerDisableLine" | "SpellCheckerDisableNext" | "SpellCheckerIgnoreInDocSetting" | "string" | "UnicodeRef" | "Urls" | "UUID" | "Everything"))[]
+    
+    language?: string
+    
+    words?: string[]
+  }
+  
+  cspellOptionsRoot?: (string | string)
+  
+  customWordListFile?: (string | {
+    
+    path: string
+  })
+  
+  debugMode?: boolean
+  
+  generateSuggestions: boolean
+  
+  ignoreImportProperties?: boolean
+  
+  ignoreImports?: boolean
+  
+  numSuggestions: number
+}]
 // ----- @nx/dependency-checks -----
 type NxDependencyChecks = []|[{
   buildTargets?: string[]

package/dist/preset.mjs

@@ -4,8 +4,7 @@ import { fileURLToPath as banner_fileURLToPath } from 'node:url';
 const __filename = banner_fileURLToPath(import.meta.url);
 const __dirname = banner_dirname(__filename);
 
-import tsEslint$1 from 'typescript-eslint';
-import unicorn from 'eslint-plugin-unicorn';
+import { plugins, rules } from '@cspell/eslint-plugin/recommended';
 import nxPlugin from '@nx/eslint-plugin';
 import jsxA11y from 'eslint-plugin-jsx-a11y';
 import markdown from 'eslint-plugin-markdown';
@@ -13,9 +12,11 @@ import prettierConfig from 'eslint-plugin-prettier/recommended';
 import react from 'eslint-plugin-react';
 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 globals from 'globals';
 import jsoncParser from 'jsonc-eslint-parser';
+import tsEslint$1 from 'typescript-eslint';
 import require$$0 from 'eslint/use-at-your-own-risk';
 import require$$0$1 from 'eslint';
 import os from 'node:os';
@@ -13012,6 +13013,25 @@ function getStormConfig(options = {
     // https://www.npmjs.com/package/eslint-plugin-yml
     ...yml.configs["flat/recommended"],
     ...yml.configs["flat/prettier"],
+    // CSpell
+    {
+      plugins: {
+        ...plugins
+      },
+      rules: {
+        ...rules,
+        "@cspell/spellchecker": [
+          "warn",
+          {
+            // configFile: new URL(
+            //   "./.vscode/cspell.json",
+            //   import.meta.url
+            // ).toString(),
+            autoFix: true
+          }
+        ]
+      }
+    },
     // User overrides
     ...userConfigs
   ].filter(Boolean);

package/dist/rules.d.ts

@@ -3,14 +3,18 @@
 import type { Linter } from 'eslint'
 
 export interface RuleOptions {
+  /**
+   * CSpell spellchecker
+   */
+  '@cspell/spellchecker'?: Linter.RuleEntry<CspellSpellchecker>
   /**
    * Checks dependencies in project's package.json for version mismatches
-   * @see https://github.com/nrwl/nx/blob/19.5.3/docs/generated/packages/eslint-plugin/documents/dependency-checks.md
+   * @see https://github.com/nrwl/nx/blob/19.5.6/docs/generated/packages/eslint-plugin/documents/dependency-checks.md
    */
   '@nx/dependency-checks'?: Linter.RuleEntry<NxDependencyChecks>
   /**
    * Ensure that module boundaries are respected within the monorepo
-   * @see https://github.com/nrwl/nx/blob/19.5.3/docs/generated/packages/eslint-plugin/documents/enforce-module-boundaries.md
+   * @see https://github.com/nrwl/nx/blob/19.5.6/docs/generated/packages/eslint-plugin/documents/enforce-module-boundaries.md
    */
   '@nx/enforce-module-boundaries'?: Linter.RuleEntry<NxEnforceModuleBoundaries>
   /**
@@ -2330,6 +2334,81 @@ export interface RuleOptions {
 }
 
 /* ======= Declarations ======= */
+// ----- @cspell/spellchecker -----
+type CspellSpellchecker = []|[{
+  
+  autoFix: boolean
+  
+  checkComments?: boolean
+  
+  checkIdentifiers?: boolean
+  
+  checkJSXText?: boolean
+  
+  checkScope?: [string, boolean][]
+  
+  checkStringTemplates?: boolean
+  
+  checkStrings?: boolean
+  
+  configFile?: string
+  
+  cspell?: {
+    
+    allowCompoundWords?: boolean
+    
+    dictionaries?: (string | string)[]
+    dictionaryDefinitions?: {
+      
+      description?: string
+      
+      name: string
+      
+      noSuggest?: boolean
+      
+      path: string
+      
+      repMap?: [string, string][]
+      
+      type?: ("S" | "W" | "C" | "T")
+      
+      useCompounds?: boolean
+    }[]
+    
+    enabled?: boolean
+    
+    flagWords?: string[]
+    
+    ignoreRegExpList?: (string | string | ("Base64" | "Base64MultiLine" | "Base64SingleLine" | "CStyleComment" | "CStyleHexValue" | "CSSHexValue" | "CommitHash" | "CommitHashLink" | "Email" | "EscapeCharacters" | "HexValues" | "href" | "PhpHereDoc" | "PublicKey" | "RsaCert" | "SshRsa" | "SHA" | "HashStrings" | "SpellCheckerDisable" | "SpellCheckerDisableBlock" | "SpellCheckerDisableLine" | "SpellCheckerDisableNext" | "SpellCheckerIgnoreInDocSetting" | "string" | "UnicodeRef" | "Urls" | "UUID" | "Everything"))[]
+    
+    ignoreWords?: string[]
+    
+    import?: (string | string[])
+    
+    includeRegExpList?: (string | string | ("Base64" | "Base64MultiLine" | "Base64SingleLine" | "CStyleComment" | "CStyleHexValue" | "CSSHexValue" | "CommitHash" | "CommitHashLink" | "Email" | "EscapeCharacters" | "HexValues" | "href" | "PhpHereDoc" | "PublicKey" | "RsaCert" | "SshRsa" | "SHA" | "HashStrings" | "SpellCheckerDisable" | "SpellCheckerDisableBlock" | "SpellCheckerDisableLine" | "SpellCheckerDisableNext" | "SpellCheckerIgnoreInDocSetting" | "string" | "UnicodeRef" | "Urls" | "UUID" | "Everything"))[]
+    
+    language?: string
+    
+    words?: string[]
+  }
+  
+  cspellOptionsRoot?: (string | string)
+  
+  customWordListFile?: (string | {
+    
+    path: string
+  })
+  
+  debugMode?: boolean
+  
+  generateSuggestions: boolean
+  
+  ignoreImportProperties?: boolean
+  
+  ignoreImports?: boolean
+  
+  numSuggestions: number
+}]
 // ----- @nx/dependency-checks -----
 type NxDependencyChecks = []|[{
   buildTargets?: string[]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storm-software/eslint",
-  "version": "0.52.0",
+  "version": "0.54.0",
   "type": "module",
   "description": "⚡ A package containing the base ESLint configuration used by Storm Software across many projects.",
   "repository": {
@@ -66,6 +66,7 @@
     }
   },
   "dependencies": {
+    "@cspell/eslint-plugin": "8.13.1",
     "@graphql-eslint/eslint-plugin": "3.20.1",
     "@next/eslint-plugin-next": "14.2.4",
     "eslint-plugin-es-x": "7.6.0",