qfai 0.4.7 → 0.5.0

package/dist/index.d.cts

@@ -119,6 +119,7 @@ type ReportContractCoverage = {
 };
 type ReportSpecCoverage = {
     contractRefMissing: number;
+    missingRefSpecs: string[];
     specToContractIds: Record<string, string[]>;
 };
 type ReportTraceability = {

package/dist/index.d.ts

@@ -1,2 +1,168 @@
-export * from "./core/index.js";
-//# sourceMappingURL=index.d.ts.map
+type ScCoverage = {
+    total: number;
+    covered: number;
+    missing: number;
+    missingIds: string[];
+    refs: Record<string, string[]>;
+};
+type TestFileScan = {
+    globs: string[];
+    excludeGlobs: string[];
+    matchedFileCount: number;
+};
+
+type IssueSeverity = "info" | "warning" | "error";
+type IssueLocation = {
+    line: number;
+    column?: number;
+};
+type Issue = {
+    code: string;
+    severity: IssueSeverity;
+    message: string;
+    file?: string;
+    refs?: string[];
+    rule?: string;
+    loc?: IssueLocation;
+};
+type ValidationCounts = {
+    info: number;
+    warning: number;
+    error: number;
+};
+type ValidationTraceability = {
+    sc: ScCoverage;
+    testFiles: TestFileScan;
+};
+type ValidationResult = {
+    toolVersion: string;
+    issues: Issue[];
+    counts: ValidationCounts;
+    traceability: ValidationTraceability;
+};
+
+type FailOn = "never" | "warning" | "error";
+type OutputFormat = "text" | "github";
+type TraceabilitySeverity = "warning" | "error";
+type QfaiPaths = {
+    contractsDir: string;
+    specsDir: string;
+    rulesDir: string;
+    outDir: string;
+    promptsDir: string;
+    srcDir: string;
+    testsDir: string;
+};
+type QfaiValidationConfig = {
+    failOn: FailOn;
+    require: {
+        specSections: string[];
+    };
+    traceability: {
+        brMustHaveSc: boolean;
+        scMustHaveTest: boolean;
+        testFileGlobs: string[];
+        testFileExcludeGlobs: string[];
+        scNoTestSeverity: TraceabilitySeverity;
+        allowOrphanContracts: boolean;
+        unknownContractIdSeverity: TraceabilitySeverity;
+    };
+};
+type QfaiOutputConfig = {
+    validateJsonPath: string;
+};
+type QfaiConfig = {
+    paths: QfaiPaths;
+    validation: QfaiValidationConfig;
+    output: QfaiOutputConfig;
+};
+type ConfigPathKey = keyof QfaiPaths;
+type ConfigLoadResult = {
+    config: QfaiConfig;
+    issues: Issue[];
+    configPath: string;
+};
+declare const defaultConfig: QfaiConfig;
+declare function getConfigPath(root: string): string;
+declare function loadConfig(root: string): Promise<ConfigLoadResult>;
+declare function resolvePath(root: string, config: QfaiConfig, key: ConfigPathKey): string;
+
+type IdPrefix = "SPEC" | "BR" | "SC" | "UI" | "API" | "DB";
+type IdFormatPrefix = IdPrefix | "ADR";
+declare function extractIds(text: string, prefix: IdPrefix): string[];
+declare function extractAllIds(text: string): string[];
+declare function extractInvalidIds(text: string, prefixes: IdFormatPrefix[]): string[];
+
+type ReportSummary = {
+    specs: number;
+    scenarios: number;
+    contracts: {
+        api: number;
+        ui: number;
+        db: number;
+    };
+    counts: ValidationCounts;
+};
+type ReportIds = {
+    spec: string[];
+    br: string[];
+    sc: string[];
+    ui: string[];
+    api: string[];
+    db: string[];
+};
+type ReportContractCoverage = {
+    total: number;
+    referenced: number;
+    orphan: number;
+    idToSpecs: Record<string, string[]>;
+};
+type ReportSpecCoverage = {
+    contractRefMissing: number;
+    missingRefSpecs: string[];
+    specToContractIds: Record<string, string[]>;
+};
+type ReportTraceability = {
+    upstreamIdsFound: number;
+    referencedInCodeOrTests: boolean;
+    sc: ScCoverage;
+    scSources: Record<string, string[]>;
+    testFiles: TestFileScan;
+    contracts: ReportContractCoverage;
+    specs: ReportSpecCoverage;
+};
+type ReportData = {
+    tool: "qfai";
+    version: string;
+    generatedAt: string;
+    root: string;
+    configPath: string;
+    summary: ReportSummary;
+    ids: ReportIds;
+    traceability: ReportTraceability;
+    issues: Issue[];
+};
+declare function createReportData(root: string, validation?: ValidationResult, configResult?: ConfigLoadResult): Promise<ReportData>;
+declare function formatReportMarkdown(data: ReportData): string;
+declare function formatReportJson(data: ReportData): string;
+
+declare function validateProject(root: string, configResult?: ConfigLoadResult): Promise<ValidationResult>;
+
+declare function resolveToolVersion(): Promise<string>;
+
+declare function validateContracts(root: string, config: QfaiConfig): Promise<Issue[]>;
+declare function lintSql(text: string, file: string): Issue[];
+
+declare function validateDeltas(root: string, config: QfaiConfig): Promise<Issue[]>;
+
+declare function validateDefinedIds(root: string, config: QfaiConfig): Promise<Issue[]>;
+
+declare function validateScenarios(root: string, config: QfaiConfig): Promise<Issue[]>;
+declare function validateScenarioContent(text: string, file: string): Issue[];
+
+declare function validateSpecs(root: string, config: QfaiConfig): Promise<Issue[]>;
+declare function validateSpecContent(text: string, file: string, requiredSections: string[]): Issue[];
+
+declare function validateTraceability(root: string, config: QfaiConfig): Promise<Issue[]>;
+
+export { type ConfigLoadResult, type ConfigPathKey, type FailOn, type IdFormatPrefix, type IdPrefix, type Issue, type IssueLocation, type IssueSeverity, type OutputFormat, type QfaiConfig, type QfaiOutputConfig, type QfaiPaths, type QfaiValidationConfig, type ReportContractCoverage, type ReportData, type ReportIds, type ReportSpecCoverage, type ReportSummary, type ReportTraceability, type TraceabilitySeverity, type ValidationCounts, type ValidationResult, type ValidationTraceability, createReportData, defaultConfig, extractAllIds, extractIds, extractInvalidIds, formatReportJson, formatReportMarkdown, getConfigPath, lintSql, loadConfig, resolvePath, resolveToolVersion, validateContracts, validateDefinedIds, validateDeltas, validateProject, validateScenarioContent, validateScenarios, validateSpecContent, validateSpecs, validateTraceability };

package/dist/index.mjs

@@ -1102,8 +1102,8 @@ import { readFile as readFile4 } from "fs/promises";
 import path6 from "path";
 import { fileURLToPath } from "url";
 async function resolveToolVersion() {
-  if ("0.4.7".length > 0) {
-    return "0.4.7";
+  if ("0.5.0".length > 0) {
+    return "0.5.0";
   }
   try {
     const packagePath = resolvePackageJsonPath();
@@ -2446,8 +2446,11 @@ async function createReportData(root, validation, configResult) {
     db: dbFiles
   } = await collectContractFiles(uiRoot, apiRoot, dbRoot);
   const contractIndex = await buildContractIndex(root, config);
-  const specContractRefs = await collectSpecContractRefs(specFiles);
   const contractIdList = Array.from(contractIndex.ids);
+  const specContractRefs = await collectSpecContractRefs(
+    specFiles,
+    contractIdList
+  );
   const referencedContracts = /* @__PURE__ */ new Set();
   for (const ids of specContractRefs.specToContractIds.values()) {
     ids.forEach((id) => referencedContracts.add(id));
@@ -2528,6 +2531,7 @@ async function createReportData(root, validation, configResult) {
       },
       specs: {
         contractRefMissing: specContractRefs.missingRefSpecs.size,
+        missingRefSpecs: toSortedArray2(specContractRefs.missingRefSpecs),
         specToContractIds: specToContractIdsRecord
       }
     },
@@ -2610,6 +2614,16 @@ function formatReportMarkdown(data) {
     }
   }
   lines.push("");
+  lines.push("## Spec\u3067 contract-ref \u672A\u5BA3\u8A00");
+  const missingRefSpecs = data.traceability.specs.missingRefSpecs;
+  if (missingRefSpecs.length === 0) {
+    lines.push("- (none)");
+  } else {
+    for (const specId of missingRefSpecs) {
+      lines.push(`- ${specId}`);
+    }
+  }
+  lines.push("");
   lines.push("## SC\u30AB\u30D0\u30EC\u30C3\u30B8");
   lines.push(`- total: ${data.traceability.sc.total}`);
   lines.push(`- covered: ${data.traceability.sc.covered}`);
@@ -2713,10 +2727,13 @@ function formatReportMarkdown(data) {
 function formatReportJson(data) {
   return JSON.stringify(data, null, 2);
 }
-async function collectSpecContractRefs(specFiles) {
+async function collectSpecContractRefs(specFiles, contractIdList) {
   const specToContractIds = /* @__PURE__ */ new Map();
   const idToSpecs = /* @__PURE__ */ new Map();
   const missingRefSpecs = /* @__PURE__ */ new Set();
+  for (const contractId of contractIdList) {
+    idToSpecs.set(contractId, /* @__PURE__ */ new Set());
+  }
   for (const file of specFiles) {
     const text = await readFile11(file, "utf-8");
     const parsed = parseSpec(text, file);
@@ -2724,13 +2741,15 @@ async function collectSpecContractRefs(specFiles) {
     const refs = parsed.contractRefs;
     if (refs.lines.length === 0) {
       missingRefSpecs.add(specKey);
+      continue;
     }
     const currentContracts = specToContractIds.get(specKey) ?? /* @__PURE__ */ new Set();
     for (const id of refs.ids) {
       currentContracts.add(id);
-      const specs = idToSpecs.get(id) ?? /* @__PURE__ */ new Set();
-      specs.add(specKey);
-      idToSpecs.set(id, specs);
+      const specs = idToSpecs.get(id);
+      if (specs) {
+        specs.add(specKey);
+      }
     }
     specToContractIds.set(specKey, currentContracts);
   }