Support (Neo)Vim by coc.nvim

.github/workflows/node.js.yml

@@ -26,6 +26,6 @@ jobs:
       with:
         node-version: ${{ matrix.node-version }}
         cache: 'npm'
-    - run: npm ci
+    - run: npm ci --force
     - run: npm run compile
     - run: npm run lint

.gitignore

@@ -1,5 +1,6 @@
+*.tgz
 out
 node_modules
 write-good-linter-*.vsix
 .DS_Store
-test.md
+test.md

.npmignore

@@ -0,0 +1,3 @@
+/*
+!/out/
+*.map

README.md

@@ -1,9 +1,25 @@
 # Write Good Linter for Visual Studio Code
 
-Provides a [write-good](https://github.com/btford/write-good) linter extension for [Visual Studio Code](https://code.visualstudio.com/).
+Provides a [write-good](https://github.com/btford/write-good) linter extension for [Visual Studio Code](https://code.visualstudio.com/)
+and (Neo)Vim.
 
 ## Installation
 
+### (Neo)Vim
+
+- [coc-marketplace](https://github.com/fannheyward/coc-marketplace)
+- [npm](https://www.npmjs.com/package/write-good-linter)
+- vim:
+
+```vim
+" command line
+CocInstall write-good-linter
+" or add the following code to your vimrc
+let g:coc_global_extensions = ['write-good-linter', 'other coc-plugins']
+```
+
+### VS Code
+
 Press F1 or CTRL+P (or CMD+P) and type out `> ext install travisthetechie.write-good-linter`. Check out the latest published version on the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=travisthetechie.write-good-linter).
 
 ## Settings

eslint.config.mjs

@@ -32,4 +32,4 @@ export default [
             "@typescript-eslint/no-non-null-assertion": 0,
         },
     },
-];
+];

package.json

@@ -5,15 +5,19 @@
   "version": "0.1.6",
   "publisher": "travisthetechie",
   "engines": {
+    "coc": "^0.0.82",
     "vscode": "^1.95.0"
   },
+  "keywords": [
+    "coc.nvim"
+  ],
   "categories": [
     "Linters"
   ],
   "activationEvents": [
-    "onStartupFinished"
+    "*"
   ],
-  "main": "./out/src/extension",
+  "main": "./out/src/extension.js",
   "contributes": {
     "configuration": {
       "type": "object",
@@ -75,6 +79,7 @@
     "@eslint/js": "^9.15.0",
     "@types/node": "^22.9.3",
     "@types/vscode": "1.95.0",
+    "coc.nvim": "^0.0.83-next.18",
     "@types/write-good": "1.0.3",
     "@typescript-eslint/eslint-plugin": "^8.15.0",
     "@typescript-eslint/parser": "^8.15.0",

src/extension.ts

@@ -1,5 +1,30 @@
-import { workspace, ExtensionContext, TextDocument, languages, Uri,
-         Diagnostic, DiagnosticCollection } from 'vscode';
+import type {
+    ExtensionContext as ExtensionContext_vscode,
+    TextDocument as TextDocument_vscode,
+    Diagnostic as Diagnostic_vscode,
+    DiagnosticCollection as DiagnosticCollection_vscode,
+} from 'vscode';
+import type {
+    ExtensionContext as ExtensionContext_coc,
+    TextDocument as TextDocument_coc,
+    Diagnostic as Diagnostic_coc,
+    DiagnosticCollection as DiagnosticCollection_coc,
+} from 'coc.nvim';
+type ExtensionContext = ExtensionContext_vscode | ExtensionContext_coc;
+type TextDocument = TextDocument_vscode | TextDocument_coc;
+type Diagnostic = Diagnostic_vscode | Diagnostic_coc;
+type DiagnosticCollection = DiagnosticCollection_vscode | DiagnosticCollection_coc;
+let vscode;
+try {
+    vscode = require('vscode');  // eslint-disable-line
+} catch (error) {
+    vscode = require('coc.nvim');  // eslint-disable-line
+}
+const workspace = vscode.workspace;
+const languages = vscode.languages;
+const Uri = vscode.Uri;
+
+
 import { lintText } from './linter';
 
 let diagnosticCollection: DiagnosticCollection;
@@ -27,10 +52,25 @@ export function activate(context: ExtensionContext) {
         }
     }));
 
+    function didOpenTextDocument(document: TextDocument) {
+        if (isWriteGoodLanguage(document.languageId)) {
+            doLint(document);
+        }
+    }
+
+    context.subscriptions.push(workspace.onDidOpenTextDocument(didOpenTextDocument));
+    workspace.documents.map((doc) => {
+        didOpenTextDocument(doc.textDocument);
+    });
+
     // attempt to only lint changes on motification
     context.subscriptions.push(workspace.onDidChangeTextDocument(event => {
-        if (!isWriteGoodLanguage(event.document.languageId)) {
-            // language is unsupported. 
+        try {
+            if (!isWriteGoodLanguage(event.document.languageId)) {
+                // language is unsupported. 
+                return;
+            }
+        } catch (error) {
             return;
         }
 
@@ -75,7 +115,13 @@ function resetDiagnostics() {
     diagnosticCollection.clear();
 
     diagnosticMap.forEach((diags, file) => {
-        diagnosticCollection.set(Uri.parse(file), diags);
+        try {
+            // @ts-expect-error: for vscode
+            diagnosticCollection.set(Uri.parse(file), diags);
+        } catch (e) {
+            // @ts-expect-error: for coc.nvim
+            diagnosticCollection.set(Uri.parse(file).path, diags);
+        }
     });
 }
 
@@ -95,4 +141,4 @@ function doLint(document: TextDocument) {
     diagnosticMap.set(document.uri.toString(), diagnostics);
     lastLint.set(document.uri.toString(), (new Date()).getTime());
     resetDiagnostics();
-}
+}

src/linter.ts

@@ -1,4 +1,16 @@
-import { Diagnostic, DiagnosticSeverity, Range, Position } from 'vscode';
+import type { Diagnostic as Diagnostic_vscode } from 'vscode';
+import type { Diagnostic as Diagnostic_coc } from 'coc.nvim';
+type Diagnostic = Diagnostic_vscode | Diagnostic_coc;
+let vscode;
+try {
+    vscode = require('vscode');
+} catch (error) {
+    vscode = require('coc.nvim');
+}
+const DiagnosticSeverity = vscode.DiagnosticSeverity;
+const Range = vscode.Range;
+const Position = vscode.Position;
+const Diagnostic = vscode.Diagnostic;
 import * as WriteGood from 'write-good';
 
 interface Suggestion {
@@ -13,9 +25,15 @@
     lines.forEach((line, lineCount) => {
         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));
+            try {
+                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));
+            } catch (e) {
+              const start = Position.create(lineCount + startingLine, suggestion.index);
+              const end = Position.create(lineCount + startingLine, suggestion.index + suggestion.offset);
+              diagnostics.push(Diagnostic.create(Range.create(start, end), suggestion.reason, DiagnosticSeverity.Warning));
+            }
         });
     });
-}
+}

tsconfig.json

@@ -4,11 +4,12 @@
 		"target": "es6",
 		"outDir": "out",
 		"lib": [ "es6", "dom" ],
+		"allowSyntheticDefaultImports": true,
 		"sourceMap": true,
         "rootDir": "."
 	},
 	"exclude": [
 		"node_modules",
 		".vscode-test"
 	]
-}
+}