@lyse-labs/lyse 0.1.0-alpha.2
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/LICENSE +45 -0
- package/PRIVACY.md +181 -0
- package/README.md +34 -0
- package/SECURITY.md +43 -0
- package/dist/bench/evidence-pack/anti-dummy.d.ts +11 -0
- package/dist/bench/evidence-pack/anti-dummy.js +20 -0
- package/dist/bench/evidence-pack/anti-dummy.js.map +1 -0
- package/dist/bench/evidence-pack/builder.d.ts +14 -0
- package/dist/bench/evidence-pack/builder.js +77 -0
- package/dist/bench/evidence-pack/builder.js.map +1 -0
- package/dist/bench/evidence-pack/histograms.d.ts +2 -0
- package/dist/bench/evidence-pack/histograms.js +131 -0
- package/dist/bench/evidence-pack/histograms.js.map +1 -0
- package/dist/bench/evidence-pack/manifest-detector.d.ts +2 -0
- package/dist/bench/evidence-pack/manifest-detector.js +65 -0
- package/dist/bench/evidence-pack/manifest-detector.js.map +1 -0
- package/dist/bench/evidence-pack/package-json-digest.d.ts +2 -0
- package/dist/bench/evidence-pack/package-json-digest.js +51 -0
- package/dist/bench/evidence-pack/package-json-digest.js.map +1 -0
- package/dist/bench/evidence-pack/sampler.d.ts +2 -0
- package/dist/bench/evidence-pack/sampler.js +140 -0
- package/dist/bench/evidence-pack/sampler.js.map +1 -0
- package/dist/bench/evidence-pack/types.d.ts +127 -0
- package/dist/bench/evidence-pack/types.js +2 -0
- package/dist/bench/evidence-pack/types.js.map +1 -0
- package/dist/bench/evidence-pack/verifier-corpus.d.ts +5 -0
- package/dist/bench/evidence-pack/verifier-corpus.js +13 -0
- package/dist/bench/evidence-pack/verifier-corpus.js.map +1 -0
- package/dist/bench/taxonomy-loader.d.ts +20 -0
- package/dist/bench/taxonomy-loader.js +28 -0
- package/dist/bench/taxonomy-loader.js.map +1 -0
- package/dist/bench/taxonomy.v3.json +20 -0
- package/dist/cli/__tests__/version-migration.test.d.ts +1 -0
- package/dist/cli/__tests__/version-migration.test.js +69 -0
- package/dist/cli/__tests__/version-migration.test.js.map +1 -0
- package/dist/cli/output/__tests__/eslint-style.test.d.ts +1 -0
- package/dist/cli/output/__tests__/eslint-style.test.js +205 -0
- package/dist/cli/output/__tests__/eslint-style.test.js.map +1 -0
- package/dist/cli/output/__tests__/limit.test.d.ts +1 -0
- package/dist/cli/output/__tests__/limit.test.js +65 -0
- package/dist/cli/output/__tests__/limit.test.js.map +1 -0
- package/dist/cli/output/eslint-style.d.ts +18 -0
- package/dist/cli/output/eslint-style.js +42 -0
- package/dist/cli/output/eslint-style.js.map +1 -0
- package/dist/cli/output/limit.d.ts +5 -0
- package/dist/cli/output/limit.js +32 -0
- package/dist/cli/output/limit.js.map +1 -0
- package/dist/cli/output/score-gauge.d.ts +4 -0
- package/dist/cli/output/score-gauge.js +15 -0
- package/dist/cli/output/score-gauge.js.map +1 -0
- package/dist/cli/version-migration.d.ts +18 -0
- package/dist/cli/version-migration.js +49 -0
- package/dist/cli/version-migration.js.map +1 -0
- package/dist/cli.d.ts +2 -0
- package/dist/cli.js +856 -0
- package/dist/cli.js.map +1 -0
- package/dist/codemods/diff.d.ts +17 -0
- package/dist/codemods/diff.js +77 -0
- package/dist/codemods/diff.js.map +1 -0
- package/dist/codemods/git-helpers.d.ts +10 -0
- package/dist/codemods/git-helpers.js +75 -0
- package/dist/codemods/git-helpers.js.map +1 -0
- package/dist/codemods/index.d.ts +27 -0
- package/dist/codemods/index.js +40 -0
- package/dist/codemods/index.js.map +1 -0
- package/dist/codemods/naming-component-pascalcase.d.ts +13 -0
- package/dist/codemods/naming-component-pascalcase.js +106 -0
- package/dist/codemods/naming-component-pascalcase.js.map +1 -0
- package/dist/codemods/naming-hook-prefix.d.ts +13 -0
- package/dist/codemods/naming-hook-prefix.js +86 -0
- package/dist/codemods/naming-hook-prefix.js.map +1 -0
- package/dist/codemods/safety.d.ts +50 -0
- package/dist/codemods/safety.js +109 -0
- package/dist/codemods/safety.js.map +1 -0
- package/dist/codemods/safety.test.d.ts +1 -0
- package/dist/codemods/safety.test.js +154 -0
- package/dist/codemods/safety.test.js.map +1 -0
- package/dist/codemods/shadow-native.d.ts +2 -0
- package/dist/codemods/shadow-native.js +103 -0
- package/dist/codemods/shadow-native.js.map +1 -0
- package/dist/codemods/tokens-color.d.ts +2 -0
- package/dist/codemods/tokens-color.js +69 -0
- package/dist/codemods/tokens-color.js.map +1 -0
- package/dist/codemods/tokens-spacing.d.ts +2 -0
- package/dist/codemods/tokens-spacing.js +66 -0
- package/dist/codemods/tokens-spacing.js.map +1 -0
- package/dist/commands/__tests__/email-prompt.test.d.ts +1 -0
- package/dist/commands/__tests__/email-prompt.test.js +126 -0
- package/dist/commands/__tests__/email-prompt.test.js.map +1 -0
- package/dist/commands/__tests__/explain-score.test.d.ts +1 -0
- package/dist/commands/__tests__/explain-score.test.js +88 -0
- package/dist/commands/__tests__/explain-score.test.js.map +1 -0
- package/dist/commands/__tests__/feedback.test.d.ts +1 -0
- package/dist/commands/__tests__/feedback.test.js +186 -0
- package/dist/commands/__tests__/feedback.test.js.map +1 -0
- package/dist/commands/audit-flags.d.ts +49 -0
- package/dist/commands/audit-flags.js +17 -0
- package/dist/commands/audit-flags.js.map +1 -0
- package/dist/commands/audit-pipeline.d.ts +31 -0
- package/dist/commands/audit-pipeline.js +342 -0
- package/dist/commands/audit-pipeline.js.map +1 -0
- package/dist/commands/bench-pack.d.ts +5 -0
- package/dist/commands/bench-pack.js +61 -0
- package/dist/commands/bench-pack.js.map +1 -0
- package/dist/commands/ci-setup.d.ts +9 -0
- package/dist/commands/ci-setup.js +42 -0
- package/dist/commands/ci-setup.js.map +1 -0
- package/dist/commands/email-prompt.d.ts +36 -0
- package/dist/commands/email-prompt.js +160 -0
- package/dist/commands/email-prompt.js.map +1 -0
- package/dist/commands/explain-score.d.ts +35 -0
- package/dist/commands/explain-score.js +137 -0
- package/dist/commands/explain-score.js.map +1 -0
- package/dist/commands/explain.d.ts +6 -0
- package/dist/commands/explain.js +93 -0
- package/dist/commands/explain.js.map +1 -0
- package/dist/commands/feedback.d.ts +31 -0
- package/dist/commands/feedback.js +155 -0
- package/dist/commands/feedback.js.map +1 -0
- package/dist/commands/fix.d.ts +48 -0
- package/dist/commands/fix.js +191 -0
- package/dist/commands/fix.js.map +1 -0
- package/dist/commands/init-detect.d.ts +20 -0
- package/dist/commands/init-detect.js +124 -0
- package/dist/commands/init-detect.js.map +1 -0
- package/dist/commands/init-write-agents-md.d.ts +14 -0
- package/dist/commands/init-write-agents-md.js +71 -0
- package/dist/commands/init-write-agents-md.js.map +1 -0
- package/dist/commands/init-write-lyse-md.d.ts +14 -0
- package/dist/commands/init-write-lyse-md.js +253 -0
- package/dist/commands/init-write-lyse-md.js.map +1 -0
- package/dist/commands/init.d.ts +8 -0
- package/dist/commands/init.js +147 -0
- package/dist/commands/init.js.map +1 -0
- package/dist/commands/mcp-entry.d.ts +33 -0
- package/dist/commands/mcp-entry.js +47 -0
- package/dist/commands/mcp-entry.js.map +1 -0
- package/dist/commands/mcp-setup.d.ts +10 -0
- package/dist/commands/mcp-setup.js +74 -0
- package/dist/commands/mcp-setup.js.map +1 -0
- package/dist/commands/share.d.ts +4 -0
- package/dist/commands/share.js +60 -0
- package/dist/commands/share.js.map +1 -0
- package/dist/commands/telemetry.d.ts +4 -0
- package/dist/commands/telemetry.js +27 -0
- package/dist/commands/telemetry.js.map +1 -0
- package/dist/commands/templates/lyse-workflow.yml.template +30 -0
- package/dist/config/schema.d.ts +158 -0
- package/dist/config/schema.js +136 -0
- package/dist/config/schema.js.map +1 -0
- package/dist/credentials/keychain.d.ts +20 -0
- package/dist/credentials/keychain.js +35 -0
- package/dist/credentials/keychain.js.map +1 -0
- package/dist/credentials/keychain.test.d.ts +1 -0
- package/dist/credentials/keychain.test.js +32 -0
- package/dist/credentials/keychain.test.js.map +1 -0
- package/dist/credentials/paths.d.ts +1 -0
- package/dist/credentials/paths.js +6 -0
- package/dist/credentials/paths.js.map +1 -0
- package/dist/credentials/store.d.ts +17 -0
- package/dist/credentials/store.js +60 -0
- package/dist/credentials/store.js.map +1 -0
- package/dist/credentials/store.test.d.ts +1 -0
- package/dist/credentials/store.test.js +48 -0
- package/dist/credentials/store.test.js.map +1 -0
- package/dist/detection/from-filesystem.d.ts +2 -0
- package/dist/detection/from-filesystem.js +26 -0
- package/dist/detection/from-filesystem.js.map +1 -0
- package/dist/detection/from-git.d.ts +2 -0
- package/dist/detection/from-git.js +53 -0
- package/dist/detection/from-git.js.map +1 -0
- package/dist/detection/from-package-json.d.ts +2 -0
- package/dist/detection/from-package-json.js +194 -0
- package/dist/detection/from-package-json.js.map +1 -0
- package/dist/detection/pre-flight.d.ts +5 -0
- package/dist/detection/pre-flight.js +47 -0
- package/dist/detection/pre-flight.js.map +1 -0
- package/dist/detection/types.d.ts +27 -0
- package/dist/detection/types.js +2 -0
- package/dist/detection/types.js.map +1 -0
- package/dist/entitlement/check.d.ts +7 -0
- package/dist/entitlement/check.js +37 -0
- package/dist/entitlement/check.js.map +1 -0
- package/dist/entitlement/index.d.ts +1 -0
- package/dist/entitlement/index.js +2 -0
- package/dist/entitlement/index.js.map +1 -0
- package/dist/entitlement/keys.d.ts +10 -0
- package/dist/entitlement/keys.js +14 -0
- package/dist/entitlement/keys.js.map +1 -0
- package/dist/history/ndjson-store.d.ts +70 -0
- package/dist/history/ndjson-store.js +102 -0
- package/dist/history/ndjson-store.js.map +1 -0
- package/dist/identity/index.d.ts +1 -0
- package/dist/identity/index.js +2 -0
- package/dist/identity/index.js.map +1 -0
- package/dist/identity/repo-bucket.d.ts +22 -0
- package/dist/identity/repo-bucket.js +78 -0
- package/dist/identity/repo-bucket.js.map +1 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +15 -0
- package/dist/index.js.map +1 -0
- package/dist/llm/layer4-stage.d.ts +18 -0
- package/dist/llm/layer4-stage.js +12 -0
- package/dist/llm/layer4-stage.js.map +1 -0
- package/dist/loaders/components.d.ts +26 -0
- package/dist/loaders/components.js +285 -0
- package/dist/loaders/components.js.map +1 -0
- package/dist/loaders/stories.d.ts +2 -0
- package/dist/loaders/stories.js +231 -0
- package/dist/loaders/stories.js.map +1 -0
- package/dist/loaders/token-graph.d.ts +39 -0
- package/dist/loaders/token-graph.js +146 -0
- package/dist/loaders/token-graph.js.map +1 -0
- package/dist/loaders/tokens.d.ts +2 -0
- package/dist/loaders/tokens.js +521 -0
- package/dist/loaders/tokens.js.map +1 -0
- package/dist/mcp/_find-root.d.ts +12 -0
- package/dist/mcp/_find-root.js +28 -0
- package/dist/mcp/_find-root.js.map +1 -0
- package/dist/mcp/server.d.ts +1 -0
- package/dist/mcp/server.js +42 -0
- package/dist/mcp/server.js.map +1 -0
- package/dist/mcp/tools/audit-file.d.ts +25 -0
- package/dist/mcp/tools/audit-file.js +147 -0
- package/dist/mcp/tools/audit-file.js.map +1 -0
- package/dist/mcp/tools/suggest-fix.d.ts +13 -0
- package/dist/mcp/tools/suggest-fix.js +100 -0
- package/dist/mcp/tools/suggest-fix.js.map +1 -0
- package/dist/menu/action-menu.d.ts +6 -0
- package/dist/menu/action-menu.js +15 -0
- package/dist/menu/action-menu.js.map +1 -0
- package/dist/menu/prompts.d.ts +7 -0
- package/dist/menu/prompts.js +30 -0
- package/dist/menu/prompts.js.map +1 -0
- package/dist/menu/repl.d.ts +17 -0
- package/dist/menu/repl.js +77 -0
- package/dist/menu/repl.js.map +1 -0
- package/dist/parsers/css-in-js.d.ts +2 -0
- package/dist/parsers/css-in-js.js +69 -0
- package/dist/parsers/css-in-js.js.map +1 -0
- package/dist/parsers/css.d.ts +2 -0
- package/dist/parsers/css.js +32 -0
- package/dist/parsers/css.js.map +1 -0
- package/dist/parsers/scss-transform.d.ts +25 -0
- package/dist/parsers/scss-transform.js +55 -0
- package/dist/parsers/scss-transform.js.map +1 -0
- package/dist/parsers/tailwind-v4.d.ts +8 -0
- package/dist/parsers/tailwind-v4.js +90 -0
- package/dist/parsers/tailwind-v4.js.map +1 -0
- package/dist/parsers/ts-morph-project.d.ts +16 -0
- package/dist/parsers/ts-morph-project.js +77 -0
- package/dist/parsers/ts-morph-project.js.map +1 -0
- package/dist/parsers/ts.d.ts +2 -0
- package/dist/parsers/ts.js +61 -0
- package/dist/parsers/ts.js.map +1 -0
- package/dist/reliability/__tests__/types.test.d.ts +1 -0
- package/dist/reliability/__tests__/types.test.js +14 -0
- package/dist/reliability/__tests__/types.test.js.map +1 -0
- package/dist/reliability/catalogue/__tests__/promotion.test.d.ts +1 -0
- package/dist/reliability/catalogue/__tests__/promotion.test.js +23 -0
- package/dist/reliability/catalogue/__tests__/promotion.test.js.map +1 -0
- package/dist/reliability/catalogue/__tests__/sub-axes.test.d.ts +1 -0
- package/dist/reliability/catalogue/__tests__/sub-axes.test.js +27 -0
- package/dist/reliability/catalogue/__tests__/sub-axes.test.js.map +1 -0
- package/dist/reliability/catalogue/promotion.d.ts +8 -0
- package/dist/reliability/catalogue/promotion.js +25 -0
- package/dist/reliability/catalogue/promotion.js.map +1 -0
- package/dist/reliability/catalogue/sub-axes.d.ts +3 -0
- package/dist/reliability/catalogue/sub-axes.js +18 -0
- package/dist/reliability/catalogue/sub-axes.js.map +1 -0
- package/dist/reliability/confidence/__tests__/manifest-loader.test.d.ts +1 -0
- package/dist/reliability/confidence/__tests__/manifest-loader.test.js +103 -0
- package/dist/reliability/confidence/__tests__/manifest-loader.test.js.map +1 -0
- package/dist/reliability/confidence/bundled-manifest.d.ts +2 -0
- package/dist/reliability/confidence/bundled-manifest.js +8 -0
- package/dist/reliability/confidence/bundled-manifest.js.map +1 -0
- package/dist/reliability/confidence/index.d.ts +3 -0
- package/dist/reliability/confidence/index.js +3 -0
- package/dist/reliability/confidence/index.js.map +1 -0
- package/dist/reliability/confidence/manifest-loader.d.ts +8 -0
- package/dist/reliability/confidence/manifest-loader.js +53 -0
- package/dist/reliability/confidence/manifest-loader.js.map +1 -0
- package/dist/reliability/feedback/__tests__/interactive.test.d.ts +1 -0
- package/dist/reliability/feedback/__tests__/interactive.test.js +85 -0
- package/dist/reliability/feedback/__tests__/interactive.test.js.map +1 -0
- package/dist/reliability/feedback/__tests__/repo-bucket.test.d.ts +1 -0
- package/dist/reliability/feedback/__tests__/repo-bucket.test.js +18 -0
- package/dist/reliability/feedback/__tests__/repo-bucket.test.js.map +1 -0
- package/dist/reliability/feedback/__tests__/sender.test.d.ts +1 -0
- package/dist/reliability/feedback/__tests__/sender.test.js +101 -0
- package/dist/reliability/feedback/__tests__/sender.test.js.map +1 -0
- package/dist/reliability/feedback/interactive.d.ts +20 -0
- package/dist/reliability/feedback/interactive.js +150 -0
- package/dist/reliability/feedback/interactive.js.map +1 -0
- package/dist/reliability/feedback/repo-bucket.d.ts +2 -0
- package/dist/reliability/feedback/repo-bucket.js +9 -0
- package/dist/reliability/feedback/repo-bucket.js.map +1 -0
- package/dist/reliability/feedback/sender.d.ts +16 -0
- package/dist/reliability/feedback/sender.js +28 -0
- package/dist/reliability/feedback/sender.js.map +1 -0
- package/dist/reliability/index.d.ts +1 -0
- package/dist/reliability/index.js +2 -0
- package/dist/reliability/index.js.map +1 -0
- package/dist/reliability/llm-eval/__tests__/budget.test.d.ts +1 -0
- package/dist/reliability/llm-eval/__tests__/budget.test.js +39 -0
- package/dist/reliability/llm-eval/__tests__/budget.test.js.map +1 -0
- package/dist/reliability/llm-eval/budget.d.ts +14 -0
- package/dist/reliability/llm-eval/budget.js +43 -0
- package/dist/reliability/llm-eval/budget.js.map +1 -0
- package/dist/reliability/score/__tests__/formula-v1.test.d.ts +1 -0
- package/dist/reliability/score/__tests__/formula-v1.test.js +29 -0
- package/dist/reliability/score/__tests__/formula-v1.test.js.map +1 -0
- package/dist/reliability/score/formula-v1.d.ts +13 -0
- package/dist/reliability/score/formula-v1.js +19 -0
- package/dist/reliability/score/formula-v1.js.map +1 -0
- package/dist/reliability/score/version-pin.d.ts +1 -0
- package/dist/reliability/score/version-pin.js +2 -0
- package/dist/reliability/score/version-pin.js.map +1 -0
- package/dist/reliability/score/weight.d.ts +1 -0
- package/dist/reliability/score/weight.js +5 -0
- package/dist/reliability/score/weight.js.map +1 -0
- package/dist/reliability/types.d.ts +39 -0
- package/dist/reliability/types.js +2 -0
- package/dist/reliability/types.js.map +1 -0
- package/dist/reporters/coverage-footer.d.ts +2 -0
- package/dist/reporters/coverage-footer.js +7 -0
- package/dist/reporters/coverage-footer.js.map +1 -0
- package/dist/reporters/json.d.ts +5 -0
- package/dist/reporters/json.js +51 -0
- package/dist/reporters/json.js.map +1 -0
- package/dist/reporters/markdown.d.ts +7 -0
- package/dist/reporters/markdown.js +35 -0
- package/dist/reporters/markdown.js.map +1 -0
- package/dist/reporters/sarif.d.ts +5 -0
- package/dist/reporters/sarif.js +109 -0
- package/dist/reporters/sarif.js.map +1 -0
- package/dist/reporters/terminal-format.d.ts +34 -0
- package/dist/reporters/terminal-format.js +97 -0
- package/dist/reporters/terminal-format.js.map +1 -0
- package/dist/reporters/terminal.d.ts +4 -0
- package/dist/reporters/terminal.js +201 -0
- package/dist/reporters/terminal.js.map +1 -0
- package/dist/rule-runner.d.ts +8 -0
- package/dist/rule-runner.js +22 -0
- package/dist/rule-runner.js.map +1 -0
- package/dist/rules/_codemod-adapter.d.ts +16 -0
- package/dist/rules/_codemod-adapter.js +49 -0
- package/dist/rules/_codemod-adapter.js.map +1 -0
- package/dist/rules/_exclude.d.ts +11 -0
- package/dist/rules/_exclude.js +17 -0
- package/dist/rules/_exclude.js.map +1 -0
- package/dist/rules/_function-body-analysis.d.ts +82 -0
- package/dist/rules/_function-body-analysis.js +379 -0
- package/dist/rules/_function-body-analysis.js.map +1 -0
- package/dist/rules/_rule-module.d.ts +31 -0
- package/dist/rules/_rule-module.js +32 -0
- package/dist/rules/_rule-module.js.map +1 -0
- package/dist/rules/_skip-context.d.ts +36 -0
- package/dist/rules/_skip-context.js +128 -0
- package/dist/rules/_skip-context.js.map +1 -0
- package/dist/rules/a11y-essentials.d.ts +1 -0
- package/dist/rules/a11y-essentials.js +140 -0
- package/dist/rules/a11y-essentials.js.map +1 -0
- package/dist/rules/ai-surface-agents-md-quality.d.ts +22 -0
- package/dist/rules/ai-surface-agents-md-quality.js +233 -0
- package/dist/rules/ai-surface-agents-md-quality.js.map +1 -0
- package/dist/rules/ai-surface-component-manifest-json.d.ts +19 -0
- package/dist/rules/ai-surface-component-manifest-json.js +232 -0
- package/dist/rules/ai-surface-component-manifest-json.js.map +1 -0
- package/dist/rules/ai-surface-ds-index-exported.d.ts +19 -0
- package/dist/rules/ai-surface-ds-index-exported.js +239 -0
- package/dist/rules/ai-surface-ds-index-exported.js.map +1 -0
- package/dist/rules/components-shadow-native.d.ts +2 -0
- package/dist/rules/components-shadow-native.js +118 -0
- package/dist/rules/components-shadow-native.js.map +1 -0
- package/dist/rules/manifest.d.ts +5 -0
- package/dist/rules/manifest.js +20 -0
- package/dist/rules/manifest.js.map +1 -0
- package/dist/rules/naming-component-pascalcase.d.ts +7 -0
- package/dist/rules/naming-component-pascalcase.js +197 -0
- package/dist/rules/naming-component-pascalcase.js.map +1 -0
- package/dist/rules/naming-hook-prefix.d.ts +6 -0
- package/dist/rules/naming-hook-prefix.js +185 -0
- package/dist/rules/naming-hook-prefix.js.map +1 -0
- package/dist/rules/pack-loader.d.ts +30 -0
- package/dist/rules/pack-loader.js +60 -0
- package/dist/rules/pack-loader.js.map +1 -0
- package/dist/rules/pack-validator.d.ts +8 -0
- package/dist/rules/pack-validator.js +97 -0
- package/dist/rules/pack-validator.js.map +1 -0
- package/dist/rules/registry.d.ts +3 -0
- package/dist/rules/registry.js +28 -0
- package/dist/rules/registry.js.map +1 -0
- package/dist/rules/storybook-coverage.d.ts +1 -0
- package/dist/rules/storybook-coverage.js +49 -0
- package/dist/rules/storybook-coverage.js.map +1 -0
- package/dist/rules/templates/_regex-utils.d.ts +5 -0
- package/dist/rules/templates/_regex-utils.js +8 -0
- package/dist/rules/templates/_regex-utils.js.map +1 -0
- package/dist/rules/templates/a11y-jsx-template.d.ts +15 -0
- package/dist/rules/templates/a11y-jsx-template.js +69 -0
- package/dist/rules/templates/a11y-jsx-template.js.map +1 -0
- package/dist/rules/templates/css-property-token-compliance.d.ts +18 -0
- package/dist/rules/templates/css-property-token-compliance.js +56 -0
- package/dist/rules/templates/css-property-token-compliance.js.map +1 -0
- package/dist/rules/templates/import-source-restriction.d.ts +18 -0
- package/dist/rules/templates/import-source-restriction.js +60 -0
- package/dist/rules/templates/import-source-restriction.js.map +1 -0
- package/dist/rules/templates/js-call-token-compliance.d.ts +18 -0
- package/dist/rules/templates/js-call-token-compliance.js +61 -0
- package/dist/rules/templates/js-call-token-compliance.js.map +1 -0
- package/dist/rules/templates/js-prop-token-compliance.d.ts +21 -0
- package/dist/rules/templates/js-prop-token-compliance.js +56 -0
- package/dist/rules/templates/js-prop-token-compliance.js.map +1 -0
- package/dist/rules/templates/naming-convention.d.ts +18 -0
- package/dist/rules/templates/naming-convention.js +76 -0
- package/dist/rules/templates/naming-convention.js.map +1 -0
- package/dist/rules/templates/registry.d.ts +5 -0
- package/dist/rules/templates/registry.js +30 -0
- package/dist/rules/templates/registry.js.map +1 -0
- package/dist/rules/templates/storybook-coverage-template.d.ts +15 -0
- package/dist/rules/templates/storybook-coverage-template.js +58 -0
- package/dist/rules/templates/storybook-coverage-template.js.map +1 -0
- package/dist/rules/templates/tailwind-utility-class-compliance.d.ts +15 -0
- package/dist/rules/templates/tailwind-utility-class-compliance.js +70 -0
- package/dist/rules/templates/tailwind-utility-class-compliance.js.map +1 -0
- package/dist/rules/templates/types.d.ts +16 -0
- package/dist/rules/templates/types.js +2 -0
- package/dist/rules/templates/types.js.map +1 -0
- package/dist/rules/tokens-description-coverage.d.ts +15 -0
- package/dist/rules/tokens-description-coverage.js +193 -0
- package/dist/rules/tokens-description-coverage.js.map +1 -0
- package/dist/rules/tokens-dtcg-conformance.d.ts +47 -0
- package/dist/rules/tokens-dtcg-conformance.js +363 -0
- package/dist/rules/tokens-dtcg-conformance.js.map +1 -0
- package/dist/rules/tokens-no-hardcoded-color.d.ts +18 -0
- package/dist/rules/tokens-no-hardcoded-color.js +436 -0
- package/dist/rules/tokens-no-hardcoded-color.js.map +1 -0
- package/dist/rules/tokens-no-hardcoded-spacing.d.ts +8 -0
- package/dist/rules/tokens-no-hardcoded-spacing.js +193 -0
- package/dist/rules/tokens-no-hardcoded-spacing.js.map +1 -0
- package/dist/scorer.d.ts +38 -0
- package/dist/scorer.js +126 -0
- package/dist/scorer.js.map +1 -0
- package/dist/share/clipboard.d.ts +26 -0
- package/dist/share/clipboard.js +76 -0
- package/dist/share/clipboard.js.map +1 -0
- package/dist/suppression/__tests__/inline.test.d.ts +1 -0
- package/dist/suppression/__tests__/inline.test.js +25 -0
- package/dist/suppression/__tests__/inline.test.js.map +1 -0
- package/dist/suppression/__tests__/lyseignore.test.d.ts +1 -0
- package/dist/suppression/__tests__/lyseignore.test.js +32 -0
- package/dist/suppression/__tests__/lyseignore.test.js.map +1 -0
- package/dist/suppression/defaults.d.ts +1 -0
- package/dist/suppression/defaults.js +14 -0
- package/dist/suppression/defaults.js.map +1 -0
- package/dist/suppression/inline.d.ts +7 -0
- package/dist/suppression/inline.js +32 -0
- package/dist/suppression/inline.js.map +1 -0
- package/dist/suppression/lyseignore.d.ts +2 -0
- package/dist/suppression/lyseignore.js +22 -0
- package/dist/suppression/lyseignore.js.map +1 -0
- package/dist/telemetry/consent.d.ts +48 -0
- package/dist/telemetry/consent.js +139 -0
- package/dist/telemetry/consent.js.map +1 -0
- package/dist/telemetry/index.d.ts +2 -0
- package/dist/telemetry/index.js +3 -0
- package/dist/telemetry/index.js.map +1 -0
- package/dist/telemetry/local-log.d.ts +64 -0
- package/dist/telemetry/local-log.js +123 -0
- package/dist/telemetry/local-log.js.map +1 -0
- package/dist/tokens/dtcg-model.d.ts +53 -0
- package/dist/tokens/dtcg-model.js +18 -0
- package/dist/tokens/dtcg-model.js.map +1 -0
- package/dist/tokens/normalizer.d.ts +17 -0
- package/dist/tokens/normalizer.js +360 -0
- package/dist/tokens/normalizer.js.map +1 -0
- package/dist/types.d.ts +300 -0
- package/dist/types.js +4 -0
- package/dist/types.js.map +1 -0
- package/dist/util/git.d.ts +6 -0
- package/dist/util/git.js +40 -0
- package/dist/util/git.js.map +1 -0
- package/dist/util/git.test.d.ts +5 -0
- package/dist/util/git.test.js +42 -0
- package/dist/util/git.test.js.map +1 -0
- package/dist/util/gitignore.d.ts +9 -0
- package/dist/util/gitignore.js +39 -0
- package/dist/util/gitignore.js.map +1 -0
- package/dist/util/hash-deps.d.ts +6 -0
- package/dist/util/hash-deps.js +24 -0
- package/dist/util/hash-deps.js.map +1 -0
- package/dist/util/spinner.d.ts +41 -0
- package/dist/util/spinner.js +126 -0
- package/dist/util/spinner.js.map +1 -0
- package/dist/util/with-spinner.d.ts +11 -0
- package/dist/util/with-spinner.js +19 -0
- package/dist/util/with-spinner.js.map +1 -0
- package/dist/walker.d.ts +14 -0
- package/dist/walker.js +91 -0
- package/dist/walker.js.map +1 -0
- package/package.json +83 -0
- package/rules-manifest.json +289 -0
- package/schemas/v1/lyse-config.json +82 -0
- package/schemas/v1/lyse-event.json +68 -0
- package/schemas/v1/lyse-license.json +19 -0
- package/schemas/v1/lyse-llm-payload.json +53 -0
- package/schemas/v1/lyse-llm-response.json +45 -0
- package/schemas/v1/lyse-result.json +98 -0
- package/schemas/v1/lyse-rules.json +42 -0
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
// packages/core/src/rules/templates/naming-convention.ts
|
|
2
|
+
import { z } from 'zod';
|
|
3
|
+
import { basename } from 'node:path';
|
|
4
|
+
const ConfigSchema = z.object({
|
|
5
|
+
target: z.enum(['file', 'export']),
|
|
6
|
+
pattern: z.string(),
|
|
7
|
+
exceptions: z.array(z.string()).default([]),
|
|
8
|
+
});
|
|
9
|
+
export const namingConventionTemplate = {
|
|
10
|
+
name: 'naming-convention',
|
|
11
|
+
description: 'Flags file names or exported symbols that do not match a regex pattern.',
|
|
12
|
+
configSchema: ConfigSchema,
|
|
13
|
+
build({ ruleId, axis, severity, config }) {
|
|
14
|
+
const cfg = ConfigSchema.parse(config);
|
|
15
|
+
const id = ruleId;
|
|
16
|
+
// 'off' is not a runtime severity; fall back to 'info' if provided.
|
|
17
|
+
const sev = (severity === 'off' ? 'info' : severity);
|
|
18
|
+
const re = new RegExp(cfg.pattern);
|
|
19
|
+
const exceptionSet = new Set(cfg.exceptions);
|
|
20
|
+
const rule = {
|
|
21
|
+
id,
|
|
22
|
+
axis,
|
|
23
|
+
async evaluate(_ctx, parsed) {
|
|
24
|
+
const findings = [];
|
|
25
|
+
let opportunities = 0;
|
|
26
|
+
if (cfg.target === 'file') {
|
|
27
|
+
for (const file of parsed.ts) {
|
|
28
|
+
const name = basename(file.path);
|
|
29
|
+
if (!name.endsWith('.tsx'))
|
|
30
|
+
continue;
|
|
31
|
+
opportunities++;
|
|
32
|
+
if (exceptionSet.has(name))
|
|
33
|
+
continue;
|
|
34
|
+
if (re.test(name))
|
|
35
|
+
continue;
|
|
36
|
+
findings.push({
|
|
37
|
+
ruleId: id,
|
|
38
|
+
axis,
|
|
39
|
+
severity: sev,
|
|
40
|
+
location: { file: file.path, line: 1, column: 1 },
|
|
41
|
+
message: `File "${name}" does not match naming pattern ${cfg.pattern}`,
|
|
42
|
+
});
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
else {
|
|
46
|
+
// target === 'export'
|
|
47
|
+
const exportRe = /export\s+(?:const|function|class)\s+(\w+)/g;
|
|
48
|
+
for (const file of parsed.ts) {
|
|
49
|
+
exportRe.lastIndex = 0;
|
|
50
|
+
let m;
|
|
51
|
+
while ((m = exportRe.exec(file.source)) !== null) {
|
|
52
|
+
opportunities++;
|
|
53
|
+
const name = m[1];
|
|
54
|
+
if (exceptionSet.has(name))
|
|
55
|
+
continue;
|
|
56
|
+
if (re.test(name))
|
|
57
|
+
continue;
|
|
58
|
+
const before = file.source.slice(0, m.index);
|
|
59
|
+
const line = before.split('\n').length;
|
|
60
|
+
findings.push({
|
|
61
|
+
ruleId: id,
|
|
62
|
+
axis,
|
|
63
|
+
severity: sev,
|
|
64
|
+
location: { file: file.path, line, column: 1 },
|
|
65
|
+
message: `Export "${name}" does not match naming pattern ${cfg.pattern}`,
|
|
66
|
+
});
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
return { findings, opportunities };
|
|
71
|
+
},
|
|
72
|
+
};
|
|
73
|
+
return rule;
|
|
74
|
+
},
|
|
75
|
+
};
|
|
76
|
+
//# sourceMappingURL=naming-convention.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"naming-convention.js","sourceRoot":"","sources":["../../../src/rules/templates/naming-convention.ts"],"names":[],"mappings":"AAAA,yDAAyD;AACzD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAErC,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5B,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAClC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;CAC5C,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,wBAAwB,GAAyB;IAC5D,IAAI,EAAE,mBAAmB;IACzB,WAAW,EAAE,yEAAyE;IACtF,YAAY,EAAE,YAAY;IAC1B,KAAK,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE;QACtC,MAAM,GAAG,GAAG,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACvC,MAAM,EAAE,GAAG,MAAM,CAAC;QAClB,oEAAoE;QACpE,MAAM,GAAG,GAAa,CAAC,QAAQ,KAAK,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAa,CAAC;QAC3E,MAAM,EAAE,GAAG,IAAI,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACnC,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC7C,MAAM,IAAI,GAAS;YACjB,EAAE;YACF,IAAI;YACJ,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM;gBACzB,MAAM,QAAQ,GAAc,EAAE,CAAC;gBAC/B,IAAI,aAAa,GAAG,CAAC,CAAC;gBACtB,IAAI,GAAG,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;oBAC1B,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;wBAC7B,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;wBACjC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;4BAAE,SAAS;wBACrC,aAAa,EAAE,CAAC;wBAChB,IAAI,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC;4BAAE,SAAS;wBACrC,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC;4BAAE,SAAS;wBAC5B,QAAQ,CAAC,IAAI,CAAC;4BACZ,MAAM,EAAE,EAAE;4BACV,IAAI;4BACJ,QAAQ,EAAE,GAAG;4BACb,QAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE;4BACjD,OAAO,EAAE,SAAS,IAAI,mCAAmC,GAAG,CAAC,OAAO,EAAE;yBACvE,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,sBAAsB;oBACtB,MAAM,QAAQ,GAAG,4CAA4C,CAAC;oBAC9D,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;wBAC7B,QAAQ,CAAC,SAAS,GAAG,CAAC,CAAC;wBACvB,IAAI,CAAyB,CAAC;wBAC9B,OAAO,CAAC,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;4BACjD,aAAa,EAAE,CAAC;4BAChB,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,CAAE,CAAC;4BACnB,IAAI,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC;gCAAE,SAAS;4BACrC,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC;gCAAE,SAAS;4BAC5B,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;4BAC7C,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;4BACvC,QAAQ,CAAC,IAAI,CAAC;gCACZ,MAAM,EAAE,EAAE;gCACV,IAAI;gCACJ,QAAQ,EAAE,GAAG;gCACb,QAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,EAAE;gCAC9C,OAAO,EAAE,WAAW,IAAI,mCAAmC,GAAG,CAAC,OAAO,EAAE;6BACzE,CAAC,CAAC;wBACL,CAAC;oBACH,CAAC;gBACH,CAAC;gBACD,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC;YACrC,CAAC;SACF,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;CACF,CAAC"}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import type { RuleTemplate } from './types.js';
|
|
2
|
+
export declare const TEMPLATE_CATALOG_VERSION = 1;
|
|
3
|
+
export declare function getTemplate(name: string): RuleTemplate | undefined;
|
|
4
|
+
export declare function listTemplates(): ReadonlyArray<RuleTemplate>;
|
|
5
|
+
export declare function templateCatalogDescriptions(): string;
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { jsPropTokenComplianceTemplate } from './js-prop-token-compliance.js';
|
|
2
|
+
import { jsCallTokenComplianceTemplate } from './js-call-token-compliance.js';
|
|
3
|
+
import { cssPropertyTokenComplianceTemplate } from './css-property-token-compliance.js';
|
|
4
|
+
import { tailwindUtilityClassComplianceTemplate } from './tailwind-utility-class-compliance.js';
|
|
5
|
+
import { importSourceRestrictionTemplate } from './import-source-restriction.js';
|
|
6
|
+
import { namingConventionTemplate } from './naming-convention.js';
|
|
7
|
+
import { storybookCoverageTemplate } from './storybook-coverage-template.js';
|
|
8
|
+
import { a11yJsxTemplate } from './a11y-jsx-template.js';
|
|
9
|
+
export const TEMPLATE_CATALOG_VERSION = 1;
|
|
10
|
+
const TEMPLATES = [
|
|
11
|
+
jsPropTokenComplianceTemplate,
|
|
12
|
+
jsCallTokenComplianceTemplate,
|
|
13
|
+
cssPropertyTokenComplianceTemplate,
|
|
14
|
+
tailwindUtilityClassComplianceTemplate,
|
|
15
|
+
importSourceRestrictionTemplate,
|
|
16
|
+
namingConventionTemplate,
|
|
17
|
+
storybookCoverageTemplate,
|
|
18
|
+
a11yJsxTemplate,
|
|
19
|
+
];
|
|
20
|
+
const BY_NAME = new Map(TEMPLATES.map((t) => [t.name, t]));
|
|
21
|
+
export function getTemplate(name) {
|
|
22
|
+
return BY_NAME.get(name);
|
|
23
|
+
}
|
|
24
|
+
export function listTemplates() {
|
|
25
|
+
return TEMPLATES;
|
|
26
|
+
}
|
|
27
|
+
export function templateCatalogDescriptions() {
|
|
28
|
+
return TEMPLATES.map((t) => `- ${t.name}: ${t.description}`).join('\n');
|
|
29
|
+
}
|
|
30
|
+
//# sourceMappingURL=registry.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"registry.js","sourceRoot":"","sources":["../../../src/rules/templates/registry.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,6BAA6B,EAAE,MAAM,+BAA+B,CAAC;AAC9E,OAAO,EAAE,6BAA6B,EAAE,MAAM,+BAA+B,CAAC;AAC9E,OAAO,EAAE,kCAAkC,EAAE,MAAM,oCAAoC,CAAC;AACxF,OAAO,EAAE,sCAAsC,EAAE,MAAM,wCAAwC,CAAC;AAChG,OAAO,EAAE,+BAA+B,EAAE,MAAM,gCAAgC,CAAC;AACjF,OAAO,EAAE,wBAAwB,EAAE,MAAM,wBAAwB,CAAC;AAClE,OAAO,EAAE,yBAAyB,EAAE,MAAM,kCAAkC,CAAC;AAC7E,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC;AAE1C,MAAM,SAAS,GAAgC;IAC7C,6BAA6C;IAC7C,6BAA6C;IAC7C,kCAAkD;IAClD,sCAAsD;IACtD,+BAA+C;IAC/C,wBAAwC;IACxC,yBAAyC;IACzC,eAA+B;CAChC,CAAC;AAEF,MAAM,OAAO,GAAG,IAAI,GAAG,CAAuB,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AAEjF,MAAM,UAAU,WAAW,CAAC,IAAY;IACtC,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AAC3B,CAAC;AAED,MAAM,UAAU,aAAa;IAC3B,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,UAAU,2BAA2B;IACzC,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1E,CAAC"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
import type { RuleTemplate } from './types.js';
|
|
3
|
+
declare const ConfigSchema: z.ZodObject<{
|
|
4
|
+
component_glob: z.ZodString;
|
|
5
|
+
story_glob_template: z.ZodString;
|
|
6
|
+
}, "strip", z.ZodTypeAny, {
|
|
7
|
+
component_glob: string;
|
|
8
|
+
story_glob_template: string;
|
|
9
|
+
}, {
|
|
10
|
+
component_glob: string;
|
|
11
|
+
story_glob_template: string;
|
|
12
|
+
}>;
|
|
13
|
+
type Config = z.infer<typeof ConfigSchema>;
|
|
14
|
+
export declare const storybookCoverageTemplate: RuleTemplate<Config>;
|
|
15
|
+
export {};
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
// packages/core/src/rules/templates/storybook-coverage-template.ts
|
|
2
|
+
import { z } from 'zod';
|
|
3
|
+
import { basename, dirname } from 'node:path';
|
|
4
|
+
const ConfigSchema = z.object({
|
|
5
|
+
component_glob: z.string(),
|
|
6
|
+
story_glob_template: z.string(), // e.g., "{stem}.stories.tsx"
|
|
7
|
+
});
|
|
8
|
+
export const storybookCoverageTemplate = {
|
|
9
|
+
name: 'storybook-coverage-template',
|
|
10
|
+
description: 'Flags components without a corresponding stories file based on a path template.',
|
|
11
|
+
configSchema: ConfigSchema,
|
|
12
|
+
build({ ruleId, axis, severity, config }) {
|
|
13
|
+
const cfg = ConfigSchema.parse(config);
|
|
14
|
+
const id = ruleId;
|
|
15
|
+
// 'off' is not a runtime severity; fall back to 'info' if provided.
|
|
16
|
+
const sev = (severity === 'off' ? 'info' : severity);
|
|
17
|
+
const componentRe = globToRegExp(cfg.component_glob);
|
|
18
|
+
const isStoryFile = (p) => /\.stories\.(tsx?|jsx?)$/.test(p);
|
|
19
|
+
const rule = {
|
|
20
|
+
id,
|
|
21
|
+
axis,
|
|
22
|
+
async evaluate(_ctx, parsed) {
|
|
23
|
+
const allPaths = new Set(parsed.ts.map((f) => f.path));
|
|
24
|
+
const findings = [];
|
|
25
|
+
let opportunities = 0;
|
|
26
|
+
for (const file of parsed.ts) {
|
|
27
|
+
if (!componentRe.test(file.path))
|
|
28
|
+
continue;
|
|
29
|
+
if (isStoryFile(file.path))
|
|
30
|
+
continue;
|
|
31
|
+
opportunities++;
|
|
32
|
+
const name = basename(file.path);
|
|
33
|
+
const stem = name.replace(/\.tsx?$/, '');
|
|
34
|
+
const expectedStory = dirname(file.path) + '/' + cfg.story_glob_template.replace('{stem}', stem);
|
|
35
|
+
if (allPaths.has(expectedStory))
|
|
36
|
+
continue;
|
|
37
|
+
findings.push({
|
|
38
|
+
ruleId: id,
|
|
39
|
+
axis,
|
|
40
|
+
severity: sev,
|
|
41
|
+
location: { file: file.path, line: 1, column: 1 },
|
|
42
|
+
message: `Missing story file: expected ${expectedStory}`,
|
|
43
|
+
});
|
|
44
|
+
}
|
|
45
|
+
return { findings, opportunities };
|
|
46
|
+
},
|
|
47
|
+
};
|
|
48
|
+
return rule;
|
|
49
|
+
},
|
|
50
|
+
};
|
|
51
|
+
function globToRegExp(glob) {
|
|
52
|
+
const escaped = glob
|
|
53
|
+
.replace(/[.+^${}()|[\]\\]/g, '\\$&')
|
|
54
|
+
.replace(/\*\*/g, '.+')
|
|
55
|
+
.replace(/\*/g, '[^/]+');
|
|
56
|
+
return new RegExp('^' + escaped + '$');
|
|
57
|
+
}
|
|
58
|
+
//# sourceMappingURL=storybook-coverage-template.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"storybook-coverage-template.js","sourceRoot":"","sources":["../../../src/rules/templates/storybook-coverage-template.ts"],"names":[],"mappings":"AAAA,mEAAmE;AACnE,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAE9C,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5B,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,6BAA6B;CAC/D,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,yBAAyB,GAAyB;IAC7D,IAAI,EAAE,6BAA6B;IACnC,WAAW,EAAE,iFAAiF;IAC9F,YAAY,EAAE,YAAY;IAC1B,KAAK,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE;QACtC,MAAM,GAAG,GAAG,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACvC,MAAM,EAAE,GAAG,MAAM,CAAC;QAClB,oEAAoE;QACpE,MAAM,GAAG,GAAa,CAAC,QAAQ,KAAK,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAa,CAAC;QAC3E,MAAM,WAAW,GAAG,YAAY,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QACrD,MAAM,WAAW,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACrE,MAAM,IAAI,GAAS;YACjB,EAAE;YACF,IAAI;YACJ,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM;gBACzB,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;gBACvD,MAAM,QAAQ,GAAc,EAAE,CAAC;gBAC/B,IAAI,aAAa,GAAG,CAAC,CAAC;gBACtB,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;oBAC7B,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;wBAAE,SAAS;oBAC3C,IAAI,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC;wBAAE,SAAS;oBACrC,aAAa,EAAE,CAAC;oBAChB,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBACjC,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;oBACzC,MAAM,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,mBAAmB,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;oBACjG,IAAI,QAAQ,CAAC,GAAG,CAAC,aAAa,CAAC;wBAAE,SAAS;oBAC1C,QAAQ,CAAC,IAAI,CAAC;wBACZ,MAAM,EAAE,EAAE;wBACV,IAAI;wBACJ,QAAQ,EAAE,GAAG;wBACb,QAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE;wBACjD,OAAO,EAAE,gCAAgC,aAAa,EAAE;qBACzD,CAAC,CAAC;gBACL,CAAC;gBACD,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC;YACrC,CAAC;SACF,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;CACF,CAAC;AAEF,SAAS,YAAY,CAAC,IAAY;IAChC,MAAM,OAAO,GAAG,IAAI;SACjB,OAAO,CAAC,mBAAmB,EAAE,MAAM,CAAC;SACpC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC;SACtB,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC3B,OAAO,IAAI,MAAM,CAAC,GAAG,GAAG,OAAO,GAAG,GAAG,CAAC,CAAC;AACzC,CAAC"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
import type { RuleTemplate } from './types.js';
|
|
3
|
+
declare const ConfigSchema: z.ZodObject<{
|
|
4
|
+
class_prefixes: z.ZodArray<z.ZodString, "many">;
|
|
5
|
+
allow_arbitrary_for: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
|
|
6
|
+
}, "strip", z.ZodTypeAny, {
|
|
7
|
+
class_prefixes: string[];
|
|
8
|
+
allow_arbitrary_for: string[];
|
|
9
|
+
}, {
|
|
10
|
+
class_prefixes: string[];
|
|
11
|
+
allow_arbitrary_for?: string[] | undefined;
|
|
12
|
+
}>;
|
|
13
|
+
type Config = z.infer<typeof ConfigSchema>;
|
|
14
|
+
export declare const tailwindUtilityClassComplianceTemplate: RuleTemplate<Config>;
|
|
15
|
+
export {};
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
// packages/core/src/rules/templates/tailwind-utility-class-compliance.ts
|
|
2
|
+
import { z } from 'zod';
|
|
3
|
+
import { escapeRegExp } from './_regex-utils.js';
|
|
4
|
+
const ConfigSchema = z.object({
|
|
5
|
+
class_prefixes: z.array(z.string()),
|
|
6
|
+
allow_arbitrary_for: z.array(z.string()).default([]),
|
|
7
|
+
});
|
|
8
|
+
export const tailwindUtilityClassComplianceTemplate = {
|
|
9
|
+
name: 'tailwind-utility-class-compliance',
|
|
10
|
+
description: 'Flags Tailwind utility classes with arbitrary values (e.g. bg-[#1e293b]) for the specified prefixes. ' +
|
|
11
|
+
'These bypass the configured scale.',
|
|
12
|
+
configSchema: ConfigSchema,
|
|
13
|
+
build({ ruleId, axis, severity, config }) {
|
|
14
|
+
const cfg = ConfigSchema.parse(config);
|
|
15
|
+
const id = ruleId;
|
|
16
|
+
// 'off' is not a runtime severity; fall back to 'info' if provided.
|
|
17
|
+
const sev = (severity === 'off' ? 'info' : severity);
|
|
18
|
+
const allowedSet = new Set(cfg.allow_arbitrary_for);
|
|
19
|
+
const prefixGroup = cfg.class_prefixes.map(escapeRegExp).join('|');
|
|
20
|
+
// Build regexes once at rule-construction time; not inside evaluate().
|
|
21
|
+
// Regex to detect prefix-[value] patterns (e.g. bg-[#1e293b], text-[1rem])
|
|
22
|
+
const arbitraryRe = new RegExp(`^(?:${prefixGroup})(?:-[a-z0-9]+)*-\\[`);
|
|
23
|
+
// Regex to check if class starts with any watched prefix
|
|
24
|
+
const prefixRe = new RegExp(`^(?:${prefixGroup})(?:-|$)`);
|
|
25
|
+
// Match className="..." or className={`...`} — capture the value
|
|
26
|
+
const classNameRe = /\bclassName\s*=\s*["'`]([^"'`]+)["'`]/g;
|
|
27
|
+
const rule = {
|
|
28
|
+
id,
|
|
29
|
+
axis,
|
|
30
|
+
async evaluate(_ctx, parsed) {
|
|
31
|
+
const findings = [];
|
|
32
|
+
let opportunities = 0;
|
|
33
|
+
for (const file of parsed.ts) {
|
|
34
|
+
classNameRe.lastIndex = 0;
|
|
35
|
+
let cm;
|
|
36
|
+
while ((cm = classNameRe.exec(file.source)) !== null) {
|
|
37
|
+
const classes = cm[1].split(/\s+/);
|
|
38
|
+
for (const cls of classes) {
|
|
39
|
+
if (!prefixRe.test(cls))
|
|
40
|
+
continue;
|
|
41
|
+
opportunities++;
|
|
42
|
+
if (!cls.includes('['))
|
|
43
|
+
continue;
|
|
44
|
+
// Check if this prefix is explicitly allowed for arbitrary values
|
|
45
|
+
const prefix = cls.split('-')[0];
|
|
46
|
+
if (allowedSet.has(prefix))
|
|
47
|
+
continue;
|
|
48
|
+
if (!arbitraryRe.test(cls))
|
|
49
|
+
continue;
|
|
50
|
+
const classIndex = cm.index + cm[0].indexOf(cls);
|
|
51
|
+
const before = file.source.slice(0, classIndex);
|
|
52
|
+
const line = before.split('\n').length;
|
|
53
|
+
const column = classIndex - before.lastIndexOf('\n');
|
|
54
|
+
findings.push({
|
|
55
|
+
ruleId: id,
|
|
56
|
+
axis,
|
|
57
|
+
severity: sev,
|
|
58
|
+
location: { file: file.path, line, column },
|
|
59
|
+
message: `Arbitrary Tailwind value "${cls}" bypasses the configured scale`,
|
|
60
|
+
});
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
return { findings, opportunities };
|
|
65
|
+
},
|
|
66
|
+
};
|
|
67
|
+
return rule;
|
|
68
|
+
},
|
|
69
|
+
};
|
|
70
|
+
//# sourceMappingURL=tailwind-utility-class-compliance.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tailwind-utility-class-compliance.js","sourceRoot":"","sources":["../../../src/rules/templates/tailwind-utility-class-compliance.ts"],"names":[],"mappings":"AAAA,yEAAyE;AACzE,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5B,cAAc,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACnC,mBAAmB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;CACrD,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,sCAAsC,GAAyB;IAC1E,IAAI,EAAE,mCAAmC;IACzC,WAAW,EACT,uGAAuG;QACvG,oCAAoC;IACtC,YAAY,EAAE,YAAY;IAC1B,KAAK,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE;QACtC,MAAM,GAAG,GAAG,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACvC,MAAM,EAAE,GAAG,MAAM,CAAC;QAClB,oEAAoE;QACpE,MAAM,GAAG,GAAa,CAAC,QAAQ,KAAK,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAa,CAAC;QAC3E,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;QACpD,MAAM,WAAW,GAAG,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnE,uEAAuE;QACvE,2EAA2E;QAC3E,MAAM,WAAW,GAAG,IAAI,MAAM,CAAC,OAAO,WAAW,sBAAsB,CAAC,CAAC;QACzE,yDAAyD;QACzD,MAAM,QAAQ,GAAG,IAAI,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC,CAAC;QAC1D,iEAAiE;QACjE,MAAM,WAAW,GAAG,wCAAwC,CAAC;QAC7D,MAAM,IAAI,GAAS;YACjB,EAAE;YACF,IAAI;YACJ,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM;gBACzB,MAAM,QAAQ,GAAc,EAAE,CAAC;gBAC/B,IAAI,aAAa,GAAG,CAAC,CAAC;gBACtB,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;oBAC7B,WAAW,CAAC,SAAS,GAAG,CAAC,CAAC;oBAC1B,IAAI,EAA0B,CAAC;oBAC/B,OAAO,CAAC,EAAE,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;wBACrD,MAAM,OAAO,GAAG,EAAE,CAAC,CAAC,CAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;wBACpC,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;4BAC1B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC;gCAAE,SAAS;4BAClC,aAAa,EAAE,CAAC;4BAChB,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC;gCAAE,SAAS;4BACjC,kEAAkE;4BAClE,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAE,CAAC;4BAClC,IAAI,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC;gCAAE,SAAS;4BACrC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC;gCAAE,SAAS;4BACrC,MAAM,UAAU,GAAG,EAAE,CAAC,KAAK,GAAG,EAAE,CAAC,CAAC,CAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;4BAClD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC;4BAChD,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;4BACvC,MAAM,MAAM,GAAG,UAAU,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;4BACrD,QAAQ,CAAC,IAAI,CAAC;gCACZ,MAAM,EAAE,EAAE;gCACV,IAAI;gCACJ,QAAQ,EAAE,GAAG;gCACb,QAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE;gCAC3C,OAAO,EAAE,6BAA6B,GAAG,iCAAiC;6BAC3E,CAAC,CAAC;wBACL,CAAC;oBACH,CAAC;gBACH,CAAC;gBACD,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC;YACrC,CAAC;SACF,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;CACF,CAAC"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type { Rule } from '../../types.js';
|
|
2
|
+
export interface RuleTemplate<TConfig = Record<string, unknown>> {
|
|
3
|
+
/** Template name as referenced in `.lyse/generated-rules.yaml`. */
|
|
4
|
+
readonly name: string;
|
|
5
|
+
/** One-line description shown to the LLM in the catalog. */
|
|
6
|
+
readonly description: string;
|
|
7
|
+
/** Zod schema (as a function returning z.ZodTypeAny). */
|
|
8
|
+
readonly configSchema: unknown;
|
|
9
|
+
/** Build a runnable Rule from a config + a generated rule id + axis + severity. */
|
|
10
|
+
build(args: {
|
|
11
|
+
ruleId: string;
|
|
12
|
+
axis: Rule['axis'];
|
|
13
|
+
severity: 'error' | 'warning' | 'info' | 'off';
|
|
14
|
+
config: TConfig;
|
|
15
|
+
}): Rule;
|
|
16
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/rules/templates/types.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { Rule } from "../types.js";
|
|
2
|
+
import { type DtcgDocument } from "../tokens/dtcg-model.js";
|
|
3
|
+
export declare function isSemanticTokenPath(path: string[]): boolean;
|
|
4
|
+
interface CoverageStats {
|
|
5
|
+
semanticCount: number;
|
|
6
|
+
semanticWithDescription: number;
|
|
7
|
+
}
|
|
8
|
+
declare function walkForCoverage(doc: DtcgDocument): CoverageStats;
|
|
9
|
+
export declare const rule: Rule;
|
|
10
|
+
export declare const _internal: {
|
|
11
|
+
walkForCoverage: typeof walkForCoverage;
|
|
12
|
+
isSemanticTokenPath: typeof isSemanticTokenPath;
|
|
13
|
+
COVERAGE_THRESHOLD: number;
|
|
14
|
+
};
|
|
15
|
+
export {};
|
|
@@ -0,0 +1,193 @@
|
|
|
1
|
+
import { readFileSync, statSync } from "node:fs";
|
|
2
|
+
import { isAbsolute, join, relative } from "node:path";
|
|
3
|
+
import fg from "fast-glob";
|
|
4
|
+
import { isPathExcluded } from "./_exclude.js";
|
|
5
|
+
import { createLyseRule } from "./_rule-module.js";
|
|
6
|
+
import { isDtcgGroup, isDtcgToken, } from "../tokens/dtcg-model.js";
|
|
7
|
+
const MAX_FILE_BYTES = 1_000_000;
|
|
8
|
+
const RULE_ID = "tokens/description-coverage";
|
|
9
|
+
const COVERAGE_THRESHOLD = 0.8; // 80 %
|
|
10
|
+
const SEMANTIC_PATH_SEGMENTS = new Set([
|
|
11
|
+
"action",
|
|
12
|
+
"surface",
|
|
13
|
+
"text",
|
|
14
|
+
"background",
|
|
15
|
+
"border",
|
|
16
|
+
"feedback",
|
|
17
|
+
"state",
|
|
18
|
+
"interactive",
|
|
19
|
+
"link",
|
|
20
|
+
"semantic",
|
|
21
|
+
]);
|
|
22
|
+
function discoverDtcgFiles(ctx) {
|
|
23
|
+
if (!ctx.repoRoot)
|
|
24
|
+
return [];
|
|
25
|
+
let entries = [];
|
|
26
|
+
try {
|
|
27
|
+
entries = fg.sync(["**/*.tokens.json", "tokens/**/*.json", "**/tokens/**/*.json"], {
|
|
28
|
+
cwd: ctx.repoRoot,
|
|
29
|
+
absolute: false,
|
|
30
|
+
dot: false,
|
|
31
|
+
ignore: ["**/node_modules/**", "**/dist/**", "**/build/**", "**/.git/**"],
|
|
32
|
+
followSymbolicLinks: false,
|
|
33
|
+
});
|
|
34
|
+
}
|
|
35
|
+
catch {
|
|
36
|
+
return [];
|
|
37
|
+
}
|
|
38
|
+
const out = new Set();
|
|
39
|
+
for (const rel of entries) {
|
|
40
|
+
if (isPathExcluded(rel, ctx.excludePaths))
|
|
41
|
+
continue;
|
|
42
|
+
out.add(rel);
|
|
43
|
+
}
|
|
44
|
+
return Array.from(out).sort();
|
|
45
|
+
}
|
|
46
|
+
function readJsonIfSmall(absPath) {
|
|
47
|
+
try {
|
|
48
|
+
const stat = statSync(absPath);
|
|
49
|
+
if (!stat.isFile())
|
|
50
|
+
return null;
|
|
51
|
+
if (stat.size > MAX_FILE_BYTES)
|
|
52
|
+
return null;
|
|
53
|
+
const raw = readFileSync(absPath, "utf8");
|
|
54
|
+
if (raw.trim().length === 0)
|
|
55
|
+
return null;
|
|
56
|
+
return JSON.parse(raw);
|
|
57
|
+
}
|
|
58
|
+
catch {
|
|
59
|
+
return null;
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
function hasAnyValueKey(node, depthBudget) {
|
|
63
|
+
if (depthBudget < 0)
|
|
64
|
+
return false;
|
|
65
|
+
if (typeof node !== "object" || node === null || Array.isArray(node))
|
|
66
|
+
return false;
|
|
67
|
+
for (const [k, v] of Object.entries(node)) {
|
|
68
|
+
if (k === "$value")
|
|
69
|
+
return true;
|
|
70
|
+
if (typeof v === "object" && v !== null && hasAnyValueKey(v, depthBudget - 1))
|
|
71
|
+
return true;
|
|
72
|
+
}
|
|
73
|
+
return false;
|
|
74
|
+
}
|
|
75
|
+
function looksLikeDtcg(data) {
|
|
76
|
+
if (typeof data !== "object" || data === null || Array.isArray(data))
|
|
77
|
+
return false;
|
|
78
|
+
return hasAnyValueKey(data, 4);
|
|
79
|
+
}
|
|
80
|
+
export function isSemanticTokenPath(path) {
|
|
81
|
+
if (path.length === 0)
|
|
82
|
+
return false;
|
|
83
|
+
// A path is semantic if any segment matches a known semantic prefix.
|
|
84
|
+
for (const seg of path) {
|
|
85
|
+
if (SEMANTIC_PATH_SEGMENTS.has(seg))
|
|
86
|
+
return true;
|
|
87
|
+
}
|
|
88
|
+
// brand.semantic.* — the "semantic" segment already matches above. Top-level
|
|
89
|
+
// primitives like color.blue.500 / spacing.16 / radius.md are intentionally
|
|
90
|
+
// excluded because none of their segments are in the semantic set.
|
|
91
|
+
return false;
|
|
92
|
+
}
|
|
93
|
+
function walkForCoverage(doc) {
|
|
94
|
+
const stats = { semanticCount: 0, semanticWithDescription: 0 };
|
|
95
|
+
const visit = (node, path) => {
|
|
96
|
+
if (typeof node !== "object" || node === null || Array.isArray(node))
|
|
97
|
+
return;
|
|
98
|
+
if (isDtcgToken(node)) {
|
|
99
|
+
if (isSemanticTokenPath(path)) {
|
|
100
|
+
stats.semanticCount++;
|
|
101
|
+
const desc = node.$description;
|
|
102
|
+
if (typeof desc === "string" && desc.trim().length > 0) {
|
|
103
|
+
stats.semanticWithDescription++;
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
return;
|
|
107
|
+
}
|
|
108
|
+
if (!isDtcgGroup(node))
|
|
109
|
+
return;
|
|
110
|
+
for (const [k, v] of Object.entries(node)) {
|
|
111
|
+
if (k.startsWith("$"))
|
|
112
|
+
continue;
|
|
113
|
+
visit(v, [...path, k]);
|
|
114
|
+
}
|
|
115
|
+
};
|
|
116
|
+
visit(doc, []);
|
|
117
|
+
return stats;
|
|
118
|
+
}
|
|
119
|
+
const evaluate = async (ctx, _files) => {
|
|
120
|
+
const findings = [];
|
|
121
|
+
const relFiles = discoverDtcgFiles(ctx);
|
|
122
|
+
if (relFiles.length === 0) {
|
|
123
|
+
return { findings, opportunities: 0 };
|
|
124
|
+
}
|
|
125
|
+
let totalSemantic = 0;
|
|
126
|
+
let totalDescribed = 0;
|
|
127
|
+
let primaryFile = null;
|
|
128
|
+
for (const rel of relFiles) {
|
|
129
|
+
const abs = isAbsolute(rel) ? rel : join(ctx.repoRoot, rel);
|
|
130
|
+
const data = readJsonIfSmall(abs);
|
|
131
|
+
if (data === null)
|
|
132
|
+
continue;
|
|
133
|
+
if (!looksLikeDtcg(data))
|
|
134
|
+
continue;
|
|
135
|
+
if (primaryFile === null)
|
|
136
|
+
primaryFile = relative(ctx.repoRoot, abs) || rel;
|
|
137
|
+
const stats = walkForCoverage(data);
|
|
138
|
+
totalSemantic += stats.semanticCount;
|
|
139
|
+
totalDescribed += stats.semanticWithDescription;
|
|
140
|
+
}
|
|
141
|
+
// No semantic tokens found — N/A
|
|
142
|
+
if (totalSemantic === 0) {
|
|
143
|
+
return { findings, opportunities: 0 };
|
|
144
|
+
}
|
|
145
|
+
const coverage = totalDescribed / totalSemantic;
|
|
146
|
+
if (coverage < COVERAGE_THRESHOLD) {
|
|
147
|
+
const pct = (coverage * 100).toFixed(coverage * 100 < 1 ? 0 : 1).replace(/\.0$/, "");
|
|
148
|
+
findings.push({
|
|
149
|
+
ruleId: RULE_ID,
|
|
150
|
+
axis: "tokens",
|
|
151
|
+
severity: "info",
|
|
152
|
+
location: { file: primaryFile ?? "lyse.tokens.json", line: 1, column: 1 },
|
|
153
|
+
message: `Semantic-layer $description coverage is ${pct}% (${totalDescribed}/${totalSemantic}); target is 80%`,
|
|
154
|
+
suggestion: "add $description to semantic tokens (action.*, surface.*, text.*, feedback.*, etc.)",
|
|
155
|
+
});
|
|
156
|
+
}
|
|
157
|
+
return { findings, opportunities: totalSemantic };
|
|
158
|
+
};
|
|
159
|
+
export const rule = createLyseRule({
|
|
160
|
+
meta: {
|
|
161
|
+
axis: "tokens",
|
|
162
|
+
lyseRuleId: RULE_ID,
|
|
163
|
+
defaultSeverity: "info",
|
|
164
|
+
shortDescription: "Semantic tokens should declare a $description",
|
|
165
|
+
fullDescription: "Measures the fraction of semantic-layer tokens (`action.*`, `surface.*`, `text.*`, `background.*`, `border.*`, `feedback.*`, `state.*`, `interactive.*`, `link.*`, or any token under a `semantic` group) that declare a non-empty `$description`. Emits a single summary finding when coverage falls below 80%.",
|
|
166
|
+
helpUri: "https://github.com/lyse-labs/lyse/blob/main/docs/rules/tokens-description-coverage.md",
|
|
167
|
+
rationale: `Why it matters
|
|
168
|
+
|
|
169
|
+
Semantic tokens are the contract surface between design and code. Their primitive counterparts (\`color.blue.500\`, \`spacing.16\`) are self-explanatory — a number or a hex. But \`action.primary\` only makes sense if the token explains *what* it's for: "the default action color for primary buttons, brand surfaces, and emphasized text".
|
|
170
|
+
|
|
171
|
+
Undocumented semantic tokens cause AI agents and humans alike to pick the wrong token. \`$description\` is the cheapest documentation surface in a DS — and the one most often skipped.
|
|
172
|
+
|
|
173
|
+
The rule is intentionally informational (severity: info) and computes coverage on the semantic layer only. Primitive tokens are excluded from the denominator.`,
|
|
174
|
+
examples: [
|
|
175
|
+
{
|
|
176
|
+
good: '{ "action": { "primary": { "$value": "{color.brand.500}", "$type": "color", "$description": "Default action color for primary CTAs and emphasized text" } } }',
|
|
177
|
+
bad: '{ "action": { "primary": { "$value": "{color.brand.500}", "$type": "color" } } }',
|
|
178
|
+
},
|
|
179
|
+
],
|
|
180
|
+
allowlist: [
|
|
181
|
+
"primitive tokens — `color.blue.500`, `spacing.16`, `radius.md` — excluded from the denominator",
|
|
182
|
+
"repos with no DTCG file — rule is N/A (opportunities = 0)",
|
|
183
|
+
],
|
|
184
|
+
},
|
|
185
|
+
defaultOptions: [],
|
|
186
|
+
create: () => ({ evaluate }),
|
|
187
|
+
});
|
|
188
|
+
export const _internal = {
|
|
189
|
+
walkForCoverage,
|
|
190
|
+
isSemanticTokenPath,
|
|
191
|
+
COVERAGE_THRESHOLD,
|
|
192
|
+
};
|
|
193
|
+
//# sourceMappingURL=tokens-description-coverage.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tokens-description-coverage.js","sourceRoot":"","sources":["../../src/rules/tokens-description-coverage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACvD,OAAO,EAAE,MAAM,WAAW,CAAC;AAQ3B,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EACL,WAAW,EACX,WAAW,GAGZ,MAAM,yBAAyB,CAAC;AAEjC,MAAM,cAAc,GAAG,SAAS,CAAC;AACjC,MAAM,OAAO,GAAG,6BAA6B,CAAC;AAC9C,MAAM,kBAAkB,GAAG,GAAG,CAAC,CAAC,OAAO;AAEvC,MAAM,sBAAsB,GAAG,IAAI,GAAG,CAAS;IAC7C,QAAQ;IACR,SAAS;IACT,MAAM;IACN,YAAY;IACZ,QAAQ;IACR,UAAU;IACV,OAAO;IACP,aAAa;IACb,MAAM;IACN,UAAU;CACX,CAAC,CAAC;AAEH,SAAS,iBAAiB,CAAC,GAAgB;IACzC,IAAI,CAAC,GAAG,CAAC,QAAQ;QAAE,OAAO,EAAE,CAAC;IAC7B,IAAI,OAAO,GAAa,EAAE,CAAC;IAC3B,IAAI,CAAC;QACH,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC,kBAAkB,EAAE,kBAAkB,EAAE,qBAAqB,CAAC,EAAE;YACjF,GAAG,EAAE,GAAG,CAAC,QAAQ;YACjB,QAAQ,EAAE,KAAK;YACf,GAAG,EAAE,KAAK;YACV,MAAM,EAAE,CAAC,oBAAoB,EAAE,YAAY,EAAE,aAAa,EAAE,YAAY,CAAC;YACzE,mBAAmB,EAAE,KAAK;SAC3B,CAAC,CAAC;IACL,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,MAAM,GAAG,GAAG,IAAI,GAAG,EAAU,CAAC;IAC9B,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;QAC1B,IAAI,cAAc,CAAC,GAAG,EAAE,GAAG,CAAC,YAAY,CAAC;YAAE,SAAS;QACpD,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACf,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;AAChC,CAAC;AAED,SAAS,eAAe,CAAC,OAAe;IACtC,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC/B,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAAE,OAAO,IAAI,CAAC;QAChC,IAAI,IAAI,CAAC,IAAI,GAAG,cAAc;YAAE,OAAO,IAAI,CAAC;QAC5C,MAAM,GAAG,GAAG,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC1C,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QACzC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED,SAAS,cAAc,CAAC,IAAa,EAAE,WAAmB;IACxD,IAAI,WAAW,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC;IAClC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QAAE,OAAO,KAAK,CAAC;IACnF,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1C,IAAI,CAAC,KAAK,QAAQ;YAAE,OAAO,IAAI,CAAC;QAChC,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI,IAAI,cAAc,CAAC,CAAC,EAAE,WAAW,GAAG,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC;IAC7F,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,aAAa,CAAC,IAAa;IAClC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QAAE,OAAO,KAAK,CAAC;IACnF,OAAO,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;AACjC,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,IAAc;IAChD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACpC,qEAAqE;IACrE,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,sBAAsB,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,OAAO,IAAI,CAAC;IACnD,CAAC;IACD,6EAA6E;IAC7E,4EAA4E;IAC5E,mEAAmE;IACnE,OAAO,KAAK,CAAC;AACf,CAAC;AAOD,SAAS,eAAe,CAAC,GAAiB;IACxC,MAAM,KAAK,GAAkB,EAAE,aAAa,EAAE,CAAC,EAAE,uBAAuB,EAAE,CAAC,EAAE,CAAC;IAC9E,MAAM,KAAK,GAAG,CAAC,IAAa,EAAE,IAAc,EAAE,EAAE;QAC9C,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;YAAE,OAAO;QAC7E,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;YACtB,IAAI,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9B,KAAK,CAAC,aAAa,EAAE,CAAC;gBACtB,MAAM,IAAI,GAAI,IAA2B,CAAC,YAAY,CAAC;gBACvD,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACvD,KAAK,CAAC,uBAAuB,EAAE,CAAC;gBAClC,CAAC;YACH,CAAC;YACD,OAAO;QACT,CAAC;QACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;YAAE,OAAO;QAC/B,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1C,IAAI,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC;gBAAE,SAAS;YAChC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC;IACH,CAAC,CAAC;IACF,KAAK,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IACf,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,QAAQ,GAAG,KAAK,EACpB,GAAgB,EAChB,MAAmB,EACM,EAAE;IAC3B,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,MAAM,QAAQ,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACxC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC,EAAE,CAAC;IACxC,CAAC;IAED,IAAI,aAAa,GAAG,CAAC,CAAC;IACtB,IAAI,cAAc,GAAG,CAAC,CAAC;IACvB,IAAI,WAAW,GAAkB,IAAI,CAAC;IAEtC,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;QAC3B,MAAM,GAAG,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QAC5D,MAAM,IAAI,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC;QAClC,IAAI,IAAI,KAAK,IAAI;YAAE,SAAS;QAC5B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;YAAE,SAAS;QACnC,IAAI,WAAW,KAAK,IAAI;YAAE,WAAW,GAAG,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,IAAI,GAAG,CAAC;QAC3E,MAAM,KAAK,GAAG,eAAe,CAAC,IAAoB,CAAC,CAAC;QACpD,aAAa,IAAI,KAAK,CAAC,aAAa,CAAC;QACrC,cAAc,IAAI,KAAK,CAAC,uBAAuB,CAAC;IAClD,CAAC;IAED,iCAAiC;IACjC,IAAI,aAAa,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC,EAAE,CAAC;IACxC,CAAC;IAED,MAAM,QAAQ,GAAG,cAAc,GAAG,aAAa,CAAC;IAChD,IAAI,QAAQ,GAAG,kBAAkB,EAAE,CAAC;QAClC,MAAM,GAAG,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,QAAQ,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACrF,QAAQ,CAAC,IAAI,CAAC;YACZ,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,MAAM;YAChB,QAAQ,EAAE,EAAE,IAAI,EAAE,WAAW,IAAI,kBAAkB,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE;YACzE,OAAO,EAAE,2CAA2C,GAAG,MAAM,cAAc,IAAI,aAAa,kBAAkB;YAC9G,UAAU,EAAE,qFAAqF;SAClG,CAAC,CAAC;IACL,CAAC;IAED,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,aAAa,EAAE,CAAC;AACpD,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,IAAI,GAAS,cAAc,CAAC;IACvC,IAAI,EAAE;QACJ,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE,OAAO;QACnB,eAAe,EAAE,MAAM;QACvB,gBAAgB,EAAE,+CAA+C;QACjE,eAAe,EACb,kTAAkT;QACpT,OAAO,EACL,uFAAuF;QACzF,SAAS,EAAE;;;;;;+JAMgJ;QAC3J,QAAQ,EAAE;YACR;gBACE,IAAI,EAAE,+JAA+J;gBACrK,GAAG,EAAE,kFAAkF;aACxF;SACF;QACD,SAAS,EAAE;YACT,gGAAgG;YAChG,2DAA2D;SAC5D;KACF;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC;CAC7B,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,eAAe;IACf,mBAAmB;IACnB,kBAAkB;CACnB,CAAC"}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import type { Rule, RuleContext } from "../types.js";
|
|
2
|
+
import { type DtcgDocument, type DtcgType } from "../tokens/dtcg-model.js";
|
|
3
|
+
/**
|
|
4
|
+
* Discovers DTCG-shaped JSON files under the repo:
|
|
5
|
+
* - `**\/*.tokens.json`
|
|
6
|
+
* - `tokens/**\/*.json`
|
|
7
|
+
* - any `*.json` whose top-level value contains a `$value` somewhere (heuristic)
|
|
8
|
+
*
|
|
9
|
+
* Files larger than 1 MB are skipped to avoid pathological cases. Files
|
|
10
|
+
* matched by `ctx.excludePaths` are skipped.
|
|
11
|
+
*/
|
|
12
|
+
declare function discoverDtcgFiles(ctx: RuleContext): string[];
|
|
13
|
+
declare function looksLikeDtcg(data: unknown): boolean;
|
|
14
|
+
/**
|
|
15
|
+
* Heuristic that infers a likely `$type` from a token's value, used to flag
|
|
16
|
+
* tokens that have `$value` but no `$type` when one is clearly inferable.
|
|
17
|
+
*/
|
|
18
|
+
declare function inferTypeFromValue(value: unknown): DtcgType | null;
|
|
19
|
+
interface WalkOutcome {
|
|
20
|
+
tokenCount: number;
|
|
21
|
+
inheritedTypeConflicts: {
|
|
22
|
+
path: string;
|
|
23
|
+
groupType: DtcgType;
|
|
24
|
+
tokenType: DtcgType;
|
|
25
|
+
}[];
|
|
26
|
+
brokenAliases: {
|
|
27
|
+
path: string;
|
|
28
|
+
alias: string;
|
|
29
|
+
}[];
|
|
30
|
+
missingInferableTypes: {
|
|
31
|
+
path: string;
|
|
32
|
+
inferred: DtcgType;
|
|
33
|
+
}[];
|
|
34
|
+
shapeIssues: {
|
|
35
|
+
path: string;
|
|
36
|
+
reason: string;
|
|
37
|
+
}[];
|
|
38
|
+
}
|
|
39
|
+
declare function walkDocument(doc: DtcgDocument): WalkOutcome;
|
|
40
|
+
export declare const rule: Rule;
|
|
41
|
+
export declare const _internal: {
|
|
42
|
+
discoverDtcgFiles: typeof discoverDtcgFiles;
|
|
43
|
+
walkDocument: typeof walkDocument;
|
|
44
|
+
looksLikeDtcg: typeof looksLikeDtcg;
|
|
45
|
+
inferTypeFromValue: typeof inferTypeFromValue;
|
|
46
|
+
};
|
|
47
|
+
export {};
|