fix: Issues relating to the RegExp Tester (#558)

* Add overrides to improve spell checker speed * fix: do not show Test command if view not enabled. * Update cspell-words.txt * fix: be able to match against regexp as well as name. * fix: trim long names. * fix: only perform actions when regex view is turned on.
streetsidesoftware · Sep 27, 2020 · 176c016 · 176c016
1 parent d782f72
commit 176c016
Show file tree

Hide file tree

Showing 6 changed files with 78 additions and 43 deletions.
diff --git a/cspell-words.txt b/cspell-words.txt
@@ -29,6 +29,7 @@ devtools
 dict
 disqus
 downlevel
+enablement
 endhighlight
 envs
 gemfiles

diff --git a/packages/_server/src/PatternMatcher.ts b/packages/_server/src/PatternMatcher.ts
@@ -124,7 +124,7 @@ function resolvePattern(pat: string | NamedPattern, knownPatterns: Map<string, P
     if (isNamedPattern(pat)) {
         return {...pat, regexp: toRegExp(pat.regexp)};
     }
-    return knownPatterns.get(pat.toLowerCase()) || ({ name: pat, regexp: toRegExp(pat, 'g')});
+    return knownPatterns.get(pat) || knownPatterns.get(pat.toLowerCase()) || ({ name: pat, regexp: toRegExp(pat, 'g')});
 }
 
 function isNamedPattern(pattern: string | NamedPattern): pattern is NamedPattern {

diff --git a/packages/_server/src/server.ts b/packages/_server/src/server.ts
@@ -58,9 +58,35 @@ const tds = CSpell;
 
 const defaultCheckLimit = Validator.defaultCheckLimit;
 
+export const regExSpellingGuardBlock = /(\bc?spell(?:-?checker)?::?)\s*disable(?!-line|-next)\b[\s\S]*?((?:\1\s*enable\b)|$)/gi;
+export const regExSpellingGuardNext = /\bc?spell(?:-?checker)?::?\s*disable-next\b.*\s.*/gi;
+export const regExSpellingGuardLine = /^.*\bc?spell(?:-?checker)?::?\s*disable-line\b.*/gim;
+
+
 const overRideDefaults: CSpellUserSettings = {
+    id: 'Extension overrides',
     patterns: [
+        {
+            // Turn off the build-in expression by matching the beginning of the doc.
+            name: 'SpellCheckerDisable',
+            pattern: /^(?=.?)/,
+        },
+        {
+            name: 'SpellCheckerDisableBlock',
+            pattern: regExSpellingGuardBlock,
+        },
+        {
+            name: 'SpellCheckerDisableNext',
+            pattern: regExSpellingGuardNext,
+        },
+        {
+            name: 'SpellCheckerDisableLine',
+            pattern: regExSpellingGuardLine,
+        },
     ],
+    ignoreRegExpList: [
+        'SpellCheckerDisableBlock', 'SpellCheckerDisableNext', 'SpellCheckerDisableLine',
+    ]
 };
 
 // Turn off the spell checker by default. The setting files should have it set.

diff --git a/packages/client/package.json b/packages/client/package.json
@@ -60,7 +60,14 @@
                     "when": "editorTextFocus && config.cSpell.showCommandsInEditorContextMenu",
                     "group": "A_cspell@9"
                 }
-            ]
+            ],
+            "commandPalette": [
+                {
+                  "command": "cSpellRegExpTester.testRegExp",
+                  "title": "Test a Regular Expression on the current document X.",
+                  "when": "config.cSpell.experimental.enableRegexpView"
+                }
+              ]
         },
         "views": {
             "explorer": [

diff --git a/packages/client/src/extensionRegEx/RegexpOutlineProvider.ts b/packages/client/src/extensionRegEx/RegexpOutlineProvider.ts
@@ -1,5 +1,5 @@
 import * as vscode from 'vscode';
-import { MatchPatternsToDocumentResult, PatternMatch } from '../server';
+import { PatternMatch } from '../server';
 
 export class RegexpOutlineProvider implements vscode.TreeDataProvider<OutlineItem> {
 
@@ -52,7 +52,7 @@ function createCategoryItem(category: string, matches: PatternMatch[]): OutlineI
 }
 
 function createLeaf(offset: PatternMatch): OutlineItem {
-	const treeItem = new vscode.TreeItem(offset.name);
+	const treeItem = new vscode.TreeItem(trimName(offset.name));
 	const timeMs = offset.elapsedTime.toFixed(2);
 	const msg = offset.message ? ' ' + offset.message : ''
 	const parts = [
@@ -74,3 +74,11 @@ function createLeaf(offset: PatternMatch): OutlineItem {
 
 	return item;
 }
+
+function trimName(name: string) {
+	const maxLen = 50;
+	if (name.length <= maxLen) {
+		return name;
+	}
+	return name.substr(0, maxLen - 1) + '…';
+}
diff --git a/packages/client/src/extensionRegEx/extensionRegEx.ts b/packages/client/src/extensionRegEx/extensionRegEx.ts
@@ -8,14 +8,8 @@ interface DisposableLike {
 	dispose(): any;
 }
 
-interface InProgress {
-	activeEditor: vscode.TextEditor;
-	document: vscode.TextDocument;
-	version: number;
-}
-
 // this method is called when vs code is activated
-export function activate(context: vscode.ExtensionContext, client: CSpellClient) {
+export function activate(context: vscode.ExtensionContext, client: CSpellClient): void {
 
     const statusBar = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Left);
 
@@ -43,31 +37,23 @@ export function activate(context: vscode.ExtensionContext, client: CSpellClient)
 		}
 	});
 
-	let activeEditor = vscode.window.activeTextEditor;
-	let pattern: string | undefined = '/\\w+/';
-
 	let isActive = fetchIsEnabledFromConfig();
 
+	let activeEditor = isActive ? vscode.window.activeTextEditor : undefined;
+	let pattern: string | undefined = undefined;
+
 	async function updateDecorations() {
 		disposeCurrent();
-		if (!isActive) {
-			activeEditor?.setDecorations(decorationTypeExclude, []);
-			statusBar.hide();
+		if (!isActive || !activeEditor) {
+			clearDecorations();
 			return;
 		}
 
-		if (!activeEditor) {
-			return;
-		}
-		if (!pattern) {
-			activeEditor.setDecorations(decorationTypeExclude, []);
-			statusBar.hide();
-			return;
-		}
+		const userPatterns = pattern ? [pattern] : [];
 		const document = activeEditor.document;
 		const version = document.version;
 		const config = await client.getConfigurationForDocument(document);
-		const extractedPatterns = extractPatternsFromConfig(config.docSettings, [pattern]);
+		const extractedPatterns = extractPatternsFromConfig(config.docSettings, userPatterns);
 		const patterns = extractedPatterns.map(p => p.pattern);
 
 		client.matchPatternsInDocument(document, patterns).then(result => {
@@ -110,6 +96,11 @@ export function activate(context: vscode.ExtensionContext, client: CSpellClient)
 		});
 	}
 
+	function clearDecorations() {
+		activeEditor?.setDecorations(decorationTypeExclude, []);
+		statusBar.hide();
+	}
+
 	function createHoverMessage(match: PatternMatch) {
 		const r = (new vscode.MarkdownString())
 			.appendText(match.name + ' ' + match.elapsedTime.toFixed(2) + 'ms');
@@ -131,7 +122,7 @@ export function activate(context: vscode.ExtensionContext, client: CSpellClient)
 	}
 
 	function updateStatusBar(pattern: string | undefined, info?: StatusBarInfo) {
-		if (pattern) {
+		if (isActive && pattern) {
 			const { elapsedTime, count = 0 } = info || {};
 			const time = elapsedTime ? `${elapsedTime.toFixed(2)}ms` : '$(clock)';
 			statusBar.text = `${time} | ${pattern}`;
@@ -148,14 +139,16 @@ export function activate(context: vscode.ExtensionContext, client: CSpellClient)
 	}
 
 	vscode.window.onDidChangeActiveTextEditor(editor => {
-		activeEditor = editor;
-		if (editor) {
-			triggerUpdateDecorations();
+		if (isActive) {
+			activeEditor = editor;
+			if (editor) {
+				triggerUpdateDecorations();
+			}
 		}
 	}, null, context.subscriptions);
 
 	vscode.workspace.onDidChangeTextDocument(event => {
-		if (activeEditor && event.document === activeEditor.document) {
+		if (isActive && activeEditor && event.document === activeEditor.document) {
 			triggerUpdateDecorations();
 		}
 	}, null, context.subscriptions);
@@ -179,17 +172,7 @@ export function activate(context: vscode.ExtensionContext, client: CSpellClient)
 			value: pattern?.toString(),
 			validateInput
 		}).then(value => {
-			if (!value) {
-				pattern = undefined;
-				triggerUpdateDecorations();
-				return;
-			}
-			try {
-				pattern = value;
-			} catch (e) {
-				vscode.window.showWarningMessage(e.toString());
-				pattern = undefined;
-			}
+			pattern = value ? value : undefined;
 			triggerUpdateDecorations();
 		});
 	}
@@ -204,7 +187,17 @@ export function activate(context: vscode.ExtensionContext, client: CSpellClient)
 	}
 
 	function updateIsActive() {
+		const currentIsActive = isActive;
 		isActive = fetchIsEnabledFromConfig();
+		if (currentIsActive == isActive) {
+			return;
+		}
+		if (isActive) {
+			activeEditor = vscode.window.activeTextEditor;
+			triggerUpdateDecorations();
+		} else {
+			clearDecorations();
+		}
 	}
 
 	function dispose() {
@@ -244,5 +237,5 @@ function extractPatternsFromConfig(config: CSpellUserSettings | undefined, userP
 
 function fetchIsEnabledFromConfig(): boolean {
 	const cfg = vscode.workspace.getConfiguration('cSpell');
-	return !!cfg && !!cfg.get('experimental.enableRegexpView');
+	return !!cfg?.get('experimental.enableRegexpView');
 }