qfai 0.2.9 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (24) hide show
  1. package/README.md +6 -8
  2. package/assets/init/.qfai/README.md +6 -5
  3. package/assets/init/.qfai/rules/conventions.md +21 -0
  4. package/assets/init/.qfai/specs/README.md +51 -0
  5. package/assets/init/.qfai/specs/spec-001/delta.md +30 -0
  6. package/assets/init/.qfai/specs/spec-001/scenario.md +10 -0
  7. package/assets/init/.qfai/{spec/spec-0001-sample.md → specs/spec-001/spec.md} +3 -1
  8. package/assets/init/root/.github/workflows/qfai.yml +1 -1
  9. package/assets/init/root/qfai.config.yaml +5 -8
  10. package/dist/cli/index.cjs +637 -351
  11. package/dist/cli/index.cjs.map +1 -1
  12. package/dist/cli/index.mjs +634 -348
  13. package/dist/cli/index.mjs.map +1 -1
  14. package/dist/index.cjs +602 -297
  15. package/dist/index.cjs.map +1 -1
  16. package/dist/index.d.cts +9 -11
  17. package/dist/index.d.ts +9 -11
  18. package/dist/index.mjs +601 -297
  19. package/dist/index.mjs.map +1 -1
  20. package/package.json +1 -1
  21. package/assets/init/.qfai/spec/README.md +0 -80
  22. package/assets/init/.qfai/spec/decisions/ADR-0001.md +0 -9
  23. package/assets/init/.qfai/spec/decisions/README.md +0 -36
  24. package/assets/init/.qfai/spec/scenarios/scenarios.feature +0 -6
package/dist/index.d.ts CHANGED
@@ -26,16 +26,14 @@ type ValidationResult = {
26
26
  };
27
27
 
28
28
  type FailOn = "never" | "warning" | "error";
29
- type OutputFormat = "text" | "json" | "github";
29
+ type OutputFormat = "text" | "github";
30
30
  type TraceabilitySeverity = "warning" | "error";
31
31
  type QfaiPaths = {
32
- specDir: string;
33
- decisionsDir: string;
34
- scenariosDir: string;
35
32
  contractsDir: string;
36
- uiContractsDir: string;
37
- apiContractsDir: string;
38
- dataContractsDir: string;
33
+ specsDir: string;
34
+ rulesDir: string;
35
+ outDir: string;
36
+ promptsDir: string;
39
37
  srcDir: string;
40
38
  testsDir: string;
41
39
  };
@@ -52,8 +50,7 @@ type QfaiValidationConfig = {
52
50
  };
53
51
  };
54
52
  type QfaiOutputConfig = {
55
- format: OutputFormat;
56
- jsonPath: string;
53
+ validateJsonPath: string;
57
54
  };
58
55
  type QfaiConfig = {
59
56
  paths: QfaiPaths;
@@ -80,7 +77,6 @@ declare function extractInvalidIds(text: string, prefixes: IdFormatPrefix[]): st
80
77
  type ReportSummary = {
81
78
  specs: number;
82
79
  scenarios: number;
83
- decisions: number;
84
80
  contracts: {
85
81
  api: number;
86
82
  ui: number;
@@ -122,6 +118,8 @@ declare function resolveToolVersion(): Promise<string>;
122
118
  declare function validateContracts(root: string, config: QfaiConfig): Promise<Issue[]>;
123
119
  declare function lintSql(text: string, file: string): Issue[];
124
120
 
121
+ declare function validateDeltas(root: string, config: QfaiConfig): Promise<Issue[]>;
122
+
125
123
  declare function validateDefinedIds(root: string, config: QfaiConfig): Promise<Issue[]>;
126
124
 
127
125
  declare function validateScenarios(root: string, config: QfaiConfig): Promise<Issue[]>;
@@ -132,4 +130,4 @@ declare function validateSpecContent(text: string, file: string, requiredSection
132
130
 
133
131
  declare function validateTraceability(root: string, config: QfaiConfig): Promise<Issue[]>;
134
132
 
135
- 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 ReportData, type ReportIds, type ReportSummary, type ReportTraceability, type TraceabilitySeverity, VALIDATION_SCHEMA_VERSION, type ValidationCounts, type ValidationResult, createReportData, defaultConfig, extractAllIds, extractIds, extractInvalidIds, formatReportJson, formatReportMarkdown, getConfigPath, lintSql, loadConfig, resolvePath, resolveToolVersion, validateContracts, validateDefinedIds, validateProject, validateScenarioContent, validateScenarios, validateSpecContent, validateSpecs, validateTraceability };
133
+ 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 ReportData, type ReportIds, type ReportSummary, type ReportTraceability, type TraceabilitySeverity, VALIDATION_SCHEMA_VERSION, type ValidationCounts, type ValidationResult, createReportData, defaultConfig, extractAllIds, extractIds, extractInvalidIds, formatReportJson, formatReportMarkdown, getConfigPath, lintSql, loadConfig, resolvePath, resolveToolVersion, validateContracts, validateDefinedIds, validateDeltas, validateProject, validateScenarioContent, validateScenarios, validateSpecContent, validateSpecs, validateTraceability };