@supersigil/vitest 0.1.0

package/README.md

@@ -0,0 +1,45 @@
+# @supersigil/vitest
+
+Vitest helper for annotating tests with [Supersigil](https://supersigil.org) criterion refs.
+
+## Installation
+
+```sh
+npm install -D @supersigil/vitest
+```
+
+## Usage
+
+Use the `verifies()` function to link test cases to specification criteria:
+
+```ts
+import { verifies } from '@supersigil/vitest'
+
+it('rejects invalid email', verifies('auth/req#req-1-1'), () => {
+  expect(validateEmail('bad')).toBe(false)
+})
+```
+
+Multiple criteria can be referenced:
+
+```ts
+it('sends welcome email', verifies('auth/req#req-2-1', 'notifications/req#req-1-1'), () => {
+  // ...
+})
+```
+
+The returned object can be spread into other test options:
+
+```ts
+it('completes within timeout', { ...verifies('perf/req#req-1-1'), timeout: 5000 }, () => {
+  // ...
+})
+```
+
+## How it works
+
+`verifies()` returns a Vitest-compatible metadata object (`{ meta: { verifies: [...] } }`) that Supersigil reads during verification to trace test coverage back to specification criteria.
+
+## License
+
+[MIT](../../LICENSE-MIT) OR [Apache-2.0](../../LICENSE-APACHE)

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+declare module 'vitest' {
+    interface TaskMeta {
+        verifies?: string[];
+    }
+}
+export declare function verifies(...refs: string[]): {
+    meta: {
+        verifies: string[];
+    };
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,QAAQ,CAAC;IACtB,UAAU,QAAQ;QAChB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;KACpB;CACF;AAED,wBAAgB,QAAQ,CACtB,GAAG,IAAI,EAAE,MAAM,EAAE,GAChB;IAAE,IAAI,EAAE;QAAE,QAAQ,EAAE,MAAM,EAAE,CAAA;KAAE,CAAA;CAAE,CAElC"}

package/dist/index.js

@@ -0,0 +1,8 @@
+// src/index.ts
+function verifies(...refs) {
+  return { meta: { verifies: refs } };
+}
+export {
+  verifies
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/index.ts"],
+  "sourcesContent": ["declare module 'vitest' {\n  interface TaskMeta {\n    verifies?: string[]\n  }\n}\n\nexport function verifies(\n  ...refs: string[]\n): { meta: { verifies: string[] } } {\n  return { meta: { verifies: refs } }\n}\n"],
+  "mappings": ";AAMO,SAAS,YACX,MAC+B;AAClC,SAAO,EAAE,MAAM,EAAE,UAAU,KAAK,EAAE;AACpC;",
+  "names": []
+}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@supersigil/vitest",
+  "version": "0.1.0",
+  "description": "Vitest helper for annotating tests with Supersigil criterion refs",
+  "license": "MIT OR Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jonisavo/supersigil.git",
+    "directory": "packages/vitest"
+  },
+  "homepage": "https://supersigil.org",
+  "bugs": "https://github.com/jonisavo/supersigil/issues",
+  "keywords": [
+    "vitest",
+    "testing",
+    "supersigil",
+    "specification",
+    "traceability"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist/",
+    "src/",
+    "README.md"
+  ],
+  "peerDependencies": {
+    "vitest": ">=4.1.0"
+  },
+  "devDependencies": {
+    "esbuild": "^0.28.0",
+    "typescript": "^6.0.2",
+    "vitest": "^4.1.3"
+  },
+  "scripts": {
+    "build": "node esbuild.mjs && tsc --emitDeclarationOnly --noEmit false --outDir dist",
+    "test": "vitest run"
+  }
+}

package/src/index.ts

@@ -0,0 +1,11 @@
+declare module 'vitest' {
+  interface TaskMeta {
+    verifies?: string[]
+  }
+}
+
+export function verifies(
+  ...refs: string[]
+): { meta: { verifies: string[] } } {
+  return { meta: { verifies: refs } }
+}