@cspell/eslint-plugin 5.19.2 → 5.19.5

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
 

package/dist/index.js

@@ -1,5 +1,5 @@
 /*!
- * @cspell/eslint-plugin v5.19.1
+ * @cspell/eslint-plugin v5.19.4
  * Copyright 2022 Jason Dent <jason@streetsidesoftware.nl>
  * Released under the MIT License
  * https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-eslint-plugin#readme
@@ -139,8 +139,7 @@ function create(context) {
     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)
@@ -430,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.19.1
+ * @cspell/eslint-plugin v5.19.4
  * 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 = {
@@ -131,8 +131,7 @@ function create(context) {
     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)
@@ -422,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.2",
+  "version": "5.19.5",
   "description": "[WIP] CSpell ESLint plugin",
   "keywords": [
     "cspell",
@@ -54,25 +54,25 @@
     "node": ">=12.13.0"
   },
   "devDependencies": {
-    "@rollup/plugin-commonjs": "^21.0.2",
+    "@rollup/plugin-commonjs": "^21.0.3",
     "@rollup/plugin-json": "^4.1.0",
     "@rollup/plugin-node-resolve": "^13.1.3",
     "@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",
-    "eslint": "^8.11.0",
+    "@types/node": "^17.0.23",
+    "@typescript-eslint/parser": "^5.17.0",
+    "@typescript-eslint/types": "^5.17.0",
+    "@typescript-eslint/typescript-estree": "^5.17.0",
+    "eslint": "^8.12.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.2"
+    "cspell-lib": "^5.19.5"
   },
-  "gitHead": "6540cb9f716993c554dc50dd54dd76d553f8f5e4"
+  "gitHead": "0d113f01b51c3bc149a01269878d4217a58ecb97"
 }