@cspell/eslint-plugin 5.19.0 → 5.19.3

package/README.md

@@ -1,10 +1,16 @@
-# [WIP] CSpell ESLint Plugin
+# CSpell ESLint Plugin
 
 A spell checker plugin for ESLint based upon CSpell.
 
-## [WIP] - Work In Progress
+## Feedback Welcome
 
-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.
+This plugin is still in active development as part of the CSpell suite of tools and applications.
+
+## In Combination with CSpell
+
+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 either 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
 
@@ -21,30 +27,36 @@ This plugin is still in active development. Due to the nature of how files are p
 
 ## Options
 
-```ts
+````ts
 interface Options {
   /**
    * Number of spelling suggestions to make.
    * @default 8
    */
   numSuggestions: number;
-
   /**
    * Generate suggestions
    * @default true
    */
   generateSuggestions: boolean;
-
-  /**
-   * Output debug logs
-   * @default false
-   */
-  debugMode?: 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
@@ -65,8 +77,13 @@ interface Options {
    * @default true
    */
   checkComments?: boolean;
+  /**
+   * Output debug logs
+   * @default false
+   */
+  debugMode?: boolean;
 }
-```
+````
 
 Example:
 

package/dist/index.d.ts

@@ -45,7 +45,20 @@ interface Check {
      */
     ignoreImports?: boolean;
     /**
-     * Spell check identifiers (variables names, function names, and class names)
+     * 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;

package/dist/index.js

@@ -1,5 +1,5 @@
 /*!
- * @cspell/eslint-plugin v5.18.5
+ * @cspell/eslint-plugin v5.19.2
  * Copyright 2022 Jason Dent <jason@streetsidesoftware.nl>
  * Released under the MIT License
  * https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-eslint-plugin#readme
@@ -23,6 +23,7 @@ const defaultCheckOptions = {
     checkStrings: true,
     checkStringTemplates: true,
     ignoreImports: true,
+    ignoreImportProperties: true,
 };
 const defaultOptions = {
     ...defaultCheckOptions,
@@ -47,7 +48,7 @@ var properties = {
 	},
 	checkIdentifiers: {
 		"default": true,
-		description: "Spell check identifiers (variables names, function names, and class names)",
+		description: "Spell check identifiers (variables names, function names, class names, etc.)",
 		type: "boolean"
 	},
 	checkStringTemplates: {
@@ -70,6 +71,11 @@ var properties = {
 		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",
@@ -129,19 +135,21 @@ function 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, options, defaultSettings);
+    const validator = getDocValidator(context);
     validator.prepareSync();
     function checkLiteral(node) {
         if (!options.checkStrings)
             return;
         if (typeof node.value === 'string') {
+            debugNode(node, node.value);
             if (options.ignoreImports && isImportOrRequired(node))
                 return;
-            debugNode(node, node.value);
+            if (options.ignoreImportProperties && isImportedProperty(node))
+                return;
             checkNodeText(node, node.value);
         }
     }
@@ -153,15 +161,29 @@ function create(context) {
         checkNodeText(node, node.value.cooked || node.value.raw);
     }
     function checkIdentifier(node) {
-        if (options.ignoreImports && isImportIdentifier(node)) {
-            importedIdentifiers.add(node.name);
-            return;
+        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 (importedIdentifiers.has(node.name))
+        if (toIgnore.has(node.name) && !isObjectProperty(node))
+            return;
+        if (skipCheckForRawImportIdentifiers(node))
             return;
-        debugNode(node, node.name);
         checkNodeText(node, node.name);
     }
     function checkComment(node) {
@@ -184,12 +206,49 @@ function create(context) {
         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) {
         var _a;
         const messageId = issue.isFlagged ? 'wordForbidden' : 'wordUnknown';
@@ -295,6 +354,19 @@ function create(context) {
     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;
     }
@@ -357,6 +429,33 @@ const configs = {
         },
     },
 };
+const cache = { lastDoc: undefined };
+const docValCache = new WeakMap();
+function getDocValidator(context) {
+    const text = context.getSourceCode().getText();
+    const doc = getTextDocument(context.getFilename(), text);
+    const cachedValidator = docValCache.get(doc);
+    if (cachedValidator) {
+        cachedValidator.updateDocumentText(text);
+        return cachedValidator;
+    }
+    const options = normalizeOptions(context.options[0]);
+    isDebugMode = options.debugMode || false;
+    isDebugMode && logContext(context);
+    const validator = new cspellLib.DocumentValidator(doc, options, defaultSettings);
+    docValCache.set(doc, validator);
+    return validator;
+}
+function getTextDocument(filename, content) {
+    var _a;
+    if (((_a = cache.lastDoc) === null || _a === void 0 ? void 0 : _a.filename) === filename) {
+        return cache.lastDoc.doc;
+    }
+    const doc = cspellLib.createTextDocument({ uri: filename, content });
+    // console.error(`CreateTextDocument: ${doc.uri}`);
+    cache.lastDoc = { filename, doc };
+    return doc;
+}
 
 exports.configs = configs;
 exports.rules = rules;

package/dist/index.mjs

@@ -1,12 +1,12 @@
 /*!
- * @cspell/eslint-plugin v5.18.5
+ * @cspell/eslint-plugin v5.19.2
  * 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 { createTextDocument, DocumentValidator } from 'cspell-lib';
+import { DocumentValidator, createTextDocument } from 'cspell-lib';
 import { format } from 'util';
 
 const defaultCheckOptions = {
@@ -15,6 +15,7 @@ const defaultCheckOptions = {
     checkStrings: true,
     checkStringTemplates: true,
     ignoreImports: true,
+    ignoreImportProperties: true,
 };
 const defaultOptions = {
     ...defaultCheckOptions,
@@ -39,7 +40,7 @@ var properties = {
 	},
 	checkIdentifiers: {
 		"default": true,
-		description: "Spell check identifiers (variables names, function names, and class names)",
+		description: "Spell check identifiers (variables names, function names, class names, etc.)",
 		type: "boolean"
 	},
 	checkStringTemplates: {
@@ -62,6 +63,11 @@ var properties = {
 		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",
@@ -121,19 +127,21 @@ function 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, options, defaultSettings);
+    const validator = getDocValidator(context);
     validator.prepareSync();
     function checkLiteral(node) {
         if (!options.checkStrings)
             return;
         if (typeof node.value === 'string') {
+            debugNode(node, node.value);
             if (options.ignoreImports && isImportOrRequired(node))
                 return;
-            debugNode(node, node.value);
+            if (options.ignoreImportProperties && isImportedProperty(node))
+                return;
             checkNodeText(node, node.value);
         }
     }
@@ -145,15 +153,29 @@ function create(context) {
         checkNodeText(node, node.value.cooked || node.value.raw);
     }
     function checkIdentifier(node) {
-        if (options.ignoreImports && isImportIdentifier(node)) {
-            importedIdentifiers.add(node.name);
-            return;
+        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 (importedIdentifiers.has(node.name))
+        if (toIgnore.has(node.name) && !isObjectProperty(node))
+            return;
+        if (skipCheckForRawImportIdentifiers(node))
             return;
-        debugNode(node, node.name);
         checkNodeText(node, node.name);
     }
     function checkComment(node) {
@@ -176,12 +198,49 @@ function create(context) {
         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) {
         var _a;
         const messageId = issue.isFlagged ? 'wordForbidden' : 'wordUnknown';
@@ -287,6 +346,19 @@ function create(context) {
     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;
     }
@@ -349,6 +421,33 @@ const configs = {
         },
     },
 };
+const cache = { lastDoc: undefined };
+const docValCache = new WeakMap();
+function getDocValidator(context) {
+    const text = context.getSourceCode().getText();
+    const doc = getTextDocument(context.getFilename(), text);
+    const cachedValidator = docValCache.get(doc);
+    if (cachedValidator) {
+        cachedValidator.updateDocumentText(text);
+        return cachedValidator;
+    }
+    const options = normalizeOptions(context.options[0]);
+    isDebugMode = options.debugMode || false;
+    isDebugMode && logContext(context);
+    const validator = new DocumentValidator(doc, options, defaultSettings);
+    docValCache.set(doc, validator);
+    return validator;
+}
+function getTextDocument(filename, content) {
+    var _a;
+    if (((_a = cache.lastDoc) === null || _a === void 0 ? void 0 : _a.filename) === filename) {
+        return cache.lastDoc.doc;
+    }
+    const doc = createTextDocument({ uri: filename, content });
+    // console.error(`CreateTextDocument: ${doc.uri}`);
+    cache.lastDoc = { filename, doc };
+    return doc;
+}
 
 export { configs, rules };
 //# sourceMappingURL=index.mjs.map

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "5.19.0",
+  "version": "5.19.3",
   "description": "[WIP] CSpell ESLint plugin",
   "keywords": [
     "cspell",
@@ -60,19 +60,19 @@
     "@rollup/plugin-typescript": "^8.3.1",
     "@types/eslint": "^8.4.1",
     "@types/estree": "^0.0.51",
-    "@types/node": "^17.0.21",
-    "@typescript-eslint/parser": "^5.14.0",
-    "@typescript-eslint/types": "^5.14.0",
-    "@typescript-eslint/typescript-estree": "^5.14.0",
+    "@types/node": "^17.0.22",
+    "@typescript-eslint/parser": "^5.16.0",
+    "@typescript-eslint/types": "^5.16.0",
+    "@typescript-eslint/typescript-estree": "^5.16.0",
     "eslint": "^8.11.0",
     "mocha": "^9.2.2",
     "rimraf": "^3.0.2",
-    "rollup": "^2.70.0",
+    "rollup": "^2.70.1",
     "rollup-plugin-dts": "^4.2.0",
-    "ts-json-schema-generator": "^0.98.0"
+    "ts-json-schema-generator": "^1.0.0"
   },
   "dependencies": {
-    "cspell-lib": "^5.19.0"
+    "cspell-lib": "^5.19.3"
   },
-  "gitHead": "7873efe40a3287d3e025f705e1712c12d3cb392e"
+  "gitHead": "df43735d8f85fddbbd0befca7d98956f50474ce7"
 }