@cspell/eslint-plugin 8.3.2 → 8.4.1

package/README.md

@@ -14,11 +14,68 @@ This plugin is still in active development as part of the CSpell suite of tools
   npm install --save-dev @cspell/eslint-plugin
   ```
 
-- Add to it to `.eslintrc.json`
+- Add the plugin to the ESLint configuration (see below:)
+  - [Configuration (new: `eslint.config.js`)](#configuration-new-eslintconfigjs)
+  - [Configuration (Legacy: `.eslintrc`)](#configuration-legacy-eslintrc)
 
-  ```json
+### Configuration (new: `eslint.config.js`)
+
+**`eslint.config.js` using recommended.**
+
+```js
+import cspellESLintPluginRecommended from '@cspell/eslint-plugin/recommended';
+
+export default [
+  // other config imports
+  cspellESLintPluginRecommended
+  // other configs
+];
+```
+
+**Or**
+
+**`eslint.config.js` using configs.**
+
+```js
+import cspellConfigs from '@cspell/eslint-plugin/configs';
+
+export default [
+  // other config imports
+  cspellConfigs.recommended
+  // other configs
+];
+```
+
+**Or**
+
+**`eslint.config.js` using `plugins`**
+
+```js
+import cspellPlugin from '@cspell/eslint-plugin';
+
+export default [
+  // other config imports
+  {
+    plugins: { '@cspell': cspellPlugin },
+    rules: {
+      '@cspell/spellchecker': ['warn', {}]
+    }
+  }
+  // other configs
+];
+```
+
+### Configuration (Legacy: `.eslintrc`)
+
+Add `"plugin:@cspell/recommended"` to the `extends` section of the configuration.
+
+**`.eslintrc`**
+
+```json
+{
   "extends": ["plugin:@cspell/recommended"]
-  ```
+}
+```
 
 ## Options
 
@@ -87,6 +144,11 @@ interface Options {
    * Some CSpell Settings
    */
   cspell?: {
+    /**
+     * The language locale to use, i.e. `en-US,en-GB` to enable both
+     * American and British English.
+     */
+    language?: string;
     /** List of words to be considered correct. */
     words?: string[];
     /**
@@ -141,7 +203,39 @@ interface Options {
 }
 ````
 
-Example:
+Examples:
+
+**`eslint.config.js`**
+
+```js
+import cspellPlugin from '@cspell/eslint-plugin';
+
+export default [
+  {
+    plugins: { '@cspell': cspellPlugin },
+    rules: {
+      '@cspell/spellchecker': ['warn', { checkComments: false, autoFix: true }]
+    }
+  }
+];
+```
+
+**`eslint.config.js`**
+
+```js
+import cspellConfigs from '@cspell/eslint-plugin/configs';
+
+export default [
+  cspellConfigs.recommended,
+  {
+    rules: {
+      '@cspell/spellchecker': ['warn', { checkComments: false, autoFix: true }]
+    }
+  }
+];
+```
+
+**`.eslintrc.json`**
 
 ```json
 {

package/assets/options.schema.json

@@ -158,6 +158,11 @@
           },
           "type": "array"
         },
+        "language": {
+          "default": "en",
+          "description": "Current active spelling language. This specifies the language locale to use in choosing the general dictionary.\n\nFor example:\n\n- \"en-GB\" for British English.\n- \"en,nl\" to enable both English and Dutch.",
+          "type": "string"
+        },
         "words": {
           "description": "List of words to be considered correct.",
           "items": {

package/dist/common/options.d.cts

@@ -23,7 +23,7 @@ export interface Options extends Check {
     debugMode?: boolean;
 }
 type DictionaryDefinition = DictionaryDefinitionPreferred;
-export type CSpellOptions = Pick<CSpellSettings, 'allowCompoundWords' | 'dictionaries' | 'enabled' | 'flagWords' | 'ignoreWords' | 'ignoreRegExpList' | 'includeRegExpList' | 'import' | 'words'> & {
+export type CSpellOptions = Pick<CSpellSettings, 'allowCompoundWords' | 'dictionaries' | 'enabled' | 'flagWords' | 'ignoreWords' | 'ignoreRegExpList' | 'includeRegExpList' | 'import' | 'language' | 'words'> & {
     dictionaryDefinitions?: DictionaryDefinition[];
 };
 export type RequiredOptions = Required<Pick<Options, Exclude<keyof Options, 'debugMode'>>> & Pick<Options, 'debugMode'>;

package/dist/plugin/configs.cjs

@@ -0,0 +1,37 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.debug = exports.recommended = void 0;
+const cspell_eslint_plugin_cjs_1 = require("./cspell-eslint-plugin.cjs");
+exports.recommended = __importStar(require("./recommended.cjs"));
+exports.debug = {
+    plugins: {
+        '@cspell': cspell_eslint_plugin_cjs_1.plugin,
+    },
+    rules: {
+        '@cspell/spellchecker': ['warn', { debugMode: true }],
+    },
+};
+//# sourceMappingURL=configs.cjs.map

package/dist/plugin/configs.d.cts

@@ -0,0 +1,4 @@
+import type { Linter } from 'eslint';
+export * as recommended from './recommended.cjs';
+export declare const debug: Linter.FlatConfig;
+//# sourceMappingURL=configs.d.cts.map

package/dist/plugin/cspell-eslint-plugin.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.configs = exports.rules = void 0;
+exports.plugin = exports.configs = exports.meta = exports.rules = void 0;
 const fs_1 = require("fs");
 const path_1 = require("path");
 const synckit_1 = require("synckit");
@@ -8,13 +8,13 @@ const logger_cjs_1 = require("../common/logger.cjs");
 const defaultCheckOptions_cjs_1 = require("./defaultCheckOptions.cjs");
 const optionsSchema = JSON.parse((0, fs_1.readFileSync)((0, path_1.join)(__dirname, '../../assets/options.schema.json'), 'utf8'));
 const schema = optionsSchema;
-const spellCheck = (0, synckit_1.createSyncFn)(require.resolve('../worker/worker.mjs'), undefined, 30000);
+const spellCheck = (0, synckit_1.createSyncFn)(require.resolve('../worker/worker.mjs'), 30000);
 const messages = {
     wordUnknown: 'Unknown word: "{{word}}"',
     wordForbidden: 'Forbidden word: "{{word}}"',
     suggestWord: '{{word}}{{preferred}}',
 };
-const meta = {
+const ruleMeta = {
     docs: {
         description: 'CSpell spellchecker',
         category: 'Possible Errors',
@@ -93,11 +93,12 @@ function create(context) {
     }
     return { Program: checkProgram };
 }
+const spellchecker = {
+    meta: ruleMeta,
+    create,
+};
 exports.rules = {
-    spellchecker: {
-        meta,
-        create,
-    },
+    spellchecker,
 };
 function logContext(log, context) {
     log('context: %o', {
@@ -109,18 +110,24 @@ function logContext(log, context) {
         options: context.options.length === 1 ? context.options[0] : context.options,
     });
 }
-exports.configs = {
-    recommended: {
-        plugins: ['@cspell'],
-        rules: {
-            '@cspell/spellchecker': ['warn', {}],
-        },
+exports.meta = { name: '@cspell' };
+const recommended = {
+    plugins: ['@cspell'],
+    rules: {
+        '@cspell/spellchecker': ['warn', {}],
     },
-    debug: {
-        plugins: ['@cspell'],
-        rules: {
-            '@cspell/spellchecker': ['warn', { debugMode: true }],
-        },
+};
+const debugConfig = {
+    plugins: ['@cspell'],
+    rules: {
+        '@cspell/spellchecker': ['warn', { debugMode: true }],
     },
 };
+exports.configs = {
+    debug: debugConfig,
+    'debug-legacy': debugConfig,
+    recommended,
+    'recommended-legacy': recommended,
+};
+exports.plugin = { rules: exports.rules, configs: exports.configs, meta: exports.meta };
 //# sourceMappingURL=cspell-eslint-plugin.cjs.map

package/dist/plugin/cspell-eslint-plugin.d.cts

@@ -1,22 +1,19 @@
-import type { Rule } from 'eslint';
-interface PluginRules {
-    ['spellchecker']: Rule.RuleModule;
-}
-export declare const rules: PluginRules;
-export declare const configs: {
-    recommended: {
-        plugins: string[];
-        rules: {
-            '@cspell/spellchecker': {}[];
-        };
+import type { ESLint, Rule } from 'eslint';
+type ESlintPlugin = ESLint.Plugin;
+export declare const rules: {
+    spellchecker: Rule.RuleModule;
+};
+export declare const meta: {
+    readonly name: "@cspell";
+};
+export declare const configs: ESlintPlugin['configs'];
+export declare const plugin: {
+    rules: {
+        spellchecker: Rule.RuleModule;
     };
-    debug: {
-        plugins: string[];
-        rules: {
-            '@cspell/spellchecker': (string | {
-                debugMode: boolean;
-            })[];
-        };
+    configs: Record<string, ESLint.ConfigData<import("eslint").Linter.RulesRecord> | import("eslint").Linter.FlatConfig | import("eslint").Linter.FlatConfig[]>;
+    meta: {
+        readonly name: "@cspell";
     };
 };
 export {};

package/dist/plugin/index.cjs

@@ -1,7 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.rules = exports.configs = void 0;
-var cspell_eslint_plugin_cjs_1 = require("./cspell-eslint-plugin.cjs");
-Object.defineProperty(exports, "configs", { enumerable: true, get: function () { return cspell_eslint_plugin_cjs_1.configs; } });
-Object.defineProperty(exports, "rules", { enumerable: true, get: function () { return cspell_eslint_plugin_cjs_1.rules; } });
+exports.rules = exports.meta = exports.configs = void 0;
+const cspell_eslint_plugin_cjs_1 = require("./cspell-eslint-plugin.cjs");
+var cspell_eslint_plugin_cjs_2 = require("./cspell-eslint-plugin.cjs");
+Object.defineProperty(exports, "configs", { enumerable: true, get: function () { return cspell_eslint_plugin_cjs_2.configs; } });
+Object.defineProperty(exports, "meta", { enumerable: true, get: function () { return cspell_eslint_plugin_cjs_2.meta; } });
+Object.defineProperty(exports, "rules", { enumerable: true, get: function () { return cspell_eslint_plugin_cjs_2.rules; } });
+exports.default = cspell_eslint_plugin_cjs_1.plugin;
 //# sourceMappingURL=index.cjs.map

package/dist/plugin/index.d.cts

@@ -1,3 +1,5 @@
 export type { Options } from '../common/options.cjs';
-export { configs, rules } from './cspell-eslint-plugin.cjs';
+import { plugin } from './cspell-eslint-plugin.cjs';
+export { configs, meta, rules } from './cspell-eslint-plugin.cjs';
+export default plugin;
 //# sourceMappingURL=index.d.cts.map

package/dist/plugin/recommended.cjs

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rules = exports.plugins = void 0;
+const cspell_eslint_plugin_cjs_1 = require("./cspell-eslint-plugin.cjs");
+const config = {
+    plugins: {
+        '@cspell': cspell_eslint_plugin_cjs_1.plugin,
+    },
+    rules: {
+        '@cspell/spellchecker': ['warn', {}],
+    },
+};
+exports.plugins = config.plugins;
+exports.rules = config.rules;
+//# sourceMappingURL=recommended.cjs.map

package/dist/plugin/recommended.d.cts

@@ -0,0 +1,4 @@
+import type { Linter } from 'eslint';
+export declare const plugins: Record<string, import("eslint").ESLint.Plugin> | undefined;
+export declare const rules: Linter.RulesRecord | undefined;
+//# sourceMappingURL=recommended.d.cts.map

package/dist/worker/types.d.cts

@@ -28,7 +28,7 @@ export interface SpellCheckResults {
     issues: Issue[];
     errors?: Error[];
 }
-type SpellCheckFn = (filename: string, text: string, root: Node, options: WorkerOptions) => Promise<SpellCheckResults>;
+export type SpellCheckFn = (filename: string, text: string, root: Node, options: WorkerOptions) => Promise<SpellCheckResults>;
 export type SpellCheckSyncFn = (...p: Parameters<SpellCheckFn>) => Awaited<ReturnType<SpellCheckFn>>;
 export {};
 //# sourceMappingURL=types.d.cts.map

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "8.3.2",
+  "version": "8.4.1",
   "description": "CSpell ESLint plugin",
   "keywords": [
     "cspell",
@@ -23,6 +23,18 @@
       "require": "./dist/plugin/index.cjs",
       "import": "./dist/plugin/index.cjs",
       "default": "./dist/plugin/index.cjs"
+    },
+    "./configs": {
+      "types": "./dist/plugin/configs.d.cts",
+      "require": "./dist/plugin/configs.cjs",
+      "import": "./dist/plugin/configs.cjs",
+      "default": "./dist/plugin/configs.cjs"
+    },
+    "./recommended": {
+      "types": "./dist/plugin/recommended.d.cts",
+      "require": "./dist/plugin/recommended.cjs",
+      "import": "./dist/plugin/recommended.cjs",
+      "default": "./dist/plugin/recommended.cjs"
     }
   },
   "type": "module",
@@ -60,24 +72,24 @@
     "node": ">=18"
   },
   "devDependencies": {
-    "@types/eslint": "^8.56.0",
+    "@types/eslint": "^8.56.2",
     "@types/estree": "^1.0.5",
     "@types/mocha": "^10.0.6",
-    "@typescript-eslint/eslint-plugin": "^6.16.0",
-    "@typescript-eslint/parser": "^6.16.0",
-    "@typescript-eslint/types": "^6.16.0",
-    "@typescript-eslint/typescript-estree": "^6.16.0",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "@typescript-eslint/parser": "^6.21.0",
+    "@typescript-eslint/types": "^6.21.0",
+    "@typescript-eslint/typescript-estree": "^6.21.0",
     "eslint": "^8.56.0",
     "eslint-plugin-react": "^7.33.2",
-    "mocha": "^10.2.0",
+    "mocha": "^10.3.0",
     "ts-json-schema-generator": "^1.5.0",
     "typescript": "^5.3.3"
   },
   "dependencies": {
-    "@cspell/cspell-types": "8.3.2",
-    "cspell-lib": "8.3.2",
+    "@cspell/cspell-types": "8.4.1",
+    "cspell-lib": "8.4.1",
     "estree-walker": "^3.0.3",
-    "synckit": "^0.8.8"
+    "synckit": "^0.9.0"
   },
-  "gitHead": "98f622b2b12529f2d1ccf0f3a57991e4c08b3e3a"
+  "gitHead": "d57dbadb81b859d659c578cd8e81ac5dbcbaae8c"
 }