@cspell/eslint-plugin 5.19.0 → 5.19.1

package/README.md

@@ -21,30 +21,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 +71,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.0
  * 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,6 +135,7 @@ 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);
@@ -139,9 +146,11 @@ function create(context) {
         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 +162,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 +207,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 +355,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;
     }

package/dist/index.mjs

@@ -1,5 +1,5 @@
 /*!
- * @cspell/eslint-plugin v5.18.5
+ * @cspell/eslint-plugin v5.19.0
  * Copyright 2022 Jason Dent <jason@streetsidesoftware.nl>
  * Released under the MIT License
  * https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-eslint-plugin#readme
@@ -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,6 +127,7 @@ 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);
@@ -131,9 +138,11 @@ function create(context) {
         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 +154,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 +199,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 +347,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;
     }

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "5.19.0",
+  "version": "5.19.1",
   "description": "[WIP] CSpell ESLint plugin",
   "keywords": [
     "cspell",
@@ -72,7 +72,7 @@
     "ts-json-schema-generator": "^0.98.0"
   },
   "dependencies": {
-    "cspell-lib": "^5.19.0"
+    "cspell-lib": "^5.19.1"
   },
-  "gitHead": "7873efe40a3287d3e025f705e1712c12d3cb392e"
+  "gitHead": "622cd59a44bf1f76d538e3cf37983f387c5423e8"
 }