Add eslint-plugin-vitest

.vscode/settings.json

@@ -0,0 +1,14 @@
+{
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "cSpell.words": [
+    "camelcase",
+    "eslintconfig",
+    "falsey",
+    "nonconstructor",
+    "plusplus",
+    "sonarjs",
+    "tailwindcss",
+    "viam",
+    "viamrobotics"
+  ]
+}

package.json

@@ -37,6 +37,7 @@
     "eslint-plugin-svelte": "^2.35.1",
     "eslint-plugin-tailwindcss": "^3.13.1",
     "eslint-plugin-unicorn": "^50.0.1",
+    "eslint-plugin-vitest": "^0.3.20",
     "prettier": "^3.1.1",
     "prettier-plugin-svelte": "^3.1.2",
     "prettier-plugin-tailwindcss": "^0.5.10",

packages/eslint-config/README.md

@@ -17,7 +17,8 @@ pnpm add --save-dev \
   eslint \
   eslint-config-prettier \
   eslint-plugin-sonarjs \
-  eslint-plugin-unicorn
+  eslint-plugin-unicorn \
+  eslint-plugin-vitest
 ```
 
 ```js
@@ -47,7 +48,8 @@ pnpm add --save-dev \
   eslint-plugin-sonarjs \
   eslint-plugin-svelte \
   eslint-plugin-tailwindcss \
-  eslint-plugin-unicorn
+  eslint-plugin-unicorn \
+  eslint-plugin-vitest
 ```
 
 ```js

packages/eslint-config/base.cjs

@@ -203,13 +203,40 @@ module.exports = {
         'unicorn/prefer-module': 'off',
       },
     },
-    // Relax rules that don't make sense for testing
+    // Rules for tests
     {
-      files: ['**/__tests__/**', '**/*.spec.ts'],
+      files: ['**/__tests__/**', '**/*.test.ts', '**/*.spec.ts'],
+      extends: ['plugin:vitest/recommended'],
       rules: {
         '@typescript-eslint/no-non-null-assertion': 'off',
         '@typescript-eslint/no-unsafe-assignment': 'off',
         'sonarjs/no-duplicate-string': 'off',
+        'vitest/consistent-test-filename': [
+          'error',
+          {
+            pattern: '.*\\.spec\\.(ts|svelte)$',
+          },
+        ],
+        'vitest/consistent-test-it': ['error', { fn: 'it' }],
+        'vitest/no-conditional-expect': 'error',
+        'vitest/no-conditional-in-test': 'error',
+        'vitest/no-conditional-tests': 'error',
+        'vitest/no-restricted-matchers': [
+          'error',
+          {
+            toBeFalsey: 'Prefer `toBe` or `toEqual`',
+            toBeTruthy: 'Prefer `toBe` or `toEqual`',
+          },
+        ],
+        'vitest/no-restricted-vi-methods': [
+          'error',
+          {
+            spyOn: 'Do not partially mock objects',
+          },
+        ],
+        'vitest/prefer-each': 'error',
+        'vitest/require-top-level-describe': 'error',
+        'vitest/valid-expect': ['error', { maxArgs: 2 }],
       },
     },
     // Rules that don't make sense for ambient type files

packages/eslint-config/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "Common ESLint configuration for Viam projects.",
   "files": [
     "**/*",
@@ -48,14 +48,18 @@
     "eslint-plugin-sonarjs": ">=0.19 <0.24",
     "eslint-plugin-svelte": ">=2 <3",
     "eslint-plugin-tailwindcss": ">=3 <4",
-    "eslint-plugin-unicorn": ">=47 <51"
+    "eslint-plugin-unicorn": ">=47 <51",
+    "eslint-plugin-vitest": ">=0.3.0"
   },
   "peerDependenciesMeta": {
     "eslint-plugin-svelte": {
       "optional": true
     },
     "eslint-plugin-tailwindcss": {
       "optional": true
+    },
+    "eslint-plugin-vitest": {
+      "optional": true
     }
   }
 }

tests/peers.spec.ts

@@ -2,7 +2,7 @@
 import path from 'node:path';
 import url from 'node:url';
 import fs from 'node:fs';
-import { describe, test, expect } from 'vitest';
+import { describe, it, expect } from 'vitest';
 import semver from 'semver';
 
 interface PackageJSON {
@@ -21,25 +21,22 @@ const getManifest = (pkgPath: string) =>
 describe('peer dependency specifications', () => {
   const { devDependencies } = getManifest('');
 
-  packages.forEach((packageName) => {
-    describe(packageName, () => {
-      const { peerDependencies } = getManifest(
-        path.join('packages', packageName)
-      );
+  describe.each(packages)(`Package %s`, (packageName) => {
+    const { peerDependencies } = getManifest(
+      path.join('packages', packageName)
+    );
+    const cases = Object.entries(peerDependencies).map(
+      ([dependencyName, peerRange]) => ({ dependencyName, peerRange })
+    );
 
-      Object.entries(peerDependencies).forEach(
-        ([dependencyName, peerRange]) => {
-          test(dependencyName, () => {
-            const devVersion = devDependencies[dependencyName];
+    it.each(cases)('$dependency name', ({ dependencyName, peerRange }) => {
+      const devVersion = devDependencies[dependencyName];
 
-            expect(devVersion).toBeDefined();
-            expect(
-              semver.subset(devVersion!, peerRange),
-              `"${devVersion!}" should be within peer range "${peerRange}"`
-            ).toBe(true);
-          });
-        }
-      );
+      expect(devVersion).toBeDefined();
+      expect(
+        semver.subset(devVersion!, peerRange),
+        `"${devVersion!}" should be within peer range "${peerRange}"`
+      ).toBe(true);
     });
   });
 });