Add tests.

- Use vitest.
- Add tests to CI workflow.
- Add `catch-spacing` rule tests.
- Start adding tests taken from `test/index.js`.

Author: davidlehn

.github/workflows/main.yaml

@@ -22,3 +22,19 @@ jobs:
     - run: npm install
     - name: Run eslint
       run: npm run lint
+  test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    strategy:
+      matrix:
+        node-version: [24.x]
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm install
+    - run: npm run test

package.json

@@ -21,7 +21,7 @@
     "./examples/**/*.js"
   ],
   "scripts": {
-    "test": "eslint",
+    "test": "vitest",
     "lint": "eslint --ignore-pattern 'test/**/*.js'"
   },
   "repository": {
@@ -54,7 +54,8 @@
   "devDependencies": {
     "eslint": "^9.38.0",
     "eslint-plugin-eslint-plugin": "^7.0.0",
-    "eslint-plugin-import": "^2.32.0"
+    "eslint-plugin-import": "^2.32.0",
+    "vitest": "^4.0.18"
   },
   "peerDependencies": {
     "eslint": "^9.38.0"

test/000-rules.test.js

@@ -0,0 +1,40 @@
+/**
+ * Test digitalbazaar eslint rules.
+*/
+import catchSpacing from '../rules/catch-spacing.js';
+import {RuleTester} from 'eslint';
+
+const ruleTester = new RuleTester({
+  languageOptions: {
+    ecmaVersion: 2022,
+    sourceType: 'module'
+  }
+});
+
+ruleTester.run('catch-spacing', catchSpacing, {
+  valid: [
+    {
+      code: 'try {} catch(e) {}'
+    },
+    {
+      code: 'try {} catch {}'
+    }
+  ],
+  invalid: [
+    {
+      code: 'try {} catch (e) {}',
+      errors: [{messageId: 'unexpectedSpace'}],
+      output: 'try {} catch(e) {}'
+    },
+    {
+      code: 'try {} catch (e){}',
+      errors: [{messageId: 'unexpectedSpace'}],
+      output: 'try {} catch(e){}'
+    },
+    {
+      code: 'try {} catch{}',
+      errors: [{messageId: 'missingSpace'}],
+      output: 'try {} catch {}'
+    }
+  ]
+});

test/001-config.test.js

@@ -0,0 +1,111 @@
+/**
+ * Test digitalbazaar eslint configs.
+*/
+import {describe, expect, it} from 'vitest';
+import {ESLint} from 'eslint';
+import {join} from 'node:path';
+
+describe('@digitalbazaar/eslint-config base', () => {
+  const eslint = new ESLint({
+    overrideConfigFile: join(import.meta.dirname, '../configs/base.js')
+  });
+
+  it('incorrect import sort all', async () => {
+    const results = await eslint.lintText(`
+// incorrect all
+import * as bAll from 'b.js';
+import * as aAll from 'a.js';
+    `);
+    const messages = results[0].messages;
+    expect(messages.some(m => m.ruleId === 'sort-imports')).toBe(true);
+  });
+
+  it('correct import sort all', async () => {
+    const results = await eslint.lintText(`
+// correct all
+import * as aaAll from 'a.js';
+import * as bbAll from 'b.js';
+    `);
+    const messages = results[0].messages;
+    expect(messages.some(m => m.ruleId === 'sort-imports')).toBe(false);
+  });
+
+  it('incorrect import sort multiple', async () => {
+    const results = await eslint.lintText(`
+// incorrect multiple
+import {zed, rat, girl} from 'baboon2000.js';
+    `);
+    const messages = results[0].messages;
+    expect(messages.some(m => m.ruleId === 'sort-imports')).toBe(true);
+  });
+
+  it('correct import sort multiple', async () => {
+    const results = await eslint.lintText(`
+// correct multiple
+import {girl2, rat2, zed2} from 'baboon2000.js';
+    `);
+    const messages = results[0].messages;
+    expect(messages.some(m => m.ruleId === 'sort-imports')).toBe(false);
+  });
+
+  it('incorrect import sort single', async () => {
+    const results = await eslint.lintText(`
+// incorrect single
+import {default1} from 'defaulter';
+import aDefault1 from 'adefaulter';
+    `);
+    const messages = results[0].messages;
+    expect(messages.some(m => m.ruleId === 'sort-imports')).toBe(true);
+  });
+
+  it('correct import sort single', async () => {
+    const results = await eslint.lintText(`
+// correct single
+import aDefault2 from 'adefaulter';
+import {default2} from 'defaulter';
+    `);
+    const messages = results[0].messages;
+    expect(messages.some(m => m.ruleId === 'sort-imports')).toBe(false);
+  });
+
+  it('incorrect import sort no members', async () => {
+    const results = await eslint.lintText(`
+// imports with no members must go last
+import 'no-members';
+import * as baboon1 from 'baboon-lib-1';
+    `);
+    const messages = results[0].messages;
+    expect(messages.some(m => m.ruleId === 'sort-imports')).toBe(true);
+  });
+
+  it('correct import sort no members', async () => {
+    const results = await eslint.lintText(`
+// imports with no members must go last
+import * as baboon2 from 'baboon-lib-1';
+import 'no-members';
+    `);
+    const messages = results[0].messages;
+    expect(messages.some(m => m.ruleId === 'sort-imports')).toBe(false);
+  });
+
+  it('correct import sort mixed', async () => {
+    const results = await eslint.lintText(`
+/*
+ * import * as all goes first
+ * import {multiple, members} goes second
+ * import singleMember goes third
+ * import {singleMember} goes third
+ * import 'no-members' goes last
+ */
+import * as baboon3 from 'babbon-lib-3';
+import {multi1, multi2, multi3} from 'multi-x-3';
+import single3 from 'has-default-export';
+import {single4} from 'has-single-named-export';
+import 'no-export';
+    `);
+    const messages = results[0].messages;
+    expect(messages.some(m => m.ruleId === 'sort-imports')).toBe(false);
+  });
+
+  // see more examples in index.js
+});

vitest.config.js

@@ -0,0 +1,7 @@
+import {defineConfig} from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    setupFiles: ['./vitest.setup.js']
+  }
+});

vitest.setup.js

@@ -0,0 +1,8 @@
+import {RuleTester} from 'eslint';
+import {afterAll, describe, it} from 'vitest';
+
+// Assign Vitest's functions to RuleTester's static properties
+RuleTester.afterAll = afterAll;
+RuleTester.describe = describe;
+RuleTester.it = it;
+RuleTester.itOnly = it.only;