Offline, privacy-first grammar checker. Fast, open-source, Rust-powered
feat(vscode-plugin): add tests for languages supported
Matthew Espino83c273ab8cba
diff --git a/packages/vscode-plugin/src/tests/fixtures/.vscode/settings.json b/packages/vscode-plugin/src/tests/fixtures/.vscode/settings.jsonindex c1b88aaea..231c4441a 100644--- a/packages/vscode-plugin/src/tests/fixtures/.vscode/settings.json+++ b/packages/vscode-plugin/src/tests/fixtures/.vscode/settings.json@@ -1,4 +1,5 @@{+ "files.associations": { "git-commit": "git-commit" },"harper-ls.linters.spell_check": true,"harper-ls.linters.repeated_words": true}diff --git a/packages/vscode-plugin/src/tests/fixtures/languages/c.c b/packages/vscode-plugin/src/tests/fixtures/languages/c.cnew file mode 100644index 000000000..44e74b819--- /dev/null+++ b/packages/vscode-plugin/src/tests/fixtures/languages/c.c@@ -0,0 +1,7 @@+#include <stdio.h>++// Errorz+int main() {+ printf("Hello World!\n");+ return 0;+}diff --git a/packages/vscode-plugin/src/tests/fixtures/languages/cpp.cpp b/packages/vscode-plugin/src/tests/fixtures/languages/cpp.cppnew file mode 100644index 000000000..6a2b96069--- /dev/null+++ b/packages/vscode-plugin/src/tests/fixtures/languages/cpp.cpp@@ -0,0 +1,6 @@+import module std;++int main() {+ /* Errorz */+ std::print("Hello World!\n");+}diff --git a/packages/vscode-plugin/src/tests/fixtures/languages/cpp.h b/packages/vscode-plugin/src/tests/fixtures/languages/cpp.hnew file mode 100644index 000000000..a1357400c--- /dev/null+++ b/packages/vscode-plugin/src/tests/fixtures/languages/cpp.h@@ -0,0 +1 @@+// Errorz\ No newline at end of filediff --git a/packages/vscode-plugin/src/tests/fixtures/languages/csharp.cs b/packages/vscode-plugin/src/tests/fixtures/languages/csharp.csnew file mode 100644index 000000000..28673d5ba--- /dev/null+++ b/packages/vscode-plugin/src/tests/fixtures/languages/csharp.cs@@ -0,0 +1,6 @@+/*++ Errorz++*/+System.Console.WriteLine("Hello World!");diff --git a/packages/vscode-plugin/src/tests/fixtures/languages/git-commit b/packages/vscode-plugin/src/tests/fixtures/languages/git-commitnew file mode 100644index 000000000..f13f44d23--- /dev/null+++ b/packages/vscode-plugin/src/tests/fixtures/languages/git-commit@@ -0,0 +1,9 @@+Errorz++# Please enter the commit message for your changes. Lines starting+# with '#' will be ignored, and an empty message aborts the commit.+#+# On branch main+# Changes to be committed:+# modified: hello-world+#diff --git a/packages/vscode-plugin/src/tests/fixtures/languages/go.go b/packages/vscode-plugin/src/tests/fixtures/languages/go.gonew file mode 100644index 000000000..efe21a5fb--- /dev/null+++ b/packages/vscode-plugin/src/tests/fixtures/languages/go.go@@ -0,0 +1,8 @@+package main++import "fmt"++// Errorz+func main() {+ fmt.Println("Hello World!")+}diff --git a/packages/vscode-plugin/src/tests/fixtures/languages/html.html b/packages/vscode-plugin/src/tests/fixtures/languages/html.htmlnew file mode 100644index 000000000..d9d7cd331--- /dev/null+++ b/packages/vscode-plugin/src/tests/fixtures/languages/html.html@@ -0,0 +1,11 @@+<!doctype html>+<html lang="en">+ <head>+ <meta charset="UTF-8" />+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />+ <title>Hello World!</title>+ </head>+ <body>+ <h1>Errorz</h1>+ </body>+</html>diff --git a/packages/vscode-plugin/src/tests/fixtures/languages/java.java b/packages/vscode-plugin/src/tests/fixtures/languages/java.javanew file mode 100644index 000000000..daee3db56--- /dev/null+++ b/packages/vscode-plugin/src/tests/fixtures/languages/java.java@@ -0,0 +1,8 @@+public class HelloWorld {+ /**+ * @param args Errorz+ */+ public static void main(String[] args) {+ System.out.println("Hello World!");+ }+}diff --git a/packages/vscode-plugin/src/tests/fixtures/languages/javascript.js b/packages/vscode-plugin/src/tests/fixtures/languages/javascript.jsnew file mode 100644index 000000000..413363b71--- /dev/null+++ b/packages/vscode-plugin/src/tests/fixtures/languages/javascript.js@@ -0,0 +1,2 @@+console.log('Hello World!');+// Errorzdiff --git a/packages/vscode-plugin/src/tests/fixtures/languages/javascriptreact.jsx b/packages/vscode-plugin/src/tests/fixtures/languages/javascriptreact.jsxnew file mode 100644index 000000000..fe2f5180e--- /dev/null+++ b/packages/vscode-plugin/src/tests/fixtures/languages/javascriptreact.jsx@@ -0,0 +1,6 @@+/**+ * @param {{message: string}} props Errorz+ */+export default function Main(props = { message: 'Hello World!' }) {+ return <h1>{props.message}</h1>;+}diff --git a/packages/vscode-plugin/src/tests/fixtures/languages/lua.lua b/packages/vscode-plugin/src/tests/fixtures/languages/lua.luanew file mode 100644index 000000000..962730c36--- /dev/null+++ b/packages/vscode-plugin/src/tests/fixtures/languages/lua.lua@@ -0,0 +1 @@+print "Hello World!" -- Errorz\ No newline at end of filediff --git a/packages/vscode-plugin/src/tests/fixtures/languages/nix.nix b/packages/vscode-plugin/src/tests/fixtures/languages/nix.nixnew file mode 100644index 000000000..17a4892cd--- /dev/null+++ b/packages/vscode-plugin/src/tests/fixtures/languages/nix.nix@@ -0,0 +1,2 @@+"Hello World!"+# Errorzdiff --git a/packages/vscode-plugin/src/tests/fixtures/languages/plaintext b/packages/vscode-plugin/src/tests/fixtures/languages/plaintextnew file mode 100644index 000000000..448d8e426--- /dev/null+++ b/packages/vscode-plugin/src/tests/fixtures/languages/plaintext@@ -0,0 +1 @@+Errorz\ No newline at end of filediff --git a/packages/vscode-plugin/src/tests/fixtures/languages/plaintext.txt b/packages/vscode-plugin/src/tests/fixtures/languages/plaintext.txtnew file mode 100644index 000000000..da570e8eb--- /dev/null+++ b/packages/vscode-plugin/src/tests/fixtures/languages/plaintext.txt@@ -0,0 +1,5 @@+++++Errorzdiff --git a/packages/vscode-plugin/src/tests/fixtures/languages/python.py b/packages/vscode-plugin/src/tests/fixtures/languages/python.pynew file mode 100644index 000000000..2389ce27d--- /dev/null+++ b/packages/vscode-plugin/src/tests/fixtures/languages/python.py@@ -0,0 +1,2 @@+print("Hello World!")+# Errorz\ No newline at end of filediff --git a/packages/vscode-plugin/src/tests/fixtures/languages/ruby.rb b/packages/vscode-plugin/src/tests/fixtures/languages/ruby.rbnew file mode 100644index 000000000..b91bbd2cd--- /dev/null+++ b/packages/vscode-plugin/src/tests/fixtures/languages/ruby.rb@@ -0,0 +1,7 @@+puts "Hello World!" =begin+++ Errorz+++=end\ No newline at end of filediff --git a/packages/vscode-plugin/src/tests/fixtures/languages/rust.rs b/packages/vscode-plugin/src/tests/fixtures/languages/rust.rsnew file mode 100644index 000000000..a102eed0a--- /dev/null+++ b/packages/vscode-plugin/src/tests/fixtures/languages/rust.rs@@ -0,0 +1,4 @@+/// Errorz+fn main() {+ println!("Hello World!");+}diff --git a/packages/vscode-plugin/src/tests/fixtures/languages/shellscript b/packages/vscode-plugin/src/tests/fixtures/languages/shellscriptnew file mode 100644index 000000000..57852f414--- /dev/null+++ b/packages/vscode-plugin/src/tests/fixtures/languages/shellscript@@ -0,0 +1,4 @@+#!/usr/bin/env bash++# Errorz+echo "Hello World!"diff --git a/packages/vscode-plugin/src/tests/fixtures/languages/shellscript.bash b/packages/vscode-plugin/src/tests/fixtures/languages/shellscript.bashnew file mode 100644index 000000000..6ef9f6356--- /dev/null+++ b/packages/vscode-plugin/src/tests/fixtures/languages/shellscript.bash@@ -0,0 +1,8 @@+echo "Hello World!"+++++++# Errorzdiff --git a/packages/vscode-plugin/src/tests/fixtures/languages/shellscript.sh b/packages/vscode-plugin/src/tests/fixtures/languages/shellscript.shnew file mode 100644index 000000000..ea7abf69d--- /dev/null+++ b/packages/vscode-plugin/src/tests/fixtures/languages/shellscript.sh@@ -0,0 +1 @@+echo "Hello World!" # Errorzdiff --git a/packages/vscode-plugin/src/tests/fixtures/languages/swift.swift b/packages/vscode-plugin/src/tests/fixtures/languages/swift.swiftnew file mode 100644index 000000000..c96eeded1--- /dev/null+++ b/packages/vscode-plugin/src/tests/fixtures/languages/swift.swift@@ -0,0 +1,22 @@++++++++++ // Errorz++++++++++++print("Hello, World!")\ No newline at end of filediff --git a/packages/vscode-plugin/src/tests/fixtures/languages/toml.toml b/packages/vscode-plugin/src/tests/fixtures/languages/toml.tomlnew file mode 100644index 000000000..8fafc9fdc--- /dev/null+++ b/packages/vscode-plugin/src/tests/fixtures/languages/toml.toml@@ -0,0 +1,3 @@+[hello-world]+# Errorz+output = "Hello World!"diff --git a/packages/vscode-plugin/src/tests/fixtures/languages/typescript.ts b/packages/vscode-plugin/src/tests/fixtures/languages/typescript.tsnew file mode 100644index 000000000..d47d8faf2--- /dev/null+++ b/packages/vscode-plugin/src/tests/fixtures/languages/typescript.ts@@ -0,0 +1 @@+console.log('Hello World!'); // Errorzdiff --git a/packages/vscode-plugin/src/tests/fixtures/languages/typescriptreact.tsx b/packages/vscode-plugin/src/tests/fixtures/languages/typescriptreact.tsxnew file mode 100644index 000000000..4a37c71f6--- /dev/null+++ b/packages/vscode-plugin/src/tests/fixtures/languages/typescriptreact.tsx@@ -0,0 +1,8 @@+export default function Main({ message = 'Hello World!' }: { message: string }) {+ return (+ <h1>+ {/* Errorz */}+ {message}+ </h1>+ );+}diff --git a/packages/vscode-plugin/src/tests/suite/helper.ts b/packages/vscode-plugin/src/tests/suite/helper.tsnew file mode 100644index 000000000..aa5904ae3--- /dev/null+++ b/packages/vscode-plugin/src/tests/suite/helper.ts@@ -0,0 +1,64 @@+import type { Diagnostic, Extension } from 'vscode';++import {+ DiagnosticSeverity,+ extensions,+ languages,+ Position,+ Range,+ Uri,+ window,+ workspace+} from 'vscode';++export async function activateHarper(): Promise<Extension<void>> {+ const harper = extensions.getExtension('elijah-potter.harper')!;++ if (!harper.isActive) {+ await harper.activate();+ }++ return harper;+}++export async function openFile(...pathSegments: string[]): Promise<Uri> {+ const uri = Uri.joinPath(Uri.file(workspace.workspaceFolders![0].uri.path), ...pathSegments);+ await window.showTextDocument(await workspace.openTextDocument(uri));+ return uri;+}++export function getActualDiagnostics(resource: Uri): Diagnostic[] {+ return languages.getDiagnostics(resource).filter((d) => d.source === 'Harper');+}++export function createExpectedDiagnostics(+ ...data: { message: string; range: Range }[]+): Diagnostic[] {+ return data.map((d) => ({ ...d, source: 'Harper', severity: DiagnosticSeverity.Information }));+}++export function compareActualVsExpectedDiagnostics(+ actual: Diagnostic[],+ expected: Diagnostic[]+): void {+ expect(actual.length).toBe(expected.length);+ for (let i = 0; i < actual.length; i++) {+ expect(actual[i].source).toBe(expected[i].source);+ expect(actual[i].message).toBe(expected[i].message);+ expect(actual[i].severity).toBe(expected[i].severity);+ expect(actual[i].range).toEqual(expected[i].range);+ }+}++export function createRange(+ startRow: number,+ startColumn: number,+ endRow: number,+ endColumn: number+): Range {+ return new Range(new Position(startRow, startColumn), new Position(endRow, endColumn));+}++export function sleep(duration: number): Promise<void> {+ return new Promise((resolve) => setTimeout(resolve, duration));+}diff --git a/packages/vscode-plugin/src/tests/suite/integration.test.ts b/packages/vscode-plugin/src/tests/suite/integration.test.tsindex b4c341b25..594752306 100644--- a/packages/vscode-plugin/src/tests/suite/integration.test.ts+++ b/packages/vscode-plugin/src/tests/suite/integration.test.ts@@ -1,30 +1,25 @@import type { Extension } from 'vscode';+import { ConfigurationTarget, Uri, workspace } from 'vscode';+import {- ConfigurationTarget,- Diagnostic,- DiagnosticSeverity,- extensions,- languages,- Position,- Range,- Uri,- window,- workspace-} from 'vscode';+ activateHarper,+ compareActualVsExpectedDiagnostics,+ createExpectedDiagnostics,+ createRange,+ getActualDiagnostics,+ openFile,+ sleep+} from './helper';-describe('Harper Extension', () => {+describe('Integration >', () => {let harper: Extension<void>;- let documentUri: Uri;+ let markdownUri: Uri;beforeAll(async () => {- harper = extensions.getExtension('elijah-potter.harper')!;- await harper.activate();-+ harper = await activateHarper();// Open test file so diagnostics can occur- documentUri = Uri.joinPath(Uri.file(workspace.workspaceFolders![0].uri.path), 'integration.md');- await window.showTextDocument(await workspace.openTextDocument(documentUri));-+ markdownUri = await openFile('integration.md');// Wait for `harper-ls` to startawait sleep(500);});@@ -34,60 +29,36 @@ describe('Harper Extension', () => {});it('gives correct diagnostics', () => {- const actual = languages.getDiagnostics(documentUri);- const expected: Diagnostic[] = [- {- source: 'Harper',- message: 'Did you mean to repeat this word?',- severity: DiagnosticSeverity.Information,- range: new Range(new Position(2, 39), new Position(2, 48))- },- {- source: 'Harper',- message: 'Did you mean to spell “errorz” this way?',- severity: DiagnosticSeverity.Information,- range: new Range(new Position(2, 26), new Position(2, 32))- }- ];-- expect(actual.length).toBe(expected.length);- for (let i = 0; i < actual.length; i++) {- expect(actual[i].source).toBe(expected[i].source);- expect(actual[i].message).toBe(expected[i].message);- expect(actual[i].severity).toBe(expected[i].severity);- expect(actual[i].range).toEqual(expected[i].range);- }+ compareActualVsExpectedDiagnostics(+ getActualDiagnostics(markdownUri),+ createExpectedDiagnostics(+ {+ message: 'Did you mean to repeat this word?',+ range: createRange(2, 39, 2, 48)+ },+ {+ message: 'Did you mean to spell “errorz” this way?',+ range: createRange(2, 26, 2, 32)+ }+ )+ );});it('updates diagnostics on configuration change', async () => {const config = workspace.getConfiguration('harper-ls.linters');await config.update('repeated_words', false, ConfigurationTarget.Workspace);- // Wait for `harper-ls` to restart+ // Wait for `harper-ls` to restart and send new diagnosticsawait sleep(1000);- const actual = languages.getDiagnostics(documentUri);- const expected: Diagnostic[] = [- {- source: 'Harper',+ compareActualVsExpectedDiagnostics(+ getActualDiagnostics(markdownUri),+ createExpectedDiagnostics({message: 'Did you mean to spell “errorz” this way?',- severity: DiagnosticSeverity.Information,- range: new Range(new Position(2, 26), new Position(2, 32))- }- ];-- expect(actual.length).toBe(expected.length);- for (let i = 0; i < actual.length; i++) {- expect(actual[i].source).toBe(expected[i].source);- expect(actual[i].message).toBe(expected[i].message);- expect(actual[i].severity).toBe(expected[i].severity);- expect(actual[i].range).toEqual(expected[i].range);- }+ range: createRange(2, 26, 2, 32)+ })+ );// Set config back to default valueawait config.update('repeated_words', true, ConfigurationTarget.Workspace);});});--function sleep(duration: number) {- return new Promise((resolve) => setTimeout(resolve, duration));-}diff --git a/packages/vscode-plugin/src/tests/suite/languages.test.ts b/packages/vscode-plugin/src/tests/suite/languages.test.tsnew file mode 100644index 000000000..cf931a947--- /dev/null+++ b/packages/vscode-plugin/src/tests/suite/languages.test.ts@@ -0,0 +1,65 @@+import {+ activateHarper,+ compareActualVsExpectedDiagnostics,+ createExpectedDiagnostics,+ createRange,+ getActualDiagnostics,+ openFile,+ sleep+} from './helper';++describe('Languages >', () => {+ beforeAll(async () => {+ await activateHarper();+ // Wait for `harper-ls` to start+ await sleep(500);+ });++ [+ // Uncomment when #265 is fixed.+ // { type: 'JavaScript JSX', file: 'javascriptreact.jsx', row: 1, column: 36 },+ // Uncomment when #65 is fixed.+ // { type: 'Shellscript without extension', file: 'shellscript', row: 2, column: 2 },++ // VSCode doesn't support Nix and TOML files out of the box. Uncomment when you figure out how+ // to support them during testing.+ // { type: 'Nix', file: 'nix.nix', row: 1, column: 2 },+ // { type: 'TOML', file: 'toml.toml', row: 1, column: 2 },++ { type: 'C', file: 'c.c', row: 2, column: 3 },+ { type: 'C++', file: 'cpp.cpp', row: 3, column: 5 },+ { type: 'H', file: 'cpp.h', row: 0, column: 3 },+ { type: 'C#', file: 'csharp.cs', row: 2, column: 2 },+ { type: 'Git Commit', file: 'git-commit', row: 0, column: 0 },+ { type: 'Go', file: 'go.go', row: 4, column: 4 },+ { type: 'HTML', file: 'html.html', row: 8, column: 6 },+ { type: 'Java', file: 'java.java', row: 2, column: 17 },+ { type: 'JavaScript', file: 'javascript.js', row: 1, column: 3 },+ { type: 'Lua', file: 'lua.lua', row: 0, column: 24 },+ { type: 'Plaintext without extension', file: 'plaintext', row: 0, column: 0 },+ { type: 'Plaintext with extension', file: 'plaintext.txt', row: 4, column: 0 },+ { type: 'Python', file: 'python.py', row: 1, column: 2 },+ { type: 'Ruby', file: 'ruby.rb', row: 3, column: 16 },+ { type: 'Rust', file: 'rust.rs', row: 0, column: 4 },+ { type: 'Shellscript with .bash extension', file: 'shellscript.bash', row: 7, column: 9 },+ { type: 'Shellscript with .sh extension', file: 'shellscript.sh', row: 0, column: 22 },+ { type: 'Swift', file: 'swift.swift', row: 9, column: 26 },+ { type: 'TypeScript', file: 'typescript.ts', row: 0, column: 32 },+ { type: 'TypeScript JSX', file: 'typescriptreact.tsx', row: 3, column: 7 }+ ].forEach((testCase) => {+ it(`gives correct diagnostics for ${testCase.type} files`, async () => {+ const uri = await openFile('languages', testCase.file);++ // Wait for `harper-ls` to send diagnostics+ await sleep(50);++ compareActualVsExpectedDiagnostics(+ getActualDiagnostics(uri),+ createExpectedDiagnostics({+ message: 'Did you mean to spell “Errorz” this way?',+ range: createRange(testCase.row, testCase.column, testCase.row, testCase.column + 6)+ })+ );+ });+ });+});diff --git a/packages/vscode-plugin/tsconfig.json b/packages/vscode-plugin/tsconfig.jsonindex b73cdba1d..37e2d068b 100644--- a/packages/vscode-plugin/tsconfig.json+++ b/packages/vscode-plugin/tsconfig.json@@ -1,4 +1,5 @@{+ "exclude": ["src/tests/fixtures"],"compilerOptions": {"module": "Node16","target": "ES2022",