chore: update CI workflow and testing setup, add unit tests for erbBlock

Author: kudoas

.github/workflows/ci.yml

@@ -19,4 +19,5 @@ jobs:
       - run: gem install ruby-lsp
       - run: bun install
       - run: bun run build
+      - run: bun run test
       - run: xvfb-run -a bun run test:e2e

bun.lock

@@ -51,8 +51,9 @@
   "scripts": {
     "build": "bun x tsc -p tsconfig.json",
     "watch": "bun x tsc -w -p tsconfig.json",
-    "pretest": "bun x tsc -p tsconfig.json",
-    "test": "bun run test:e2e",
+    "test": "NODE_OPTIONS=--disable-warning=MODULE_TYPELESS_PACKAGE_JSON TS_NODE_PROJECT=tsconfig.test.json bun x mocha --ui tdd --require ts-node/register --extension ts \"src/test/unit/**/*.test.ts\"",
+    "test:watch": "NODE_OPTIONS=--disable-warning=MODULE_TYPELESS_PACKAGE_JSON TS_NODE_PROJECT=tsconfig.test.json bun x mocha --ui tdd --require ts-node/register --extension ts --watch --watch-files \"src/**/*.ts\" \"src/test/unit/**/*.test.ts\"",
+    "pretest:e2e": "bun x tsc -p tsconfig.json",
     "test:e2e": "node ./dist/test/runTest.js"
   },
   "packageManager": "bun@1.3.5",
@@ -65,6 +66,7 @@
     "@types/node": "^25.0.3",
     "@types/vscode": "^1.107.0",
     "@vscode/test-electron": "^2.4.3",
-    "mocha": "^10.8.2"
+    "mocha": "^10.8.2",
+    "ts-node": "^10.9.2"
   }
 }

package.json

@@ -1,37 +1,22 @@
-import { execFile } from 'child_process';
-import * as path from 'path';
-import { promisify } from 'util';
+import { execFile } from 'node:child_process';
+import * as path from 'node:path';
+import { promisify } from 'node:util';
 
-import {
-  downloadAndUnzipVSCode,
-  resolveCliPathFromVSCodeExecutablePath,
-  runTests,
-} from '@vscode/test-electron';
+import { downloadAndUnzipVSCode, resolveCliPathFromVSCodeExecutablePath, runTests } from '@vscode/test-electron';
 
 const execFileAsync = promisify(execFile);
 const DEPENDENCY_EXTENSIONS = ['Shopify.ruby-lsp'];
 
 async function installExtension(cliPath: string, extensionsDir: string, extensionId: string) {
-  await execFileAsync(cliPath, [
-    '--extensions-dir',
-    extensionsDir,
-    '--install-extension',
-    extensionId,
-  ]);
+  await execFileAsync(cliPath, ['--extensions-dir', extensionsDir, '--install-extension', extensionId]);
 }
 
 async function main() {
   try {
     const extensionDevelopmentPath = path.resolve(__dirname, '../..');
     const extensionTestsPath = path.resolve(__dirname, './suite/index');
-    const workspacePath = path.resolve(
-      extensionDevelopmentPath,
-      'test-fixtures/ruby-workspace'
-    );
-    const extensionsDir = path.resolve(
-      extensionDevelopmentPath,
-      '.vscode-test/extensions'
-    );
+    const workspacePath = path.resolve(extensionDevelopmentPath, 'test-fixtures/ruby-workspace');
+    const extensionsDir = path.resolve(extensionDevelopmentPath, '.vscode-test/extensions');
     const vscodeExecutablePath = await downloadAndUnzipVSCode('stable');
     const cliPath = resolveCliPathFromVSCodeExecutablePath(vscodeExecutablePath);
 
@@ -43,13 +28,12 @@ async function main() {
       extensionDevelopmentPath,
       extensionTestsPath,
       vscodeExecutablePath,
-      launchArgs: [workspacePath, '--extensions-dir', extensionsDir],
+      launchArgs: [workspacePath, '--extensions-dir', extensionsDir]
     });
   } catch (error) {
-    console.error('Failed to run extension tests.');
-    console.error(error);
+    console.error('Failed to run extension tests.', error);
     process.exit(1);
   }
 }
 
-void main();
+main();

src/test/runTest.ts

@@ -1,32 +1,32 @@
-import * as assert from 'assert';
+import { ok } from 'node:assert';
 import * as vscode from 'vscode';
 
 const FIXTURE_RELATIVE_PATH = 'app/views/example.html.erb';
 
 suite('ERB Inline JS Helper - Happy Path', () => {
   let document: vscode.TextDocument;
 
-  suiteSetup(async function () {
+  suiteSetup(async () => {
     const workspaceRoot = vscode.workspace.workspaceFolders?.[0]?.uri.fsPath;
-    assert.ok(workspaceRoot, 'Workspace is not open');
+    ok(workspaceRoot, 'Workspace is not open');
 
     document = await vscode.workspace.openTextDocument(vscode.Uri.file(`${workspaceRoot}/${FIXTURE_RELATIVE_PATH}`));
 
     const extension = vscode.extensions.getExtension('kudoas.erb-inline-js-helper');
-    assert.ok(extension, 'Extension is not found');
+    ok(extension, 'Extension is not found');
     await extension.activate();
-    assert.ok(extension.isActive, 'Extension did not activate');
+    ok(extension.isActive, 'Extension did not activate');
   });
 
-  test('extension activates', async function () {
+  test('extension activates', async () => {
     const extension = vscode.extensions.getExtension('kudoas.erb-inline-js-helper');
 
-    assert.ok(extension, 'Extension is not found');
+    ok(extension, 'Extension is not found');
     await extension.activate();
-    assert.ok(extension.isActive, 'Extension did not activate');
+    ok(extension.isActive, 'Extension did not activate');
   });
 
-  test('completion provides console.log', async function () {
+  test('completion provides console.log', async () => {
     const position = positionAtSubstring(document, 'console.', 0, 'completion target', 'after');
 
     const list = await vscode.commands.executeCommand<vscode.CompletionList>(
@@ -36,29 +36,29 @@ suite('ERB Inline JS Helper - Happy Path', () => {
       '.'
     );
 
-    assert.ok(list, 'Completion list is undefined');
+    ok(list, 'Completion list is undefined');
     const labels = list.items.map((item) => (typeof item.label === 'string' ? item.label : item.label.label));
-    assert.ok(labels.includes('log'), 'Expected "log" in completion items');
+    ok(labels.includes('log'), 'Expected "log" in completion items');
   });
 
-  test('hover shows info for message', async function () {
+  test('hover shows info for message', async () => {
     const position = positionAtSubstring(document, 'message', 0, 'hover target');
     const hovers = await vscode.commands.executeCommand<vscode.Hover[]>(
       'vscode.executeHoverProvider',
       document.uri,
       position
     );
 
-    assert.ok(hovers && hovers.length > 0, 'Hover is empty');
+    ok(hovers && hovers.length > 0, 'Hover is empty');
     const text = hovers
       .flatMap((hover) => hover.contents)
       .map((content) => (typeof content === 'string' ? content : content.value))
       .join(' ');
 
-    assert.ok(text.includes('message'), 'Hover does not mention "message"');
+    ok(text.includes('message'), 'Hover does not mention "message"');
   });
 
-  test('definition points to message declaration', async function () {
+  test('definition points to message declaration', async () => {
     const usageLineIndex = indexOfSubstring(document, 'console.log(message);', 0, 'definition usage line');
     const usageNameIndex = indexOfSubstring(document, 'message', usageLineIndex, 'definition usage');
     const usagePosition = document.positionAt(usageNameIndex);
@@ -67,7 +67,7 @@ suite('ERB Inline JS Helper - Happy Path', () => {
     >('vscode.executeDefinitionProvider', document.uri, usagePosition);
 
     const locations = normalizeLocations(definitions);
-    assert.ok(locations.length > 0, 'Definition result is empty');
+    ok(locations.length > 0, 'Definition result is empty');
 
     const declarationLineIndex = indexOfSubstring(document, 'const message', 0, 'definition declaration');
     const declarationNameIndex = indexOfSubstring(
@@ -83,7 +83,7 @@ suite('ERB Inline JS Helper - Happy Path', () => {
         location.uri.toString() === document.uri.toString() && location.range.start.isEqual(declarationNamePosition)
     );
 
-    assert.ok(match, 'Definition did not resolve to the message declaration');
+    ok(match, 'Definition did not resolve to the message declaration');
   });
 });
 
@@ -102,7 +102,7 @@ function positionAtSubstring(
 function indexOfSubstring(document: vscode.TextDocument, substring: string, fromIndex: number, label: string): number {
   const text = document.getText();
   const index = text.indexOf(substring, fromIndex);
-  assert.ok(index !== -1, `Missing substring for ${label}: ${substring}`);
+  ok(index !== -1, `Missing substring for ${label}: ${substring}`);
   return index;
 }
 

src/test/suite/extension.test.ts

@@ -1,5 +1,5 @@
-import * as fs from 'fs';
-import * as path from 'path';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
 
 import Mocha from 'mocha';
 

src/test/suite/index.ts

@@ -0,0 +1,22 @@
+import { ok, strictEqual } from 'node:assert';
+
+import { findJavascriptTagBlock } from '../../erbBlock';
+
+suite('erbBlock', () => {
+  test('findJavascriptTagBlock returns expected range', () => {
+    const erb = `
+    <div>
+      <%= javascript_tag do %>
+        const answer = 42;
+      <% end %>
+    </div>`;
+    const offset = erb.indexOf('answer');
+    const block = findJavascriptTagBlock(erb, offset);
+
+    ok(block);
+    const expectedStart = erb.indexOf('%>') + 2;
+    const expectedEnd = erb.indexOf('<% end %>');
+    strictEqual(block!.start, expectedStart);
+    strictEqual(block!.end, expectedEnd);
+  });
+});

src/test/unit/erbBlocks.test.ts

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "types": ["node", "mocha", "vscode"]
+  },
+  "include": ["src/**/*.ts"]
+}