* Adding only-lint-on-save configuration.

* Seemed to have messed up configuration last release; fixing. I was following
  instructions in the console, so not sure how I ended up down the wrong path.
* Refactored some of the code to help support the future path of having partial
  linting.
* Added some tests after the refactor. I could still use more tests around
  release documents, but I don't know how to drive those from tesets currently.

Author: TravisTheTechie

.vscodeignore

@@ -7,3 +7,4 @@ src/**
 .gitignore
 tsconfig.json
 vsc-extension-quickstart.md
+write-good-linter-*.vsix

README.md

@@ -12,6 +12,8 @@ Press F1 or CTRL+P (or CMD+P) and type out `> ext install travisthetechie.write-
 
 `write-good.write-good-config` is a direct pass through to the underlying [write-good](https://github.com/btford/write-good) engine. To enable eprime check and disable check for so at the start of sentance, add `"write-good.write-good-config": { "eprime": true, "so": false }` to your settings.
 
+`write-good.only-lint-on-save` disables linting during editing for large files. A save triggers linting. 
+
 ## 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,7 +2,7 @@
   "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.3",
+  "version": "0.1.4",
   "publisher": "travisthetechie",
   "engines": {
     "vscode": "^1.26.0"
@@ -19,6 +19,15 @@
       "type": "object",
       "title": "write-good",
       "properties": {
+        "write-good.only-lint-on-save": {
+          "type": [ 
+            "null", 
+            "boolean" 
+          ],
+          "default": false,
+          "markdownDescription": "Disables linting during editing for large files. A save triggers linting.",
+          "scope": "resource"
+        },
         "write-good.write-good-config": {
           "type": [
             "object",
@@ -48,7 +57,7 @@
   },
   "scripts": {
     "vscode:prepublish": "tsc -p ./",
-    "compile": "tsc -watch -p ./",
+    "compile": "tsc -p ./",
     "postinstall": "node ./node_modules/vscode/bin/install"
   },
   "devDependencies": {

src/extension.ts

@@ -1,9 +1,9 @@
 'use strict';
 
 import { workspace, ExtensionContext, TextDocument, languages, Uri,
-         Diagnostic, DiagnosticSeverity, Range, Position, DiagnosticCollection } from 'vscode';
-import * as WriteGood from 'write-good';
+         Diagnostic, DiagnosticCollection, TextDocumentContentChangeEvent } from 'vscode';
 import { isNullOrUndefined } from 'util';
+import { lintText } from './linter';
 
 let diagnosticCollection: DiagnosticCollection;
 let diagnosticMap: Map<string, Diagnostic[]>;
@@ -14,23 +14,40 @@ export function activate(context: ExtensionContext) {
     diagnosticCollection = languages.createDiagnosticCollection("Write-Good Lints");
     diagnosticMap = new Map();
 
-    function isWriteGoodLanguage(languageId) {
+    if (context == null) return;
+
+    function isWriteGoodLanguage(languageId: string) {
         let wgLanguages: string = workspace.getConfiguration('write-good').get('languages');
         return (wgLanguages.indexOf(languageId) > -1 || wgLanguages === '*');
     }
 
+    // full lint when document is saved
+    context.subscriptions.push(workspace.onDidSaveTextDocument(document => {
+        if (isWriteGoodLanguage(document.languageId)) {
+            doLint(document);
+        }
+    }));
+
+    // attempt to only lint changes on motification
     context.subscriptions.push(workspace.onDidChangeTextDocument(event => {
         if (isWriteGoodLanguage(event.document.languageId)) {
-            doLint(event.document);
+            // 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);
+            }
         }
     }));
 
+    // full lint on a new document/opened document
     context.subscriptions.push(workspace.onDidOpenTextDocument(event => {
         if (isWriteGoodLanguage(event.languageId)) {
             doLint(event);
         }
     }));
 
+    // clean up any lints when the document is closed
     context.subscriptions.push(workspace.onDidCloseTextDocument(event => {
         if (diagnosticMap.has(event.uri.toString())) {
             diagnosticMap.delete(event.uri.toString());
@@ -43,12 +60,6 @@ export function deactivate() {
     console.log("Write-Good Linter deactivating...")
 }
 
-interface Suggestion {
-    index: number,
-    offset: number,
-    reason: string
-}
-
 function resetDiagnostics() {
     diagnosticCollection.clear();
 
@@ -57,21 +68,41 @@ function resetDiagnostics() {
     });
 }
 
-function doLint(document: TextDocument) {
-    var wgConfig: object = workspace.getConfiguration('write-good').get('write-good.write-good-config');
+function getWriteGoodConfig() : object {
+    var wgConfig: object = workspace.getConfiguration('write-good').get('write-good-config');
     if (isNullOrUndefined(wgConfig)) {
         wgConfig = {};
     }
-    let diagnostics: Diagnostic[] = [];
-    let lines = document.getText().split(/\r?\n/g);
-    lines.forEach((line, lineCount) => {
-        let suggestions : Suggestion[] = WriteGood(line, wgConfig);
-        suggestions.forEach((suggestion, si) => {
-            let start = new Position(lineCount, suggestion.index);
-            let end = new Position(lineCount, suggestion.index + suggestion.offset);
-            diagnostics.push(new Diagnostic(new Range(start, end), suggestion.reason, DiagnosticSeverity.Warning));
+    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[] = [];
+    lintText(document.getText(), wgConfig, 0, diagnostics);
 
     diagnosticMap.set(document.uri.toString(), diagnostics);
     resetDiagnostics();

src/linter.ts

@@ -0,0 +1,21 @@
+import { Diagnostic, DiagnosticSeverity, Range, Position } from 'vscode';
+import * as WriteGood from 'write-good';
+
+interface Suggestion {
+    index: number,
+    offset: number,
+    reason: string
+}
+
+export function lintText(content: string, wgConfig: object, startingLine: number = 0, diagnostics: Diagnostic[] = []) {
+    if (content == null) return;
+    let 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);
+            diagnostics.push(new Diagnostic(new Range(start, end), suggestion.reason, DiagnosticSeverity.Warning));
+        });
+    });
+}

test/extension.test.ts

@@ -0,0 +1,43 @@
+// 
+// Note: This example test is leveraging the Mocha test framework.
+// Please refer to their documentation on https://mochajs.org/ for help.
+//
+
+// The module 'assert' provides assertion methods from node
+import * as assert from 'assert';
+
+// You can import and use all API from the 'vscode' module
+// as well as import your extension to test it
+import { Diagnostic } from 'vscode';
+import * as linter from '../src/linter';
+
+suite("Linter Tests", () => {
+
+	let wgConfig = {};
+	let diagonstics: Diagnostic[] = [];
+
+	test("Linter accepts empty text", () => {
+		diagonstics = [];
+		linter.lintText("", wgConfig, 0, diagonstics);
+
+		assert.strictEqual(diagonstics.length, 0);
+	});
+
+	test("Linter accepts null text", () => {
+		diagonstics = [];
+		linter.lintText(null, wgConfig, 0, diagonstics);
+
+		assert.strictEqual(diagonstics.length, 0);
+	});
+
+	test("Expect diagonstics from input text", () => {
+		const text = "This is licensed under the MIT open source license.";
+		diagonstics = [];
+		linter.lintText(text, wgConfig, 0, diagonstics);
+
+		// find 'is licensed'
+		assert.strictEqual(diagonstics.length, 1);
+		assert.strictEqual(diagonstics[0].range.start.character, 5);
+		assert.strictEqual(diagonstics[0].range.end.character, 16);
+	});
+});