v0.1.5: debouncing linting attempts

* Updating to latest version of everything
* Removed tests, they aren't really doing anything
* Added new configuration for debounce time on change events
* Added eslint

Author: TravisTheTechie

.eslintrc.js

@@ -0,0 +1,20 @@
+/**@type {import('eslint').Linter.Config} */
+// eslint-disable-next-line no-undef
+module.exports = {
+  root: true,
+  parser: '@typescript-eslint/parser',
+  plugins: [
+    '@typescript-eslint',
+  ],
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+  ],
+  rules: {
+    'semi': [2, "always"],
+    '@typescript-eslint/no-unused-vars': 0,
+    '@typescript-eslint/no-explicit-any': 0,
+    '@typescript-eslint/explicit-module-boundary-types': 0,
+    '@typescript-eslint/no-non-null-assertion': 0,
+  }
+};

.gitignore

@@ -1,3 +1,6 @@
 out
 node_modules
 write-good-linter-*.vsix
+.DS_Store
+package-lock.json
+test.md

.vscode/tasks.json

@@ -8,23 +8,36 @@
 
 // A task runner that calls a custom npm script that compiles the extension.
 {
-	"version": "0.1.0",
+	"version": "2.0.0",
 
 	// we want to run npm
 	"command": "npm",
 
-	// the command is a shell script
-	"isShellCommand": true,
-
-	// show the output window only if unrecognized errors occur.
-	"showOutput": "silent",
-
 	// we run the custom script "compile" as defined in package.json
 	"args": ["run", "compile", "--loglevel", "silent"],
 
 	// The tsc compiler is started in watching mode
-	"isWatching": true,
+	"isBackground": true,
 
 	// use the standard tsc in watch mode problem matcher to find compile problems in the output.
-	"problemMatcher": "$tsc-watch"
+	"problemMatcher": "$tsc-watch",
+	"tasks": [
+		{
+			"label": "npm",
+			"type": "shell",
+			"command": "npm",
+			"args": [
+				"run",
+				"compile",
+				"--loglevel",
+				"silent"
+			],
+			"isBackground": true,
+			"problemMatcher": "$tsc-watch",
+			"group": {
+				"_id": "build",
+				"isDefault": false
+			}
+		}
+	]
 }

README.md

@@ -14,6 +14,8 @@ Press F1 or CTRL+P (or CMD+P) and type out `> ext install travisthetechie.write-
 
 `write-good.only-lint-on-save` disables linting during editing for large files. A save triggers linting. 
 
+`write-good.debounce-time-in-ms` is the minimum time, in milliseconds, that must wait between linting attempts. Saving ignores the minimum time. Default is 200ms. This is useful if linting causes any performance hit and you want to limit it. 
+
 ## License and acknowledgements
 
 This is licensed under the MIT open source license. Do what you want with this software, just include notice that it orginated with me.

package.json

@@ -2,23 +2,32 @@
   "name": "write-good-linter",
   "displayName": "Write Good Linter",
   "description": "Applies the Write Good Linter to your Markdown, so you can write more good.",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "publisher": "travisthetechie",
   "engines": {
-    "vscode": "^1.26.0"
+    "vscode": "^1.89.0"
   },
   "categories": [
     "Linters"
   ],
   "activationEvents": [
-    "*"
+    "onStartupFinished"
   ],
   "main": "./out/src/extension",
   "contributes": {
     "configuration": {
       "type": "object",
       "title": "write-good",
       "properties": {
+        "write-good.debounce-time-in-ms": {
+          "type": [
+            "null",
+            "number"
+          ],
+          "default": 200,
+          "markdownDescription": "Minimum milliseconds between linting attempts. Default is 200ms, increasing this can reduce load when working with large files. Linting on save and load are not rate limited.",
+          "scope": "resouce"
+        },
         "write-good.only-lint-on-save": {
           "type": [ 
             "null", 
@@ -56,19 +65,21 @@
     }
   },
   "scripts": {
-    "vscode:prepublish": "tsc -p ./",
-    "compile": "tsc -p ./",
-    "postinstall": "node ./node_modules/vscode/bin/install"
+		"vscode:prepublish": "npm run compile",
+		"compile": "tsc -p ./",
+		"lint": "eslint \"src/**/*.ts\"",
+		"watch": "tsc -watch -p ./"
   },
   "devDependencies": {
-    "@types/mocha": "^5.2.7",
-    "@types/node": "^10.12.18",
-    "mocha": "^6.2.2",
-    "typescript": "^3.7.4",
-    "vscode": "^1.1.36"
+		"@typescript-eslint/eslint-plugin": "^6.7.0",
+		"@typescript-eslint/parser": "^6.7.0",
+		"eslint": "^8.56.0",
+    "@types/node": "^20.12.12",
+    "@types/vscode": "1.89.0",
+    "typescript": "^5.4.5"
   },
   "dependencies": {
-    "write-good": "^1.0.2"
+    "write-good": "^1.0.8"
   },
   "license": "MIT",
   "repository": {

src/extension.ts

@@ -1,23 +1,24 @@
 'use strict';
 
 import { workspace, ExtensionContext, TextDocument, languages, Uri,
-         Diagnostic, DiagnosticCollection, TextDocumentContentChangeEvent } from 'vscode';
-import { isNullOrUndefined } from 'util';
+         Diagnostic, DiagnosticCollection } from 'vscode';
 import { lintText } from './linter';
 
 let diagnosticCollection: DiagnosticCollection;
 let diagnosticMap: Map<string, Diagnostic[]>;
+let lastLint: Map<string, number>;
 
 export function activate(context: ExtensionContext) {
 
     console.log("Write-Good Linter active...");
     diagnosticCollection = languages.createDiagnosticCollection("Write-Good Lints");
     diagnosticMap = new Map();
+    lastLint = new Map();
 
     if (context == null) return;
 
     function isWriteGoodLanguage(languageId: string) {
-        let wgLanguages: string = workspace.getConfiguration('write-good').get('languages');
+        const wgLanguages: string = workspace.getConfiguration('write-good').get('languages');
         return (wgLanguages.indexOf(languageId) > -1 || wgLanguages === '*');
     }
 
@@ -30,13 +31,25 @@ export function activate(context: ExtensionContext) {
 
     // attempt to only lint changes on motification
     context.subscriptions.push(workspace.onDidChangeTextDocument(event => {
-        if (isWriteGoodLanguage(event.document.languageId)) {
-            // this doesn't work yet, instead, check for a setting?
-            // doPartialLint(event.document, event.contentChanges);
-            const onlyLintOnSave: Boolean = workspace.getConfiguration('write-good').get('only-lint-on-save');
-            if (!onlyLintOnSave) {
-                doLint(event.document);
-            }
+        if (!isWriteGoodLanguage(event.document.languageId)) {
+            // language is unsupported. 
+            return;
+        }
+
+        const onlyLintOnSave: boolean = workspace.getConfiguration('write-good').get('only-lint-on-save');
+        if (onlyLintOnSave) {
+            // not a save event, so don't bother linting
+            return;
+        }
+
+        // debounce linting on editing
+        const debounceMs: number = workspace.getConfiguration('write-good').get('debounce-time-in-ms');
+        const lastLintMs: number = lastLint.get(event.document.uri.toString()) || 0;
+        const nowMs = (new Date()).getTime();
+        if (lastLintMs + debounceMs < nowMs) {
+            // debounce time is less than now, let's do this
+            console.log("LINTING!!!!");
+            doLint(event.document);
         }
     }));
 
@@ -57,7 +70,7 @@ export function activate(context: ExtensionContext) {
 }
 
 export function deactivate() {
-    console.log("Write-Good Linter deactivating...")
+    console.log("Write-Good Linter deactivating...");
 }
 
 function resetDiagnostics() {
@@ -69,41 +82,19 @@ function resetDiagnostics() {
 }
 
 function getWriteGoodConfig() : object {
-    var wgConfig: object = workspace.getConfiguration('write-good').get('write-good-config');
-    if (isNullOrUndefined(wgConfig)) {
+    let wgConfig: object = workspace.getConfiguration('write-good').get('write-good-config');
+    if (wgConfig === undefined || wgConfig === null) {
         wgConfig = {};
     }
     return wgConfig;
 }
 
-function doPartialLint(document: TextDocument, changes: TextDocumentContentChangeEvent[]) {
-    const wgConfig = getWriteGoodConfig();
-    let diagnostics: Diagnostic[] = diagnosticMap.get(document.uri.toString());
-    changes.forEach((changeEvent, index) => {
-        // remove any overlapping diagnostics
-        let toRemove: number[] = [];
-        diagnostics.forEach((diagnostic, index) => {
-            // if the diagnostic range intersects with the change event, we assume the diagnostic should be removed
-            // and will be re-added with the change event.  
-            if (diagnostic.range.intersection(changeEvent.range) != undefined) {
-                toRemove.push(index);
-            }
-        });
-        toRemove.forEach((i) => diagnostics.splice(i, 1));
-
-        // skip linting if there's content
-        if(changeEvent.text.length > 0) {
-            const lineOffset = changeEvent.range.start.line;
-            lintText(changeEvent.text, wgConfig, lineOffset, diagnostics);
-        }
-    });
-}
-
 function doLint(document: TextDocument) {
     const wgConfig = getWriteGoodConfig();
-    let diagnostics: Diagnostic[] = [];
+    const diagnostics: Diagnostic[] = [];
     lintText(document.getText(), wgConfig, 0, diagnostics);
 
     diagnosticMap.set(document.uri.toString(), diagnostics);
+    lastLint.set(document.uri.toString(), (new Date()).getTime());
     resetDiagnostics();
 }

src/linter.ts

@@ -9,12 +9,12 @@ interface Suggestion {
 
 export function lintText(content: string, wgConfig: object, startingLine: number = 0, diagnostics: Diagnostic[] = []) {
     if (content == null) return;
-    let lines = content.split(/\r?\n/g);
+    const lines = content.split(/\r?\n/g);
     lines.forEach((line, lineCount) => {
-        let suggestions : Suggestion[] = WriteGood(line, wgConfig);
-        suggestions.forEach((suggestion, si) => {
-            let start = new Position(lineCount + startingLine, suggestion.index);
-            let end = new Position(lineCount + startingLine, suggestion.index + suggestion.offset);
+        const suggestions : Suggestion[] = WriteGood(line, wgConfig);
+        suggestions.forEach((suggestion) => {
+            const start = new Position(lineCount + startingLine, suggestion.index);
+            const end = new Position(lineCount + startingLine, suggestion.index + suggestion.offset);
             diagnostics.push(new Diagnostic(new Range(start, end), suggestion.reason, DiagnosticSeverity.Warning));
         });
     });