@cspell/eslint-plugin 5.18.5 → 5.19.2

package/README.md

@@ -1,3 +1,91 @@
-# `@cspell/eslint-plugin-cspell`
+# [WIP] CSpell ESLint Plugin
 
-**[WIP]** A CSpell Plugin for ESLint.
+A spell checker plugin for ESLint based upon CSpell.
+
+## [WIP] - Work In Progress
+
+This plugin is still in active development. Due to the nature of how files are parsed, the `cspell` command line tool and this ESLint plugin will give different results. It is recommended that ESLint or `cspell` checks a file, but not both. Use `ignorePaths` setting in `cspell.json` to tell the `cspell` command line tool to ignore files checked by ESLint.
+
+## Quick Setup
+
+- Install `@cspell/eslint-plugin` as a dev-dependency
+
+  ```sh
+  npm install --save-dev @cspell/eslint-plugin
+  ```
+
+- Add to it to `.eslintrc.json`
+  ```json
+  "extends": ["plugin:@cspell/recommended"]
+  ```
+
+## Options
+
+````ts
+interface Options {
+  /**
+   * Number of spelling suggestions to make.
+   * @default 8
+   */
+  numSuggestions: number;
+  /**
+   * Generate suggestions
+   * @default true
+   */
+  generateSuggestions: boolean;
+  /**
+   * Ignore import and require names
+   * @default true
+   */
+  ignoreImports?: boolean;
+  /**
+   * Ignore the properties of imported variables, structures, and types.
+   *
+   * Example:
+   * ```
+   * import { example } from 'third-party';
+   *
+   * const msg = example.property; // `property` is not spell checked.
+   * ```
+   *
+   * @default true
+   */
+  ignoreImportProperties?: boolean;
+  /**
+   * Spell check identifiers (variables names, function names, and class names)
+   * @default true
+   */
+  checkIdentifiers?: boolean;
+  /**
+   * Spell check strings
+   * @default true
+   */
+  checkStrings?: boolean;
+  /**
+   * Spell check template strings
+   * @default true
+   */
+  checkStringTemplates?: boolean;
+  /**
+   * Spell check comments
+   * @default true
+   */
+  checkComments?: boolean;
+  /**
+   * Output debug logs
+   * @default false
+   */
+  debugMode?: boolean;
+}
+````
+
+Example:
+
+```json
+{
+  "plugins": ["@cspell"],
+  "rules": {
+    "@cspell/spellchecker": ["warn", { "checkComments": false }]
+  }
+}
+```

package/dist/index.d.ts

@@ -1,8 +1,82 @@
 import { Rule } from 'eslint';
 
 interface PluginRules {
-    ['cspell']: Rule.RuleModule;
+    ['spellchecker']: Rule.RuleModule;
 }
 declare const rules: PluginRules;
+declare const configs: {
+    recommended: {
+        plugins: string[];
+        rules: {
+            '@cspell/spellchecker': {}[];
+        };
+    };
+    debug: {
+        plugins: string[];
+        rules: {
+            '@cspell/spellchecker': (string | {
+                debugMode: boolean;
+            })[];
+        };
+    };
+};
 
-export { rules };
+interface Options extends Check {
+    /**
+     * Number of spelling suggestions to make.
+     * @default 8
+     */
+    numSuggestions: number;
+    /**
+     * Generate suggestions
+     * @default true
+     */
+    generateSuggestions: boolean;
+    /**
+     * Output debug logs
+     * @default false
+     */
+    debugMode?: boolean;
+}
+interface Check {
+    /**
+     * Ignore import and require names
+     * @default true
+     */
+    ignoreImports?: boolean;
+    /**
+     * Ignore the properties of imported variables, structures, and types.
+     *
+     * Example:
+     * ```
+     * import { example } from 'third-party';
+     *
+     * const msg = example.property; // `property` is not spell checked.
+     * ```
+     *
+     * @default true
+     */
+    ignoreImportProperties?: boolean;
+    /**
+     * Spell check identifiers (variables names, function names, class names, etc.)
+     * @default true
+     */
+    checkIdentifiers?: boolean;
+    /**
+     * Spell check strings
+     * @default true
+     */
+    checkStrings?: boolean;
+    /**
+     * Spell check template strings
+     * @default true
+     */
+    checkStringTemplates?: boolean;
+    /**
+     * Spell check comments
+     * @default true
+     */
+    checkComments?: boolean;
+}
+
+export { Options, configs, rules };

package/dist/index.js

@@ -1,5 +1,5 @@
 /*!
- * @cspell/eslint-plugin v5.18.5
+ * @cspell/eslint-plugin v5.19.1
  * Copyright 2022 Jason Dent <jason@streetsidesoftware.nl>
  * Released under the MIT License
  * https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-eslint-plugin#readme
@@ -10,17 +10,112 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var assert = require('assert');
-var util = require('util');
 var cspellLib = require('cspell-lib');
+var util = require('util');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
 var assert__default = /*#__PURE__*/_interopDefaultLegacy(assert);
 
+const defaultCheckOptions = {
+    checkComments: true,
+    checkIdentifiers: true,
+    checkStrings: true,
+    checkStringTemplates: true,
+    ignoreImports: true,
+    ignoreImportProperties: true,
+};
+const defaultOptions = {
+    ...defaultCheckOptions,
+    numSuggestions: 8,
+    generateSuggestions: true,
+    debugMode: false,
+};
+function normalizeOptions(opts) {
+    const options = Object.assign({}, defaultOptions, opts || {});
+    return options;
+}
+
+var $schema = "http://json-schema.org/draft-07/schema#";
+var additionalProperties = false;
+var definitions = {
+};
+var properties = {
+	checkComments: {
+		"default": true,
+		description: "Spell check comments",
+		type: "boolean"
+	},
+	checkIdentifiers: {
+		"default": true,
+		description: "Spell check identifiers (variables names, function names, class names, etc.)",
+		type: "boolean"
+	},
+	checkStringTemplates: {
+		"default": true,
+		description: "Spell check template strings",
+		type: "boolean"
+	},
+	checkStrings: {
+		"default": true,
+		description: "Spell check strings",
+		type: "boolean"
+	},
+	debugMode: {
+		"default": false,
+		description: "Output debug logs",
+		type: "boolean"
+	},
+	generateSuggestions: {
+		"default": true,
+		description: "Generate suggestions",
+		type: "boolean"
+	},
+	ignoreImportProperties: {
+		"default": true,
+		description: "Ignore the properties of imported variables, structures, and types.\n\nExample: ``` import { example } from 'third-party';\n\nconst msg = example.property; // `property` is not spell checked. ```",
+		type: "boolean"
+	},
+	ignoreImports: {
+		"default": true,
+		description: "Ignore import and require names",
+		type: "boolean"
+	},
+	numSuggestions: {
+		"default": 8,
+		description: "Number of spelling suggestions to make.",
+		type: "number"
+	}
+};
+var required = [
+	"numSuggestions",
+	"generateSuggestions"
+];
+var type = "object";
+var optionsSchema = {
+	$schema: $schema,
+	additionalProperties: additionalProperties,
+	definitions: definitions,
+	properties: properties,
+	required: required,
+	type: type
+};
+
+const schema = optionsSchema;
+const messages = {
+    wordUnknown: 'Unknown word: "{{word}}"',
+    wordForbidden: 'Forbidden word: "{{word}}"',
+    suggestWord: '{{word}}',
+};
 const meta = {
     docs: {
-        description: 'CSpell',
+        description: 'CSpell spellchecker',
+        category: 'Possible Errors',
+        recommended: false,
     },
+    messages,
+    hasSuggestions: true,
+    schema: [schema],
 };
 const defaultSettings = {
     patterns: [
@@ -32,55 +127,160 @@ const defaultSettings = {
     // },
     ],
 };
-const log = () => undefined;
+let isDebugMode = false;
+function log(...args) {
+    if (!isDebugMode)
+        return;
+    console.log(...args);
+}
 function create(context) {
+    const options = normalizeOptions(context.options[0]);
+    const toIgnore = new Set();
+    const importedIdentifiers = new Set();
+    isDebugMode = options.debugMode || false;
+    isDebugMode && logContext(context);
     const doc = cspellLib.createTextDocument({ uri: context.getFilename(), content: context.getSourceCode().getText() });
-    const validator = new cspellLib.DocumentValidator(doc, {}, defaultSettings);
+    const validator = new cspellLib.DocumentValidator(doc, options, defaultSettings);
     validator.prepareSync();
-    log(`
-
-id: ${context.id}
-cwd: ${context.getCwd()}
-filename: ${context.getFilename()}
-physicalFilename: ${context.getPhysicalFilename()}
-scope: ${context.getScope().type}
-`);
     function checkLiteral(node) {
+        if (!options.checkStrings)
+            return;
         if (typeof node.value === 'string') {
+            debugNode(node, node.value);
+            if (options.ignoreImports && isImportOrRequired(node))
+                return;
+            if (options.ignoreImportProperties && isImportedProperty(node))
+                return;
             checkNodeText(node, node.value);
         }
     }
     function checkTemplateElement(node) {
+        if (!options.checkStringTemplates)
+            return;
+        debugNode(node, node.value);
         // console.log('Template: %o', node.value);
         checkNodeText(node, node.value.cooked || node.value.raw);
     }
     function checkIdentifier(node) {
+        debugNode(node, node.name);
+        if (options.ignoreImports) {
+            if (isRawImportIdentifier(node)) {
+                toIgnore.add(node.name);
+                return;
+            }
+            if (isImportIdentifier(node)) {
+                importedIdentifiers.add(node.name);
+                if (isLocalImportIdentifierUnique(node)) {
+                    checkNodeText(node, node.name);
+                }
+                return;
+            }
+            else if (options.ignoreImportProperties && isImportedProperty(node)) {
+                return;
+            }
+        }
+        if (!options.checkIdentifiers)
+            return;
+        if (toIgnore.has(node.name) && !isObjectProperty(node))
+            return;
+        if (skipCheckForRawImportIdentifiers(node))
+            return;
         checkNodeText(node, node.name);
     }
     function checkComment(node) {
+        if (!options.checkComments)
+            return;
+        debugNode(node, node.value);
         checkNodeText(node, node.value);
-        util.format('%o', node);
     }
     function checkNodeText(node, text) {
         if (!node.range)
             return;
         const adj = node.type === 'Literal' ? 1 : 0;
         const range = [node.range[0] + adj, node.range[1] - adj];
-        const scope = inheritance(node);
+        const scope = calcScope();
         const result = validator.checkText(range, text, scope);
         result.forEach((issue) => reportIssue(issue));
     }
+    function calcScope(_node) {
+        // inheritance(node);
+        return [];
+    }
+    function isImportIdentifier(node) {
+        const parent = node.parent;
+        if (node.type !== 'Identifier' || !parent)
+            return false;
+        return ((parent.type === 'ImportSpecifier' ||
+            parent.type === 'ImportNamespaceSpecifier' ||
+            parent.type === 'ImportDefaultSpecifier') &&
+            parent.local === node);
+    }
+    function isRawImportIdentifier(node) {
+        const parent = node.parent;
+        if (node.type !== 'Identifier' || !parent)
+            return false;
+        return ((parent.type === 'ImportSpecifier' && parent.imported === node) ||
+            (parent.type === 'ExportSpecifier' && parent.local === node));
+    }
+    function isLocalImportIdentifierUnique(node) {
+        var _a, _b, _c, _d;
+        const parent = getImportParent(node);
+        if (!parent)
+            return true;
+        const { imported, local } = parent;
+        if (imported.name !== local.name)
+            return true;
+        return ((_a = imported.range) === null || _a === void 0 ? void 0 : _a[0]) !== ((_b = local.range) === null || _b === void 0 ? void 0 : _b[0]) && ((_c = imported.range) === null || _c === void 0 ? void 0 : _c[1]) !== ((_d = local.range) === null || _d === void 0 ? void 0 : _d[1]);
+    }
+    function getImportParent(node) {
+        const parent = node.parent;
+        return (parent === null || parent === void 0 ? void 0 : parent.type) === 'ImportSpecifier' ? parent : undefined;
+    }
+    function skipCheckForRawImportIdentifiers(node) {
+        if (options.ignoreImports)
+            return false;
+        const parent = getImportParent(node);
+        return !!parent && parent.imported === node && !isLocalImportIdentifierUnique(node);
+    }
+    function isImportedProperty(node) {
+        const obj = findOriginObject(node);
+        return !!obj && obj.type === 'Identifier' && importedIdentifiers.has(obj.name);
+    }
+    function isObjectProperty(node) {
+        var _a;
+        return ((_a = node.parent) === null || _a === void 0 ? void 0 : _a.type) === 'MemberExpression';
+    }
     function reportIssue(issue) {
-        // const messageId = issue.isFlagged ? 'cspell-forbidden-word' : 'cspell-unknown-word';
-        const messageType = issue.isFlagged ? 'Forbidden' : 'Unknown';
-        const message = `${messageType} word: "${issue.text}"`;
+        var _a;
+        const messageId = issue.isFlagged ? 'wordForbidden' : 'wordUnknown';
+        const data = {
+            word: issue.text,
+        };
         const code = context.getSourceCode();
-        const start = code.getLocFromIndex(issue.offset);
-        const end = code.getLocFromIndex(issue.offset + (issue.length || issue.text.length));
-        const loc = { start, end };
+        const start = issue.offset;
+        const end = issue.offset + (issue.length || issue.text.length);
+        const startPos = code.getLocFromIndex(start);
+        const endPos = code.getLocFromIndex(end);
+        const loc = { start: startPos, end: endPos };
+        function fixFactory(word) {
+            return (fixer) => fixer.replaceTextRange([start, end], word);
+        }
+        function createSug(word) {
+            const data = { word };
+            const messageId = 'suggestWord';
+            return {
+                messageId,
+                data,
+                fix: fixFactory(word),
+            };
+        }
+        log('Suggestions: %o', issue.suggestions);
+        const suggest = (_a = issue.suggestions) === null || _a === void 0 ? void 0 : _a.map(createSug);
         const des = {
-            message,
+            messageId,
+            data,
             loc,
+            suggest,
         };
         context.report(des);
     }
@@ -105,6 +305,14 @@ scope: ${context.getScope().type}
             const extra = node.source === child ? '.source' : '';
             return node.type + extra;
         }
+        if (node.type === 'ExportSpecifier') {
+            const extra = node.exported === child ? '.exported' : node.local === child ? '.local' : '';
+            return node.type + extra;
+        }
+        if (node.type === 'ExportNamedDeclaration') {
+            const extra = node.source === child ? '.source' : '';
+            return node.type + extra;
+        }
         if (node.type === 'Property') {
             const extra = node.key === child ? 'key' : node.value === child ? 'value' : '';
             return [node.type, node.kind, extra].join('.');
@@ -125,15 +333,57 @@ scope: ${context.getScope().type}
             const extra = node.id === child ? 'id' : node.body === child ? 'body' : 'superClass';
             return node.type + '.' + extra;
         }
+        if (node.type === 'CallExpression') {
+            const extra = node.callee === child ? 'callee' : 'arguments';
+            return node.type + '.' + extra;
+        }
         if (node.type === 'Literal') {
             return tagLiteral(node);
         }
+        if (node.type === 'Block') {
+            return node.value[0] === '*' ? 'Comment.docBlock' : 'Comment.block';
+        }
+        if (node.type === 'Line') {
+            return 'Comment.line';
+        }
         return node.type;
     }
     function inheritance(node) {
         const a = [...context.getAncestors(), node];
         return a.map(mapNode);
     }
+    function inheritanceSummary(node) {
+        return inheritance(node).join(' ');
+    }
+    /**
+     * find the origin of a member expression
+     */
+    function findOriginObject(node) {
+        const parent = node.parent;
+        if ((parent === null || parent === void 0 ? void 0 : parent.type) !== 'MemberExpression' || parent.property !== node)
+            return undefined;
+        let obj = parent.object;
+        while (obj.type === 'MemberExpression') {
+            obj = obj.object;
+        }
+        return obj;
+    }
+    function isFunctionCall(node, name) {
+        return (node === null || node === void 0 ? void 0 : node.type) === 'CallExpression' && node.callee.type === 'Identifier' && node.callee.name === name;
+    }
+    function isRequireCall(node) {
+        return isFunctionCall(node, 'require');
+    }
+    function isImportOrRequired(node) {
+        var _a;
+        return isRequireCall(node.parent) || (((_a = node.parent) === null || _a === void 0 ? void 0 : _a.type) === 'ImportDeclaration' && node.parent.source === node);
+    }
+    function debugNode(node, value) {
+        if (!isDebugMode)
+            return;
+        const val = util.format('%o', value);
+        log(`${inheritanceSummary(node)}: ${val}`);
+    }
 }
 function tagLiteral(node) {
     var _a;
@@ -149,11 +399,38 @@ function tagLiteral(node) {
     return node.type + '.' + extra;
 }
 const rules = {
-    cspell: {
+    spellchecker: {
         meta,
         create,
     },
 };
+function logContext(context) {
+    log('\n\n************************');
+    // log(context.getSourceCode().text);
+    log(`
+
+id: ${context.id}
+cwd: ${context.getCwd()}
+filename: ${context.getFilename()}
+physicalFilename: ${context.getPhysicalFilename()}
+scope: ${context.getScope().type}
+`);
+}
+const configs = {
+    recommended: {
+        plugins: ['@cspell'],
+        rules: {
+            '@cspell/spellchecker': ['warn', {}],
+        },
+    },
+    debug: {
+        plugins: ['@cspell'],
+        rules: {
+            '@cspell/spellchecker': ['warn', { debugMode: true }],
+        },
+    },
+};
 
+exports.configs = configs;
 exports.rules = rules;
 //# sourceMappingURL=index.js.map

package/dist/index.mjs

@@ -1,18 +1,113 @@
 /*!
- * @cspell/eslint-plugin v5.18.5
+ * @cspell/eslint-plugin v5.19.1
  * Copyright 2022 Jason Dent <jason@streetsidesoftware.nl>
  * Released under the MIT License
  * https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-eslint-plugin#readme
  */
 
 import assert from 'assert';
-import { format } from 'util';
 import { createTextDocument, DocumentValidator } from 'cspell-lib';
+import { format } from 'util';
 
+const defaultCheckOptions = {
+    checkComments: true,
+    checkIdentifiers: true,
+    checkStrings: true,
+    checkStringTemplates: true,
+    ignoreImports: true,
+    ignoreImportProperties: true,
+};
+const defaultOptions = {
+    ...defaultCheckOptions,
+    numSuggestions: 8,
+    generateSuggestions: true,
+    debugMode: false,
+};
+function normalizeOptions(opts) {
+    const options = Object.assign({}, defaultOptions, opts || {});
+    return options;
+}
+
+var $schema = "http://json-schema.org/draft-07/schema#";
+var additionalProperties = false;
+var definitions = {
+};
+var properties = {
+	checkComments: {
+		"default": true,
+		description: "Spell check comments",
+		type: "boolean"
+	},
+	checkIdentifiers: {
+		"default": true,
+		description: "Spell check identifiers (variables names, function names, class names, etc.)",
+		type: "boolean"
+	},
+	checkStringTemplates: {
+		"default": true,
+		description: "Spell check template strings",
+		type: "boolean"
+	},
+	checkStrings: {
+		"default": true,
+		description: "Spell check strings",
+		type: "boolean"
+	},
+	debugMode: {
+		"default": false,
+		description: "Output debug logs",
+		type: "boolean"
+	},
+	generateSuggestions: {
+		"default": true,
+		description: "Generate suggestions",
+		type: "boolean"
+	},
+	ignoreImportProperties: {
+		"default": true,
+		description: "Ignore the properties of imported variables, structures, and types.\n\nExample: ``` import { example } from 'third-party';\n\nconst msg = example.property; // `property` is not spell checked. ```",
+		type: "boolean"
+	},
+	ignoreImports: {
+		"default": true,
+		description: "Ignore import and require names",
+		type: "boolean"
+	},
+	numSuggestions: {
+		"default": 8,
+		description: "Number of spelling suggestions to make.",
+		type: "number"
+	}
+};
+var required = [
+	"numSuggestions",
+	"generateSuggestions"
+];
+var type = "object";
+var optionsSchema = {
+	$schema: $schema,
+	additionalProperties: additionalProperties,
+	definitions: definitions,
+	properties: properties,
+	required: required,
+	type: type
+};
+
+const schema = optionsSchema;
+const messages = {
+    wordUnknown: 'Unknown word: "{{word}}"',
+    wordForbidden: 'Forbidden word: "{{word}}"',
+    suggestWord: '{{word}}',
+};
 const meta = {
     docs: {
-        description: 'CSpell',
+        description: 'CSpell spellchecker',
+        category: 'Possible Errors',
+        recommended: false,
     },
+    messages,
+    hasSuggestions: true,
+    schema: [schema],
 };
 const defaultSettings = {
     patterns: [
@@ -24,55 +119,160 @@ const defaultSettings = {
     // },
     ],
 };
-const log = () => undefined;
+let isDebugMode = false;
+function log(...args) {
+    if (!isDebugMode)
+        return;
+    console.log(...args);
+}
 function create(context) {
+    const options = normalizeOptions(context.options[0]);
+    const toIgnore = new Set();
+    const importedIdentifiers = new Set();
+    isDebugMode = options.debugMode || false;
+    isDebugMode && logContext(context);
     const doc = createTextDocument({ uri: context.getFilename(), content: context.getSourceCode().getText() });
-    const validator = new DocumentValidator(doc, {}, defaultSettings);
+    const validator = new DocumentValidator(doc, options, defaultSettings);
     validator.prepareSync();
-    log(`
-
-id: ${context.id}
-cwd: ${context.getCwd()}
-filename: ${context.getFilename()}
-physicalFilename: ${context.getPhysicalFilename()}
-scope: ${context.getScope().type}
-`);
     function checkLiteral(node) {
+        if (!options.checkStrings)
+            return;
         if (typeof node.value === 'string') {
+            debugNode(node, node.value);
+            if (options.ignoreImports && isImportOrRequired(node))
+                return;
+            if (options.ignoreImportProperties && isImportedProperty(node))
+                return;
             checkNodeText(node, node.value);
         }
     }
     function checkTemplateElement(node) {
+        if (!options.checkStringTemplates)
+            return;
+        debugNode(node, node.value);
         // console.log('Template: %o', node.value);
         checkNodeText(node, node.value.cooked || node.value.raw);
     }
     function checkIdentifier(node) {
+        debugNode(node, node.name);
+        if (options.ignoreImports) {
+            if (isRawImportIdentifier(node)) {
+                toIgnore.add(node.name);
+                return;
+            }
+            if (isImportIdentifier(node)) {
+                importedIdentifiers.add(node.name);
+                if (isLocalImportIdentifierUnique(node)) {
+                    checkNodeText(node, node.name);
+                }
+                return;
+            }
+            else if (options.ignoreImportProperties && isImportedProperty(node)) {
+                return;
+            }
+        }
+        if (!options.checkIdentifiers)
+            return;
+        if (toIgnore.has(node.name) && !isObjectProperty(node))
+            return;
+        if (skipCheckForRawImportIdentifiers(node))
+            return;
         checkNodeText(node, node.name);
     }
     function checkComment(node) {
+        if (!options.checkComments)
+            return;
+        debugNode(node, node.value);
         checkNodeText(node, node.value);
-        format('%o', node);
     }
     function checkNodeText(node, text) {
         if (!node.range)
             return;
         const adj = node.type === 'Literal' ? 1 : 0;
         const range = [node.range[0] + adj, node.range[1] - adj];
-        const scope = inheritance(node);
+        const scope = calcScope();
         const result = validator.checkText(range, text, scope);
         result.forEach((issue) => reportIssue(issue));
     }
+    function calcScope(_node) {
+        // inheritance(node);
+        return [];
+    }
+    function isImportIdentifier(node) {
+        const parent = node.parent;
+        if (node.type !== 'Identifier' || !parent)
+            return false;
+        return ((parent.type === 'ImportSpecifier' ||
+            parent.type === 'ImportNamespaceSpecifier' ||
+            parent.type === 'ImportDefaultSpecifier') &&
+            parent.local === node);
+    }
+    function isRawImportIdentifier(node) {
+        const parent = node.parent;
+        if (node.type !== 'Identifier' || !parent)
+            return false;
+        return ((parent.type === 'ImportSpecifier' && parent.imported === node) ||
+            (parent.type === 'ExportSpecifier' && parent.local === node));
+    }
+    function isLocalImportIdentifierUnique(node) {
+        var _a, _b, _c, _d;
+        const parent = getImportParent(node);
+        if (!parent)
+            return true;
+        const { imported, local } = parent;
+        if (imported.name !== local.name)
+            return true;
+        return ((_a = imported.range) === null || _a === void 0 ? void 0 : _a[0]) !== ((_b = local.range) === null || _b === void 0 ? void 0 : _b[0]) && ((_c = imported.range) === null || _c === void 0 ? void 0 : _c[1]) !== ((_d = local.range) === null || _d === void 0 ? void 0 : _d[1]);
+    }
+    function getImportParent(node) {
+        const parent = node.parent;
+        return (parent === null || parent === void 0 ? void 0 : parent.type) === 'ImportSpecifier' ? parent : undefined;
+    }
+    function skipCheckForRawImportIdentifiers(node) {
+        if (options.ignoreImports)
+            return false;
+        const parent = getImportParent(node);
+        return !!parent && parent.imported === node && !isLocalImportIdentifierUnique(node);
+    }
+    function isImportedProperty(node) {
+        const obj = findOriginObject(node);
+        return !!obj && obj.type === 'Identifier' && importedIdentifiers.has(obj.name);
+    }
+    function isObjectProperty(node) {
+        var _a;
+        return ((_a = node.parent) === null || _a === void 0 ? void 0 : _a.type) === 'MemberExpression';
+    }
     function reportIssue(issue) {
-        // const messageId = issue.isFlagged ? 'cspell-forbidden-word' : 'cspell-unknown-word';
-        const messageType = issue.isFlagged ? 'Forbidden' : 'Unknown';
-        const message = `${messageType} word: "${issue.text}"`;
+        var _a;
+        const messageId = issue.isFlagged ? 'wordForbidden' : 'wordUnknown';
+        const data = {
+            word: issue.text,
+        };
         const code = context.getSourceCode();
-        const start = code.getLocFromIndex(issue.offset);
-        const end = code.getLocFromIndex(issue.offset + (issue.length || issue.text.length));
-        const loc = { start, end };
+        const start = issue.offset;
+        const end = issue.offset + (issue.length || issue.text.length);
+        const startPos = code.getLocFromIndex(start);
+        const endPos = code.getLocFromIndex(end);
+        const loc = { start: startPos, end: endPos };
+        function fixFactory(word) {
+            return (fixer) => fixer.replaceTextRange([start, end], word);
+        }
+        function createSug(word) {
+            const data = { word };
+            const messageId = 'suggestWord';
+            return {
+                messageId,
+                data,
+                fix: fixFactory(word),
+            };
+        }
+        log('Suggestions: %o', issue.suggestions);
+        const suggest = (_a = issue.suggestions) === null || _a === void 0 ? void 0 : _a.map(createSug);
         const des = {
-            message,
+            messageId,
+            data,
             loc,
+            suggest,
         };
         context.report(des);
     }
@@ -97,6 +297,14 @@ scope: ${context.getScope().type}
             const extra = node.source === child ? '.source' : '';
             return node.type + extra;
         }
+        if (node.type === 'ExportSpecifier') {
+            const extra = node.exported === child ? '.exported' : node.local === child ? '.local' : '';
+            return node.type + extra;
+        }
+        if (node.type === 'ExportNamedDeclaration') {
+            const extra = node.source === child ? '.source' : '';
+            return node.type + extra;
+        }
         if (node.type === 'Property') {
             const extra = node.key === child ? 'key' : node.value === child ? 'value' : '';
             return [node.type, node.kind, extra].join('.');
@@ -117,15 +325,57 @@ scope: ${context.getScope().type}
             const extra = node.id === child ? 'id' : node.body === child ? 'body' : 'superClass';
             return node.type + '.' + extra;
         }
+        if (node.type === 'CallExpression') {
+            const extra = node.callee === child ? 'callee' : 'arguments';
+            return node.type + '.' + extra;
+        }
         if (node.type === 'Literal') {
             return tagLiteral(node);
         }
+        if (node.type === 'Block') {
+            return node.value[0] === '*' ? 'Comment.docBlock' : 'Comment.block';
+        }
+        if (node.type === 'Line') {
+            return 'Comment.line';
+        }
         return node.type;
     }
     function inheritance(node) {
         const a = [...context.getAncestors(), node];
         return a.map(mapNode);
     }
+    function inheritanceSummary(node) {
+        return inheritance(node).join(' ');
+    }
+    /**
+     * find the origin of a member expression
+     */
+    function findOriginObject(node) {
+        const parent = node.parent;
+        if ((parent === null || parent === void 0 ? void 0 : parent.type) !== 'MemberExpression' || parent.property !== node)
+            return undefined;
+        let obj = parent.object;
+        while (obj.type === 'MemberExpression') {
+            obj = obj.object;
+        }
+        return obj;
+    }
+    function isFunctionCall(node, name) {
+        return (node === null || node === void 0 ? void 0 : node.type) === 'CallExpression' && node.callee.type === 'Identifier' && node.callee.name === name;
+    }
+    function isRequireCall(node) {
+        return isFunctionCall(node, 'require');
+    }
+    function isImportOrRequired(node) {
+        var _a;
+        return isRequireCall(node.parent) || (((_a = node.parent) === null || _a === void 0 ? void 0 : _a.type) === 'ImportDeclaration' && node.parent.source === node);
+    }
+    function debugNode(node, value) {
+        if (!isDebugMode)
+            return;
+        const val = format('%o', value);
+        log(`${inheritanceSummary(node)}: ${val}`);
+    }
 }
 function tagLiteral(node) {
     var _a;
@@ -141,11 +391,37 @@ function tagLiteral(node) {
     return node.type + '.' + extra;
 }
 const rules = {
-    cspell: {
+    spellchecker: {
         meta,
         create,
     },
 };
+function logContext(context) {
+    log('\n\n************************');
+    // log(context.getSourceCode().text);
+    log(`
+
+id: ${context.id}
+cwd: ${context.getCwd()}
+filename: ${context.getFilename()}
+physicalFilename: ${context.getPhysicalFilename()}
+scope: ${context.getScope().type}
+`);
+}
+const configs = {
+    recommended: {
+        plugins: ['@cspell'],
+        rules: {
+            '@cspell/spellchecker': ['warn', {}],
+        },
+    },
+    debug: {
+        plugins: ['@cspell'],
+        rules: {
+            '@cspell/spellchecker': ['warn', { debugMode: true }],
+        },
+    },
+};
 
-export { rules };
+export { configs, rules };
 //# sourceMappingURL=index.mjs.map

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "5.18.5",
+  "version": "5.19.2",
   "description": "[WIP] CSpell ESLint plugin",
   "keywords": [
     "cspell",
@@ -33,8 +33,10 @@
     "!**/*.map"
   ],
   "scripts": {
-    "build": "rollup --config rollup.config.ts --configPlugin typescript",
-    "watch": "npm run build -- --watch",
+    "build": "npm run build-schema && npm run build-rollup",
+    "build-rollup": "rollup --config rollup.config.ts --configPlugin typescript",
+    "build-schema": "ts-json-schema-generator --no-top-ref --path src/options.ts --type Options  -o  ./src/_auto_generated_/options.schema.json",
+    "watch": "npm run build-rollup -- --watch",
     "clean": "rimraf dist coverage .tsbuildinfo",
     "clean-build": "npm run clean && npm run build",
     "coverage": "echo coverage",
@@ -53,6 +55,7 @@
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^21.0.2",
+    "@rollup/plugin-json": "^4.1.0",
     "@rollup/plugin-node-resolve": "^13.1.3",
     "@rollup/plugin-typescript": "^8.3.1",
     "@types/eslint": "^8.4.1",
@@ -61,13 +64,15 @@
     "@typescript-eslint/parser": "^5.14.0",
     "@typescript-eslint/types": "^5.14.0",
     "@typescript-eslint/typescript-estree": "^5.14.0",
-    "eslint": "^8.10.0",
-    "mocha": "^9.2.1",
+    "eslint": "^8.11.0",
+    "mocha": "^9.2.2",
     "rimraf": "^3.0.2",
     "rollup": "^2.70.0",
-    "rollup-plugin-dts": "^4.2.0"
+    "rollup-plugin-dts": "^4.2.0",
+    "ts-json-schema-generator": "^0.98.0"
   },
   "dependencies": {
-    "cspell-lib": "^5.18.5"
-  }
+    "cspell-lib": "^5.19.2"
+  },
+  "gitHead": "6540cb9f716993c554dc50dd54dd76d553f8f5e4"
 }