agent-rulebook 0.1.0
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 +4 -0
- package/README.md +66 -0
- package/dist/cli.d.ts +2 -0
- package/dist/cli.js +4 -0
- package/dist/cli.js.map +1 -0
- package/dist/commands/add.d.ts +2 -0
- package/dist/commands/add.js +134 -0
- package/dist/commands/add.js.map +1 -0
- package/dist/commands/index.d.ts +3 -0
- package/dist/commands/index.js +41 -0
- package/dist/commands/index.js.map +1 -0
- package/dist/commands/init.d.ts +2 -0
- package/dist/commands/init.js +17 -0
- package/dist/commands/init.js.map +1 -0
- package/dist/commands/mcp.d.ts +2 -0
- package/dist/commands/mcp.js +17 -0
- package/dist/commands/mcp.js.map +1 -0
- package/dist/commands/migrate.d.ts +2 -0
- package/dist/commands/migrate.js +73 -0
- package/dist/commands/migrate.js.map +1 -0
- package/dist/commands/output.d.ts +6 -0
- package/dist/commands/output.js +49 -0
- package/dist/commands/output.js.map +1 -0
- package/dist/commands/search.d.ts +2 -0
- package/dist/commands/search.js +57 -0
- package/dist/commands/search.js.map +1 -0
- package/dist/core/compatibility-matcher.d.ts +17 -0
- package/dist/core/compatibility-matcher.js +146 -0
- package/dist/core/compatibility-matcher.js.map +1 -0
- package/dist/core/dedup.d.ts +22 -0
- package/dist/core/dedup.js +54 -0
- package/dist/core/dedup.js.map +1 -0
- package/dist/core/error-signature.d.ts +15 -0
- package/dist/core/error-signature.js +59 -0
- package/dist/core/error-signature.js.map +1 -0
- package/dist/core/facets.d.ts +9 -0
- package/dist/core/facets.js +46 -0
- package/dist/core/facets.js.map +1 -0
- package/dist/core/index.d.ts +30 -0
- package/dist/core/index.js +16 -0
- package/dist/core/index.js.map +1 -0
- package/dist/core/lesson-importer.d.ts +22 -0
- package/dist/core/lesson-importer.js +94 -0
- package/dist/core/lesson-importer.js.map +1 -0
- package/dist/core/paths.d.ts +5 -0
- package/dist/core/paths.js +11 -0
- package/dist/core/paths.js.map +1 -0
- package/dist/core/project-environment-detector.d.ts +43 -0
- package/dist/core/project-environment-detector.js +464 -0
- package/dist/core/project-environment-detector.js.map +1 -0
- package/dist/core/ranker.d.ts +3 -0
- package/dist/core/ranker.js +47 -0
- package/dist/core/ranker.js.map +1 -0
- package/dist/core/redaction.d.ts +35 -0
- package/dist/core/redaction.js +149 -0
- package/dist/core/redaction.js.map +1 -0
- package/dist/core/rule-compatibility.d.ts +66 -0
- package/dist/core/rule-compatibility.js +53 -0
- package/dist/core/rule-compatibility.js.map +1 -0
- package/dist/core/rule-parser.d.ts +25 -0
- package/dist/core/rule-parser.js +81 -0
- package/dist/core/rule-parser.js.map +1 -0
- package/dist/core/rule-schema.d.ts +231 -0
- package/dist/core/rule-schema.js +184 -0
- package/dist/core/rule-schema.js.map +1 -0
- package/dist/core/rule-writer.d.ts +35 -0
- package/dist/core/rule-writer.js +63 -0
- package/dist/core/rule-writer.js.map +1 -0
- package/dist/core/search-types.d.ts +51 -0
- package/dist/core/search-types.js +2 -0
- package/dist/core/search-types.js.map +1 -0
- package/dist/core/slug.d.ts +13 -0
- package/dist/core/slug.js +42 -0
- package/dist/core/slug.js.map +1 -0
- package/dist/core/stack-detector.d.ts +56 -0
- package/dist/core/stack-detector.js +358 -0
- package/dist/core/stack-detector.js.map +1 -0
- package/dist/index.d.ts +5 -0
- package/dist/index.js +4 -0
- package/dist/index.js.map +1 -0
- package/dist/mcp/index.d.ts +7 -0
- package/dist/mcp/index.js +5 -0
- package/dist/mcp/index.js.map +1 -0
- package/dist/mcp/lesson-capture.d.ts +30 -0
- package/dist/mcp/lesson-capture.js +146 -0
- package/dist/mcp/lesson-capture.js.map +1 -0
- package/dist/mcp/rules-add-lesson-tool.d.ts +4 -0
- package/dist/mcp/rules-add-lesson-tool.js +73 -0
- package/dist/mcp/rules-add-lesson-tool.js.map +1 -0
- package/dist/mcp/rules-dedup-lesson-tool.d.ts +4 -0
- package/dist/mcp/rules-dedup-lesson-tool.js +69 -0
- package/dist/mcp/rules-dedup-lesson-tool.js.map +1 -0
- package/dist/mcp/rules-list-facets-tool.d.ts +3 -0
- package/dist/mcp/rules-list-facets-tool.js +31 -0
- package/dist/mcp/rules-list-facets-tool.js.map +1 -0
- package/dist/mcp/rules-prepare-lesson-tool.d.ts +4 -0
- package/dist/mcp/rules-prepare-lesson-tool.js +7 -0
- package/dist/mcp/rules-prepare-lesson-tool.js.map +1 -0
- package/dist/mcp/rules-search-error-tool.d.ts +4 -0
- package/dist/mcp/rules-search-error-tool.js +99 -0
- package/dist/mcp/rules-search-error-tool.js.map +1 -0
- package/dist/mcp/rules-search-for-project-tool.d.ts +4 -0
- package/dist/mcp/rules-search-for-project-tool.js +103 -0
- package/dist/mcp/rules-search-for-project-tool.js.map +1 -0
- package/dist/mcp/rules-search-tool.d.ts +7 -0
- package/dist/mcp/rules-search-tool.js +65 -0
- package/dist/mcp/rules-search-tool.js.map +1 -0
- package/dist/mcp/schemas.d.ts +222 -0
- package/dist/mcp/schemas.js +99 -0
- package/dist/mcp/schemas.js.map +1 -0
- package/dist/mcp/server.d.ts +5 -0
- package/dist/mcp/server.js +29 -0
- package/dist/mcp/server.js.map +1 -0
- package/dist/mcp/tool-output.d.ts +32 -0
- package/dist/mcp/tool-output.js +74 -0
- package/dist/mcp/tool-output.js.map +1 -0
- package/dist/mcp/tools.d.ts +300 -0
- package/dist/mcp/tools.js +123 -0
- package/dist/mcp/tools.js.map +1 -0
- package/dist/migration/adapters/fenced-lessons.d.ts +2 -0
- package/dist/migration/adapters/fenced-lessons.js +55 -0
- package/dist/migration/adapters/fenced-lessons.js.map +1 -0
- package/dist/migration/adapters/global-rules.d.ts +2 -0
- package/dist/migration/adapters/global-rules.js +72 -0
- package/dist/migration/adapters/global-rules.js.map +1 -0
- package/dist/migration/adapters/index.d.ts +2 -0
- package/dist/migration/adapters/index.js +13 -0
- package/dist/migration/adapters/index.js.map +1 -0
- package/dist/migration/adapters/markdown-lessons.d.ts +2 -0
- package/dist/migration/adapters/markdown-lessons.js +36 -0
- package/dist/migration/adapters/markdown-lessons.js.map +1 -0
- package/dist/migration/adapters/structured-lessons.d.ts +2 -0
- package/dist/migration/adapters/structured-lessons.js +8 -0
- package/dist/migration/adapters/structured-lessons.js.map +1 -0
- package/dist/migration/adapters/structured-shared.d.ts +3 -0
- package/dist/migration/adapters/structured-shared.js +97 -0
- package/dist/migration/adapters/structured-shared.js.map +1 -0
- package/dist/migration/applier.d.ts +32 -0
- package/dist/migration/applier.js +469 -0
- package/dist/migration/applier.js.map +1 -0
- package/dist/migration/index.d.ts +11 -0
- package/dist/migration/index.js +7 -0
- package/dist/migration/index.js.map +1 -0
- package/dist/migration/manifest.d.ts +262 -0
- package/dist/migration/manifest.js +89 -0
- package/dist/migration/manifest.js.map +1 -0
- package/dist/migration/migration-report.d.ts +147 -0
- package/dist/migration/migration-report.js +81 -0
- package/dist/migration/migration-report.js.map +1 -0
- package/dist/migration/scanner.d.ts +2 -0
- package/dist/migration/scanner.js +314 -0
- package/dist/migration/scanner.js.map +1 -0
- package/dist/migration/source-adapter.d.ts +37 -0
- package/dist/migration/source-adapter.js +2 -0
- package/dist/migration/source-adapter.js.map +1 -0
- package/dist/migration/verifier.d.ts +5 -0
- package/dist/migration/verifier.js +217 -0
- package/dist/migration/verifier.js.map +1 -0
- package/dist/program.d.ts +2 -0
- package/dist/program.js +21 -0
- package/dist/program.js.map +1 -0
- package/dist/storage/index-check.d.ts +19 -0
- package/dist/storage/index-check.js +114 -0
- package/dist/storage/index-check.js.map +1 -0
- package/dist/storage/index.d.ts +15 -0
- package/dist/storage/index.js +9 -0
- package/dist/storage/index.js.map +1 -0
- package/dist/storage/indexer.d.ts +19 -0
- package/dist/storage/indexer.js +354 -0
- package/dist/storage/indexer.js.map +1 -0
- package/dist/storage/migrations.d.ts +3 -0
- package/dist/storage/migrations.js +110 -0
- package/dist/storage/migrations.js.map +1 -0
- package/dist/storage/rule-discovery.d.ts +4 -0
- package/dist/storage/rule-discovery.js +34 -0
- package/dist/storage/rule-discovery.js.map +1 -0
- package/dist/storage/rule-store.d.ts +10 -0
- package/dist/storage/rule-store.js +12 -0
- package/dist/storage/rule-store.js.map +1 -0
- package/dist/storage/rulebook-home.d.ts +21 -0
- package/dist/storage/rulebook-home.js +75 -0
- package/dist/storage/rulebook-home.js.map +1 -0
- package/dist/storage/search-service.d.ts +17 -0
- package/dist/storage/search-service.js +252 -0
- package/dist/storage/search-service.js.map +1 -0
- package/dist/storage/sqlite-errors.d.ts +26 -0
- package/dist/storage/sqlite-errors.js +55 -0
- package/dist/storage/sqlite-errors.js.map +1 -0
- package/dist/storage/sqlite.d.ts +13 -0
- package/dist/storage/sqlite.js +34 -0
- package/dist/storage/sqlite.js.map +1 -0
- package/package.json +62 -0
|
@@ -0,0 +1,184 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
import { isKnownFacetValue, normalizeFacetValue } from './facets.js';
|
|
3
|
+
import { LegacyCompatibility, RuleCompatibilitySchema } from './rule-compatibility.js';
|
|
4
|
+
const isoDateStringSchema = z.string().regex(/^\d{4}-\d{2}-\d{2}(?:T\d{2}:\d{2}:\d{2}(?:\.\d{3})?Z?)?$/, 'Expected an ISO date string');
|
|
5
|
+
const facetValueSchema = z.string().transform(normalizeFacetValue).pipe(z.string().min(1));
|
|
6
|
+
const optionalFacetArraySchema = z.preprocess((value) => {
|
|
7
|
+
if (value === undefined || value === null) {
|
|
8
|
+
return [];
|
|
9
|
+
}
|
|
10
|
+
if (typeof value === 'string') {
|
|
11
|
+
return [value];
|
|
12
|
+
}
|
|
13
|
+
return value;
|
|
14
|
+
}, z.array(facetValueSchema).default([]));
|
|
15
|
+
export const RuleStatusSchema = z.enum(['draft', 'active', 'deprecated', 'superseded']);
|
|
16
|
+
export const RuleConfidenceSchema = z.enum(['low', 'medium', 'high']);
|
|
17
|
+
export const RuleLanguageSchema = z.preprocess((value) => (typeof value === 'string' ? normalizeFacetValue(value) : value), z.enum(['swift', 'kotlin', 'typescript', 'javascript', 'python', 'mcp', 'other']));
|
|
18
|
+
export const RuleScopeSchema = z.enum(['shared', 'project']);
|
|
19
|
+
const provenanceSourceRefSchema = z
|
|
20
|
+
.string()
|
|
21
|
+
.trim()
|
|
22
|
+
.min(1)
|
|
23
|
+
.refine((value) => !value.startsWith('/') && !value.startsWith('~') && !/^[A-Za-z]:[\\/]/.test(value), 'Source reference must not contain a local absolute path');
|
|
24
|
+
const ImportedProvenanceSchema = z.object({
|
|
25
|
+
imported: z.literal(true),
|
|
26
|
+
source_kind: z.enum([
|
|
27
|
+
'project_markdown',
|
|
28
|
+
'skill_lessons',
|
|
29
|
+
'codex_rules',
|
|
30
|
+
'legacy_yaml',
|
|
31
|
+
]),
|
|
32
|
+
source_project: z.string().trim().min(1).optional(),
|
|
33
|
+
source_ref: provenanceSourceRefSchema,
|
|
34
|
+
source_checksum: z
|
|
35
|
+
.string()
|
|
36
|
+
.regex(/^sha256:[a-f0-9]{64}$/i, 'Expected a sha256-prefixed checksum'),
|
|
37
|
+
});
|
|
38
|
+
const DirectProvenanceSchema = z.object({
|
|
39
|
+
imported: z.literal(false),
|
|
40
|
+
});
|
|
41
|
+
export const RuleProvenanceSchema = z.discriminatedUnion('imported', [
|
|
42
|
+
ImportedProvenanceSchema,
|
|
43
|
+
DirectProvenanceSchema,
|
|
44
|
+
]);
|
|
45
|
+
const LegacyActivationSchema = z.object({
|
|
46
|
+
basis: z.literal('legacy_curated'),
|
|
47
|
+
capture_mode: z.literal('migration'),
|
|
48
|
+
});
|
|
49
|
+
const TddVerifiedActivationSchema = z.object({
|
|
50
|
+
basis: z.literal('tdd_verified'),
|
|
51
|
+
capture_mode: z.literal('tdd_auto'),
|
|
52
|
+
criteria: z.object({
|
|
53
|
+
debugging_cost: z.literal('high'),
|
|
54
|
+
token_cost: z.literal('high'),
|
|
55
|
+
recurrence_risk: z.literal('high'),
|
|
56
|
+
}),
|
|
57
|
+
dedup_result: z.literal('new'),
|
|
58
|
+
verification: z.object({
|
|
59
|
+
kind: z.enum(['focused_test', 'integration_test', 'manual_verification']),
|
|
60
|
+
evidence: z.string().trim().min(1),
|
|
61
|
+
}),
|
|
62
|
+
});
|
|
63
|
+
const ManualActivationSchema = z.object({
|
|
64
|
+
basis: z.literal('manual_review'),
|
|
65
|
+
capture_mode: z.literal('manual'),
|
|
66
|
+
});
|
|
67
|
+
export const RuleActivationSchema = z.discriminatedUnion('basis', [
|
|
68
|
+
LegacyActivationSchema,
|
|
69
|
+
TddVerifiedActivationSchema,
|
|
70
|
+
ManualActivationSchema,
|
|
71
|
+
]);
|
|
72
|
+
const ruleFields = {
|
|
73
|
+
id: z.string().trim().min(1),
|
|
74
|
+
title: z.string().trim().min(1),
|
|
75
|
+
summary: z.string().trim().min(1),
|
|
76
|
+
mistake: z.string().trim().min(1),
|
|
77
|
+
fix: z.string().trim().min(1),
|
|
78
|
+
confidence: RuleConfidenceSchema,
|
|
79
|
+
status: RuleStatusSchema,
|
|
80
|
+
created_at: isoDateStringSchema,
|
|
81
|
+
language: RuleLanguageSchema.optional(),
|
|
82
|
+
platforms: optionalFacetArraySchema,
|
|
83
|
+
tools: optionalFacetArraySchema,
|
|
84
|
+
categories: optionalFacetArraySchema,
|
|
85
|
+
trigger: z.preprocess((value) => value ?? [], z.array(z.string()).default([])),
|
|
86
|
+
anti_conditions: z.preprocess((value) => value ?? [], z.array(z.string()).default([])),
|
|
87
|
+
error_signature: z.string().min(1).optional(),
|
|
88
|
+
source_project: z.string().min(1).optional(),
|
|
89
|
+
verified_at: isoDateStringSchema.optional(),
|
|
90
|
+
updated_at: isoDateStringSchema.optional(),
|
|
91
|
+
superseded_by: z.string().trim().min(1).nullable().optional(),
|
|
92
|
+
};
|
|
93
|
+
export const LegacyRuleSchema = z.object({
|
|
94
|
+
schema_version: z.literal(1).optional(),
|
|
95
|
+
...ruleFields,
|
|
96
|
+
});
|
|
97
|
+
export const RuleSchema = z
|
|
98
|
+
.object({
|
|
99
|
+
schema_version: z.literal(2),
|
|
100
|
+
rule_scope: RuleScopeSchema,
|
|
101
|
+
project_key: facetValueSchema
|
|
102
|
+
.refine((value) => /^[a-z0-9][a-z0-9._-]*$/.test(value), 'Expected a stable project key')
|
|
103
|
+
.optional(),
|
|
104
|
+
compatibility: RuleCompatibilitySchema,
|
|
105
|
+
provenance: RuleProvenanceSchema,
|
|
106
|
+
activation: RuleActivationSchema,
|
|
107
|
+
...ruleFields,
|
|
108
|
+
})
|
|
109
|
+
.superRefine((rule, context) => {
|
|
110
|
+
if (rule.rule_scope === 'project' && rule.project_key === undefined) {
|
|
111
|
+
context.addIssue({
|
|
112
|
+
code: 'custom',
|
|
113
|
+
path: ['project_key'],
|
|
114
|
+
message: 'Project scoped rules require a stable project_key',
|
|
115
|
+
});
|
|
116
|
+
}
|
|
117
|
+
if (rule.rule_scope === 'shared' && rule.project_key !== undefined) {
|
|
118
|
+
context.addIssue({
|
|
119
|
+
code: 'custom',
|
|
120
|
+
path: ['project_key'],
|
|
121
|
+
message: 'Shared rules cannot include a project_key',
|
|
122
|
+
});
|
|
123
|
+
}
|
|
124
|
+
if (rule.status === 'superseded' && rule.superseded_by == null) {
|
|
125
|
+
context.addIssue({
|
|
126
|
+
code: 'custom',
|
|
127
|
+
path: ['superseded_by'],
|
|
128
|
+
message: 'Superseded rules require superseded_by',
|
|
129
|
+
});
|
|
130
|
+
}
|
|
131
|
+
if (rule.superseded_by === rule.id) {
|
|
132
|
+
context.addIssue({
|
|
133
|
+
code: 'custom',
|
|
134
|
+
path: ['superseded_by'],
|
|
135
|
+
message: 'A rule cannot supersede itself',
|
|
136
|
+
});
|
|
137
|
+
}
|
|
138
|
+
if (rule.status !== 'superseded' && rule.superseded_by != null) {
|
|
139
|
+
context.addIssue({
|
|
140
|
+
code: 'custom',
|
|
141
|
+
path: ['superseded_by'],
|
|
142
|
+
message: 'Only superseded rules can name a replacement',
|
|
143
|
+
});
|
|
144
|
+
}
|
|
145
|
+
if (rule.activation.basis === 'tdd_verified' && rule.status !== 'active') {
|
|
146
|
+
context.addIssue({
|
|
147
|
+
code: 'custom',
|
|
148
|
+
path: ['status'],
|
|
149
|
+
message: 'TDD verified activation requires active status',
|
|
150
|
+
});
|
|
151
|
+
}
|
|
152
|
+
});
|
|
153
|
+
export const LegacyRuleMarkerSchema = z.object({
|
|
154
|
+
source_schema_version: z.literal(1),
|
|
155
|
+
});
|
|
156
|
+
export function toLegacyRuleCandidate(input) {
|
|
157
|
+
const { schema_version: _schemaVersion, ...fields } = input;
|
|
158
|
+
return {
|
|
159
|
+
...fields,
|
|
160
|
+
schema_version: 2,
|
|
161
|
+
rule_scope: 'shared',
|
|
162
|
+
compatibility: {
|
|
163
|
+
scope: LegacyCompatibility.scope,
|
|
164
|
+
constraints: [],
|
|
165
|
+
verified_with: [],
|
|
166
|
+
},
|
|
167
|
+
provenance: { imported: false },
|
|
168
|
+
activation: { basis: 'legacy_curated', capture_mode: 'migration' },
|
|
169
|
+
legacy: { source_schema_version: 1 },
|
|
170
|
+
};
|
|
171
|
+
}
|
|
172
|
+
export function collectUnknownFacetWarnings(rule) {
|
|
173
|
+
const warnings = [];
|
|
174
|
+
for (const facet of ['platforms', 'tools', 'categories']) {
|
|
175
|
+
for (const value of rule[facet]) {
|
|
176
|
+
if (!isKnownFacetValue(facet, value)) {
|
|
177
|
+
warnings.push({ kind: 'unknown_facet', facet, value });
|
|
178
|
+
}
|
|
179
|
+
}
|
|
180
|
+
}
|
|
181
|
+
return warnings;
|
|
182
|
+
}
|
|
183
|
+
export { isKnownFacetValue } from './facets.js';
|
|
184
|
+
//# sourceMappingURL=rule-schema.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"rule-schema.js","sourceRoot":"","sources":["../../src/core/rule-schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACrE,OAAO,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AAEvF,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAC1C,0DAA0D,EAC1D,6BAA6B,CAC9B,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AAE3F,MAAM,wBAAwB,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC,KAAK,EAAE,EAAE;IACtD,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAC1C,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,CAAC,KAAK,CAAC,CAAC;IACjB,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;AAE1C,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC,CAAC;AACxF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;AACtE,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,UAAU,CAC5C,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAC3E,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAClF,CAAC;AACF,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC;AAE7D,MAAM,yBAAyB,GAAG,CAAC;KAChC,MAAM,EAAE;KACR,IAAI,EAAE;KACN,GAAG,CAAC,CAAC,CAAC;KACN,MAAM,CACL,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,EAC7F,yDAAyD,CAC1D,CAAC;AAEJ,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;IACzB,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC;QAClB,kBAAkB;QAClB,eAAe;QACf,aAAa;QACb,aAAa;KACd,CAAC;IACF,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACnD,UAAU,EAAE,yBAAyB;IACrC,eAAe,EAAE,CAAC;SACf,MAAM,EAAE;SACR,KAAK,CAAC,wBAAwB,EAAE,qCAAqC,CAAC;CAC1E,CAAC,CAAC;AAEH,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;CAC3B,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,kBAAkB,CAAC,UAAU,EAAE;IACnE,wBAAwB;IACxB,sBAAsB;CACvB,CAAC,CAAC;AAEH,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC;IAClC,YAAY,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;CACrC,CAAC,CAAC;AAEH,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC;IAChC,YAAY,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;IACnC,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC;QACjB,cAAc,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;QACjC,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;QAC7B,eAAe,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;KACnC,CAAC;IACF,YAAY,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;IAC9B,YAAY,EAAE,CAAC,CAAC,MAAM,CAAC;QACrB,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,kBAAkB,EAAE,qBAAqB,CAAC,CAAC;QACzE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;KACnC,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC;IACjC,YAAY,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;CAClC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,kBAAkB,CAAC,OAAO,EAAE;IAChE,sBAAsB;IACtB,2BAA2B;IAC3B,sBAAsB;CACvB,CAAC,CAAC;AAEH,MAAM,UAAU,GAAG;IACjB,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACjC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACjC,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC7B,UAAU,EAAE,oBAAoB;IAChC,MAAM,EAAE,gBAAgB;IACxB,UAAU,EAAE,mBAAmB;IAC/B,QAAQ,EAAE,kBAAkB,CAAC,QAAQ,EAAE;IACvC,SAAS,EAAE,wBAAwB;IACnC,KAAK,EAAE,wBAAwB;IAC/B,UAAU,EAAE,wBAAwB;IACpC,OAAO,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC9E,eAAe,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACtF,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC7C,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC5C,WAAW,EAAE,mBAAmB,CAAC,QAAQ,EAAE;IAC3C,UAAU,EAAE,mBAAmB,CAAC,QAAQ,EAAE;IAC1C,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CAC9D,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,cAAc,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACvC,GAAG,UAAU;CACd,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC;KACxB,MAAM,CAAC;IACN,cAAc,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5B,UAAU,EAAE,eAAe;IAC3B,WAAW,EAAE,gBAAgB;SAC1B,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,wBAAwB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,+BAA+B,CAAC;SACxF,QAAQ,EAAE;IACb,aAAa,EAAE,uBAAuB;IACtC,UAAU,EAAE,oBAAoB;IAChC,UAAU,EAAE,oBAAoB;IAChC,GAAG,UAAU;CACd,CAAC;KACD,WAAW,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE;IAC7B,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QACpE,OAAO,CAAC,QAAQ,CAAC;YACf,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,aAAa,CAAC;YACrB,OAAO,EAAE,mDAAmD;SAC7D,CAAC,CAAC;IACL,CAAC;IAED,IAAI,IAAI,CAAC,UAAU,KAAK,QAAQ,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QACnE,OAAO,CAAC,QAAQ,CAAC;YACf,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,aAAa,CAAC;YACrB,OAAO,EAAE,2CAA2C;SACrD,CAAC,CAAC;IACL,CAAC;IAED,IAAI,IAAI,CAAC,MAAM,KAAK,YAAY,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,EAAE,CAAC;QAC/D,OAAO,CAAC,QAAQ,CAAC;YACf,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,eAAe,CAAC;YACvB,OAAO,EAAE,wCAAwC;SAClD,CAAC,CAAC;IACL,CAAC;IAED,IAAI,IAAI,CAAC,aAAa,KAAK,IAAI,CAAC,EAAE,EAAE,CAAC;QACnC,OAAO,CAAC,QAAQ,CAAC;YACf,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,eAAe,CAAC;YACvB,OAAO,EAAE,gCAAgC;SAC1C,CAAC,CAAC;IACL,CAAC;IAED,IAAI,IAAI,CAAC,MAAM,KAAK,YAAY,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,EAAE,CAAC;QAC/D,OAAO,CAAC,QAAQ,CAAC;YACf,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,eAAe,CAAC;YACvB,OAAO,EAAE,8CAA8C;SACxD,CAAC,CAAC;IACL,CAAC;IAED,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,KAAK,cAAc,IAAI,IAAI,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;QACzE,OAAO,CAAC,QAAQ,CAAC;YACf,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,QAAQ,CAAC;YAChB,OAAO,EAAE,gDAAgD;SAC1D,CAAC,CAAC;IACL,CAAC;AACH,CAAC,CAAC,CAAC;AAEL,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7C,qBAAqB,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;CACpC,CAAC,CAAC;AAaH,MAAM,UAAU,qBAAqB,CAAC,KAAyB;IAC7D,MAAM,EAAE,cAAc,EAAE,cAAc,EAAE,GAAG,MAAM,EAAE,GAAG,KAAK,CAAC;IAC5D,OAAO;QACL,GAAG,MAAM;QACT,cAAc,EAAE,CAAC;QACjB,UAAU,EAAE,QAAQ;QACpB,aAAa,EAAE;YACb,KAAK,EAAE,mBAAmB,CAAC,KAAK;YAChC,WAAW,EAAE,EAAE;YACf,aAAa,EAAE,EAAE;SAClB;QACD,UAAU,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE;QAC/B,UAAU,EAAE,EAAE,KAAK,EAAE,gBAAgB,EAAE,YAAY,EAAE,WAAW,EAAE;QAClE,MAAM,EAAE,EAAE,qBAAqB,EAAE,CAAC,EAAE;KACrC,CAAC;AACJ,CAAC;AAQD,MAAM,UAAU,2BAA2B,CAAC,IAAgB;IAC1D,MAAM,QAAQ,GAAuB,EAAE,CAAC;IACxC,KAAK,MAAM,KAAK,IAAI,CAAC,WAAW,EAAE,OAAO,EAAE,YAAY,CAAU,EAAE,CAAC;QAClE,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAChC,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC;gBACrC,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,eAAe,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;YACzD,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC"}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { type RedactionScanOptions, type RedactionScanResult } from './redaction.js';
|
|
2
|
+
import type { RuleConfidence, RuleLanguage, RuleStatus } from './rule-schema.js';
|
|
3
|
+
export type RuleDraftInput = {
|
|
4
|
+
title: string;
|
|
5
|
+
summary?: string;
|
|
6
|
+
mistake: string;
|
|
7
|
+
fix: string;
|
|
8
|
+
confidence?: RuleConfidence;
|
|
9
|
+
status?: RuleStatus;
|
|
10
|
+
language?: RuleLanguage;
|
|
11
|
+
platforms?: string[];
|
|
12
|
+
tools?: string[];
|
|
13
|
+
categories?: string[];
|
|
14
|
+
trigger?: string[];
|
|
15
|
+
anti_conditions?: string[];
|
|
16
|
+
error_signature?: string;
|
|
17
|
+
source_project?: string;
|
|
18
|
+
verified_at?: string;
|
|
19
|
+
updated_at?: string;
|
|
20
|
+
superseded_by?: string;
|
|
21
|
+
};
|
|
22
|
+
export type BuildRulePreviewOptions = RedactionScanOptions & {
|
|
23
|
+
rulebookHome: string;
|
|
24
|
+
now?: Date;
|
|
25
|
+
};
|
|
26
|
+
export type RulePreview = {
|
|
27
|
+
id: string;
|
|
28
|
+
relativePath: string;
|
|
29
|
+
yaml: string;
|
|
30
|
+
requires_confirmation: boolean;
|
|
31
|
+
can_save: boolean;
|
|
32
|
+
warnings: RedactionScanResult['warnings'];
|
|
33
|
+
suggested_redactions: RedactionScanResult['suggested_redactions'];
|
|
34
|
+
};
|
|
35
|
+
export declare function buildRulePreview(input: RuleDraftInput, options: BuildRulePreviewOptions): Promise<RulePreview>;
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
import { stringify } from 'yaml';
|
|
2
|
+
import { scanRuleDraftForRedactions, } from './redaction.js';
|
|
3
|
+
import { generateRuleIdentity } from './slug.js';
|
|
4
|
+
const DEFAULT_CONFIDENCE = 'medium';
|
|
5
|
+
const DEFAULT_STATUS = 'draft';
|
|
6
|
+
export async function buildRulePreview(input, options) {
|
|
7
|
+
const identity = await generateRuleIdentity({
|
|
8
|
+
rulebookHome: options.rulebookHome,
|
|
9
|
+
title: input.title,
|
|
10
|
+
language: input.language,
|
|
11
|
+
});
|
|
12
|
+
const redaction = scanRuleDraftForRedactions(input, { homeDir: options.homeDir });
|
|
13
|
+
const rule = buildRule(input, identity.id, options.now ?? new Date());
|
|
14
|
+
return {
|
|
15
|
+
id: identity.id,
|
|
16
|
+
relativePath: identity.relativePath,
|
|
17
|
+
yaml: stringify(rule),
|
|
18
|
+
requires_confirmation: true,
|
|
19
|
+
can_save: redaction.can_save,
|
|
20
|
+
warnings: redaction.warnings,
|
|
21
|
+
suggested_redactions: redaction.suggested_redactions,
|
|
22
|
+
};
|
|
23
|
+
}
|
|
24
|
+
function buildRule(input, id, now) {
|
|
25
|
+
const rule = {
|
|
26
|
+
id,
|
|
27
|
+
title: input.title,
|
|
28
|
+
summary: input.summary ?? input.title,
|
|
29
|
+
platforms: input.platforms ?? [],
|
|
30
|
+
tools: input.tools ?? [],
|
|
31
|
+
categories: input.categories ?? [],
|
|
32
|
+
trigger: input.trigger ?? [],
|
|
33
|
+
mistake: input.mistake,
|
|
34
|
+
fix: input.fix,
|
|
35
|
+
anti_conditions: input.anti_conditions ?? [],
|
|
36
|
+
created_at: toDateOnly(now),
|
|
37
|
+
confidence: input.confidence ?? DEFAULT_CONFIDENCE,
|
|
38
|
+
status: input.status ?? DEFAULT_STATUS,
|
|
39
|
+
};
|
|
40
|
+
if (input.language !== undefined) {
|
|
41
|
+
rule.language = input.language;
|
|
42
|
+
}
|
|
43
|
+
if (input.error_signature !== undefined) {
|
|
44
|
+
rule.error_signature = input.error_signature;
|
|
45
|
+
}
|
|
46
|
+
if (input.source_project !== undefined) {
|
|
47
|
+
rule.source_project = input.source_project;
|
|
48
|
+
}
|
|
49
|
+
if (input.verified_at !== undefined) {
|
|
50
|
+
rule.verified_at = input.verified_at;
|
|
51
|
+
}
|
|
52
|
+
if (input.updated_at !== undefined) {
|
|
53
|
+
rule.updated_at = input.updated_at;
|
|
54
|
+
}
|
|
55
|
+
if (input.superseded_by !== undefined) {
|
|
56
|
+
rule.superseded_by = input.superseded_by;
|
|
57
|
+
}
|
|
58
|
+
return rule;
|
|
59
|
+
}
|
|
60
|
+
function toDateOnly(date) {
|
|
61
|
+
return date.toISOString().slice(0, 10);
|
|
62
|
+
}
|
|
63
|
+
//# sourceMappingURL=rule-writer.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"rule-writer.js","sourceRoot":"","sources":["../../src/core/rule-writer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AACjC,OAAO,EACL,0BAA0B,GAG3B,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AAsCjD,MAAM,kBAAkB,GAAmB,QAAQ,CAAC;AACpD,MAAM,cAAc,GAAe,OAAO,CAAC;AAE3C,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,KAAqB,EACrB,OAAgC;IAEhC,MAAM,QAAQ,GAAG,MAAM,oBAAoB,CAAC;QAC1C,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,QAAQ,EAAE,KAAK,CAAC,QAAQ;KACzB,CAAC,CAAC;IACH,MAAM,SAAS,GAAG,0BAA0B,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAClF,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC,GAAG,IAAI,IAAI,IAAI,EAAE,CAAC,CAAC;IAEtE,OAAO;QACL,EAAE,EAAE,QAAQ,CAAC,EAAE;QACf,YAAY,EAAE,QAAQ,CAAC,YAAY;QACnC,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC;QACrB,qBAAqB,EAAE,IAAI;QAC3B,QAAQ,EAAE,SAAS,CAAC,QAAQ;QAC5B,QAAQ,EAAE,SAAS,CAAC,QAAQ;QAC5B,oBAAoB,EAAE,SAAS,CAAC,oBAAoB;KACrD,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,KAAqB,EAAE,EAAU,EAAE,GAAS;IAC7D,MAAM,IAAI,GAAS;QACjB,EAAE;QACF,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,KAAK;QACrC,SAAS,EAAE,KAAK,CAAC,SAAS,IAAI,EAAE;QAChC,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,EAAE;QACxB,UAAU,EAAE,KAAK,CAAC,UAAU,IAAI,EAAE;QAClC,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,EAAE;QAC5B,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,GAAG,EAAE,KAAK,CAAC,GAAG;QACd,eAAe,EAAE,KAAK,CAAC,eAAe,IAAI,EAAE;QAC5C,UAAU,EAAE,UAAU,CAAC,GAAG,CAAC;QAC3B,UAAU,EAAE,KAAK,CAAC,UAAU,IAAI,kBAAkB;QAClD,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,cAAc;KACvC,CAAC;IAEF,IAAI,KAAK,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QACjC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;IACjC,CAAC;IACD,IAAI,KAAK,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;QACxC,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC;IAC/C,CAAC;IACD,IAAI,KAAK,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;QACvC,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,CAAC;IAC7C,CAAC;IACD,IAAI,KAAK,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QACpC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;IACvC,CAAC;IACD,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;QACnC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;IACrC,CAAC;IACD,IAAI,KAAK,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;QACtC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC;IAC3C,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,UAAU,CAAC,IAAU;IAC5B,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AACzC,CAAC"}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import type { RuleConfidence, RuleLanguage, RuleStatus } from './rule-schema.js';
|
|
2
|
+
import type { CompatibilityEnvironmentComponent, CompatibilityWarning } from './compatibility-matcher.js';
|
|
3
|
+
export type SearchFilters = {
|
|
4
|
+
language?: RuleLanguage;
|
|
5
|
+
tools?: string[];
|
|
6
|
+
categories?: string[];
|
|
7
|
+
platforms?: string[];
|
|
8
|
+
status?: RuleStatus[];
|
|
9
|
+
};
|
|
10
|
+
export type SearchQuery = {
|
|
11
|
+
text: string;
|
|
12
|
+
filters?: SearchFilters;
|
|
13
|
+
environment?: CompatibilityEnvironmentComponent[];
|
|
14
|
+
projectKey?: string;
|
|
15
|
+
limit?: number;
|
|
16
|
+
};
|
|
17
|
+
export type SearchLimitPolicy = {
|
|
18
|
+
defaultLimit: number;
|
|
19
|
+
maxLimit: number;
|
|
20
|
+
};
|
|
21
|
+
export type SearchResult = {
|
|
22
|
+
id: string;
|
|
23
|
+
title: string;
|
|
24
|
+
summary: string;
|
|
25
|
+
fix: string;
|
|
26
|
+
path: string;
|
|
27
|
+
confidence: RuleConfidence;
|
|
28
|
+
status: RuleStatus;
|
|
29
|
+
applicability: 'version_agnostic' | 'compatible' | 'unknown';
|
|
30
|
+
applicabilityReason: string;
|
|
31
|
+
compatibilityEvidence: string[];
|
|
32
|
+
warnings: CompatibilityWarning[];
|
|
33
|
+
score: number;
|
|
34
|
+
};
|
|
35
|
+
export type SearchDiagnostic = {
|
|
36
|
+
code: 'unknown_facet' | 'unknown_environment' | 'incompatible_environment' | 'project_scope_mismatch' | 'invalid_rule_source';
|
|
37
|
+
message: string;
|
|
38
|
+
};
|
|
39
|
+
export type SearchResponse = {
|
|
40
|
+
results: SearchResult[];
|
|
41
|
+
hint?: string;
|
|
42
|
+
diagnostics: SearchDiagnostic[];
|
|
43
|
+
applied: {
|
|
44
|
+
filters: SearchFilters;
|
|
45
|
+
environment: string[];
|
|
46
|
+
projectKey?: string;
|
|
47
|
+
};
|
|
48
|
+
};
|
|
49
|
+
export type RankableSearchCandidate = Omit<SearchResult, 'score'> & {
|
|
50
|
+
matchScore: number;
|
|
51
|
+
};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"search-types.js","sourceRoot":"","sources":["../../src/core/search-types.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { RuleLanguage } from './rule-schema.js';
|
|
2
|
+
export type GenerateRuleIdentityOptions = {
|
|
3
|
+
rulebookHome: string;
|
|
4
|
+
title: string;
|
|
5
|
+
language?: RuleLanguage;
|
|
6
|
+
};
|
|
7
|
+
export type GeneratedRuleIdentity = {
|
|
8
|
+
id: string;
|
|
9
|
+
slug: string;
|
|
10
|
+
relativePath: string;
|
|
11
|
+
};
|
|
12
|
+
export declare function slugifyTitle(title: string): string;
|
|
13
|
+
export declare function generateRuleIdentity(options: GenerateRuleIdentityOptions): Promise<GeneratedRuleIdentity>;
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import { access } from 'node:fs/promises';
|
|
2
|
+
import { join } from 'node:path';
|
|
3
|
+
const DEFAULT_RULE_LANGUAGE = 'other';
|
|
4
|
+
export function slugifyTitle(title) {
|
|
5
|
+
const slug = title
|
|
6
|
+
.normalize('NFKD')
|
|
7
|
+
.replace(/[\u0300-\u036f]/g, '')
|
|
8
|
+
.toLowerCase()
|
|
9
|
+
.replace(/[^a-z0-9]+/g, '-')
|
|
10
|
+
.replace(/^-+|-+$/g, '')
|
|
11
|
+
.slice(0, 80)
|
|
12
|
+
.replace(/-+$/g, '');
|
|
13
|
+
return slug.length > 0 ? slug : 'rule';
|
|
14
|
+
}
|
|
15
|
+
export async function generateRuleIdentity(options) {
|
|
16
|
+
const language = options.language ?? DEFAULT_RULE_LANGUAGE;
|
|
17
|
+
const slug = slugifyTitle(options.title);
|
|
18
|
+
let suffix = 1;
|
|
19
|
+
while (true) {
|
|
20
|
+
const suffixText = suffix.toString().padStart(3, '0');
|
|
21
|
+
const candidateSlug = suffix === 1 ? slug : `${slug}-${suffixText}`;
|
|
22
|
+
const relativePath = `rules/${language}/${candidateSlug}.yaml`;
|
|
23
|
+
if (!(await fileExists(join(options.rulebookHome, relativePath)))) {
|
|
24
|
+
return {
|
|
25
|
+
id: `${language}-${slug}-${suffixText}`,
|
|
26
|
+
slug: candidateSlug,
|
|
27
|
+
relativePath,
|
|
28
|
+
};
|
|
29
|
+
}
|
|
30
|
+
suffix += 1;
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
async function fileExists(filePath) {
|
|
34
|
+
try {
|
|
35
|
+
await access(filePath);
|
|
36
|
+
return true;
|
|
37
|
+
}
|
|
38
|
+
catch {
|
|
39
|
+
return false;
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
//# sourceMappingURL=slug.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"slug.js","sourceRoot":"","sources":["../../src/core/slug.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAejC,MAAM,qBAAqB,GAAiB,OAAO,CAAC;AAEpD,MAAM,UAAU,YAAY,CAAC,KAAa;IACxC,MAAM,IAAI,GAAG,KAAK;SACf,SAAS,CAAC,MAAM,CAAC;SACjB,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC;SAC/B,WAAW,EAAE;SACb,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC;SAC3B,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC;SACvB,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC;SACZ,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAEvB,OAAO,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC;AACzC,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,OAAoC;IAEpC,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,qBAAqB,CAAC;IAC3D,MAAM,IAAI,GAAG,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACzC,IAAI,MAAM,GAAG,CAAC,CAAC;IAEf,OAAO,IAAI,EAAE,CAAC;QACZ,MAAM,UAAU,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;QACtD,MAAM,aAAa,GAAG,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,UAAU,EAAE,CAAC;QACpE,MAAM,YAAY,GAAG,SAAS,QAAQ,IAAI,aAAa,OAAO,CAAC;QAE/D,IAAI,CAAC,CAAC,MAAM,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;YAClE,OAAO;gBACL,EAAE,EAAE,GAAG,QAAQ,IAAI,IAAI,IAAI,UAAU,EAAE;gBACvC,IAAI,EAAE,aAAa;gBACnB,YAAY;aACb,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,CAAC,CAAC;IACd,CAAC;AACH,CAAC;AAED,KAAK,UAAU,UAAU,CAAC,QAAgB;IACxC,IAAI,CAAC;QACH,MAAM,MAAM,CAAC,QAAQ,CAAC,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC"}
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import type { RuleLanguage } from './rule-schema.js';
|
|
2
|
+
export { detectProjectEnvironment } from './project-environment-detector.js';
|
|
3
|
+
export type { ProjectEnvironmentComponent, ProjectEnvironmentEvidence, ProjectEnvironmentResult, ProjectEnvironmentWarning, } from './project-environment-detector.js';
|
|
4
|
+
export type ProjectStack = 'swift' | 'android' | 'typescript' | 'mcp';
|
|
5
|
+
export type ProjectStackSearchHints = {
|
|
6
|
+
queryTerms: string[];
|
|
7
|
+
filters: {
|
|
8
|
+
language?: RuleLanguage;
|
|
9
|
+
tools: string[];
|
|
10
|
+
platforms: string[];
|
|
11
|
+
};
|
|
12
|
+
};
|
|
13
|
+
export type ProjectStackMarker = {
|
|
14
|
+
kind: ProjectStackMarkerKind;
|
|
15
|
+
relativePath: string;
|
|
16
|
+
};
|
|
17
|
+
export type ProjectStackMarkerKind = 'swift_package' | 'xcode_project' | 'xcode_workspace' | 'localization' | 'swift_source' | 'gradle_settings' | 'gradle_build' | 'android_manifest' | 'android_app_source' | 'kotlin_source' | 'package_json' | 'tsconfig' | 'package_lock' | 'pnpm_lock' | 'yarn_lock' | 'typescript_source' | 'mcp_sdk_dependency' | 'mcp_command' | 'mcp_source';
|
|
18
|
+
export type ProjectStackWarning = {
|
|
19
|
+
code: 'scan_limit_exceeded';
|
|
20
|
+
message: string;
|
|
21
|
+
};
|
|
22
|
+
export type ProjectStackDetectorResult = {
|
|
23
|
+
status: 'ok';
|
|
24
|
+
projectPath: string;
|
|
25
|
+
stacks: ProjectStack[];
|
|
26
|
+
hints: string[];
|
|
27
|
+
markers: ProjectStackMarker[];
|
|
28
|
+
search: ProjectStackSearchHints;
|
|
29
|
+
warnings: ProjectStackWarning[];
|
|
30
|
+
partial: boolean;
|
|
31
|
+
} | {
|
|
32
|
+
status: 'no_stack';
|
|
33
|
+
projectPath: string;
|
|
34
|
+
stacks: [];
|
|
35
|
+
hints: [];
|
|
36
|
+
markers: [];
|
|
37
|
+
search: ProjectStackSearchHints;
|
|
38
|
+
warnings: ProjectStackWarning[];
|
|
39
|
+
partial: boolean;
|
|
40
|
+
} | {
|
|
41
|
+
status: 'error';
|
|
42
|
+
code: 'path_not_found' | 'path_not_directory' | 'access_denied';
|
|
43
|
+
projectPath: string;
|
|
44
|
+
message: string;
|
|
45
|
+
stacks: [];
|
|
46
|
+
hints: [];
|
|
47
|
+
markers: [];
|
|
48
|
+
search: ProjectStackSearchHints;
|
|
49
|
+
warnings: [];
|
|
50
|
+
partial: false;
|
|
51
|
+
};
|
|
52
|
+
export type DetectProjectStackOptions = {
|
|
53
|
+
maxDepth?: number;
|
|
54
|
+
maxFiles?: number;
|
|
55
|
+
};
|
|
56
|
+
export declare function detectProjectStack(projectPath: string, options?: DetectProjectStackOptions): Promise<ProjectStackDetectorResult>;
|