feat: CSpell REPL (#3109)

.eslintrc.js

@@ -34,6 +34,8 @@ const config = {
         '**/build/**',
         'package-lock.json',
         '**/scripts/ts-json-schema-generator.cjs',
+        '**/fixtures/**/*.js',
+        '**/webpack*.js',
     ],
     plugins: ['import', 'unicorn', 'simple-import-sort'],
     rules: {
@@ -57,7 +59,7 @@ const config = {
     },
     overrides: [
         {
-            files: ['**/*.ts', '**/*.mts', '**/*.cts', '**/*.tsx'],
+            files: ['**/*.ts', '**/*.mts', '**/*.cts', '**/*.tsx', '**/*.js', '**/*.mjs'],
             extends: ['plugin:@typescript-eslint/recommended', 'plugin:import/typescript'],
             parser: '@typescript-eslint/parser',
             plugins: ['@typescript-eslint'],

cspell-words.txt

@@ -1,4 +1,5 @@
 # Project Words
+abortable
 acanthopterygious
 activitybar
 aeiouy
@@ -63,13 +64,16 @@ nohoist
 noreply
 nospace
 onfinally
+optionator
 outfile
 overridable
 OVSX
 paginator
 permalinks
+Positionals
 Preformat
 preinstall
+Pseudoterminal
 quickfix
 quotemark
 readonly
@@ -95,6 +99,8 @@ tsbuildInfo
 tslib
 typechecking
 unelevated
+unindented
+unindents
 untracked
 untrusted
 uri's

cspell.config.yaml

@@ -53,6 +53,9 @@ overrides:
     ignoreWords:
       - colour
       - canot
+  - filename: '**/*.test.*'
+    dictionaries:
+      - lorem-ipsum
 useGitignore: true
 words:
   - dbaeumer

docs/_includes/generated-docs/commands.md

@@ -19,6 +19,7 @@
 | `cSpell.addWordToWorkspaceSettings`                  | Add Words to Workspace Settings                                                                                 |
 | `cSpell.autoFixSpellingIssues`                       | Fix all issues with a preferred suggestion in the current document.                                             |
 | `cSpell.createCSpellConfig`                          | Create a CSpell Configuration File.                                                                             |
+| `cSpell.createCSpellTerminal`                        | Create CSpell REPL Terminal                                                                                     |
 | `cSpell.createCustomDictionary`                      | Create a Custom Dictionary File.                                                                                |
 | `cSpell.disableCurrentFileType`                      | Disable Spell Checking File Type                                                                                |
 | `cSpell.disableCurrentLanguage`                      | Disable Spell Checking Document Language                                                                        |

docs/_scripts/extract-commands.js → docs/_scripts/extract-commands.mjs

@@ -1,7 +1,10 @@
-// eslint-disable-next-line node/no-unpublished-require
-const package = require('../../package.json');
+import { createRequire } from 'module';
 
-const commands = package.contributes.commands;
+const require = createRequire(import.meta.url);
+
+const pkgJson = require('../../package.json');
+
+const commands = pkgJson.contributes.commands;
 
 const compare = new Intl.Collator().compare;
 

docs/_scripts/package.json

@@ -0,0 +1,6 @@
+{
+  "type": "commonjs",
+  "engines": {
+    "node": ">=18"
+  }
+}

docs/package.json

@@ -11,7 +11,7 @@
     "test": "echo Skip Docs",
     "gen-docs": "npm run gen-config-docs && npm run gen-command-docs && npm run lint",
     "gen-config-docs": "node _scripts/extract-config.mjs > _includes/generated-docs/configuration.md",
-    "gen-command-docs": "node _scripts/extract-commands.js > _includes/generated-docs/commands.md",
+    "gen-command-docs": "node _scripts/extract-commands.mjs > _includes/generated-docs/commands.md",
     "lint": "prettier -w \"**/*.{md,markdown,yaml,yml,json,html,htm,js}\"",
     "serve": "bundle exec jekyll serve"
   },

package.json

@@ -565,6 +565,12 @@
         "category": "Spell",
         "title": "Toggle Trace Mode",
         "icon": "$(search)"
+      },
+      {
+        "command": "cSpell.createCSpellTerminal",
+        "category": "Spell",
+        "title": "Create CSpell REPL Terminal",
+        "icon": "$(terminal)"
       }
     ],
     "languages": [

packages/_server/src/DocumentValidationController.mts

@@ -33,13 +33,21 @@ export class DocumentValidationController {
         return this.docValMap.get(doc.uri);
     }
 
-    getDocumentValidator(docInfo: TextDocumentInfoWithText | TextDocument) {
+    delete(doc: TextDocumentRef) {
+        this.docValMap.delete(doc.uri);
+    }
+
+    getDocumentValidator(docInfo: TextDocumentInfoWithText | TextDocument, cache = true) {
         const uri = docInfo.uri;
         const docValEntry = this.docValMap.get(uri);
-        if (docValEntry) return docValEntry.docVal;
+        if (docValEntry) {
+            return docValEntry.docVal;
+        }
 
         const entry = this.createDocValEntry(docInfo);
-        this.docValMap.set(uri, entry);
+        if (cache) {
+            this.docValMap.set(uri, entry);
+        }
         return entry.docVal;
     }
 
@@ -61,15 +69,18 @@ export class DocumentValidationController {
     }
 
     private handleOnDidClose(e: TextDocumentChangeEvent<TextDocument>) {
-        this.docValMap.delete(e.document.uri);
+        this.delete(e.document);
     }
 
     private handleOnDidChangeContent(e: TextDocumentChangeEvent<TextDocument>) {
         this._handleOnDidChangeContent(e).catch(() => undefined);
     }
 
     private async _handleOnDidChangeContent(e: TextDocumentChangeEvent<TextDocument>) {
-        const { document } = e;
+        await this.updateDocument(e.document);
+    }
+
+    async updateDocument(document: TextDocument) {
         const entry = this.docValMap.get(document.uri);
         if (!entry) return;
         const { settings, docVal } = entry;
@@ -80,6 +91,7 @@ export class DocumentValidationController {
             return;
         }
         await _docVal.updateDocumentText(document.getText());
+        return _docVal;
     }
 }