@anselmdk/feature-spec-md 0.1.0 → 0.1.1-rc.2

package/dist/types.d.ts

@@ -0,0 +1,142 @@
+/** Shared frontmatter fields supported by all spec documents. */
+export type SpecFrontmatter = {
+    id: string;
+    title: string;
+    status?: "draft" | "active" | "deprecated";
+    owner?: string;
+};
+/** Frontmatter fields supported by documents that may reference models. */
+export type ModelReferenceFrontmatter = SpecFrontmatter & {
+    model?: string;
+    models?: string[] | string;
+};
+/** Frontmatter fields supported by `*.feature.md` files. */
+export type FeatureFrontmatter = ModelReferenceFrontmatter;
+/** Frontmatter fields supported by `*.design.md` files. */
+export type DesignFrontmatter = ModelReferenceFrontmatter;
+/** Parsed contents of one `*.model.md` file. */
+export type ModelSpec = {
+    kind: "model";
+    filePath: string;
+    frontmatter: SpecFrontmatter;
+    title: string;
+    purpose: string;
+    modelItems: ModelItem[];
+    rules: FeatureRule[];
+    source: string;
+};
+/** Parsed contents of one `*.feature.md` file. */
+export type FeatureSpec = {
+    kind?: "feature";
+    filePath: string;
+    frontmatter: FeatureFrontmatter;
+    title: string;
+    purpose: string;
+    rules: FeatureRule[];
+    scenarios: FeatureScenario[];
+    source: string;
+};
+/** Parsed contents of one `*.stack.md` file. */
+export type StackSpec = {
+    kind: "stack";
+    filePath: string;
+    frontmatter: SpecFrontmatter;
+    title: string;
+    purpose: string;
+    stack: string;
+    context: string;
+    rationale: string;
+    consequences: string;
+    rules: FeatureRule[];
+    source: string;
+};
+/** Parsed contents of one `*.design.md` file. */
+export type DesignSpec = {
+    kind: "design";
+    filePath: string;
+    frontmatter: DesignFrontmatter;
+    title: string;
+    purpose: string;
+    design: string;
+    principles: string;
+    layout: string;
+    interaction: string;
+    visualStyle: string;
+    rules: FeatureRule[];
+    source: string;
+};
+/** Any parsed spec document. */
+export type SpecDocument = ModelSpec | FeatureSpec | StackSpec | DesignSpec;
+/** A model concept declared in the `## Model` section. */
+export type ModelItem = {
+    id: string;
+    title: string;
+    body: string;
+    line: number;
+};
+/** A rule declared in the `## Rules` section. */
+export type FeatureRule = {
+    id: string;
+    text: string;
+    keyword?: RuleKeyword;
+    strength: "required" | "recommended" | "optional" | "unspecified";
+    line: number;
+};
+/** A concrete example declared in the `## Scenarios` section. */
+export type FeatureScenario = {
+    id: string;
+    title: string;
+    line: number;
+    steps: FeatureStep[];
+};
+/** A single Given / When / Then style step inside a scenario. */
+export type FeatureStep = {
+    keyword: StepKeyword;
+    text: string;
+    line: number;
+};
+export type RuleKeyword = "MUST" | "MUST NOT" | "SHOULD" | "SHOULD NOT" | "MAY" | "OPTIONAL";
+export type StepKeyword = "Given" | "When" | "Then" | "And" | "But";
+/** Validation problem found in a spec, test reference, or report input. */
+export type ValidationIssue = {
+    code: string;
+    severity: "error" | "warning";
+    message: string;
+    filePath?: string;
+    line?: number;
+};
+/** A model item, rule, or scenario ID found in executable tests. */
+export type TestReference = {
+    id: string;
+    filePath: string;
+    line: number;
+    kind: "model" | "rule" | "scenario";
+    source: "title" | "tag" | "covers" | "annotation" | "free-text";
+};
+/** Coverage state for one expected model item, rule, or scenario. */
+export type CoverageItem = {
+    id: string;
+    title?: string;
+    filePath?: string;
+    line?: number;
+    covered: boolean;
+    references: TestReference[];
+};
+/** Complete test coverage mapping for a set of spec documents. */
+export type CoverageSummary = {
+    modelCoverage?: CoverageItem[];
+    ruleCoverage: CoverageItem[];
+    scenarioCoverage: CoverageItem[];
+    orphanModelReferences?: TestReference[];
+    orphanRuleReferences: TestReference[];
+    orphanScenarioReferences: TestReference[];
+};
+/** Screenshot evidence associated with an exact spec line. */
+export type SpecScreenshot = {
+    specPath: string;
+    line: number;
+    path: string;
+    title?: string;
+    testPath?: string;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,iEAAiE;AACjE,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,YAAY,CAAC;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,2EAA2E;AAC3E,MAAM,MAAM,yBAAyB,GAAG,eAAe,GAAG;IACxD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;CAC5B,CAAC;AAEF,4DAA4D;AAC5D,MAAM,MAAM,kBAAkB,GAAG,yBAAyB,CAAC;AAE3D,2DAA2D;AAC3D,MAAM,MAAM,iBAAiB,GAAG,yBAAyB,CAAC;AAE1D,gDAAgD;AAChD,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,OAAO,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,eAAe,CAAC;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,SAAS,EAAE,CAAC;IACxB,KAAK,EAAE,WAAW,EAAE,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,kDAAkD;AAClD,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,kBAAkB,CAAC;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,WAAW,EAAE,CAAC;IACrB,SAAS,EAAE,eAAe,EAAE,CAAC;IAC7B,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,gDAAgD;AAChD,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,OAAO,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,eAAe,CAAC;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,WAAW,EAAE,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,iDAAiD;AACjD,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,EAAE,QAAQ,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,iBAAiB,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,WAAW,EAAE,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,gCAAgC;AAChC,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,WAAW,GAAG,SAAS,GAAG,UAAU,CAAC;AAE5E,0DAA0D;AAC1D,MAAM,MAAM,SAAS,GAAG;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,iDAAiD;AACjD,MAAM,MAAM,WAAW,GAAG;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,QAAQ,EAAE,UAAU,GAAG,aAAa,GAAG,UAAU,GAAG,aAAa,CAAC;IAClE,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,iEAAiE;AACjE,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,WAAW,EAAE,CAAC;CACtB,CAAC;AAEF,iEAAiE;AACjE,MAAM,MAAM,WAAW,GAAG;IACxB,OAAO,EAAE,WAAW,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,WAAW,GACnB,MAAM,GACN,UAAU,GACV,QAAQ,GACR,YAAY,GACZ,KAAK,GACL,UAAU,CAAC;AAEf,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,CAAC;AAEpE,2EAA2E;AAC3E,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,oEAAoE;AACpE,MAAM,MAAM,aAAa,GAAG;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,OAAO,GAAG,MAAM,GAAG,UAAU,CAAC;IACpC,MAAM,EAAE,OAAO,GAAG,KAAK,GAAG,QAAQ,GAAG,YAAY,GAAG,WAAW,CAAC;CACjE,CAAC;AAEF,qEAAqE;AACrE,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,aAAa,EAAE,CAAC;CAC7B,CAAC;AAEF,kEAAkE;AAClE,MAAM,MAAM,eAAe,GAAG;IAC5B,aAAa,CAAC,EAAE,YAAY,EAAE,CAAC;IAC/B,YAAY,EAAE,YAAY,EAAE,CAAC;IAC7B,gBAAgB,EAAE,YAAY,EAAE,CAAC;IACjC,qBAAqB,CAAC,EAAE,aAAa,EAAE,CAAC;IACxC,oBAAoB,EAAE,aAAa,EAAE,CAAC;IACtC,wBAAwB,EAAE,aAAa,EAAE,CAAC;CAC3C,CAAC;AAEF,8DAA8D;AAC9D,MAAM,MAAM,cAAc,GAAG;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@anselmdk/feature-spec-md",
-  "version": "0.1.0",
-  "description": "Markdown feature specs with rule/scenario IDs, validation, coverage checks, and generated reports.",
+  "version": "0.1.1-rc.2",
+  "description": "Markdown feature specs with model, rule, and scenario IDs, validation, coverage checks, and generated reports.",
   "type": "module",
   "bin": {
     "feature-spec-md": "./dist/cli.js"
@@ -10,6 +10,14 @@
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
+    },
+    "./specDocuments": {
+      "types": "./dist/specDocuments.d.ts",
+      "import": "./dist/specDocuments.js"
+    },
+    "./playwright": {
+      "types": "./dist/playwright.d.ts",
+      "import": "./dist/playwright.js"
     }
   },
   "files": [
@@ -27,9 +35,15 @@
     "build": "tsc -p tsconfig.build.json",
     "prepare": "npm run build",
     "dev": "tsx src/cli.ts",
-    "check:example": "tsx src/cli.ts check --specs examples/**/*.feature.md --tests tests/**/*.test.ts --require-scenario-coverage=false",
+    "spec": "tsx src/cli.ts check",
+    "spec:init": "tsx src/cli.ts init",
+    "spec:report": "tsx src/cli.ts report",
+    "format": "prettier --write .",
+    "check:example": "tsx src/cli.ts check --specs examples/**/*.feature.md --require-scenario-coverage=false",
     "report:example": "tsx src/cli.ts report --specs examples/**/*.feature.md --tests tests/**/*.test.ts --out test-results/feature-spec-report/index.html",
-    "test": "tsx --test tests/**/*.test.ts",
+    "test": "npm run test:unit && npm run test:playwright",
+    "test:unit": "tsx --test tests/**/*.test.ts",
+    "test:playwright": "playwright install chromium && playwright test",
     "typecheck": "tsc -p tsconfig.json --noEmit",
     "verify": "npm run typecheck && npm test && npm run build && npm run check:example"
   },
@@ -43,7 +57,9 @@
   ],
   "license": "MIT",
   "devDependencies": {
+    "@playwright/test": "^1.60.0",
     "@types/node": "^25.3.2",
+    "prettier": "^3.8.4",
     "tsx": "^4.21.0",
     "typescript": "^5.9.3"
   }