@ryuenn3123/agentic-senior-core 2.5.11 → 2.5.12
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/.agent-context/prompts/review-code.md +1 -0
- package/.agent-context/review-checklists/pr-checklist.md +4 -0
- package/.agent-context/rules/api-docs.md +19 -0
- package/.agent-context/state/memory-continuity-benchmark.json +1 -1
- package/.cursorrules +1 -1
- package/.windsurfrules +1 -1
- package/package.json +2 -1
- package/scripts/documentation-boundary-audit.mjs +201 -0
- package/scripts/release-gate.mjs +39 -0
- package/scripts/validate.mjs +1 -0
|
@@ -15,6 +15,7 @@ Use these checklists:
|
|
|
15
15
|
2. Read .agent-context/review-checklists/security-audit.md — apply every item.
|
|
16
16
|
3. Apply documentation scope rules exactly: This applies to documentation, release notes, onboarding text, review summaries, and agent-facing explanations.
|
|
17
17
|
4. Treat scope-style findings as advisory unless they hide factual errors, contract mismatches, or non-negotiable violations.
|
|
18
|
+
5. Enforce documentation hard blockers on changed boundaries: public surface changes, API contract changes, and database structure changes must include synchronized documentation updates.
|
|
18
19
|
|
|
19
20
|
For EVERY violation found:
|
|
20
21
|
- State the exact file and line
|
|
@@ -96,6 +96,10 @@ VERDICT: PASS / FAIL (X/Y items passed)
|
|
|
96
96
|
### 10. Documentation
|
|
97
97
|
- [ ] Scope applied: This applies to documentation, release notes, onboarding text, review summaries, and agent-facing explanations
|
|
98
98
|
- [ ] Style scope review is advisory and does not block merge when API docs are synced in the same commit and contract details are correct
|
|
99
|
+
- [ ] Public surface changes fail review if documentation updates are missing or stale in the same scope
|
|
100
|
+
- [ ] API endpoint/contract changes include synchronized API/OpenAPI documentation updates
|
|
101
|
+
- [ ] Database structure changes include synchronized schema or migration documentation updates
|
|
102
|
+
- [ ] Documentation checks stay boundary-aware and only enforce touched scopes
|
|
99
103
|
- [ ] API endpoints have OpenAPI/Swagger documentation
|
|
100
104
|
- [ ] Complex business logic has comments explaining WHY
|
|
101
105
|
- [ ] Public functions/methods have JSDoc/docstrings
|
|
@@ -211,6 +211,25 @@ The spec is a contract. If the contract is wrong, consumers will break.
|
|
|
211
211
|
"I'll update the docs later" means "the docs will never be updated."
|
|
212
212
|
```
|
|
213
213
|
|
|
214
|
+
## Documentation as Hard Rule (Boundary-Aware)
|
|
215
|
+
|
|
216
|
+
Documentation checks are hard-blocking for contract accuracy, but scope-aware to avoid unnecessary overhead.
|
|
217
|
+
|
|
218
|
+
### Boundary Triggers
|
|
219
|
+
1. Public surface boundary: exported/public behavior changes in CLI, library, or runtime scripts.
|
|
220
|
+
2. API contract boundary: endpoint, route, controller, or OpenAPI contract changes.
|
|
221
|
+
3. Database structure boundary: schema, migration, repository contract, or persistence model changes.
|
|
222
|
+
|
|
223
|
+
### Boundary-Aware Enforcement
|
|
224
|
+
1. Only triggered boundaries require synchronized documentation updates.
|
|
225
|
+
2. Untouched boundaries are ignored during the same review run.
|
|
226
|
+
3. Missing docs for a triggered boundary is a blocking failure.
|
|
227
|
+
|
|
228
|
+
### Required Same-Scope Sync
|
|
229
|
+
1. Public surface changes must update user-facing docs (`README.md`, `CHANGELOG.md`, or `docs/*`).
|
|
230
|
+
2. API contract changes must update API/OpenAPI docs in the same scope.
|
|
231
|
+
3. Database structure changes must update schema/migration documentation in the same scope.
|
|
232
|
+
|
|
214
233
|
### Enforcement
|
|
215
234
|
1. API docs live next to the code (same module, same directory)
|
|
216
235
|
2. Docs update in the SAME commit as the endpoint change
|
package/.cursorrules
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# AGENTIC-SENIOR-CORE DYNAMIC GOVERNANCE RULESET
|
|
2
2
|
|
|
3
|
-
Generated by Agentic-Senior-Core CLI v2.5.
|
|
3
|
+
Generated by Agentic-Senior-Core CLI v2.5.12
|
|
4
4
|
Timestamp: 2026-04-15T00:14:51.184Z
|
|
5
5
|
Selected profile: beginner
|
|
6
6
|
Selected policy file: .agent-context/policies/llm-judge-threshold.json
|
package/.windsurfrules
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# AGENTIC-SENIOR-CORE DYNAMIC GOVERNANCE RULESET
|
|
2
2
|
|
|
3
|
-
Generated by Agentic-Senior-Core CLI v2.5.
|
|
3
|
+
Generated by Agentic-Senior-Core CLI v2.5.12
|
|
4
4
|
Timestamp: 2026-04-15T00:14:51.184Z
|
|
5
5
|
Selected profile: beginner
|
|
6
6
|
Selected policy file: .agent-context/policies/llm-judge-threshold.json
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ryuenn3123/agentic-senior-core",
|
|
3
|
-
"version": "2.5.
|
|
3
|
+
"version": "2.5.12",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "Force your AI Agent to code like a Staff Engineer, not a Junior.",
|
|
6
6
|
"bin": {
|
|
@@ -43,6 +43,7 @@
|
|
|
43
43
|
"scripts": {
|
|
44
44
|
"init": "node ./bin/agentic-senior-core.js init",
|
|
45
45
|
"audit:frontend-usability": "node ./scripts/frontend-usability-audit.mjs",
|
|
46
|
+
"audit:documentation-boundary": "node ./scripts/documentation-boundary-audit.mjs",
|
|
46
47
|
"gate:release": "node ./scripts/release-gate.mjs && node ./scripts/forbidden-content-check.mjs",
|
|
47
48
|
"prepublishOnly": "npm run gate:release",
|
|
48
49
|
"sbom:generate": "node ./scripts/generate-sbom.mjs",
|
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* documentation-boundary-audit.mjs
|
|
5
|
+
*
|
|
6
|
+
* Enforces documentation sync only on changed scope boundaries.
|
|
7
|
+
* If public surface, API contract, or database structure files change,
|
|
8
|
+
* matching documentation updates must be present in the same change scope.
|
|
9
|
+
*/
|
|
10
|
+
|
|
11
|
+
import { execFileSync } from 'node:child_process';
|
|
12
|
+
import { dirname, resolve } from 'node:path';
|
|
13
|
+
import { fileURLToPath } from 'node:url';
|
|
14
|
+
|
|
15
|
+
const __filename = fileURLToPath(import.meta.url);
|
|
16
|
+
const __dirname = dirname(__filename);
|
|
17
|
+
const REPOSITORY_ROOT = resolve(__dirname, '..');
|
|
18
|
+
|
|
19
|
+
const CORE_DOCUMENTATION_FILES = new Set(['README.md', 'CHANGELOG.md']);
|
|
20
|
+
|
|
21
|
+
const BOUNDARY_RULES = [
|
|
22
|
+
{
|
|
23
|
+
boundaryName: 'public-surface',
|
|
24
|
+
requirement: 'Public surface changes must update README.md, CHANGELOG.md, or docs/* in the same scope.',
|
|
25
|
+
trigger(filePath) {
|
|
26
|
+
return /^(bin\/|lib\/|scripts\/)/.test(filePath) && !isDocumentationFilePath(filePath);
|
|
27
|
+
},
|
|
28
|
+
docsMatcher(filePath) {
|
|
29
|
+
return filePath === 'README.md' || filePath === 'CHANGELOG.md' || filePath.startsWith('docs/');
|
|
30
|
+
},
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
boundaryName: 'api-contract',
|
|
34
|
+
requirement: 'API endpoint or contract changes must update API/OpenAPI documentation in the same scope.',
|
|
35
|
+
trigger(filePath) {
|
|
36
|
+
return !isDocumentationFilePath(filePath)
|
|
37
|
+
&& /(api|openapi|contract|controller|route|endpoint)/i.test(filePath);
|
|
38
|
+
},
|
|
39
|
+
docsMatcher(filePath) {
|
|
40
|
+
return filePath === '.agent-context/rules/api-docs.md'
|
|
41
|
+
|| /^(docs\/.*(api|contract|openapi))/i.test(filePath)
|
|
42
|
+
|| filePath === 'README.md';
|
|
43
|
+
},
|
|
44
|
+
},
|
|
45
|
+
{
|
|
46
|
+
boundaryName: 'database-structure',
|
|
47
|
+
requirement: 'Database structure changes must update schema or migration documentation in the same scope.',
|
|
48
|
+
trigger(filePath) {
|
|
49
|
+
return !isDocumentationFilePath(filePath)
|
|
50
|
+
&& /(database|schema|migration|repository|sql|prisma|typeorm|knex)/i.test(filePath);
|
|
51
|
+
},
|
|
52
|
+
docsMatcher(filePath) {
|
|
53
|
+
return filePath === '.agent-context/rules/database-design.md'
|
|
54
|
+
|| /^(docs\/.*(database|schema|migration))/i.test(filePath)
|
|
55
|
+
|| filePath === 'README.md';
|
|
56
|
+
},
|
|
57
|
+
},
|
|
58
|
+
];
|
|
59
|
+
|
|
60
|
+
function normalizeFilePath(filePath) {
|
|
61
|
+
return filePath.replace(/\\/g, '/').replace(/^\.\//, '');
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
function parseGitFileList(rawOutput) {
|
|
65
|
+
if (typeof rawOutput !== 'string' || rawOutput.trim().length === 0) {
|
|
66
|
+
return [];
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
return rawOutput
|
|
70
|
+
.split(/\r?\n/)
|
|
71
|
+
.map((filePath) => filePath.trim())
|
|
72
|
+
.filter((filePath) => filePath.length > 0)
|
|
73
|
+
.map(normalizeFilePath);
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
function runGitFileQuery(commandArguments) {
|
|
77
|
+
try {
|
|
78
|
+
const rawOutput = execFileSync('git', commandArguments, {
|
|
79
|
+
cwd: REPOSITORY_ROOT,
|
|
80
|
+
encoding: 'utf8',
|
|
81
|
+
maxBuffer: 1024 * 1024,
|
|
82
|
+
});
|
|
83
|
+
|
|
84
|
+
return parseGitFileList(rawOutput);
|
|
85
|
+
} catch {
|
|
86
|
+
return [];
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
function uniqueSorted(filePaths) {
|
|
91
|
+
return Array.from(new Set(filePaths)).sort((leftPath, rightPath) => leftPath.localeCompare(rightPath));
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
function collectChangedFiles() {
|
|
95
|
+
const workingTreeFiles = runGitFileQuery(['diff', '--name-only']);
|
|
96
|
+
const stagedFiles = runGitFileQuery(['diff', '--name-only', '--cached']);
|
|
97
|
+
const workingScopeFiles = uniqueSorted([...workingTreeFiles, ...stagedFiles]);
|
|
98
|
+
|
|
99
|
+
if (workingScopeFiles.length > 0) {
|
|
100
|
+
return {
|
|
101
|
+
source: 'working-tree-and-index',
|
|
102
|
+
files: workingScopeFiles,
|
|
103
|
+
};
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
const latestCommitRangeFiles = runGitFileQuery(['diff', '--name-only', 'HEAD~1..HEAD']);
|
|
107
|
+
if (latestCommitRangeFiles.length > 0) {
|
|
108
|
+
return {
|
|
109
|
+
source: 'latest-commit-range',
|
|
110
|
+
files: uniqueSorted(latestCommitRangeFiles),
|
|
111
|
+
};
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
const headCommitFiles = runGitFileQuery(['show', '--pretty=format:', '--name-only', 'HEAD']);
|
|
115
|
+
if (headCommitFiles.length > 0) {
|
|
116
|
+
return {
|
|
117
|
+
source: 'head-commit',
|
|
118
|
+
files: uniqueSorted(headCommitFiles),
|
|
119
|
+
};
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
return {
|
|
123
|
+
source: 'none',
|
|
124
|
+
files: [],
|
|
125
|
+
};
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
function isDocumentationFilePath(filePath) {
|
|
129
|
+
return CORE_DOCUMENTATION_FILES.has(filePath)
|
|
130
|
+
|| filePath.startsWith('docs/')
|
|
131
|
+
|| filePath.startsWith('.agent-context/review-checklists/')
|
|
132
|
+
|| filePath === '.agent-context/rules/api-docs.md'
|
|
133
|
+
|| filePath === '.agent-context/rules/database-design.md';
|
|
134
|
+
}
|
|
135
|
+
|
|
136
|
+
function evaluateBoundary(boundaryRule, changedFiles, changedDocumentationFiles) {
|
|
137
|
+
const boundaryChangedFiles = changedFiles.filter((filePath) => boundaryRule.trigger(filePath));
|
|
138
|
+
|
|
139
|
+
if (boundaryChangedFiles.length === 0) {
|
|
140
|
+
return {
|
|
141
|
+
boundaryName: boundaryRule.boundaryName,
|
|
142
|
+
requirement: boundaryRule.requirement,
|
|
143
|
+
triggered: false,
|
|
144
|
+
passed: true,
|
|
145
|
+
changedFiles: [],
|
|
146
|
+
documentationFiles: [],
|
|
147
|
+
details: 'Boundary not triggered by changed scope.',
|
|
148
|
+
};
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
const matchingDocumentationFiles = changedDocumentationFiles.filter((filePath) => boundaryRule.docsMatcher(filePath));
|
|
152
|
+
const boundaryPassed = matchingDocumentationFiles.length > 0;
|
|
153
|
+
|
|
154
|
+
const details = boundaryPassed
|
|
155
|
+
? `Boundary triggered and synchronized with documentation updates: ${matchingDocumentationFiles.join(', ')}`
|
|
156
|
+
: 'Boundary triggered without required documentation updates.';
|
|
157
|
+
|
|
158
|
+
return {
|
|
159
|
+
boundaryName: boundaryRule.boundaryName,
|
|
160
|
+
requirement: boundaryRule.requirement,
|
|
161
|
+
triggered: true,
|
|
162
|
+
passed: boundaryPassed,
|
|
163
|
+
changedFiles: boundaryChangedFiles,
|
|
164
|
+
documentationFiles: matchingDocumentationFiles,
|
|
165
|
+
details,
|
|
166
|
+
};
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
function runDocumentationBoundaryAudit() {
|
|
170
|
+
const changedScope = collectChangedFiles();
|
|
171
|
+
const changedFiles = changedScope.files;
|
|
172
|
+
const changedDocumentationFiles = changedFiles.filter(isDocumentationFilePath);
|
|
173
|
+
|
|
174
|
+
const boundaryResults = BOUNDARY_RULES.map((boundaryRule) => (
|
|
175
|
+
evaluateBoundary(boundaryRule, changedFiles, changedDocumentationFiles)
|
|
176
|
+
));
|
|
177
|
+
|
|
178
|
+
const failures = boundaryResults
|
|
179
|
+
.filter((boundaryResult) => boundaryResult.triggered && !boundaryResult.passed)
|
|
180
|
+
.map((boundaryResult) => {
|
|
181
|
+
const affectedFiles = boundaryResult.changedFiles.join(', ');
|
|
182
|
+
return `${boundaryResult.boundaryName}: ${boundaryResult.requirement} Changed files: ${affectedFiles}`;
|
|
183
|
+
});
|
|
184
|
+
|
|
185
|
+
const reportPayload = {
|
|
186
|
+
generatedAt: new Date().toISOString(),
|
|
187
|
+
auditName: 'documentation-boundary-audit',
|
|
188
|
+
source: changedScope.source,
|
|
189
|
+
changedFileCount: changedFiles.length,
|
|
190
|
+
changedFiles,
|
|
191
|
+
boundaryResults,
|
|
192
|
+
passed: failures.length === 0,
|
|
193
|
+
failureCount: failures.length,
|
|
194
|
+
failures,
|
|
195
|
+
};
|
|
196
|
+
|
|
197
|
+
console.log(JSON.stringify(reportPayload, null, 2));
|
|
198
|
+
process.exit(reportPayload.passed ? 0 : 1);
|
|
199
|
+
}
|
|
200
|
+
|
|
201
|
+
runDocumentationBoundaryAudit();
|
package/scripts/release-gate.mjs
CHANGED
|
@@ -30,6 +30,7 @@ const REQUIRED_SKILL_DOMAINS = [
|
|
|
30
30
|
const FRONTEND_PARITY_CHECKLIST_PATH = '.agent-context/review-checklists/frontend-skill-parity.md';
|
|
31
31
|
const FRONTEND_EXCELLENCE_RUBRIC_PATH = '.agent-context/review-checklists/frontend-excellence-rubric.md';
|
|
32
32
|
const FRONTEND_AUDIT_SCRIPT_PATH = 'scripts/frontend-usability-audit.mjs';
|
|
33
|
+
const DOCUMENTATION_BOUNDARY_AUDIT_SCRIPT_PATH = 'scripts/documentation-boundary-audit.mjs';
|
|
33
34
|
const BACKEND_ARCHITECTURE_RULE_PATH = '.agent-context/rules/architecture.md';
|
|
34
35
|
const BACKEND_REVIEW_CHECKLIST_PATH = '.agent-context/review-checklists/pr-checklist.md';
|
|
35
36
|
const REFACTOR_PROMPT_PATH = '.agent-context/prompts/refactor.md';
|
|
@@ -337,6 +338,44 @@ function runReleaseGate() {
|
|
|
337
338
|
}
|
|
338
339
|
}
|
|
339
340
|
|
|
341
|
+
const documentationBoundaryAuditExecution = runMachineReadableScript(DOCUMENTATION_BOUNDARY_AUDIT_SCRIPT_PATH);
|
|
342
|
+
if (!documentationBoundaryAuditExecution.report) {
|
|
343
|
+
const failureDetails = documentationBoundaryAuditExecution.executionErrorMessage
|
|
344
|
+
? `Documentation boundary audit execution failed before producing a machine-readable report: ${documentationBoundaryAuditExecution.executionErrorMessage}`
|
|
345
|
+
: 'Documentation boundary audit did not produce machine-readable JSON output';
|
|
346
|
+
pushResult(results, false, 'documentation-boundary-audit', failureDetails);
|
|
347
|
+
} else {
|
|
348
|
+
diagnostics.documentationBoundaryAudit = documentationBoundaryAuditExecution.report;
|
|
349
|
+
pushResult(
|
|
350
|
+
results,
|
|
351
|
+
true,
|
|
352
|
+
'documentation-boundary-audit',
|
|
353
|
+
`documentation-boundary-audit executed (passed=${documentationBoundaryAuditExecution.report.passed}, failures=${documentationBoundaryAuditExecution.report.failureCount})`
|
|
354
|
+
);
|
|
355
|
+
|
|
356
|
+
if (documentationBoundaryAuditExecution.report.passed === true) {
|
|
357
|
+
pushResult(
|
|
358
|
+
results,
|
|
359
|
+
true,
|
|
360
|
+
'documentation-boundary-hard-rule',
|
|
361
|
+
'Documentation hard-rule passed for all triggered boundaries'
|
|
362
|
+
);
|
|
363
|
+
} else {
|
|
364
|
+
const failedDocumentationBoundaries = Array.isArray(documentationBoundaryAuditExecution.report.failures)
|
|
365
|
+
? documentationBoundaryAuditExecution.report.failures
|
|
366
|
+
: [];
|
|
367
|
+
const failureSummary = failedDocumentationBoundaries.length > 0
|
|
368
|
+
? failedDocumentationBoundaries.join('; ')
|
|
369
|
+
: 'Documentation boundary audit failed without boundary failure details';
|
|
370
|
+
pushResult(
|
|
371
|
+
results,
|
|
372
|
+
false,
|
|
373
|
+
'documentation-boundary-hard-rule',
|
|
374
|
+
`Documentation hard-rule failed: ${failureSummary}`
|
|
375
|
+
);
|
|
376
|
+
}
|
|
377
|
+
}
|
|
378
|
+
|
|
340
379
|
const frontendParityChecklistContent = readText(FRONTEND_PARITY_CHECKLIST_PATH);
|
|
341
380
|
if (!frontendParityChecklistContent) {
|
|
342
381
|
pushResult(results, false, 'frontend-parity-checklist-exists', `Missing ${FRONTEND_PARITY_CHECKLIST_PATH}`);
|
package/scripts/validate.mjs
CHANGED
|
@@ -171,6 +171,7 @@ async function validateRequiredFiles() {
|
|
|
171
171
|
'scripts/governance-weekly-report.mjs',
|
|
172
172
|
'scripts/mcp-server.mjs',
|
|
173
173
|
'scripts/frontend-usability-audit.mjs',
|
|
174
|
+
'scripts/documentation-boundary-audit.mjs',
|
|
174
175
|
'scripts/release-gate.mjs',
|
|
175
176
|
'scripts/generate-sbom.mjs',
|
|
176
177
|
'scripts/init-project.sh',
|