@libar-dev/architect 1.0.0-pre.3
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.
- package/CHANGELOG.md +50 -0
- package/LICENSE +25 -0
- package/LICENSE-MCP +62 -0
- package/README.md +147 -0
- package/dist/api/arch-queries.d.ts +95 -0
- package/dist/api/arch-queries.d.ts.map +1 -0
- package/dist/api/arch-queries.js +310 -0
- package/dist/api/arch-queries.js.map +1 -0
- package/dist/api/context-assembler.d.ts +124 -0
- package/dist/api/context-assembler.d.ts.map +1 -0
- package/dist/api/context-assembler.js +472 -0
- package/dist/api/context-assembler.js.map +1 -0
- package/dist/api/context-formatter.d.ts +26 -0
- package/dist/api/context-formatter.d.ts.map +1 -0
- package/dist/api/context-formatter.js +183 -0
- package/dist/api/context-formatter.js.map +1 -0
- package/dist/api/coverage-analyzer.d.ts +38 -0
- package/dist/api/coverage-analyzer.d.ts.map +1 -0
- package/dist/api/coverage-analyzer.js +117 -0
- package/dist/api/coverage-analyzer.js.map +1 -0
- package/dist/api/fuzzy-match.d.ts +75 -0
- package/dist/api/fuzzy-match.d.ts.map +1 -0
- package/dist/api/fuzzy-match.js +150 -0
- package/dist/api/fuzzy-match.js.map +1 -0
- package/dist/api/handoff-generator.d.ts +45 -0
- package/dist/api/handoff-generator.d.ts.map +1 -0
- package/dist/api/handoff-generator.js +139 -0
- package/dist/api/handoff-generator.js.map +1 -0
- package/dist/api/index.d.ts +61 -0
- package/dist/api/index.d.ts.map +1 -0
- package/dist/api/index.js +54 -0
- package/dist/api/index.js.map +1 -0
- package/dist/api/pattern-helpers.d.ts +51 -0
- package/dist/api/pattern-helpers.d.ts.map +1 -0
- package/dist/api/pattern-helpers.js +84 -0
- package/dist/api/pattern-helpers.js.map +1 -0
- package/dist/api/process-state.d.ts +224 -0
- package/dist/api/process-state.d.ts.map +1 -0
- package/dist/api/process-state.js +308 -0
- package/dist/api/process-state.js.map +1 -0
- package/dist/api/rules-query.d.ts +60 -0
- package/dist/api/rules-query.d.ts.map +1 -0
- package/dist/api/rules-query.js +154 -0
- package/dist/api/rules-query.js.map +1 -0
- package/dist/api/scope-validator.d.ts +56 -0
- package/dist/api/scope-validator.d.ts.map +1 -0
- package/dist/api/scope-validator.js +293 -0
- package/dist/api/scope-validator.js.map +1 -0
- package/dist/api/stub-resolver.d.ts +117 -0
- package/dist/api/stub-resolver.d.ts.map +1 -0
- package/dist/api/stub-resolver.js +154 -0
- package/dist/api/stub-resolver.js.map +1 -0
- package/dist/api/summarize.d.ts +75 -0
- package/dist/api/summarize.d.ts.map +1 -0
- package/dist/api/summarize.js +97 -0
- package/dist/api/summarize.js.map +1 -0
- package/dist/api/types.d.ts +221 -0
- package/dist/api/types.d.ts.map +1 -0
- package/dist/api/types.js +57 -0
- package/dist/api/types.js.map +1 -0
- package/dist/cache/file-cache.d.ts +72 -0
- package/dist/cache/file-cache.d.ts.map +1 -0
- package/dist/cache/file-cache.js +80 -0
- package/dist/cache/file-cache.js.map +1 -0
- package/dist/cache/index.d.ts +5 -0
- package/dist/cache/index.d.ts.map +1 -0
- package/dist/cache/index.js +5 -0
- package/dist/cache/index.js.map +1 -0
- package/dist/cli/cli-schema.d.ts +83 -0
- package/dist/cli/cli-schema.d.ts.map +1 -0
- package/dist/cli/cli-schema.js +505 -0
- package/dist/cli/cli-schema.js.map +1 -0
- package/dist/cli/dataset-cache.d.ts +66 -0
- package/dist/cli/dataset-cache.d.ts.map +1 -0
- package/dist/cli/dataset-cache.js +179 -0
- package/dist/cli/dataset-cache.js.map +1 -0
- package/dist/cli/error-handler.d.ts +84 -0
- package/dist/cli/error-handler.d.ts.map +1 -0
- package/dist/cli/error-handler.js +197 -0
- package/dist/cli/error-handler.js.map +1 -0
- package/dist/cli/generate-docs.d.ts +30 -0
- package/dist/cli/generate-docs.d.ts.map +1 -0
- package/dist/cli/generate-docs.js +370 -0
- package/dist/cli/generate-docs.js.map +1 -0
- package/dist/cli/lint-patterns.d.ts +57 -0
- package/dist/cli/lint-patterns.d.ts.map +1 -0
- package/dist/cli/lint-patterns.js +257 -0
- package/dist/cli/lint-patterns.js.map +1 -0
- package/dist/cli/lint-process.d.ts +54 -0
- package/dist/cli/lint-process.d.ts.map +1 -0
- package/dist/cli/lint-process.js +319 -0
- package/dist/cli/lint-process.js.map +1 -0
- package/dist/cli/lint-steps.d.ts +32 -0
- package/dist/cli/lint-steps.d.ts.map +1 -0
- package/dist/cli/lint-steps.js +172 -0
- package/dist/cli/lint-steps.js.map +1 -0
- package/dist/cli/mcp-server.d.ts +22 -0
- package/dist/cli/mcp-server.d.ts.map +1 -0
- package/dist/cli/mcp-server.js +57 -0
- package/dist/cli/mcp-server.js.map +1 -0
- package/dist/cli/output-pipeline.d.ts +130 -0
- package/dist/cli/output-pipeline.d.ts.map +1 -0
- package/dist/cli/output-pipeline.js +234 -0
- package/dist/cli/output-pipeline.js.map +1 -0
- package/dist/cli/process-api.d.ts +37 -0
- package/dist/cli/process-api.d.ts.map +1 -0
- package/dist/cli/process-api.js +1550 -0
- package/dist/cli/process-api.js.map +1 -0
- package/dist/cli/repl.d.ts +38 -0
- package/dist/cli/repl.d.ts.map +1 -0
- package/dist/cli/repl.js +239 -0
- package/dist/cli/repl.js.map +1 -0
- package/dist/cli/validate-patterns.d.ts +115 -0
- package/dist/cli/validate-patterns.d.ts.map +1 -0
- package/dist/cli/validate-patterns.js +707 -0
- package/dist/cli/validate-patterns.js.map +1 -0
- package/dist/cli/version.d.ts +35 -0
- package/dist/cli/version.d.ts.map +1 -0
- package/dist/cli/version.js +64 -0
- package/dist/cli/version.js.map +1 -0
- package/dist/config/config-loader.d.ts +167 -0
- package/dist/config/config-loader.d.ts.map +1 -0
- package/dist/config/config-loader.js +294 -0
- package/dist/config/config-loader.js.map +1 -0
- package/dist/config/defaults.d.ts +92 -0
- package/dist/config/defaults.d.ts.map +1 -0
- package/dist/config/defaults.js +103 -0
- package/dist/config/defaults.js.map +1 -0
- package/dist/config/define-config.d.ts +37 -0
- package/dist/config/define-config.d.ts.map +1 -0
- package/dist/config/define-config.js +38 -0
- package/dist/config/define-config.js.map +1 -0
- package/dist/config/factory.d.ts +79 -0
- package/dist/config/factory.d.ts.map +1 -0
- package/dist/config/factory.js +116 -0
- package/dist/config/factory.js.map +1 -0
- package/dist/config/index.d.ts +45 -0
- package/dist/config/index.d.ts.map +1 -0
- package/dist/config/index.js +48 -0
- package/dist/config/index.js.map +1 -0
- package/dist/config/merge-sources.d.ts +47 -0
- package/dist/config/merge-sources.d.ts.map +1 -0
- package/dist/config/merge-sources.js +61 -0
- package/dist/config/merge-sources.js.map +1 -0
- package/dist/config/presets.d.ts +115 -0
- package/dist/config/presets.d.ts.map +1 -0
- package/dist/config/presets.js +119 -0
- package/dist/config/presets.js.map +1 -0
- package/dist/config/project-config-schema.d.ts +192 -0
- package/dist/config/project-config-schema.d.ts.map +1 -0
- package/dist/config/project-config-schema.js +231 -0
- package/dist/config/project-config-schema.js.map +1 -0
- package/dist/config/project-config.d.ts +229 -0
- package/dist/config/project-config.d.ts.map +1 -0
- package/dist/config/project-config.js +37 -0
- package/dist/config/project-config.js.map +1 -0
- package/dist/config/regex-builders.d.ts +49 -0
- package/dist/config/regex-builders.d.ts.map +1 -0
- package/dist/config/regex-builders.js +85 -0
- package/dist/config/regex-builders.js.map +1 -0
- package/dist/config/resolve-config.d.ts +65 -0
- package/dist/config/resolve-config.d.ts.map +1 -0
- package/dist/config/resolve-config.js +150 -0
- package/dist/config/resolve-config.js.map +1 -0
- package/dist/config/types.d.ts +81 -0
- package/dist/config/types.d.ts.map +1 -0
- package/dist/config/types.js +22 -0
- package/dist/config/types.js.map +1 -0
- package/dist/config/workflow-loader.d.ts +90 -0
- package/dist/config/workflow-loader.d.ts.map +1 -0
- package/dist/config/workflow-loader.js +167 -0
- package/dist/config/workflow-loader.js.map +1 -0
- package/dist/extractor/doc-extractor.d.ts +233 -0
- package/dist/extractor/doc-extractor.d.ts.map +1 -0
- package/dist/extractor/doc-extractor.js +481 -0
- package/dist/extractor/doc-extractor.js.map +1 -0
- package/dist/extractor/dual-source-extractor.d.ts +161 -0
- package/dist/extractor/dual-source-extractor.d.ts.map +1 -0
- package/dist/extractor/dual-source-extractor.js +407 -0
- package/dist/extractor/dual-source-extractor.js.map +1 -0
- package/dist/extractor/gherkin-extractor.d.ts +170 -0
- package/dist/extractor/gherkin-extractor.d.ts.map +1 -0
- package/dist/extractor/gherkin-extractor.js +543 -0
- package/dist/extractor/gherkin-extractor.js.map +1 -0
- package/dist/extractor/index.d.ts +7 -0
- package/dist/extractor/index.d.ts.map +1 -0
- package/dist/extractor/index.js +11 -0
- package/dist/extractor/index.js.map +1 -0
- package/dist/extractor/layer-inference.d.ts +66 -0
- package/dist/extractor/layer-inference.d.ts.map +1 -0
- package/dist/extractor/layer-inference.js +93 -0
- package/dist/extractor/layer-inference.js.map +1 -0
- package/dist/extractor/shape-extractor.d.ts +79 -0
- package/dist/extractor/shape-extractor.d.ts.map +1 -0
- package/dist/extractor/shape-extractor.js +966 -0
- package/dist/extractor/shape-extractor.js.map +1 -0
- package/dist/generators/built-in/cli-recipe-generator.d.ts +30 -0
- package/dist/generators/built-in/cli-recipe-generator.d.ts.map +1 -0
- package/dist/generators/built-in/cli-recipe-generator.js +155 -0
- package/dist/generators/built-in/cli-recipe-generator.js.map +1 -0
- package/dist/generators/built-in/codec-generators.d.ts +29 -0
- package/dist/generators/built-in/codec-generators.d.ts.map +1 -0
- package/dist/generators/built-in/codec-generators.js +195 -0
- package/dist/generators/built-in/codec-generators.js.map +1 -0
- package/dist/generators/built-in/decision-doc-generator.d.ts +204 -0
- package/dist/generators/built-in/decision-doc-generator.d.ts.map +1 -0
- package/dist/generators/built-in/decision-doc-generator.js +654 -0
- package/dist/generators/built-in/decision-doc-generator.js.map +1 -0
- package/dist/generators/built-in/design-review-generator.d.ts +26 -0
- package/dist/generators/built-in/design-review-generator.d.ts.map +1 -0
- package/dist/generators/built-in/design-review-generator.js +94 -0
- package/dist/generators/built-in/design-review-generator.js.map +1 -0
- package/dist/generators/built-in/index.d.ts +22 -0
- package/dist/generators/built-in/index.d.ts.map +1 -0
- package/dist/generators/built-in/index.js +23 -0
- package/dist/generators/built-in/index.js.map +1 -0
- package/dist/generators/built-in/process-api-reference-generator.d.ts +18 -0
- package/dist/generators/built-in/process-api-reference-generator.d.ts.map +1 -0
- package/dist/generators/built-in/process-api-reference-generator.js +85 -0
- package/dist/generators/built-in/process-api-reference-generator.js.map +1 -0
- package/dist/generators/built-in/reference-generators.d.ts +51 -0
- package/dist/generators/built-in/reference-generators.d.ts.map +1 -0
- package/dist/generators/built-in/reference-generators.js +320 -0
- package/dist/generators/built-in/reference-generators.js.map +1 -0
- package/dist/generators/codec-based.d.ts +63 -0
- package/dist/generators/codec-based.d.ts.map +1 -0
- package/dist/generators/codec-based.js +88 -0
- package/dist/generators/codec-based.js.map +1 -0
- package/dist/generators/content-deduplicator.d.ts +114 -0
- package/dist/generators/content-deduplicator.d.ts.map +1 -0
- package/dist/generators/content-deduplicator.js +356 -0
- package/dist/generators/content-deduplicator.js.map +1 -0
- package/dist/generators/index.d.ts +50 -0
- package/dist/generators/index.d.ts.map +1 -0
- package/dist/generators/index.js +54 -0
- package/dist/generators/index.js.map +1 -0
- package/dist/generators/orchestrator.d.ts +265 -0
- package/dist/generators/orchestrator.d.ts.map +1 -0
- package/dist/generators/orchestrator.js +570 -0
- package/dist/generators/orchestrator.js.map +1 -0
- package/dist/generators/pipeline/build-pipeline.d.ts +131 -0
- package/dist/generators/pipeline/build-pipeline.d.ts.map +1 -0
- package/dist/generators/pipeline/build-pipeline.js +248 -0
- package/dist/generators/pipeline/build-pipeline.js.map +1 -0
- package/dist/generators/pipeline/context-inference.d.ts +55 -0
- package/dist/generators/pipeline/context-inference.d.ts.map +1 -0
- package/dist/generators/pipeline/context-inference.js +76 -0
- package/dist/generators/pipeline/context-inference.js.map +1 -0
- package/dist/generators/pipeline/index.d.ts +27 -0
- package/dist/generators/pipeline/index.d.ts.map +1 -0
- package/dist/generators/pipeline/index.js +34 -0
- package/dist/generators/pipeline/index.js.map +1 -0
- package/dist/generators/pipeline/merge-patterns.d.ts +33 -0
- package/dist/generators/pipeline/merge-patterns.d.ts.map +1 -0
- package/dist/generators/pipeline/merge-patterns.js +50 -0
- package/dist/generators/pipeline/merge-patterns.js.map +1 -0
- package/dist/generators/pipeline/relationship-resolver.d.ts +47 -0
- package/dist/generators/pipeline/relationship-resolver.d.ts.map +1 -0
- package/dist/generators/pipeline/relationship-resolver.js +132 -0
- package/dist/generators/pipeline/relationship-resolver.js.map +1 -0
- package/dist/generators/pipeline/sequence-utils.d.ts +49 -0
- package/dist/generators/pipeline/sequence-utils.d.ts.map +1 -0
- package/dist/generators/pipeline/sequence-utils.js +235 -0
- package/dist/generators/pipeline/sequence-utils.js.map +1 -0
- package/dist/generators/pipeline/transform-dataset.d.ts +82 -0
- package/dist/generators/pipeline/transform-dataset.d.ts.map +1 -0
- package/dist/generators/pipeline/transform-dataset.js +355 -0
- package/dist/generators/pipeline/transform-dataset.js.map +1 -0
- package/dist/generators/pipeline/transform-types.d.ts +96 -0
- package/dist/generators/pipeline/transform-types.d.ts.map +1 -0
- package/dist/generators/pipeline/transform-types.js +18 -0
- package/dist/generators/pipeline/transform-types.js.map +1 -0
- package/dist/generators/registry.d.ts +64 -0
- package/dist/generators/registry.d.ts.map +1 -0
- package/dist/generators/registry.js +77 -0
- package/dist/generators/registry.js.map +1 -0
- package/dist/generators/source-mapper.d.ts +143 -0
- package/dist/generators/source-mapper.d.ts.map +1 -0
- package/dist/generators/source-mapper.js +602 -0
- package/dist/generators/source-mapper.js.map +1 -0
- package/dist/generators/source-mapping-validator.d.ts +118 -0
- package/dist/generators/source-mapping-validator.d.ts.map +1 -0
- package/dist/generators/source-mapping-validator.js +334 -0
- package/dist/generators/source-mapping-validator.js.map +1 -0
- package/dist/generators/types.d.ts +104 -0
- package/dist/generators/types.d.ts.map +1 -0
- package/dist/generators/types.js +5 -0
- package/dist/generators/types.js.map +1 -0
- package/dist/generators/warning-collector.d.ts +144 -0
- package/dist/generators/warning-collector.d.ts.map +1 -0
- package/dist/generators/warning-collector.js +166 -0
- package/dist/generators/warning-collector.js.map +1 -0
- package/dist/git/branch-diff.d.ts +44 -0
- package/dist/git/branch-diff.d.ts.map +1 -0
- package/dist/git/branch-diff.js +57 -0
- package/dist/git/branch-diff.js.map +1 -0
- package/dist/git/helpers.d.ts +46 -0
- package/dist/git/helpers.d.ts.map +1 -0
- package/dist/git/helpers.js +67 -0
- package/dist/git/helpers.js.map +1 -0
- package/dist/git/index.d.ts +18 -0
- package/dist/git/index.d.ts.map +1 -0
- package/dist/git/index.js +18 -0
- package/dist/git/index.js.map +1 -0
- package/dist/git/name-status.d.ts +32 -0
- package/dist/git/name-status.d.ts.map +1 -0
- package/dist/git/name-status.js +66 -0
- package/dist/git/name-status.js.map +1 -0
- package/dist/index.d.ts +107 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +122 -0
- package/dist/index.js.map +1 -0
- package/dist/lint/engine.d.ts +113 -0
- package/dist/lint/engine.d.ts.map +1 -0
- package/dist/lint/engine.js +228 -0
- package/dist/lint/engine.js.map +1 -0
- package/dist/lint/index.d.ts +26 -0
- package/dist/lint/index.d.ts.map +1 -0
- package/dist/lint/index.js +24 -0
- package/dist/lint/index.js.map +1 -0
- package/dist/lint/process-guard/decider.d.ts +166 -0
- package/dist/lint/process-guard/decider.d.ts.map +1 -0
- package/dist/lint/process-guard/decider.js +412 -0
- package/dist/lint/process-guard/decider.js.map +1 -0
- package/dist/lint/process-guard/derive-state.d.ts +96 -0
- package/dist/lint/process-guard/derive-state.d.ts.map +1 -0
- package/dist/lint/process-guard/derive-state.js +368 -0
- package/dist/lint/process-guard/derive-state.js.map +1 -0
- package/dist/lint/process-guard/detect-changes.d.ts +109 -0
- package/dist/lint/process-guard/detect-changes.d.ts.map +1 -0
- package/dist/lint/process-guard/detect-changes.js +487 -0
- package/dist/lint/process-guard/detect-changes.js.map +1 -0
- package/dist/lint/process-guard/index.d.ts +35 -0
- package/dist/lint/process-guard/index.d.ts.map +1 -0
- package/dist/lint/process-guard/index.js +39 -0
- package/dist/lint/process-guard/index.js.map +1 -0
- package/dist/lint/process-guard/types.d.ts +255 -0
- package/dist/lint/process-guard/types.d.ts.map +1 -0
- package/dist/lint/process-guard/types.js +31 -0
- package/dist/lint/process-guard/types.js.map +1 -0
- package/dist/lint/rules.d.ts +147 -0
- package/dist/lint/rules.d.ts.map +1 -0
- package/dist/lint/rules.js +289 -0
- package/dist/lint/rules.js.map +1 -0
- package/dist/lint/steps/cross-checks.d.ts +66 -0
- package/dist/lint/steps/cross-checks.d.ts.map +1 -0
- package/dist/lint/steps/cross-checks.js +290 -0
- package/dist/lint/steps/cross-checks.js.map +1 -0
- package/dist/lint/steps/feature-checks.d.ts +78 -0
- package/dist/lint/steps/feature-checks.d.ts.map +1 -0
- package/dist/lint/steps/feature-checks.js +279 -0
- package/dist/lint/steps/feature-checks.js.map +1 -0
- package/dist/lint/steps/index.d.ts +22 -0
- package/dist/lint/steps/index.d.ts.map +1 -0
- package/dist/lint/steps/index.js +26 -0
- package/dist/lint/steps/index.js.map +1 -0
- package/dist/lint/steps/pair-resolver.d.ts +29 -0
- package/dist/lint/steps/pair-resolver.d.ts.map +1 -0
- package/dist/lint/steps/pair-resolver.js +76 -0
- package/dist/lint/steps/pair-resolver.js.map +1 -0
- package/dist/lint/steps/runner.d.ts +28 -0
- package/dist/lint/steps/runner.d.ts.map +1 -0
- package/dist/lint/steps/runner.js +143 -0
- package/dist/lint/steps/runner.js.map +1 -0
- package/dist/lint/steps/step-checks.d.ts +41 -0
- package/dist/lint/steps/step-checks.d.ts.map +1 -0
- package/dist/lint/steps/step-checks.js +164 -0
- package/dist/lint/steps/step-checks.js.map +1 -0
- package/dist/lint/steps/types.d.ts +95 -0
- package/dist/lint/steps/types.d.ts.map +1 -0
- package/dist/lint/steps/types.js +79 -0
- package/dist/lint/steps/types.js.map +1 -0
- package/dist/lint/steps/utils.d.ts +22 -0
- package/dist/lint/steps/utils.d.ts.map +1 -0
- package/dist/lint/steps/utils.js +57 -0
- package/dist/lint/steps/utils.js.map +1 -0
- package/dist/mcp/file-watcher.d.ts +24 -0
- package/dist/mcp/file-watcher.d.ts.map +1 -0
- package/dist/mcp/file-watcher.js +75 -0
- package/dist/mcp/file-watcher.js.map +1 -0
- package/dist/mcp/index.d.ts +19 -0
- package/dist/mcp/index.d.ts.map +1 -0
- package/dist/mcp/index.js +21 -0
- package/dist/mcp/index.js.map +1 -0
- package/dist/mcp/pipeline-session.d.ts +33 -0
- package/dist/mcp/pipeline-session.d.ts.map +1 -0
- package/dist/mcp/pipeline-session.js +149 -0
- package/dist/mcp/pipeline-session.js.map +1 -0
- package/dist/mcp/server.d.ts +28 -0
- package/dist/mcp/server.d.ts.map +1 -0
- package/dist/mcp/server.js +197 -0
- package/dist/mcp/server.js.map +1 -0
- package/dist/mcp/tool-registry.d.ts +4 -0
- package/dist/mcp/tool-registry.d.ts.map +1 -0
- package/dist/mcp/tool-registry.js +525 -0
- package/dist/mcp/tool-registry.js.map +1 -0
- package/dist/renderable/codecs/adr.d.ts +4730 -0
- package/dist/renderable/codecs/adr.d.ts.map +1 -0
- package/dist/renderable/codecs/adr.js +590 -0
- package/dist/renderable/codecs/adr.js.map +1 -0
- package/dist/renderable/codecs/architecture.d.ts +4760 -0
- package/dist/renderable/codecs/architecture.d.ts.map +1 -0
- package/dist/renderable/codecs/architecture.js +524 -0
- package/dist/renderable/codecs/architecture.js.map +1 -0
- package/dist/renderable/codecs/business-rules.d.ts +4777 -0
- package/dist/renderable/codecs/business-rules.d.ts.map +1 -0
- package/dist/renderable/codecs/business-rules.js +648 -0
- package/dist/renderable/codecs/business-rules.js.map +1 -0
- package/dist/renderable/codecs/claude-module.d.ts +4710 -0
- package/dist/renderable/codecs/claude-module.d.ts.map +1 -0
- package/dist/renderable/codecs/claude-module.js +214 -0
- package/dist/renderable/codecs/claude-module.js.map +1 -0
- package/dist/renderable/codecs/composite.d.ts +84 -0
- package/dist/renderable/codecs/composite.d.ts.map +1 -0
- package/dist/renderable/codecs/composite.js +124 -0
- package/dist/renderable/codecs/composite.js.map +1 -0
- package/dist/renderable/codecs/convention-extractor.d.ts +105 -0
- package/dist/renderable/codecs/convention-extractor.d.ts.map +1 -0
- package/dist/renderable/codecs/convention-extractor.js +353 -0
- package/dist/renderable/codecs/convention-extractor.js.map +1 -0
- package/dist/renderable/codecs/decision-doc.d.ts +308 -0
- package/dist/renderable/codecs/decision-doc.d.ts.map +1 -0
- package/dist/renderable/codecs/decision-doc.js +485 -0
- package/dist/renderable/codecs/decision-doc.js.map +1 -0
- package/dist/renderable/codecs/design-review.d.ts +55 -0
- package/dist/renderable/codecs/design-review.d.ts.map +1 -0
- package/dist/renderable/codecs/design-review.js +532 -0
- package/dist/renderable/codecs/design-review.js.map +1 -0
- package/dist/renderable/codecs/diagram-utils.d.ts +62 -0
- package/dist/renderable/codecs/diagram-utils.d.ts.map +1 -0
- package/dist/renderable/codecs/diagram-utils.js +70 -0
- package/dist/renderable/codecs/diagram-utils.js.map +1 -0
- package/dist/renderable/codecs/helpers.d.ts +553 -0
- package/dist/renderable/codecs/helpers.d.ts.map +1 -0
- package/dist/renderable/codecs/helpers.js +913 -0
- package/dist/renderable/codecs/helpers.js.map +1 -0
- package/dist/renderable/codecs/index-codec.d.ts +4714 -0
- package/dist/renderable/codecs/index-codec.d.ts.map +1 -0
- package/dist/renderable/codecs/index-codec.js +250 -0
- package/dist/renderable/codecs/index-codec.js.map +1 -0
- package/dist/renderable/codecs/index.d.ts +46 -0
- package/dist/renderable/codecs/index.d.ts.map +1 -0
- package/dist/renderable/codecs/index.js +70 -0
- package/dist/renderable/codecs/index.js.map +1 -0
- package/dist/renderable/codecs/patterns.d.ts +4757 -0
- package/dist/renderable/codecs/patterns.d.ts.map +1 -0
- package/dist/renderable/codecs/patterns.js +462 -0
- package/dist/renderable/codecs/patterns.js.map +1 -0
- package/dist/renderable/codecs/planning.d.ts +14055 -0
- package/dist/renderable/codecs/planning.d.ts.map +1 -0
- package/dist/renderable/codecs/planning.js +449 -0
- package/dist/renderable/codecs/planning.js.map +1 -0
- package/dist/renderable/codecs/pr-changes.d.ts +4742 -0
- package/dist/renderable/codecs/pr-changes.d.ts.map +1 -0
- package/dist/renderable/codecs/pr-changes.js +425 -0
- package/dist/renderable/codecs/pr-changes.js.map +1 -0
- package/dist/renderable/codecs/reference.d.ts +215 -0
- package/dist/renderable/codecs/reference.d.ts.map +1 -0
- package/dist/renderable/codecs/reference.js +1578 -0
- package/dist/renderable/codecs/reference.js.map +1 -0
- package/dist/renderable/codecs/reporting.d.ts +14026 -0
- package/dist/renderable/codecs/reporting.d.ts.map +1 -0
- package/dist/renderable/codecs/reporting.js +365 -0
- package/dist/renderable/codecs/reporting.js.map +1 -0
- package/dist/renderable/codecs/requirements.d.ts +4743 -0
- package/dist/renderable/codecs/requirements.d.ts.map +1 -0
- package/dist/renderable/codecs/requirements.js +428 -0
- package/dist/renderable/codecs/requirements.js.map +1 -0
- package/dist/renderable/codecs/session.d.ts +9410 -0
- package/dist/renderable/codecs/session.d.ts.map +1 -0
- package/dist/renderable/codecs/session.js +848 -0
- package/dist/renderable/codecs/session.js.map +1 -0
- package/dist/renderable/codecs/shape-matcher.d.ts +54 -0
- package/dist/renderable/codecs/shape-matcher.d.ts.map +1 -0
- package/dist/renderable/codecs/shape-matcher.js +106 -0
- package/dist/renderable/codecs/shape-matcher.js.map +1 -0
- package/dist/renderable/codecs/shared-schema.d.ts +44 -0
- package/dist/renderable/codecs/shared-schema.d.ts.map +1 -0
- package/dist/renderable/codecs/shared-schema.js +43 -0
- package/dist/renderable/codecs/shared-schema.js.map +1 -0
- package/dist/renderable/codecs/taxonomy.d.ts +4733 -0
- package/dist/renderable/codecs/taxonomy.d.ts.map +1 -0
- package/dist/renderable/codecs/taxonomy.js +570 -0
- package/dist/renderable/codecs/taxonomy.js.map +1 -0
- package/dist/renderable/codecs/timeline.d.ts +14094 -0
- package/dist/renderable/codecs/timeline.d.ts.map +1 -0
- package/dist/renderable/codecs/timeline.js +906 -0
- package/dist/renderable/codecs/timeline.js.map +1 -0
- package/dist/renderable/codecs/types/base.d.ts +81 -0
- package/dist/renderable/codecs/types/base.d.ts.map +1 -0
- package/dist/renderable/codecs/types/base.js +56 -0
- package/dist/renderable/codecs/types/base.js.map +1 -0
- package/dist/renderable/codecs/types/index.d.ts +5 -0
- package/dist/renderable/codecs/types/index.d.ts.map +1 -0
- package/dist/renderable/codecs/types/index.js +5 -0
- package/dist/renderable/codecs/types/index.js.map +1 -0
- package/dist/renderable/codecs/validation-rules.d.ts +4773 -0
- package/dist/renderable/codecs/validation-rules.d.ts.map +1 -0
- package/dist/renderable/codecs/validation-rules.js +537 -0
- package/dist/renderable/codecs/validation-rules.js.map +1 -0
- package/dist/renderable/generate.d.ts +338 -0
- package/dist/renderable/generate.d.ts.map +1 -0
- package/dist/renderable/generate.js +437 -0
- package/dist/renderable/generate.js.map +1 -0
- package/dist/renderable/index.d.ts +36 -0
- package/dist/renderable/index.d.ts.map +1 -0
- package/dist/renderable/index.js +58 -0
- package/dist/renderable/index.js.map +1 -0
- package/dist/renderable/load-preamble.d.ts +56 -0
- package/dist/renderable/load-preamble.d.ts.map +1 -0
- package/dist/renderable/load-preamble.js +298 -0
- package/dist/renderable/load-preamble.js.map +1 -0
- package/dist/renderable/render.d.ts +61 -0
- package/dist/renderable/render.d.ts.map +1 -0
- package/dist/renderable/render.js +346 -0
- package/dist/renderable/render.js.map +1 -0
- package/dist/renderable/schema.d.ts +194 -0
- package/dist/renderable/schema.d.ts.map +1 -0
- package/dist/renderable/schema.js +197 -0
- package/dist/renderable/schema.js.map +1 -0
- package/dist/renderable/utils.d.ts +146 -0
- package/dist/renderable/utils.d.ts.map +1 -0
- package/dist/renderable/utils.js +362 -0
- package/dist/renderable/utils.js.map +1 -0
- package/dist/scanner/ast-parser.d.ts +75 -0
- package/dist/scanner/ast-parser.d.ts.map +1 -0
- package/dist/scanner/ast-parser.js +835 -0
- package/dist/scanner/ast-parser.js.map +1 -0
- package/dist/scanner/gherkin-ast-parser.d.ts +166 -0
- package/dist/scanner/gherkin-ast-parser.d.ts.map +1 -0
- package/dist/scanner/gherkin-ast-parser.js +507 -0
- package/dist/scanner/gherkin-ast-parser.js.map +1 -0
- package/dist/scanner/gherkin-scanner.d.ts +106 -0
- package/dist/scanner/gherkin-scanner.d.ts.map +1 -0
- package/dist/scanner/gherkin-scanner.js +149 -0
- package/dist/scanner/gherkin-scanner.js.map +1 -0
- package/dist/scanner/index.d.ts +85 -0
- package/dist/scanner/index.d.ts.map +1 -0
- package/dist/scanner/index.js +102 -0
- package/dist/scanner/index.js.map +1 -0
- package/dist/scanner/pattern-scanner.d.ts +83 -0
- package/dist/scanner/pattern-scanner.d.ts.map +1 -0
- package/dist/scanner/pattern-scanner.js +110 -0
- package/dist/scanner/pattern-scanner.js.map +1 -0
- package/dist/taxonomy/categories.d.ts +47 -0
- package/dist/taxonomy/categories.d.ts.map +1 -0
- package/dist/taxonomy/categories.js +175 -0
- package/dist/taxonomy/categories.js.map +1 -0
- package/dist/taxonomy/claude-section-values.d.ts +12 -0
- package/dist/taxonomy/claude-section-values.d.ts.map +1 -0
- package/dist/taxonomy/claude-section-values.js +17 -0
- package/dist/taxonomy/claude-section-values.js.map +1 -0
- package/dist/taxonomy/conventions.d.ts +13 -0
- package/dist/taxonomy/conventions.d.ts.map +1 -0
- package/dist/taxonomy/conventions.js +27 -0
- package/dist/taxonomy/conventions.js.map +1 -0
- package/dist/taxonomy/deliverable-status.d.ts +99 -0
- package/dist/taxonomy/deliverable-status.d.ts.map +1 -0
- package/dist/taxonomy/deliverable-status.js +131 -0
- package/dist/taxonomy/deliverable-status.js.map +1 -0
- package/dist/taxonomy/format-types.d.ts +17 -0
- package/dist/taxonomy/format-types.d.ts.map +1 -0
- package/dist/taxonomy/format-types.js +23 -0
- package/dist/taxonomy/format-types.js.map +1 -0
- package/dist/taxonomy/generator-options.d.ts +67 -0
- package/dist/taxonomy/generator-options.d.ts.map +1 -0
- package/dist/taxonomy/generator-options.js +75 -0
- package/dist/taxonomy/generator-options.js.map +1 -0
- package/dist/taxonomy/hierarchy-levels.d.ts +23 -0
- package/dist/taxonomy/hierarchy-levels.d.ts.map +1 -0
- package/dist/taxonomy/hierarchy-levels.js +22 -0
- package/dist/taxonomy/hierarchy-levels.js.map +1 -0
- package/dist/taxonomy/index.d.ts +35 -0
- package/dist/taxonomy/index.d.ts.map +1 -0
- package/dist/taxonomy/index.js +56 -0
- package/dist/taxonomy/index.js.map +1 -0
- package/dist/taxonomy/layer-types.d.ts +22 -0
- package/dist/taxonomy/layer-types.d.ts.map +1 -0
- package/dist/taxonomy/layer-types.js +28 -0
- package/dist/taxonomy/layer-types.js.map +1 -0
- package/dist/taxonomy/normalized-status.d.ts +99 -0
- package/dist/taxonomy/normalized-status.d.ts.map +1 -0
- package/dist/taxonomy/normalized-status.js +113 -0
- package/dist/taxonomy/normalized-status.js.map +1 -0
- package/dist/taxonomy/registry-builder.d.ts +104 -0
- package/dist/taxonomy/registry-builder.d.ts.map +1 -0
- package/dist/taxonomy/registry-builder.js +561 -0
- package/dist/taxonomy/registry-builder.js.map +1 -0
- package/dist/taxonomy/risk-levels.d.ts +16 -0
- package/dist/taxonomy/risk-levels.d.ts.map +1 -0
- package/dist/taxonomy/risk-levels.js +15 -0
- package/dist/taxonomy/risk-levels.js.map +1 -0
- package/dist/taxonomy/severity-types.d.ts +6 -0
- package/dist/taxonomy/severity-types.d.ts.map +1 -0
- package/dist/taxonomy/severity-types.js +5 -0
- package/dist/taxonomy/severity-types.js.map +1 -0
- package/dist/taxonomy/status-values.d.ts +39 -0
- package/dist/taxonomy/status-values.d.ts.map +1 -0
- package/dist/taxonomy/status-values.js +42 -0
- package/dist/taxonomy/status-values.js.map +1 -0
- package/dist/types/branded.d.ts +89 -0
- package/dist/types/branded.d.ts.map +1 -0
- package/dist/types/branded.js +57 -0
- package/dist/types/branded.js.map +1 -0
- package/dist/types/errors.d.ts +342 -0
- package/dist/types/errors.d.ts.map +1 -0
- package/dist/types/errors.js +251 -0
- package/dist/types/errors.js.map +1 -0
- package/dist/types/index.d.ts +41 -0
- package/dist/types/index.d.ts.map +1 -0
- package/dist/types/index.js +5 -0
- package/dist/types/index.js.map +1 -0
- package/dist/types/result.d.ts +78 -0
- package/dist/types/result.d.ts.map +1 -0
- package/dist/types/result.js +78 -0
- package/dist/types/result.js.map +1 -0
- package/dist/utils/collection-utils.d.ts +49 -0
- package/dist/utils/collection-utils.d.ts.map +1 -0
- package/dist/utils/collection-utils.js +58 -0
- package/dist/utils/collection-utils.js.map +1 -0
- package/dist/utils/id-utils.d.ts +46 -0
- package/dist/utils/id-utils.d.ts.map +1 -0
- package/dist/utils/id-utils.js +51 -0
- package/dist/utils/id-utils.js.map +1 -0
- package/dist/utils/index.d.ts +21 -0
- package/dist/utils/index.d.ts.map +1 -0
- package/dist/utils/index.js +21 -0
- package/dist/utils/index.js.map +1 -0
- package/dist/utils/string-utils.d.ts +150 -0
- package/dist/utils/string-utils.d.ts.map +1 -0
- package/dist/utils/string-utils.js +281 -0
- package/dist/utils/string-utils.js.map +1 -0
- package/dist/validation/anti-patterns.d.ts +134 -0
- package/dist/validation/anti-patterns.d.ts.map +1 -0
- package/dist/validation/anti-patterns.js +307 -0
- package/dist/validation/anti-patterns.js.map +1 -0
- package/dist/validation/dod-validator.d.ts +94 -0
- package/dist/validation/dod-validator.d.ts.map +1 -0
- package/dist/validation/dod-validator.js +198 -0
- package/dist/validation/dod-validator.js.map +1 -0
- package/dist/validation/fsm/index.d.ts +59 -0
- package/dist/validation/fsm/index.d.ts.map +1 -0
- package/dist/validation/fsm/index.js +64 -0
- package/dist/validation/fsm/index.js.map +1 -0
- package/dist/validation/fsm/states.d.ts +93 -0
- package/dist/validation/fsm/states.d.ts.map +1 -0
- package/dist/validation/fsm/states.js +98 -0
- package/dist/validation/fsm/states.js.map +1 -0
- package/dist/validation/fsm/transitions.d.ts +100 -0
- package/dist/validation/fsm/transitions.d.ts.map +1 -0
- package/dist/validation/fsm/transitions.js +122 -0
- package/dist/validation/fsm/transitions.js.map +1 -0
- package/dist/validation/fsm/validator.d.ts +163 -0
- package/dist/validation/fsm/validator.d.ts.map +1 -0
- package/dist/validation/fsm/validator.js +205 -0
- package/dist/validation/fsm/validator.js.map +1 -0
- package/dist/validation/index.d.ts +23 -0
- package/dist/validation/index.d.ts.map +1 -0
- package/dist/validation/index.js +25 -0
- package/dist/validation/index.js.map +1 -0
- package/dist/validation/types.d.ts +136 -0
- package/dist/validation/types.d.ts.map +1 -0
- package/dist/validation/types.js +56 -0
- package/dist/validation/types.js.map +1 -0
- package/dist/validation-schemas/codec-utils.d.ts +188 -0
- package/dist/validation-schemas/codec-utils.d.ts.map +1 -0
- package/dist/validation-schemas/codec-utils.js +258 -0
- package/dist/validation-schemas/codec-utils.js.map +1 -0
- package/dist/validation-schemas/config.d.ts +99 -0
- package/dist/validation-schemas/config.d.ts.map +1 -0
- package/dist/validation-schemas/config.js +178 -0
- package/dist/validation-schemas/config.js.map +1 -0
- package/dist/validation-schemas/doc-directive.d.ts +195 -0
- package/dist/validation-schemas/doc-directive.d.ts.map +1 -0
- package/dist/validation-schemas/doc-directive.js +239 -0
- package/dist/validation-schemas/doc-directive.js.map +1 -0
- package/dist/validation-schemas/dual-source.d.ts +167 -0
- package/dist/validation-schemas/dual-source.d.ts.map +1 -0
- package/dist/validation-schemas/dual-source.js +168 -0
- package/dist/validation-schemas/dual-source.js.map +1 -0
- package/dist/validation-schemas/export-info.d.ts +53 -0
- package/dist/validation-schemas/export-info.d.ts.map +1 -0
- package/dist/validation-schemas/export-info.js +101 -0
- package/dist/validation-schemas/export-info.js.map +1 -0
- package/dist/validation-schemas/extracted-pattern.d.ts +351 -0
- package/dist/validation-schemas/extracted-pattern.d.ts.map +1 -0
- package/dist/validation-schemas/extracted-pattern.js +459 -0
- package/dist/validation-schemas/extracted-pattern.js.map +1 -0
- package/dist/validation-schemas/extracted-shape.d.ts +200 -0
- package/dist/validation-schemas/extracted-shape.d.ts.map +1 -0
- package/dist/validation-schemas/extracted-shape.js +182 -0
- package/dist/validation-schemas/extracted-shape.js.map +1 -0
- package/dist/validation-schemas/feature.d.ts +554 -0
- package/dist/validation-schemas/feature.d.ts.map +1 -0
- package/dist/validation-schemas/feature.js +262 -0
- package/dist/validation-schemas/feature.js.map +1 -0
- package/dist/validation-schemas/index.d.ts +15 -0
- package/dist/validation-schemas/index.d.ts.map +1 -0
- package/dist/validation-schemas/index.js +32 -0
- package/dist/validation-schemas/index.js.map +1 -0
- package/dist/validation-schemas/lint.d.ts +46 -0
- package/dist/validation-schemas/lint.d.ts.map +1 -0
- package/dist/validation-schemas/lint.js +45 -0
- package/dist/validation-schemas/lint.js.map +1 -0
- package/dist/validation-schemas/master-dataset.d.ts +8299 -0
- package/dist/validation-schemas/master-dataset.d.ts.map +1 -0
- package/dist/validation-schemas/master-dataset.js +275 -0
- package/dist/validation-schemas/master-dataset.js.map +1 -0
- package/dist/validation-schemas/output-schemas.d.ts +183 -0
- package/dist/validation-schemas/output-schemas.d.ts.map +1 -0
- package/dist/validation-schemas/output-schemas.js +149 -0
- package/dist/validation-schemas/output-schemas.js.map +1 -0
- package/dist/validation-schemas/scenario-ref.d.ts +80 -0
- package/dist/validation-schemas/scenario-ref.d.ts.map +1 -0
- package/dist/validation-schemas/scenario-ref.js +73 -0
- package/dist/validation-schemas/scenario-ref.js.map +1 -0
- package/dist/validation-schemas/tag-registry.d.ts +210 -0
- package/dist/validation-schemas/tag-registry.d.ts.map +1 -0
- package/dist/validation-schemas/tag-registry.js +248 -0
- package/dist/validation-schemas/tag-registry.js.map +1 -0
- package/dist/validation-schemas/workflow-config.d.ts +125 -0
- package/dist/validation-schemas/workflow-config.d.ts.map +1 -0
- package/dist/validation-schemas/workflow-config.js +138 -0
- package/dist/validation-schemas/workflow-config.js.map +1 -0
- package/docs/ANNOTATION-GUIDE.md +271 -0
- package/docs/ARCHITECTURE.md +1636 -0
- package/docs/CONFIGURATION.md +337 -0
- package/docs/DOCS-GAP-ANALYSIS.md +811 -0
- package/docs/GHERKIN-PATTERNS.md +366 -0
- package/docs/INDEX.md +345 -0
- package/docs/MCP-SETUP.md +140 -0
- package/docs/METHODOLOGY.md +240 -0
- package/docs/PROCESS-API.md +65 -0
- package/docs/PROCESS-GUARD.md +341 -0
- package/docs/SESSION-GUIDES.md +391 -0
- package/docs/TAXONOMY.md +106 -0
- package/docs/VALIDATION.md +418 -0
- package/docs-live/ARCHITECTURE.md +362 -0
- package/docs-live/BUSINESS-RULES.md +24 -0
- package/docs-live/CHANGELOG-GENERATED.md +375 -0
- package/docs-live/DECISIONS.md +78 -0
- package/docs-live/INDEX.md +231 -0
- package/docs-live/PRODUCT-AREAS.md +255 -0
- package/docs-live/TAXONOMY.md +202 -0
- package/docs-live/VALIDATION-RULES.md +119 -0
- package/docs-live/_claude-md/annotation/annotation-overview.md +26 -0
- package/docs-live/_claude-md/annotation/annotation-reference.md +213 -0
- package/docs-live/_claude-md/architecture/architecture-codecs.md +160 -0
- package/docs-live/_claude-md/architecture/architecture-types.md +32 -0
- package/docs-live/_claude-md/architecture/reference-sample.md +162 -0
- package/docs-live/_claude-md/authoring/gherkin-authoring-guide.md +245 -0
- package/docs-live/_claude-md/configuration/configuration-guide.md +216 -0
- package/docs-live/_claude-md/configuration/configuration-overview.md +37 -0
- package/docs-live/_claude-md/core-types/core-types-overview.md +20 -0
- package/docs-live/_claude-md/data-api/data-api-overview.md +39 -0
- package/docs-live/_claude-md/generation/generation-overview.md +30 -0
- package/docs-live/_claude-md/process/process-overview.md +127 -0
- package/docs-live/_claude-md/validation/process-guard.md +185 -0
- package/docs-live/_claude-md/validation/validation-overview.md +37 -0
- package/docs-live/_claude-md/validation/validation-tools-guide.md +242 -0
- package/docs-live/_claude-md/workflow/session-workflow-guide.md +141 -0
- package/docs-live/business-rules/annotation.md +1462 -0
- package/docs-live/business-rules/configuration.md +465 -0
- package/docs-live/business-rules/core-types.md +531 -0
- package/docs-live/business-rules/data-api.md +1403 -0
- package/docs-live/business-rules/generation.md +4726 -0
- package/docs-live/business-rules/process.md +122 -0
- package/docs-live/business-rules/validation.md +998 -0
- package/docs-live/decisions/adr-001-taxonomy-canonical-values.md +197 -0
- package/docs-live/decisions/adr-002-gherkin-only-testing.md +57 -0
- package/docs-live/decisions/adr-003-source-first-pattern-architecture.md +147 -0
- package/docs-live/decisions/adr-004-session-workflow-commands.md +137 -0
- package/docs-live/decisions/adr-005-codec-based-markdown-rendering.md +150 -0
- package/docs-live/decisions/adr-006-single-read-model-architecture.md +136 -0
- package/docs-live/decisions/adr-021-doc-generation-proof-of-concept.md +489 -0
- package/docs-live/product-areas/ANNOTATION.md +591 -0
- package/docs-live/product-areas/CONFIGURATION.md +1048 -0
- package/docs-live/product-areas/CORE-TYPES.md +221 -0
- package/docs-live/product-areas/DATA-API.md +850 -0
- package/docs-live/product-areas/GENERATION.md +1200 -0
- package/docs-live/product-areas/PROCESS.md +351 -0
- package/docs-live/product-areas/VALIDATION.md +1135 -0
- package/docs-live/reference/ANNOTATION-REFERENCE.md +232 -0
- package/docs-live/reference/ARCHITECTURE-CODECS.md +675 -0
- package/docs-live/reference/ARCHITECTURE-TYPES.md +436 -0
- package/docs-live/reference/CONFIGURATION-GUIDE.md +235 -0
- package/docs-live/reference/GHERKIN-AUTHORING-GUIDE.md +270 -0
- package/docs-live/reference/PROCESS-API-RECIPES.md +476 -0
- package/docs-live/reference/PROCESS-API-REFERENCE.md +63 -0
- package/docs-live/reference/PROCESS-GUARD-REFERENCE.md +258 -0
- package/docs-live/reference/REFERENCE-SAMPLE.md +1135 -0
- package/docs-live/reference/SESSION-WORKFLOW-GUIDE.md +384 -0
- package/docs-live/reference/VALIDATION-TOOLS-GUIDE.md +263 -0
- package/docs-live/taxonomy/categories.md +33 -0
- package/docs-live/taxonomy/format-types.md +67 -0
- package/docs-live/taxonomy/metadata-tags.md +693 -0
- package/docs-live/validation/error-catalog.md +78 -0
- package/docs-live/validation/fsm-transitions.md +50 -0
- package/docs-live/validation/protection-levels.md +51 -0
- package/package.json +233 -0
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
# Taxonomy Reference
|
|
2
|
+
|
|
3
|
+
**Purpose:** Tag taxonomy configuration for code-first documentation
|
|
4
|
+
**Detail Level:** Overview with links to details
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Overview
|
|
9
|
+
|
|
10
|
+
**3 categories** | **60 metadata tags** | **3 aggregation tags**
|
|
11
|
+
|
|
12
|
+
Current configuration uses `@architect-` prefix with `@architect` file opt-in.
|
|
13
|
+
|
|
14
|
+
| Component | Count | Description |
|
|
15
|
+
| ---------------- | ----- | ------------------------------------ |
|
|
16
|
+
| Categories | 3 | Pattern classification by domain |
|
|
17
|
+
| Metadata Tags | 60 | Pattern enrichment and relationships |
|
|
18
|
+
| Aggregation Tags | 3 | Document routing |
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## Categories
|
|
23
|
+
|
|
24
|
+
Domain classifications for organizing patterns by priority.
|
|
25
|
+
|
|
26
|
+
| Tag | Domain | Priority | Description |
|
|
27
|
+
| ------- | -------------- | -------- | -------------- |
|
|
28
|
+
| `core` | Core | 1 | Core patterns |
|
|
29
|
+
| `api` | API | 2 | Public APIs |
|
|
30
|
+
| `infra` | Infrastructure | 3 | Infrastructure |
|
|
31
|
+
|
|
32
|
+
[Full category reference](taxonomy/categories.md)
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## Metadata Tags
|
|
37
|
+
|
|
38
|
+
Tags for enriching patterns with additional metadata.
|
|
39
|
+
|
|
40
|
+
### Core Tags
|
|
41
|
+
|
|
42
|
+
| Tag | Format | Purpose | Required | Example |
|
|
43
|
+
| --------- | ------------ | -------------------------------------------- | -------- | ----------------------------------------------------- |
|
|
44
|
+
| `pattern` | value | Explicit pattern name | Yes | `@architect-pattern CommandOrchestrator` |
|
|
45
|
+
| `status` | enum | Work item lifecycle status (per PDR-005 FSM) | No | `@architect-status roadmap` |
|
|
46
|
+
| `core` | flag | Marks as essential/must-know pattern | No | `@architect-core` |
|
|
47
|
+
| `usecase` | quoted-value | Use case association | No | `@architect-usecase "When handling command failures"` |
|
|
48
|
+
|
|
49
|
+
### Relationship Tags
|
|
50
|
+
|
|
51
|
+
| Tag | Format | Purpose | Required | Example |
|
|
52
|
+
| ------------ | ------ | -------------------------------------------------------------------------- | -------- | ---------------------------------------------------------------------- |
|
|
53
|
+
| `uses` | csv | Patterns this depends on | No | `@architect-uses CommandBus, EventStore` |
|
|
54
|
+
| `used-by` | csv | Patterns that depend on this | No | `@architect-used-by SagaOrchestrator` |
|
|
55
|
+
| `depends-on` | csv | Roadmap dependencies (pattern or phase names) | No | `@architect-depends-on EventStore, CommandBus` |
|
|
56
|
+
| `enables` | csv | Patterns this enables | No | `@architect-enables SagaOrchestrator, ProjectionBuilder` |
|
|
57
|
+
| `implements` | csv | Patterns this code file realizes (realization relationship) | No | `@architect-implements EventStoreDurability, IdempotentAppend` |
|
|
58
|
+
| `extends` | value | Base pattern this pattern extends (generalization relationship) | No | `@architect-extends ProjectionCategories` |
|
|
59
|
+
| `see-also` | csv | Related patterns for cross-reference without dependency implication | No | `@architect-see-also AgentAsBoundedContext, CrossContextIntegration` |
|
|
60
|
+
| `api-ref` | csv | File paths to implementation APIs (replaces 'See:' Markdown text in Rules) | No | `@architect-api-ref @libar-dev/platform-core/src/durability/outbox.ts` |
|
|
61
|
+
|
|
62
|
+
### Timeline Tags
|
|
63
|
+
|
|
64
|
+
| Tag | Format | Purpose | Required | Example |
|
|
65
|
+
| --------------- | ------ | ------------------------------------------------------------ | -------- | ------------------------------------ |
|
|
66
|
+
| `phase` | number | Roadmap phase number (unified across monorepo) | No | `@architect-phase 14` |
|
|
67
|
+
| `release` | value | Target release version (semver or vNEXT for unreleased work) | No | `@architect-release v0.1.0` |
|
|
68
|
+
| `quarter` | value | Delivery quarter for timeline tracking | No | `@architect-quarter Q1-2026` |
|
|
69
|
+
| `completed` | value | Completion date (YYYY-MM-DD format) | No | `@architect-completed 2026-01-08` |
|
|
70
|
+
| `effort` | value | Estimated effort (4h, 2d, 1w format) | No | `@architect-effort 2d` |
|
|
71
|
+
| `effort-actual` | value | Actual effort spent (4h, 2d, 1w format) | No | `@architect-effort-actual 3d` |
|
|
72
|
+
| `team` | value | Responsible team assignment | No | `@architect-team platform` |
|
|
73
|
+
| `workflow` | enum | Workflow discipline for process tracking | No | `@architect-workflow implementation` |
|
|
74
|
+
| `risk` | enum | Risk level for planning | No | `@architect-risk medium` |
|
|
75
|
+
| `priority` | enum | Priority level for roadmap ordering | No | `@architect-priority high` |
|
|
76
|
+
|
|
77
|
+
### ADR Tags
|
|
78
|
+
|
|
79
|
+
| Tag | Format | Purpose | Required | Example |
|
|
80
|
+
| ------------------- | ------ | ----------------------------------------------------- | -------- | -------------------------------------- |
|
|
81
|
+
| `adr` | value | ADR/PDR number for decision tracking | No | `@architect-adr 015` |
|
|
82
|
+
| `adr-status` | enum | ADR/PDR decision status | No | `@architect-adr-status accepted` |
|
|
83
|
+
| `adr-category` | value | ADR/PDR category (architecture, process, tooling) | No | `@architect-adr-category architecture` |
|
|
84
|
+
| `adr-supersedes` | value | ADR/PDR number this decision supersedes | No | `@architect-adr-supersedes 012` |
|
|
85
|
+
| `adr-superseded-by` | value | ADR/PDR number that supersedes this decision | No | `@architect-adr-superseded-by 020` |
|
|
86
|
+
| `adr-theme` | enum | Theme grouping for related decisions (from synthesis) | No | `@architect-adr-theme persistence` |
|
|
87
|
+
| `adr-layer` | enum | Evolutionary layer of the decision | No | `@architect-adr-layer foundation` |
|
|
88
|
+
|
|
89
|
+
### Architecture Tags
|
|
90
|
+
|
|
91
|
+
| Tag | Format | Purpose | Required | Example |
|
|
92
|
+
| -------------- | ------ | ----------------------------------------------------------------- | -------- | ----------------------------------- |
|
|
93
|
+
| `arch-role` | enum | Architectural role for diagram generation (component type) | No | `@architect-arch-role projection` |
|
|
94
|
+
| `arch-context` | value | Bounded context this component belongs to (for subgraph grouping) | No | `@architect-arch-context orders` |
|
|
95
|
+
| `arch-layer` | enum | Architectural layer for layered diagrams | No | `@architect-arch-layer application` |
|
|
96
|
+
|
|
97
|
+
### Other Tags
|
|
98
|
+
|
|
99
|
+
| Tag | Format | Purpose | Required | Example |
|
|
100
|
+
| ------------------------ | ------------ | -------------------------------------------------------------------------- | -------- | ---------------------------------------------------------------------------- |
|
|
101
|
+
| `brief` | value | Path to pattern brief markdown | No | `@architect-brief docs/briefs/decider-pattern.md` |
|
|
102
|
+
| `product-area` | value | Product area for PRD grouping | No | `@architect-product-area PlatformCore` |
|
|
103
|
+
| `user-role` | value | Target user persona for this feature | No | `@architect-user-role Developer` |
|
|
104
|
+
| `business-value` | value | Business value statement (hyphenated for tag format) | No | `@architect-business-value eliminates-event-replay-complexity` |
|
|
105
|
+
| `constraint` | value | Technical constraint affecting feature implementation | No | `@architect-constraint requires-convex-backend` |
|
|
106
|
+
| `level` | enum | Hierarchy level for epic->phase->task breakdown | No | `@architect-level epic` |
|
|
107
|
+
| `parent` | value | Parent pattern name in hierarchy (links tasks to phases, phases to epics) | No | `@architect-parent AggregateArchitecture` |
|
|
108
|
+
| `title` | quoted-value | Human-readable display title (supports quoted values with spaces) | No | `@architect-title:"Process Guard Linter"` |
|
|
109
|
+
| `executable-specs` | csv | Links roadmap spec to package executable spec locations (PDR-007) | No | `@architect-executable-specs platform-decider/tests/features/behavior` |
|
|
110
|
+
| `roadmap-spec` | value | Links package spec back to roadmap pattern for traceability (PDR-007) | No | `@architect-roadmap-spec DeciderPattern` |
|
|
111
|
+
| `behavior-file` | value | Path to behavior test feature file for traceability | No | `@architect-behavior-file behavior/my-pattern.feature` |
|
|
112
|
+
| `discovered-gap` | value | Gap identified during session retrospective | No | `@architect-discovered-gap missing-error-handling` |
|
|
113
|
+
| `discovered-improvement` | value | Improvement identified during session retrospective | No | `@architect-discovered-improvement cache-invalidation` |
|
|
114
|
+
| `discovered-risk` | value | Risk identified during session retrospective | No | `@architect-discovered-risk data-loss-on-migration` |
|
|
115
|
+
| `discovered-learning` | value | Learning captured during session retrospective | No | `@architect-discovered-learning convex-mutation-limits` |
|
|
116
|
+
| `extract-shapes` | csv | TypeScript type names to extract from this file for documentation | No | `@architect-extract-shapes DeciderInput, ValidationResult, ProcessViolation` |
|
|
117
|
+
| `shape` | value | Marks declaration as documentable shape, optionally with group name | No | `@architect-shape api-types` |
|
|
118
|
+
| `include` | csv | Cross-cutting document inclusion for content routing and diagram scoping | No | `@architect-include reference-sample,codec-system` |
|
|
119
|
+
| `target` | value | Target implementation path for stub files | No | `@architect-target src/api/stub-resolver.ts` |
|
|
120
|
+
| `since` | value | Design session that created this pattern | No | `@architect-since DS-A` |
|
|
121
|
+
| `convention` | csv | Convention domains for reference document generation from decision records | No | `@architect-convention fsm-rules, testing-policy` |
|
|
122
|
+
| `claude-module` | value | Module identifier for CLAUDE.md module generation (becomes filename) | No | `@architect-claude-module process-guard` |
|
|
123
|
+
| `claude-section` | enum | Target section directory in \_claude-md/ for module output | No | `@architect-claude-section process` |
|
|
124
|
+
| `claude-tags` | csv | Variation filtering tags for modular-claude-md inclusion | No | `@architect-claude-tags core-mandatory, process` |
|
|
125
|
+
| `sequence-orchestrator` | value | Identifies the coordinator module for sequence diagram generation | No | `@architect-sequence-orchestrator:init-cli` |
|
|
126
|
+
| `sequence-step` | number | Explicit execution ordering number for sequence diagram steps | No | `@architect-sequence-step:1` |
|
|
127
|
+
| `sequence-module` | csv | Maps Rule to deliverable module(s) for sequence diagram participants | No | `@architect-sequence-module:detect-context` |
|
|
128
|
+
| `sequence-error` | flag | Marks scenario as error/alternative path in sequence diagram | No | `@architect-sequence-error` |
|
|
129
|
+
|
|
130
|
+
[Full metadata tag reference](taxonomy/metadata-tags.md)
|
|
131
|
+
|
|
132
|
+
---
|
|
133
|
+
|
|
134
|
+
## Aggregation Tags
|
|
135
|
+
|
|
136
|
+
Tags that route patterns to specific aggregated documents.
|
|
137
|
+
|
|
138
|
+
| Tag | Target Document | Purpose |
|
|
139
|
+
| ---------- | --------------- | ------------------------------------------- |
|
|
140
|
+
| `overview` | OVERVIEW.md | Architecture overview patterns |
|
|
141
|
+
| `decision` | DECISIONS.md | ADR-style decisions (auto-numbered) |
|
|
142
|
+
| `intro` | None | Package introduction (template placeholder) |
|
|
143
|
+
|
|
144
|
+
---
|
|
145
|
+
|
|
146
|
+
## Format Types
|
|
147
|
+
|
|
148
|
+
How tag values are parsed and validated.
|
|
149
|
+
|
|
150
|
+
| Format | Description | Example |
|
|
151
|
+
| -------------- | ----------------------------------- | ------------------------------------- |
|
|
152
|
+
| `value` | Simple string value | `@architect-pattern MyPattern` |
|
|
153
|
+
| `enum` | Constrained to predefined values | `@architect-status roadmap` |
|
|
154
|
+
| `quoted-value` | String in quotes (preserves spaces) | `@architect-usecase "When X happens"` |
|
|
155
|
+
| `csv` | Comma-separated values | `@architect-uses A, B, C` |
|
|
156
|
+
| `number` | Numeric value | `@architect-phase 14` |
|
|
157
|
+
| `flag` | Boolean presence (no value) | `@architect-core` |
|
|
158
|
+
|
|
159
|
+
[Format type details](taxonomy/format-types.md)
|
|
160
|
+
|
|
161
|
+
---
|
|
162
|
+
|
|
163
|
+
## Presets
|
|
164
|
+
|
|
165
|
+
Available configuration presets.
|
|
166
|
+
|
|
167
|
+
| Preset | Tag Prefix | Categories | Use Case |
|
|
168
|
+
| --------------- | ------------- | ---------- | -------------------------------------- |
|
|
169
|
+
| `libar-generic` | `@architect-` | 3 | Default preset with @architect- prefix |
|
|
170
|
+
| `ddd-es-cqrs` | `@architect-` | 21 | Full DDD/ES/CQRS taxonomy |
|
|
171
|
+
|
|
172
|
+
---
|
|
173
|
+
|
|
174
|
+
## Architecture
|
|
175
|
+
|
|
176
|
+
Taxonomy source files and pipeline flow.
|
|
177
|
+
|
|
178
|
+
```plaintext
|
|
179
|
+
src/taxonomy/
|
|
180
|
+
├── categories.ts # Category definitions (21 DDD-ES-CQRS)
|
|
181
|
+
├── format-types.ts # Format type constants
|
|
182
|
+
├── registry-builder.ts # Single source of truth builder
|
|
183
|
+
├── status-values.ts # Status FSM values
|
|
184
|
+
├── generator-options.ts # Generator option values
|
|
185
|
+
├── hierarchy-levels.ts # Hierarchy level values
|
|
186
|
+
├── risk-levels.ts # Risk level values
|
|
187
|
+
└── index.ts # Barrel export
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
```mermaid
|
|
191
|
+
graph LR
|
|
192
|
+
Config[Configuration] --> Scanner[Scanner]
|
|
193
|
+
Scanner --> Extractor[Extractor]
|
|
194
|
+
Extractor --> Transformer[Transformer]
|
|
195
|
+
Transformer --> Codec[Codec]
|
|
196
|
+
Codec --> Markdown[Markdown]
|
|
197
|
+
|
|
198
|
+
Registry[TagRegistry] --> Scanner
|
|
199
|
+
Registry --> Extractor
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
---
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
# Validation Rules
|
|
2
|
+
|
|
3
|
+
**Purpose:** Process Guard validation rules and FSM reference
|
|
4
|
+
**Detail Level:** Overview with links to details
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Overview
|
|
9
|
+
|
|
10
|
+
Process Guard validates delivery workflow changes at commit time using a Decider pattern. It enforces the 4-state FSM defined in PDR-005 and prevents common workflow violations.
|
|
11
|
+
|
|
12
|
+
**6 validation rules** | **4 FSM states** | **3 protection levels**
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## Validation Rules
|
|
17
|
+
|
|
18
|
+
Rules are checked in order. Errors block commit; warnings are informational.
|
|
19
|
+
|
|
20
|
+
| Rule ID | Severity | Description |
|
|
21
|
+
| --------------------------- | -------- | --------------------------------------------------- |
|
|
22
|
+
| `completed-protection` | error | Completed specs require unlock-reason tag to modify |
|
|
23
|
+
| `invalid-status-transition` | error | Status transitions must follow FSM path |
|
|
24
|
+
| `scope-creep` | error | Active specs cannot add new deliverables |
|
|
25
|
+
| `session-scope` | warning | File outside session scope |
|
|
26
|
+
| `session-excluded` | error | File explicitly excluded from session |
|
|
27
|
+
| `deliverable-removed` | warning | Deliverable was removed from spec |
|
|
28
|
+
|
|
29
|
+
[Full error catalog with fix instructions](validation/error-catalog.md)
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## FSM State Diagram
|
|
34
|
+
|
|
35
|
+
Valid transitions per PDR-005 MVP Workflow:
|
|
36
|
+
|
|
37
|
+
```mermaid
|
|
38
|
+
stateDiagram-v2
|
|
39
|
+
[*] --> roadmap: new pattern
|
|
40
|
+
roadmap --> active
|
|
41
|
+
roadmap --> deferred
|
|
42
|
+
active --> completed
|
|
43
|
+
active --> roadmap: blocked/regressed
|
|
44
|
+
deferred --> roadmap
|
|
45
|
+
completed --> [*]: terminal
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
**Valid Transitions:**
|
|
49
|
+
|
|
50
|
+
- `roadmap` -> `active` -> `completed` (normal flow)
|
|
51
|
+
- `active` -> `roadmap` (blocked/regressed)
|
|
52
|
+
- `roadmap` <-> `deferred` (parking)
|
|
53
|
+
|
|
54
|
+
[Detailed transition matrix](validation/fsm-transitions.md)
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## Protection Levels
|
|
59
|
+
|
|
60
|
+
Protection levels determine what modifications are allowed per status.
|
|
61
|
+
|
|
62
|
+
| Status | Protection | Can Add Deliverables | Needs Unlock |
|
|
63
|
+
| ----------- | ---------- | -------------------- | ------------ |
|
|
64
|
+
| `roadmap` | none | Yes | No |
|
|
65
|
+
| `active` | scope | No | No |
|
|
66
|
+
| `completed` | hard | No | Yes |
|
|
67
|
+
| `deferred` | none | Yes | No |
|
|
68
|
+
|
|
69
|
+
[Protection level details](validation/protection-levels.md)
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
## CLI Usage
|
|
74
|
+
|
|
75
|
+
```bash
|
|
76
|
+
# Pre-commit (default mode)
|
|
77
|
+
lint-process --staged
|
|
78
|
+
|
|
79
|
+
# CI pipeline with strict mode
|
|
80
|
+
lint-process --all --strict
|
|
81
|
+
|
|
82
|
+
# Override session scope checking
|
|
83
|
+
lint-process --staged --ignore-session
|
|
84
|
+
|
|
85
|
+
# Debug: show derived process state
|
|
86
|
+
lint-process --staged --show-state
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### Options
|
|
90
|
+
|
|
91
|
+
| Flag | Description |
|
|
92
|
+
| ------------------ | --------------------------------------- |
|
|
93
|
+
| `--staged` | Validate staged files only (pre-commit) |
|
|
94
|
+
| `--all` | Validate all tracked files (CI) |
|
|
95
|
+
| `--strict` | Treat warnings as errors (exit 1) |
|
|
96
|
+
| `--ignore-session` | Skip session scope validation |
|
|
97
|
+
| `--show-state` | Debug: show derived process state |
|
|
98
|
+
| `--format json` | Machine-readable JSON output |
|
|
99
|
+
|
|
100
|
+
### Exit Codes
|
|
101
|
+
|
|
102
|
+
| Code | Meaning |
|
|
103
|
+
| ---- | ---------------------------------------------- |
|
|
104
|
+
| `0` | No errors (warnings allowed unless `--strict`) |
|
|
105
|
+
| `1` | Errors found or warnings with `--strict` |
|
|
106
|
+
|
|
107
|
+
---
|
|
108
|
+
|
|
109
|
+
## Escape Hatches
|
|
110
|
+
|
|
111
|
+
Override mechanisms for exceptional situations.
|
|
112
|
+
|
|
113
|
+
| Situation | Solution | Example |
|
|
114
|
+
| ---------------------------- | --------------------- | ---------------------------------------- |
|
|
115
|
+
| Fix bug in completed spec | Add unlock reason tag | `@architect-unlock-reason:'Fix-typo'` |
|
|
116
|
+
| Modify outside session scope | Use ignore flag | `lint-process --staged --ignore-session` |
|
|
117
|
+
| CI treats warnings as errors | Use strict flag | `lint-process --all --strict` |
|
|
118
|
+
|
|
119
|
+
---
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
### Annotation Overview
|
|
2
|
+
|
|
3
|
+
**How do I annotate code?** The annotation system is the ingestion boundary — it transforms annotated TypeScript and Gherkin files into `ExtractedPattern[]` objects that feed the entire downstream pipeline. Two parallel scanning paths (TypeScript AST + Gherkin parser) converge through dual-source merging. The system is fully data-driven: the `TagRegistry` defines all tags, formats, and categories — adding a new annotation requires only a registry entry, zero parser changes.
|
|
4
|
+
|
|
5
|
+
#### Key Invariants
|
|
6
|
+
|
|
7
|
+
- Source ownership enforced: `uses`/`used-by`/`category` belong in TypeScript only; `depends-on`/`quarter`/`team`/`phase` belong in Gherkin only. Anti-pattern detector validates at lint time
|
|
8
|
+
- Data-driven tag dispatch: Both AST parser and Gherkin parser use `TagRegistry.metadataTags` to determine extraction. 6 format types (`value`/`enum`/`csv`/`number`/`flag`/`quoted-value`) cover all tag shapes — zero parser changes for new tags
|
|
9
|
+
- Pipeline data preservation: Gherkin `Rule:` blocks, deliverables, scenarios, and all metadata flow through scanner → extractor → `ExtractedPattern` → generators without data loss
|
|
10
|
+
- Dual-source merge with conflict detection: Same pattern name in both TypeScript and Gherkin produces a merge conflict error. Phase mismatches between sources produce validation errors
|
|
11
|
+
|
|
12
|
+
**Components:** Extractor (GherkinExtractor, DualSourceExtractor, Document Extractor), Scanner (Pattern Scanner, GherkinScanner, GherkinASTParser, TypeScript AST Parser)
|
|
13
|
+
|
|
14
|
+
#### API Types
|
|
15
|
+
|
|
16
|
+
| Type | Kind |
|
|
17
|
+
| -------------------------------- | --------- |
|
|
18
|
+
| TagRegistry | interface |
|
|
19
|
+
| MetadataTagDefinitionForRegistry | interface |
|
|
20
|
+
| CategoryDefinition | interface |
|
|
21
|
+
| TagDefinition | type |
|
|
22
|
+
| CategoryTag | type |
|
|
23
|
+
| buildRegistry | function |
|
|
24
|
+
| METADATA_TAGS_BY_GROUP | const |
|
|
25
|
+
| CATEGORIES | const |
|
|
26
|
+
| CATEGORY_TAGS | const |
|
|
@@ -0,0 +1,213 @@
|
|
|
1
|
+
### Annotation Reference Guide
|
|
2
|
+
|
|
3
|
+
#### Getting Started
|
|
4
|
+
|
|
5
|
+
Every file that participates in the annotation system must have a `@architect` opt-in marker. Files without this marker are invisible to the scanner.
|
|
6
|
+
|
|
7
|
+
##### File-Level Opt-In
|
|
8
|
+
|
|
9
|
+
**TypeScript** -- file-level JSDoc block:
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
/**
|
|
13
|
+
* @architect
|
|
14
|
+
* @architect-pattern MyPattern
|
|
15
|
+
* @architect-status roadmap
|
|
16
|
+
* @architect-uses EventStore, CommandBus
|
|
17
|
+
*
|
|
18
|
+
* ## My Pattern - Description
|
|
19
|
+
*/
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
**Gherkin** -- file-level tags before `Feature:`:
|
|
23
|
+
|
|
24
|
+
```gherkin
|
|
25
|
+
@architect
|
|
26
|
+
@architect-pattern:MyPattern
|
|
27
|
+
@architect-status:roadmap
|
|
28
|
+
@architect-phase:14
|
|
29
|
+
Feature: My Pattern
|
|
30
|
+
|
|
31
|
+
**Problem:**
|
|
32
|
+
Description of the problem.
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
##### Tag Prefix by Preset
|
|
36
|
+
|
|
37
|
+
| Preset | Prefix | Categories | Use Case |
|
|
38
|
+
| ------------------------- | ------------- | ---------- | ---------------------------- |
|
|
39
|
+
| `libar-generic` (default) | `@architect-` | 3 | Simple projects |
|
|
40
|
+
| `ddd-es-cqrs` | `@architect-` | 21 | DDD/Event Sourcing monorepos |
|
|
41
|
+
|
|
42
|
+
##### Dual-Source Ownership
|
|
43
|
+
|
|
44
|
+
| Source | Owns | Example Tags |
|
|
45
|
+
| -------------- | ----------------------------------------------- | -------------------------------------------- |
|
|
46
|
+
| **TypeScript** | Implementation: runtime deps, category, shapes | `uses`, `used-by`, `extract-shapes`, `shape` |
|
|
47
|
+
| **Gherkin** | Planning: status, phase, timeline, dependencies | `status`, `phase`, `depends-on`, `quarter` |
|
|
48
|
+
|
|
49
|
+
#### Shape Extraction
|
|
50
|
+
|
|
51
|
+
Shape extraction pulls TypeScript type definitions (interfaces, type aliases, enums, functions, consts) into generated documentation. There are three modes:
|
|
52
|
+
|
|
53
|
+
##### Mode 1: File-Level Explicit Names
|
|
54
|
+
|
|
55
|
+
List specific declaration names in the file-level JSDoc:
|
|
56
|
+
|
|
57
|
+
```typescript
|
|
58
|
+
/**
|
|
59
|
+
* @architect
|
|
60
|
+
* @architect-extract-shapes MasterDatasetSchema, StatusGroupsSchema
|
|
61
|
+
*/
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
Names appear in the generated output in the order listed.
|
|
65
|
+
|
|
66
|
+
##### Mode 2: File-Level Wildcard
|
|
67
|
+
|
|
68
|
+
```typescript
|
|
69
|
+
/**
|
|
70
|
+
* @architect
|
|
71
|
+
* @architect-extract-shapes *
|
|
72
|
+
*/
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
Wildcard must be the sole value -- `*, Foo` is invalid.
|
|
76
|
+
|
|
77
|
+
##### Mode 3: Declaration-Level Tagging
|
|
78
|
+
|
|
79
|
+
Tag individual declarations with `@architect-shape`, optionally with a group name:
|
|
80
|
+
|
|
81
|
+
```typescript
|
|
82
|
+
/** @architect-shape api-types */
|
|
83
|
+
export interface CommandInput {
|
|
84
|
+
readonly aggregateId: string;
|
|
85
|
+
readonly payload: unknown;
|
|
86
|
+
}
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
The optional group name (`api-types`) enables filtering in diagram scopes and product area documents via `@architect-include`.
|
|
90
|
+
|
|
91
|
+
#### Critical Gotcha: Zod Schemas
|
|
92
|
+
|
|
93
|
+
For Zod files, extract the **schema constant** (with `Schema` suffix), not the inferred type alias:
|
|
94
|
+
|
|
95
|
+
| Wrong (type alias) | Correct (schema constant) |
|
|
96
|
+
| ---------------------------------------- | ----------------------------------------- |
|
|
97
|
+
| `@extract-shapes MasterDataset` | `@extract-shapes MasterDatasetSchema` |
|
|
98
|
+
| Shows: `z.infer<typeof ...>` (unhelpful) | Shows: `z.object({...})` (full structure) |
|
|
99
|
+
|
|
100
|
+
#### Annotation Patterns by File Type
|
|
101
|
+
|
|
102
|
+
##### Zod Schema Files
|
|
103
|
+
|
|
104
|
+
```typescript
|
|
105
|
+
/**
|
|
106
|
+
* @architect
|
|
107
|
+
* @architect-pattern MasterDataset
|
|
108
|
+
* @architect-status completed
|
|
109
|
+
* @architect-extract-shapes MasterDatasetSchema, StatusGroupsSchema, PhaseGroupSchema
|
|
110
|
+
*/
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
##### Interface / Type Files
|
|
114
|
+
|
|
115
|
+
```typescript
|
|
116
|
+
/**
|
|
117
|
+
* @architect
|
|
118
|
+
* @architect-pattern DocumentGenerator
|
|
119
|
+
* @architect-status completed
|
|
120
|
+
* @architect-extract-shapes DocumentGenerator, GeneratorContext, GeneratorOutput
|
|
121
|
+
*/
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
##### Function / Service Files
|
|
125
|
+
|
|
126
|
+
```typescript
|
|
127
|
+
/**
|
|
128
|
+
* @architect
|
|
129
|
+
* @architect-pattern TransformDataset
|
|
130
|
+
* @architect-status completed
|
|
131
|
+
* @architect-arch-context generator
|
|
132
|
+
* @architect-arch-layer application
|
|
133
|
+
* @architect-extract-shapes transformToMasterDataset, RuntimeMasterDataset
|
|
134
|
+
*/
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
##### Gherkin Feature Files
|
|
138
|
+
|
|
139
|
+
```gherkin
|
|
140
|
+
@architect
|
|
141
|
+
@architect-pattern:ProcessGuardLinter
|
|
142
|
+
@architect-status:roadmap
|
|
143
|
+
@architect-phase:99
|
|
144
|
+
@architect-depends-on:StateMachine,ValidationRules
|
|
145
|
+
Feature: Process Guard Linter
|
|
146
|
+
|
|
147
|
+
Background: Deliverables
|
|
148
|
+
Given the following deliverables:
|
|
149
|
+
| Deliverable | Status | Location |
|
|
150
|
+
| State derivation | Pending | src/lint/derive.ts |
|
|
151
|
+
|
|
152
|
+
Rule: Completed specs require unlock reason
|
|
153
|
+
|
|
154
|
+
**Invariant:** A completed spec cannot be modified without explicit unlock.
|
|
155
|
+
**Rationale:** Prevents accidental regression of validated work.
|
|
156
|
+
|
|
157
|
+
@acceptance-criteria @happy-path
|
|
158
|
+
Scenario: Reject modification without unlock
|
|
159
|
+
Given a spec with status "completed"
|
|
160
|
+
When I modify a deliverable
|
|
161
|
+
Then validation fails with "completed-protection"
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
#### Tag Groups Quick Reference
|
|
165
|
+
|
|
166
|
+
Tags are organized into 12 functional groups. For the complete reference with all values, see the generated [Taxonomy Reference](../docs-live/TAXONOMY.md).
|
|
167
|
+
|
|
168
|
+
| Group | Tags (representative) | Format Types |
|
|
169
|
+
| ---------------- | ---------------------------------------------------- | ------------------------- |
|
|
170
|
+
| **Core** | `pattern`, `status`, `core`, `brief` | value, enum, flag |
|
|
171
|
+
| **Relationship** | `uses`, `used-by`, `implements`, `depends-on` | csv, value |
|
|
172
|
+
| **Process** | `phase`, `quarter`, `effort`, `team`, `priority` | number, value, enum |
|
|
173
|
+
| **PRD** | `product-area`, `user-role`, `business-value` | value |
|
|
174
|
+
| **ADR** | `adr`, `adr-status`, `adr-category`, `adr-theme` | value, enum |
|
|
175
|
+
| **Hierarchy** | `level`, `parent`, `title` | enum, value, quoted-value |
|
|
176
|
+
| **Traceability** | `executable-specs`, `roadmap-spec`, `behavior-file` | csv, value |
|
|
177
|
+
| **Discovery** | `discovered-gap`, `discovered-improvement` | value (repeatable) |
|
|
178
|
+
| **Architecture** | `arch-role`, `arch-context`, `arch-layer`, `include` | enum, value, csv |
|
|
179
|
+
| **Extraction** | `extract-shapes`, `shape` | csv, value |
|
|
180
|
+
| **Stub** | `target`, `since` | value |
|
|
181
|
+
| **Convention** | `convention` | csv (enum values) |
|
|
182
|
+
|
|
183
|
+
#### Verification
|
|
184
|
+
|
|
185
|
+
##### CLI Commands
|
|
186
|
+
|
|
187
|
+
```bash
|
|
188
|
+
# Tag usage inventory (counts per tag and value)
|
|
189
|
+
pnpm architect:query -- tags
|
|
190
|
+
|
|
191
|
+
# Find files missing @architect opt-in marker
|
|
192
|
+
pnpm architect:query -- unannotated --path src/types
|
|
193
|
+
|
|
194
|
+
# File inventory by type (TS, Gherkin, Stubs)
|
|
195
|
+
pnpm architect:query -- sources
|
|
196
|
+
|
|
197
|
+
# Full pattern JSON including extractedShapes
|
|
198
|
+
pnpm architect:query -- query getPattern MyPattern
|
|
199
|
+
|
|
200
|
+
# Generate complete tag reference
|
|
201
|
+
pnpm docs:taxonomy
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
#### Common Issues
|
|
205
|
+
|
|
206
|
+
| Symptom | Cause | Fix |
|
|
207
|
+
| ------------------------------- | ---------------------------------- | ----------------------------------------------- |
|
|
208
|
+
| Pattern not in scanner output | Missing `@architect` opt-in marker | Add file-level `@architect` JSDoc/tag |
|
|
209
|
+
| Shape shows `z.infer<>` wrapper | Extracted type alias, not schema | Use schema constant name (e.g., `FooSchema`) |
|
|
210
|
+
| Shape not in product area doc | Missing `@architect-product-area` | Add product-area tag to file-level annotation |
|
|
211
|
+
| Declaration-level shape missing | No `@architect-shape` on decl | Add `@architect-shape` JSDoc to the declaration |
|
|
212
|
+
| Tag value rejected | Wrong format or invalid enum value | Check format type in taxonomy reference |
|
|
213
|
+
| Anti-pattern validation error | Tag on wrong source type | Move tag to correct source (TS vs Gherkin) |
|