recall-os 0.1.0 → 0.2.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/README.md +52 -20
- package/dist/cli.js +1291 -547
- package/dist/cli.js.map +1 -1
- package/dist/index.js +1291 -547
- package/dist/index.js.map +1 -1
- package/examples/generated-laravel-api/.recall/config.json +17 -0
- package/examples/generated-laravel-api/.recall/hooks/pre-commit +9 -0
- package/examples/generated-laravel-api/AGENTS.md +15 -0
- package/examples/generated-laravel-api/CLAUDE.md +9 -0
- package/examples/generated-laravel-api/README.md +11 -0
- package/examples/generated-laravel-api/docs/00-product/BRD.md +9 -0
- package/examples/generated-laravel-api/docs/00-product/PRD.md +13 -0
- package/examples/generated-laravel-api/docs/10-architecture/ARCHITECTURE.md +11 -0
- package/examples/generated-laravel-api/docs/10-architecture/FILE_WRITE_POLICY.md +8 -0
- package/examples/generated-laravel-api/docs/10-architecture/MEMORY_ENGINE.md +16 -0
- package/examples/generated-laravel-api/docs/20-security/SECURITY_MODEL.md +11 -0
- package/examples/generated-laravel-api/docs/20-security/THREAT_MODEL.md +7 -0
- package/examples/generated-laravel-api/docs/30-modules/README.md +17 -0
- package/examples/generated-laravel-api/docs/40-features/README.md +22 -0
- package/examples/generated-laravel-api/docs/50-quality/QUALITY_GATES.md +11 -0
- package/examples/generated-laravel-api/docs/50-quality/TESTING_STRATEGY.md +5 -0
- package/examples/generated-laravel-api/docs/60-engineering/AI_AGENT_RULES.md +6 -0
- package/examples/generated-laravel-api/docs/60-engineering/ENGINEERING_STANDARDS.md +11 -0
- package/examples/generated-laravel-api/docs/adrs/README.md +9 -0
- package/examples/generated-laravel-api/docs/adrs/proposed/ADR-PROPOSED-laravel-api-api-design-rest.md +31 -0
- package/examples/generated-laravel-api/docs/adrs/proposed/ADR-PROPOSED-laravel-api-application-structure.md +30 -0
- package/examples/generated-laravel-api/docs/adrs/proposed/ADR-PROPOSED-laravel-api-auth-sanctum.md +30 -0
- package/examples/generated-laravel-api/docs/adrs/proposed/ADR-PROPOSED-laravel-api-database-eloquent.md +31 -0
- package/examples/generated-laravel-api/docs/adrs/proposed/ADR-PROPOSED-laravel-api-framework.md +29 -0
- package/examples/generated-laravel-api/docs/adrs/proposed/ADR-PROPOSED-laravel-api-queues-horizon.md +29 -0
- package/examples/generated-laravel-api/docs/adrs/proposed/ADR-PROPOSED-laravel-api-testing-pest.md +30 -0
- package/examples/generated-laravel-api/docs/adrs/proposed/ADR-PROPOSED-laravel-api-validation-authorization.md +30 -0
- package/examples/generated-laravel-api/docs/ai/AI_AGENTS_SKILLS_MCP_STRATEGY.md +7 -0
- package/examples/generated-laravel-api/docs/ai/MCP_STRATEGY.md +6 -0
- package/examples/generated-laravel-api/docs/ai/RECALL_COMMANDS.md +133 -0
- package/examples/generated-laravel-api/docs/ai/presets/laravel-api-guidance.md +62 -0
- package/examples/generated-laravel-react/.recall/config.json +17 -0
- package/examples/generated-laravel-react/.recall/hooks/pre-commit +9 -0
- package/examples/generated-laravel-react/AGENTS.md +15 -0
- package/examples/generated-laravel-react/CLAUDE.md +9 -0
- package/examples/generated-laravel-react/README.md +11 -0
- package/examples/generated-laravel-react/docs/00-product/BRD.md +9 -0
- package/examples/generated-laravel-react/docs/00-product/PRD.md +13 -0
- package/examples/generated-laravel-react/docs/10-architecture/ARCHITECTURE.md +11 -0
- package/examples/generated-laravel-react/docs/10-architecture/FILE_WRITE_POLICY.md +8 -0
- package/examples/generated-laravel-react/docs/10-architecture/MEMORY_ENGINE.md +16 -0
- package/examples/generated-laravel-react/docs/20-security/SECURITY_MODEL.md +11 -0
- package/examples/generated-laravel-react/docs/20-security/THREAT_MODEL.md +7 -0
- package/examples/generated-laravel-react/docs/30-modules/README.md +17 -0
- package/examples/generated-laravel-react/docs/40-features/README.md +22 -0
- package/examples/generated-laravel-react/docs/50-quality/QUALITY_GATES.md +11 -0
- package/examples/generated-laravel-react/docs/50-quality/TESTING_STRATEGY.md +5 -0
- package/examples/generated-laravel-react/docs/60-engineering/AI_AGENT_RULES.md +6 -0
- package/examples/generated-laravel-react/docs/60-engineering/ENGINEERING_STANDARDS.md +11 -0
- package/examples/generated-laravel-react/docs/adrs/README.md +9 -0
- package/examples/generated-laravel-react/docs/adrs/proposed/ADR-PROPOSED-laravel-react-application-structure.md +30 -0
- package/examples/generated-laravel-react/docs/adrs/proposed/ADR-PROPOSED-laravel-react-auth-sanctum.md +31 -0
- package/examples/generated-laravel-react/docs/adrs/proposed/ADR-PROPOSED-laravel-react-database-eloquent.md +31 -0
- package/examples/generated-laravel-react/docs/adrs/proposed/ADR-PROPOSED-laravel-react-framework.md +29 -0
- package/examples/generated-laravel-react/docs/adrs/proposed/ADR-PROPOSED-laravel-react-frontend-inertia-react.md +31 -0
- package/examples/generated-laravel-react/docs/adrs/proposed/ADR-PROPOSED-laravel-react-queues-horizon.md +29 -0
- package/examples/generated-laravel-react/docs/adrs/proposed/ADR-PROPOSED-laravel-react-testing-pest.md +30 -0
- package/examples/generated-laravel-react/docs/adrs/proposed/ADR-PROPOSED-laravel-react-validation-authorization.md +30 -0
- package/examples/generated-laravel-react/docs/ai/AI_AGENTS_SKILLS_MCP_STRATEGY.md +7 -0
- package/examples/generated-laravel-react/docs/ai/MCP_STRATEGY.md +6 -0
- package/examples/generated-laravel-react/docs/ai/RECALL_COMMANDS.md +133 -0
- package/examples/generated-laravel-react/docs/ai/presets/laravel-react-guidance.md +64 -0
- package/examples/generated-laravel-vue/.recall/config.json +17 -0
- package/examples/generated-laravel-vue/.recall/hooks/pre-commit +9 -0
- package/examples/generated-laravel-vue/AGENTS.md +15 -0
- package/examples/generated-laravel-vue/CLAUDE.md +9 -0
- package/examples/generated-laravel-vue/README.md +11 -0
- package/examples/generated-laravel-vue/docs/00-product/BRD.md +9 -0
- package/examples/generated-laravel-vue/docs/00-product/PRD.md +13 -0
- package/examples/generated-laravel-vue/docs/10-architecture/ARCHITECTURE.md +11 -0
- package/examples/generated-laravel-vue/docs/10-architecture/FILE_WRITE_POLICY.md +8 -0
- package/examples/generated-laravel-vue/docs/10-architecture/MEMORY_ENGINE.md +16 -0
- package/examples/generated-laravel-vue/docs/20-security/SECURITY_MODEL.md +11 -0
- package/examples/generated-laravel-vue/docs/20-security/THREAT_MODEL.md +7 -0
- package/examples/generated-laravel-vue/docs/30-modules/README.md +17 -0
- package/examples/generated-laravel-vue/docs/40-features/README.md +22 -0
- package/examples/generated-laravel-vue/docs/50-quality/QUALITY_GATES.md +11 -0
- package/examples/generated-laravel-vue/docs/50-quality/TESTING_STRATEGY.md +5 -0
- package/examples/generated-laravel-vue/docs/60-engineering/AI_AGENT_RULES.md +6 -0
- package/examples/generated-laravel-vue/docs/60-engineering/ENGINEERING_STANDARDS.md +11 -0
- package/examples/generated-laravel-vue/docs/adrs/README.md +9 -0
- package/examples/generated-laravel-vue/docs/adrs/proposed/ADR-PROPOSED-laravel-vue-application-structure.md +30 -0
- package/examples/generated-laravel-vue/docs/adrs/proposed/ADR-PROPOSED-laravel-vue-auth-sanctum.md +31 -0
- package/examples/generated-laravel-vue/docs/adrs/proposed/ADR-PROPOSED-laravel-vue-database-eloquent.md +31 -0
- package/examples/generated-laravel-vue/docs/adrs/proposed/ADR-PROPOSED-laravel-vue-framework.md +29 -0
- package/examples/generated-laravel-vue/docs/adrs/proposed/ADR-PROPOSED-laravel-vue-frontend-inertia-vue.md +31 -0
- package/examples/generated-laravel-vue/docs/adrs/proposed/ADR-PROPOSED-laravel-vue-queues-horizon.md +29 -0
- package/examples/generated-laravel-vue/docs/adrs/proposed/ADR-PROPOSED-laravel-vue-testing-pest.md +30 -0
- package/examples/generated-laravel-vue/docs/adrs/proposed/ADR-PROPOSED-laravel-vue-validation-authorization.md +30 -0
- package/examples/generated-laravel-vue/docs/ai/AI_AGENTS_SKILLS_MCP_STRATEGY.md +7 -0
- package/examples/generated-laravel-vue/docs/ai/MCP_STRATEGY.md +6 -0
- package/examples/generated-laravel-vue/docs/ai/RECALL_COMMANDS.md +133 -0
- package/examples/generated-laravel-vue/docs/ai/presets/laravel-vue-guidance.md +64 -0
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -132,8 +132,8 @@ function parseConfig(value) {
|
|
|
132
132
|
if (!result.success) {
|
|
133
133
|
throw new ConfigValidationError(
|
|
134
134
|
result.error.issues.map((issue) => {
|
|
135
|
-
const
|
|
136
|
-
return `${
|
|
135
|
+
const path17 = issue.path.length > 0 ? `${issue.path.join(".")}: ` : "";
|
|
136
|
+
return `${path17}${issue.message}`;
|
|
137
137
|
})
|
|
138
138
|
);
|
|
139
139
|
}
|
|
@@ -1312,6 +1312,11 @@ and is not accepted until a human reviews and accepts it.
|
|
|
1312
1312
|
|
|
1313
1313
|
- Captures a framework already in use as reviewable repository memory.
|
|
1314
1314
|
- Requires explicit human acceptance before it becomes repository truth.
|
|
1315
|
+
|
|
1316
|
+
## Related Documents
|
|
1317
|
+
|
|
1318
|
+
- \`docs/10-architecture/ARCHITECTURE.md\` \u2014 record the accepted architecture here once promoted.
|
|
1319
|
+
- The adoption report generated alongside this proposal.
|
|
1315
1320
|
`;
|
|
1316
1321
|
}
|
|
1317
1322
|
function frameworkSlug(framework) {
|
|
@@ -1380,6 +1385,32 @@ async function inspectRepo(rootDir) {
|
|
|
1380
1385
|
} else if (python.includes("django")) {
|
|
1381
1386
|
frameworks.add("Django");
|
|
1382
1387
|
}
|
|
1388
|
+
if (has("go.mod")) {
|
|
1389
|
+
const goModules = `${await readText(rootDir, "go.mod")}${await readText(rootDir, "go.sum")}`;
|
|
1390
|
+
if (goModules.includes("gin-gonic/gin")) {
|
|
1391
|
+
frameworks.add("Gin");
|
|
1392
|
+
} else if (goModules.includes("labstack/echo")) {
|
|
1393
|
+
frameworks.add("Echo");
|
|
1394
|
+
} else if (goModules.includes("gofiber/fiber")) {
|
|
1395
|
+
frameworks.add("Fiber");
|
|
1396
|
+
} else if (goModules.includes("go-chi/chi")) {
|
|
1397
|
+
frameworks.add("Chi");
|
|
1398
|
+
}
|
|
1399
|
+
}
|
|
1400
|
+
const jvmManifest = `${await readText(rootDir, "pom.xml")}${await readText(rootDir, "build.gradle")}${await readText(rootDir, "build.gradle.kts")}`.toLowerCase();
|
|
1401
|
+
if (jvmManifest.includes("spring-boot") || jvmManifest.includes("springframework")) {
|
|
1402
|
+
frameworks.add("Spring Boot");
|
|
1403
|
+
}
|
|
1404
|
+
if (has("Cargo.toml")) {
|
|
1405
|
+
const cargo = (await readText(rootDir, "Cargo.toml")).toLowerCase();
|
|
1406
|
+
if (cargo.includes("actix-web")) {
|
|
1407
|
+
frameworks.add("Actix Web");
|
|
1408
|
+
} else if (cargo.includes("axum")) {
|
|
1409
|
+
frameworks.add("Axum");
|
|
1410
|
+
} else if (cargo.includes("rocket")) {
|
|
1411
|
+
frameworks.add("Rocket");
|
|
1412
|
+
}
|
|
1413
|
+
}
|
|
1383
1414
|
let packageManager = null;
|
|
1384
1415
|
if (has("pnpm-lock.yaml")) {
|
|
1385
1416
|
packageManager = "pnpm";
|
|
@@ -1497,13 +1528,96 @@ function formatList2(values) {
|
|
|
1497
1528
|
return values.length > 0 ? values.join(", ") : "none detected";
|
|
1498
1529
|
}
|
|
1499
1530
|
|
|
1531
|
+
// src/core/doctor/checks/code-reference-check.ts
|
|
1532
|
+
import { existsSync as existsSync4 } from "fs";
|
|
1533
|
+
import { readFile as readFile4, readdir as readdir4 } from "fs/promises";
|
|
1534
|
+
import path7 from "path";
|
|
1535
|
+
var featureFolderPattern = /^F-\d{3,}-[a-z0-9]+(?:-[a-z0-9]+)*$/u;
|
|
1536
|
+
var FEATURE_DOCS = ["PRD.md", "ARCHITECTURE_IMPACT.md"];
|
|
1537
|
+
var MODULE_DOCS = ["MODULE.md", "DECISIONS.md"];
|
|
1538
|
+
var codePathPattern = /`((?:src|tests)\/[A-Za-z0-9._/-]+\.[A-Za-z0-9]+)`/gu;
|
|
1539
|
+
var placeholderMarkers = /[<>*]|\.\.\./u;
|
|
1540
|
+
async function checkCodeReferences(context) {
|
|
1541
|
+
if (context.config === void 0) {
|
|
1542
|
+
return [];
|
|
1543
|
+
}
|
|
1544
|
+
const findings = [];
|
|
1545
|
+
const featureEntries = await readDirIfExists(context.rootDir, context.config.featuresDir);
|
|
1546
|
+
for (const folder of featureEntries) {
|
|
1547
|
+
if (!folder.isDirectory() || !featureFolderPattern.test(folder.name)) {
|
|
1548
|
+
continue;
|
|
1549
|
+
}
|
|
1550
|
+
for (const doc of FEATURE_DOCS) {
|
|
1551
|
+
const relativePath = path7.posix.join(context.config.featuresDir, folder.name, doc);
|
|
1552
|
+
findings.push(...await checkDoc(context.rootDir, relativePath));
|
|
1553
|
+
}
|
|
1554
|
+
}
|
|
1555
|
+
const moduleEntries = await readDirIfExists(context.rootDir, context.config.modulesDir);
|
|
1556
|
+
for (const folder of moduleEntries) {
|
|
1557
|
+
if (!folder.isDirectory()) {
|
|
1558
|
+
continue;
|
|
1559
|
+
}
|
|
1560
|
+
for (const doc of MODULE_DOCS) {
|
|
1561
|
+
const relativePath = path7.posix.join(context.config.modulesDir, folder.name, doc);
|
|
1562
|
+
findings.push(...await checkDoc(context.rootDir, relativePath));
|
|
1563
|
+
}
|
|
1564
|
+
}
|
|
1565
|
+
return findings;
|
|
1566
|
+
}
|
|
1567
|
+
async function checkDoc(rootDir, relativePath) {
|
|
1568
|
+
const content = await readFileIfExists(rootDir, relativePath);
|
|
1569
|
+
if (content === void 0) {
|
|
1570
|
+
return [];
|
|
1571
|
+
}
|
|
1572
|
+
const findings = [];
|
|
1573
|
+
const seen = /* @__PURE__ */ new Set();
|
|
1574
|
+
for (const match of content.matchAll(codePathPattern)) {
|
|
1575
|
+
const reference = match[1];
|
|
1576
|
+
if (placeholderMarkers.test(reference) || seen.has(reference)) {
|
|
1577
|
+
continue;
|
|
1578
|
+
}
|
|
1579
|
+
seen.add(reference);
|
|
1580
|
+
if (!existsSync4(path7.join(rootDir, reference))) {
|
|
1581
|
+
findings.push({
|
|
1582
|
+
severity: "warning",
|
|
1583
|
+
check: "drift-code-reference",
|
|
1584
|
+
message: `Repository memory references ${reference}, which does not exist.`,
|
|
1585
|
+
path: relativePath
|
|
1586
|
+
});
|
|
1587
|
+
}
|
|
1588
|
+
}
|
|
1589
|
+
return findings;
|
|
1590
|
+
}
|
|
1591
|
+
async function readDirIfExists(rootDir, relativePath) {
|
|
1592
|
+
try {
|
|
1593
|
+
return await readdir4(path7.join(rootDir, relativePath), { withFileTypes: true });
|
|
1594
|
+
} catch (error) {
|
|
1595
|
+
const nodeError = error;
|
|
1596
|
+
if (nodeError.code === "ENOENT") {
|
|
1597
|
+
return [];
|
|
1598
|
+
}
|
|
1599
|
+
throw error;
|
|
1600
|
+
}
|
|
1601
|
+
}
|
|
1602
|
+
async function readFileIfExists(rootDir, relativePath) {
|
|
1603
|
+
try {
|
|
1604
|
+
return await readFile4(path7.join(rootDir, relativePath), "utf8");
|
|
1605
|
+
} catch (error) {
|
|
1606
|
+
const nodeError = error;
|
|
1607
|
+
if (nodeError.code === "ENOENT") {
|
|
1608
|
+
return void 0;
|
|
1609
|
+
}
|
|
1610
|
+
throw error;
|
|
1611
|
+
}
|
|
1612
|
+
}
|
|
1613
|
+
|
|
1500
1614
|
// src/core/doctor/checks/config-check.ts
|
|
1501
|
-
import { readFile as
|
|
1615
|
+
import { readFile as readFile5 } from "fs/promises";
|
|
1502
1616
|
async function checkConfig(rootDir) {
|
|
1503
1617
|
const configPath = resolveSafePath(rootDir, CONFIG_PATH);
|
|
1504
1618
|
let rawConfig;
|
|
1505
1619
|
try {
|
|
1506
|
-
rawConfig = await
|
|
1620
|
+
rawConfig = await readFile5(configPath.absolutePath, "utf8");
|
|
1507
1621
|
} catch (error) {
|
|
1508
1622
|
const nodeError = error;
|
|
1509
1623
|
if (nodeError.code === "ENOENT") {
|
|
@@ -1566,21 +1680,21 @@ async function checkConfig(rootDir) {
|
|
|
1566
1680
|
}
|
|
1567
1681
|
|
|
1568
1682
|
// src/core/doctor/checks/content-check.ts
|
|
1569
|
-
import { readFile as
|
|
1570
|
-
import
|
|
1571
|
-
var
|
|
1683
|
+
import { readFile as readFile6, readdir as readdir5 } from "fs/promises";
|
|
1684
|
+
import path8 from "path";
|
|
1685
|
+
var featureFolderPattern2 = /^F-\d{3,}-[a-z0-9]+(?:-[a-z0-9]+)*$/u;
|
|
1572
1686
|
async function checkContent(context) {
|
|
1573
1687
|
if (context.config === void 0) {
|
|
1574
1688
|
return [];
|
|
1575
1689
|
}
|
|
1576
1690
|
const findings = [];
|
|
1577
|
-
const entries = await
|
|
1691
|
+
const entries = await readDirIfExists2(context.rootDir, context.config.featuresDir);
|
|
1578
1692
|
const featureFolders = entries.filter(
|
|
1579
|
-
(entry) => entry.isDirectory() &&
|
|
1693
|
+
(entry) => entry.isDirectory() && featureFolderPattern2.test(entry.name)
|
|
1580
1694
|
);
|
|
1581
1695
|
for (const folder of featureFolders) {
|
|
1582
|
-
const prdPath =
|
|
1583
|
-
const prd = await
|
|
1696
|
+
const prdPath = path8.posix.join(context.config.featuresDir, folder.name, "PRD.md");
|
|
1697
|
+
const prd = await readFileIfExists2(context.rootDir, prdPath);
|
|
1584
1698
|
if (prd === void 0) {
|
|
1585
1699
|
continue;
|
|
1586
1700
|
}
|
|
@@ -1601,6 +1715,31 @@ async function checkContent(context) {
|
|
|
1601
1715
|
});
|
|
1602
1716
|
}
|
|
1603
1717
|
}
|
|
1718
|
+
const moduleEntries = await readDirIfExists2(context.rootDir, context.config.modulesDir);
|
|
1719
|
+
const moduleFolders = moduleEntries.filter((entry) => entry.isDirectory());
|
|
1720
|
+
for (const folder of moduleFolders) {
|
|
1721
|
+
const modulePath = path8.posix.join(context.config.modulesDir, folder.name, "MODULE.md");
|
|
1722
|
+
const moduleDoc = await readFileIfExists2(context.rootDir, modulePath);
|
|
1723
|
+
if (moduleDoc === void 0) {
|
|
1724
|
+
continue;
|
|
1725
|
+
}
|
|
1726
|
+
if (sectionIsUnfilled(moduleDoc, "Purpose")) {
|
|
1727
|
+
findings.push({
|
|
1728
|
+
severity: "warning",
|
|
1729
|
+
check: "content-module",
|
|
1730
|
+
message: "Module memory purpose is still an unfilled template.",
|
|
1731
|
+
path: modulePath
|
|
1732
|
+
});
|
|
1733
|
+
}
|
|
1734
|
+
if (sectionIsUnfilled(moduleDoc, "Owns")) {
|
|
1735
|
+
findings.push({
|
|
1736
|
+
severity: "warning",
|
|
1737
|
+
check: "content-module",
|
|
1738
|
+
message: "Module memory owns section is still an unfilled template.",
|
|
1739
|
+
path: modulePath
|
|
1740
|
+
});
|
|
1741
|
+
}
|
|
1742
|
+
}
|
|
1604
1743
|
return findings;
|
|
1605
1744
|
}
|
|
1606
1745
|
function sectionIsUnfilled(content, heading) {
|
|
@@ -1615,7 +1754,7 @@ function isUnfilled(value) {
|
|
|
1615
1754
|
if (normalized === "tbd" || normalized === "todo" || normalized === "pending" || normalized === "none" || normalized === "n/a") {
|
|
1616
1755
|
return true;
|
|
1617
1756
|
}
|
|
1618
|
-
return normalized.includes("describe why this feature exists");
|
|
1757
|
+
return normalized.includes("describe why this feature exists") || normalized.includes("describe what this module owns");
|
|
1619
1758
|
}
|
|
1620
1759
|
function getSection(content, heading) {
|
|
1621
1760
|
const lines = content.split(/\r?\n/u);
|
|
@@ -1633,9 +1772,9 @@ function getSection(content, heading) {
|
|
|
1633
1772
|
}
|
|
1634
1773
|
return body.join("\n").trim();
|
|
1635
1774
|
}
|
|
1636
|
-
async function
|
|
1775
|
+
async function readDirIfExists2(rootDir, relativePath) {
|
|
1637
1776
|
try {
|
|
1638
|
-
return await
|
|
1777
|
+
return await readdir5(path8.join(rootDir, relativePath), { withFileTypes: true });
|
|
1639
1778
|
} catch (error) {
|
|
1640
1779
|
const nodeError = error;
|
|
1641
1780
|
if (nodeError.code === "ENOENT") {
|
|
@@ -1644,9 +1783,9 @@ async function readDirIfExists(rootDir, relativePath) {
|
|
|
1644
1783
|
throw error;
|
|
1645
1784
|
}
|
|
1646
1785
|
}
|
|
1647
|
-
async function
|
|
1786
|
+
async function readFileIfExists2(rootDir, relativePath) {
|
|
1648
1787
|
try {
|
|
1649
|
-
return await
|
|
1788
|
+
return await readFile6(path8.join(rootDir, relativePath), "utf8");
|
|
1650
1789
|
} catch (error) {
|
|
1651
1790
|
const nodeError = error;
|
|
1652
1791
|
if (nodeError.code === "ENOENT") {
|
|
@@ -1657,8 +1796,8 @@ async function readFileIfExists(rootDir, relativePath) {
|
|
|
1657
1796
|
}
|
|
1658
1797
|
|
|
1659
1798
|
// src/core/doctor/checks/drift-check.ts
|
|
1660
|
-
import { readFile as
|
|
1661
|
-
import
|
|
1799
|
+
import { readFile as readFile7, readdir as readdir6 } from "fs/promises";
|
|
1800
|
+
import path9 from "path";
|
|
1662
1801
|
var adrFilePattern = /^ADR-(\d{4,})-[a-z0-9]+(?:-[a-z0-9]+)*\.md$/iu;
|
|
1663
1802
|
var adrReferencePattern = /ADR-\d{4,}/giu;
|
|
1664
1803
|
async function checkDrift(context) {
|
|
@@ -1675,12 +1814,12 @@ async function loadKnownAdrs(rootDir, adrDir) {
|
|
|
1675
1814
|
const known = /* @__PURE__ */ new Map();
|
|
1676
1815
|
const files = await readMarkdownFiles(rootDir, adrDir);
|
|
1677
1816
|
for (const file of files) {
|
|
1678
|
-
const match = adrFilePattern.exec(
|
|
1817
|
+
const match = adrFilePattern.exec(path9.basename(file));
|
|
1679
1818
|
if (match === null) {
|
|
1680
1819
|
continue;
|
|
1681
1820
|
}
|
|
1682
1821
|
const id = `ADR-${match[1]}`;
|
|
1683
|
-
const content = await
|
|
1822
|
+
const content = await readFile7(path9.join(rootDir, file), "utf8");
|
|
1684
1823
|
const accepted = sectionContains(content, "Status", /\baccepted\b/iu);
|
|
1685
1824
|
const existing = known.get(id);
|
|
1686
1825
|
if (existing === void 0 || !existing.accepted && accepted) {
|
|
@@ -1693,7 +1832,7 @@ async function checkReferences(rootDir, referenceDir, knownAdrs) {
|
|
|
1693
1832
|
const findings = [];
|
|
1694
1833
|
const files = await readMarkdownFiles(rootDir, referenceDir);
|
|
1695
1834
|
for (const file of files) {
|
|
1696
|
-
const content = await
|
|
1835
|
+
const content = await readFile7(path9.join(rootDir, file), "utf8");
|
|
1697
1836
|
const referenced = /* @__PURE__ */ new Set();
|
|
1698
1837
|
for (const match of stripCode(content).matchAll(adrReferencePattern)) {
|
|
1699
1838
|
referenced.add(match[0].toUpperCase());
|
|
@@ -1725,10 +1864,10 @@ function stripCode(content) {
|
|
|
1725
1864
|
return content.replace(/```[\s\S]*?```/gu, " ").replace(/~~~[\s\S]*?~~~/gu, " ").replace(/`[^`]*`/gu, " ");
|
|
1726
1865
|
}
|
|
1727
1866
|
async function readMarkdownFiles(rootDir, relativeDir) {
|
|
1728
|
-
const entries = await
|
|
1867
|
+
const entries = await readDirIfExists3(rootDir, relativeDir);
|
|
1729
1868
|
const files = [];
|
|
1730
1869
|
for (const entry of entries) {
|
|
1731
|
-
const childRelative =
|
|
1870
|
+
const childRelative = path9.posix.join(relativeDir, entry.name);
|
|
1732
1871
|
if (entry.isDirectory()) {
|
|
1733
1872
|
files.push(...await readMarkdownFiles(rootDir, childRelative));
|
|
1734
1873
|
continue;
|
|
@@ -1759,9 +1898,9 @@ function getSection2(content, heading) {
|
|
|
1759
1898
|
}
|
|
1760
1899
|
return body.join("\n").trim();
|
|
1761
1900
|
}
|
|
1762
|
-
async function
|
|
1901
|
+
async function readDirIfExists3(rootDir, relativePath) {
|
|
1763
1902
|
try {
|
|
1764
|
-
return await
|
|
1903
|
+
return await readdir6(path9.join(rootDir, relativePath), { withFileTypes: true });
|
|
1765
1904
|
} catch (error) {
|
|
1766
1905
|
const nodeError = error;
|
|
1767
1906
|
if (nodeError.code === "ENOENT") {
|
|
@@ -1772,9 +1911,39 @@ async function readDirIfExists2(rootDir, relativePath) {
|
|
|
1772
1911
|
}
|
|
1773
1912
|
|
|
1774
1913
|
// src/core/doctor/checks/memory-integrity-check.ts
|
|
1775
|
-
import { lstat as lstat2, readFile as
|
|
1776
|
-
import
|
|
1777
|
-
|
|
1914
|
+
import { lstat as lstat2, readFile as readFile8, readdir as readdir7 } from "fs/promises";
|
|
1915
|
+
import path10 from "path";
|
|
1916
|
+
|
|
1917
|
+
// src/core/adr/adr-sections.ts
|
|
1918
|
+
var REQUIRED_ADR_SECTIONS = [
|
|
1919
|
+
"## Status",
|
|
1920
|
+
"## Context",
|
|
1921
|
+
"## Decision",
|
|
1922
|
+
"## Alternatives Considered",
|
|
1923
|
+
"## Consequences",
|
|
1924
|
+
"## Related Documents"
|
|
1925
|
+
];
|
|
1926
|
+
var SECTION_PLACEHOLDERS = {
|
|
1927
|
+
"## Related Documents": "- None yet. Link related ADRs, features, or modules as they are accepted."
|
|
1928
|
+
};
|
|
1929
|
+
function ensureRequiredAdrSections(body) {
|
|
1930
|
+
let result = body.replace(/\s+$/u, "");
|
|
1931
|
+
for (const section of REQUIRED_ADR_SECTIONS) {
|
|
1932
|
+
if (!result.includes(section)) {
|
|
1933
|
+
const placeholder = SECTION_PLACEHOLDERS[section] ?? "To be documented.";
|
|
1934
|
+
result += `
|
|
1935
|
+
|
|
1936
|
+
${section}
|
|
1937
|
+
|
|
1938
|
+
${placeholder}`;
|
|
1939
|
+
}
|
|
1940
|
+
}
|
|
1941
|
+
return `${result}
|
|
1942
|
+
`;
|
|
1943
|
+
}
|
|
1944
|
+
|
|
1945
|
+
// src/core/doctor/checks/memory-integrity-check.ts
|
|
1946
|
+
var featureFolderPattern3 = /^F-\d{3,}-[a-z0-9]+(?:-[a-z0-9]+)*$/u;
|
|
1778
1947
|
var adrFilePattern2 = /^ADR-\d{4,}-[a-z0-9]+(?:-[a-z0-9]+)*\.md$/u;
|
|
1779
1948
|
var requiredFeatureDocs = [
|
|
1780
1949
|
"PRD.md",
|
|
@@ -1788,14 +1957,7 @@ var requiredFeatureDocs = [
|
|
|
1788
1957
|
"COMPLETION_REPORT.md"
|
|
1789
1958
|
];
|
|
1790
1959
|
var requiredModuleDocs = ["MODULE.md", "TASKS.md", "TEST_PLAN.md", "DECISIONS.md"];
|
|
1791
|
-
var requiredAdrSections =
|
|
1792
|
-
"## Status",
|
|
1793
|
-
"## Context",
|
|
1794
|
-
"## Decision",
|
|
1795
|
-
"## Alternatives Considered",
|
|
1796
|
-
"## Consequences",
|
|
1797
|
-
"## Related Documents"
|
|
1798
|
-
];
|
|
1960
|
+
var requiredAdrSections = REQUIRED_ADR_SECTIONS;
|
|
1799
1961
|
async function checkMemoryIntegrity(context) {
|
|
1800
1962
|
if (context.config === void 0) {
|
|
1801
1963
|
return [];
|
|
@@ -1808,13 +1970,13 @@ async function checkMemoryIntegrity(context) {
|
|
|
1808
1970
|
}
|
|
1809
1971
|
async function checkFeatureFolders(rootDir, featuresDir) {
|
|
1810
1972
|
const findings = [];
|
|
1811
|
-
const entries = await
|
|
1973
|
+
const entries = await readDirIfExists4(rootDir, featuresDir);
|
|
1812
1974
|
const featureFolders = entries.filter(
|
|
1813
|
-
(entry) => entry.isDirectory() &&
|
|
1975
|
+
(entry) => entry.isDirectory() && featureFolderPattern3.test(entry.name)
|
|
1814
1976
|
);
|
|
1815
1977
|
for (const featureFolder of featureFolders) {
|
|
1816
1978
|
for (const requiredDoc of requiredFeatureDocs) {
|
|
1817
|
-
const filePath =
|
|
1979
|
+
const filePath = path10.posix.join(featuresDir, featureFolder.name, requiredDoc);
|
|
1818
1980
|
if (!await isFile(rootDir, filePath)) {
|
|
1819
1981
|
findings.push({
|
|
1820
1982
|
severity: "error",
|
|
@@ -1834,11 +1996,11 @@ async function checkFeatureFolders(rootDir, featuresDir) {
|
|
|
1834
1996
|
}
|
|
1835
1997
|
async function checkModuleFolders(rootDir, modulesDir) {
|
|
1836
1998
|
const findings = [];
|
|
1837
|
-
const entries = await
|
|
1999
|
+
const entries = await readDirIfExists4(rootDir, modulesDir);
|
|
1838
2000
|
const moduleFolders = entries.filter((entry) => entry.isDirectory());
|
|
1839
2001
|
for (const moduleFolder of moduleFolders) {
|
|
1840
2002
|
for (const requiredDoc of requiredModuleDocs) {
|
|
1841
|
-
const filePath =
|
|
2003
|
+
const filePath = path10.posix.join(modulesDir, moduleFolder.name, requiredDoc);
|
|
1842
2004
|
if (!await isFile(rootDir, filePath)) {
|
|
1843
2005
|
findings.push({
|
|
1844
2006
|
severity: "error",
|
|
@@ -1858,11 +2020,11 @@ async function checkModuleFolders(rootDir, modulesDir) {
|
|
|
1858
2020
|
}
|
|
1859
2021
|
async function checkAdrFiles(rootDir, adrDir) {
|
|
1860
2022
|
const findings = [];
|
|
1861
|
-
const entries = await
|
|
2023
|
+
const entries = await readDirIfExists4(rootDir, adrDir);
|
|
1862
2024
|
const adrFiles = entries.filter((entry) => entry.isFile() && adrFilePattern2.test(entry.name));
|
|
1863
2025
|
for (const adrFile of adrFiles) {
|
|
1864
|
-
const filePath =
|
|
1865
|
-
const content = await
|
|
2026
|
+
const filePath = path10.posix.join(adrDir, adrFile.name);
|
|
2027
|
+
const content = await readFile8(path10.join(rootDir, filePath), "utf8");
|
|
1866
2028
|
for (const requiredSection of requiredAdrSections) {
|
|
1867
2029
|
if (!content.includes(requiredSection)) {
|
|
1868
2030
|
findings.push({
|
|
@@ -1881,9 +2043,9 @@ async function checkAdrFiles(rootDir, adrDir) {
|
|
|
1881
2043
|
});
|
|
1882
2044
|
return findings;
|
|
1883
2045
|
}
|
|
1884
|
-
async function
|
|
2046
|
+
async function readDirIfExists4(rootDir, relativePath) {
|
|
1885
2047
|
try {
|
|
1886
|
-
return await
|
|
2048
|
+
return await readdir7(path10.join(rootDir, relativePath), { withFileTypes: true });
|
|
1887
2049
|
} catch (error) {
|
|
1888
2050
|
const nodeError = error;
|
|
1889
2051
|
if (nodeError.code === "ENOENT") {
|
|
@@ -1894,7 +2056,7 @@ async function readDirIfExists3(rootDir, relativePath) {
|
|
|
1894
2056
|
}
|
|
1895
2057
|
async function isFile(rootDir, relativePath) {
|
|
1896
2058
|
try {
|
|
1897
|
-
return (await lstat2(
|
|
2059
|
+
return (await lstat2(path10.join(rootDir, relativePath))).isFile();
|
|
1898
2060
|
} catch (error) {
|
|
1899
2061
|
const nodeError = error;
|
|
1900
2062
|
if (nodeError.code === "ENOENT") {
|
|
@@ -1906,7 +2068,7 @@ async function isFile(rootDir, relativePath) {
|
|
|
1906
2068
|
|
|
1907
2069
|
// src/core/doctor/checks/required-files-check.ts
|
|
1908
2070
|
import { lstat as lstat3 } from "fs/promises";
|
|
1909
|
-
import
|
|
2071
|
+
import path11 from "path";
|
|
1910
2072
|
var rootFiles = ["AGENTS.md", "CLAUDE.md"];
|
|
1911
2073
|
var requiredDocs = [
|
|
1912
2074
|
"00-product/PRD.md",
|
|
@@ -1933,12 +2095,12 @@ async function checkRequiredFiles(context) {
|
|
|
1933
2095
|
}
|
|
1934
2096
|
}
|
|
1935
2097
|
for (const relativeDocPath of requiredDocs) {
|
|
1936
|
-
const filePath =
|
|
2098
|
+
const filePath = path11.posix.join(docsDir, relativeDocPath);
|
|
1937
2099
|
if (!await isFile2(context.rootDir, filePath)) {
|
|
1938
2100
|
findings.push(missingFile(filePath, "required-docs"));
|
|
1939
2101
|
}
|
|
1940
2102
|
}
|
|
1941
|
-
const adrIndexPath =
|
|
2103
|
+
const adrIndexPath = path11.posix.join(context.config?.adrDir ?? "docs/adrs", "README.md");
|
|
1942
2104
|
if (!await isFile2(context.rootDir, adrIndexPath)) {
|
|
1943
2105
|
findings.push(missingFile(adrIndexPath, "required-docs"));
|
|
1944
2106
|
}
|
|
@@ -1964,7 +2126,7 @@ async function checkRequiredFiles(context) {
|
|
|
1964
2126
|
}
|
|
1965
2127
|
async function isFile2(rootDir, relativePath) {
|
|
1966
2128
|
try {
|
|
1967
|
-
return (await lstat3(
|
|
2129
|
+
return (await lstat3(path11.join(rootDir, relativePath))).isFile();
|
|
1968
2130
|
} catch (error) {
|
|
1969
2131
|
const nodeError = error;
|
|
1970
2132
|
if (nodeError.code === "ENOENT") {
|
|
@@ -1975,7 +2137,7 @@ async function isFile2(rootDir, relativePath) {
|
|
|
1975
2137
|
}
|
|
1976
2138
|
async function isDirectory(rootDir, relativePath) {
|
|
1977
2139
|
try {
|
|
1978
|
-
return (await lstat3(
|
|
2140
|
+
return (await lstat3(path11.join(rootDir, relativePath))).isDirectory();
|
|
1979
2141
|
} catch (error) {
|
|
1980
2142
|
const nodeError = error;
|
|
1981
2143
|
if (nodeError.code === "ENOENT") {
|
|
@@ -1994,9 +2156,9 @@ function missingFile(pathValue, check) {
|
|
|
1994
2156
|
}
|
|
1995
2157
|
|
|
1996
2158
|
// src/core/doctor/checks/standards-check.ts
|
|
1997
|
-
import { lstat as lstat4, readFile as
|
|
1998
|
-
import
|
|
1999
|
-
var
|
|
2159
|
+
import { lstat as lstat4, readFile as readFile9, readdir as readdir8 } from "fs/promises";
|
|
2160
|
+
import path12 from "path";
|
|
2161
|
+
var featureFolderPattern4 = /^F-\d{3,}-[a-z0-9]+(?:-[a-z0-9]+)*$/u;
|
|
2000
2162
|
var adrFilePattern3 = /^ADR-\d{4,}-[a-z0-9]+(?:-[a-z0-9]+)*\.md$/u;
|
|
2001
2163
|
var securitySensitivePattern = /\b(auth|authentication|authorization|secrets?|storage|networking?|telemetry|file writes?|write policy|dependencies?|mcp|ai api|cloud|runtime)\b/iu;
|
|
2002
2164
|
async function checkStandards(context) {
|
|
@@ -2010,18 +2172,18 @@ async function checkStandards(context) {
|
|
|
2010
2172
|
}
|
|
2011
2173
|
async function checkFeatureStandards(rootDir, featuresDir) {
|
|
2012
2174
|
const findings = [];
|
|
2013
|
-
const entries = await
|
|
2175
|
+
const entries = await readDirIfExists5(rootDir, featuresDir);
|
|
2014
2176
|
const featureFolders = entries.filter(
|
|
2015
|
-
(entry) => entry.isDirectory() &&
|
|
2177
|
+
(entry) => entry.isDirectory() && featureFolderPattern4.test(entry.name)
|
|
2016
2178
|
);
|
|
2017
2179
|
for (const featureFolder of featureFolders) {
|
|
2018
|
-
const featureDir =
|
|
2019
|
-
const completionReportPath =
|
|
2020
|
-
const reviewPath =
|
|
2021
|
-
const architectureImpactPath =
|
|
2022
|
-
const completionReport = await
|
|
2023
|
-
const review = await
|
|
2024
|
-
const architectureImpact = await
|
|
2180
|
+
const featureDir = path12.posix.join(featuresDir, featureFolder.name);
|
|
2181
|
+
const completionReportPath = path12.posix.join(featureDir, "COMPLETION_REPORT.md");
|
|
2182
|
+
const reviewPath = path12.posix.join(featureDir, "REVIEW.md");
|
|
2183
|
+
const architectureImpactPath = path12.posix.join(featureDir, "ARCHITECTURE_IMPACT.md");
|
|
2184
|
+
const completionReport = await readFileIfExists3(rootDir, completionReportPath);
|
|
2185
|
+
const review = await readFileIfExists3(rootDir, reviewPath);
|
|
2186
|
+
const architectureImpact = await readFileIfExists3(rootDir, architectureImpactPath);
|
|
2025
2187
|
if (completionReport !== void 0) {
|
|
2026
2188
|
const featureIsComplete = sectionContains2(completionReport, "Status", /\bcomplete\b/iu);
|
|
2027
2189
|
if (featureIsComplete) {
|
|
@@ -2065,11 +2227,11 @@ async function checkFeatureStandards(rootDir, featuresDir) {
|
|
|
2065
2227
|
}
|
|
2066
2228
|
async function checkAdrStandards(rootDir, adrDir) {
|
|
2067
2229
|
const findings = [];
|
|
2068
|
-
const entries = await
|
|
2230
|
+
const entries = await readDirIfExists5(rootDir, adrDir);
|
|
2069
2231
|
const adrFiles = entries.filter((entry) => entry.isFile() && adrFilePattern3.test(entry.name));
|
|
2070
2232
|
for (const adrFile of adrFiles) {
|
|
2071
|
-
const adrPath =
|
|
2072
|
-
const content = await
|
|
2233
|
+
const adrPath = path12.posix.join(adrDir, adrFile.name);
|
|
2234
|
+
const content = await readFile9(path12.join(rootDir, adrPath), "utf8");
|
|
2073
2235
|
const isAccepted = sectionContains2(content, "Status", /\baccepted\b/iu);
|
|
2074
2236
|
if (!hasMeaningfulSection(content, "Consequences")) {
|
|
2075
2237
|
findings.push({
|
|
@@ -2151,9 +2313,9 @@ function isPlaceholder(value) {
|
|
|
2151
2313
|
}
|
|
2152
2314
|
return normalized.includes("implementation is in progress") || normalized.includes("will be completed after implementation");
|
|
2153
2315
|
}
|
|
2154
|
-
async function
|
|
2316
|
+
async function readDirIfExists5(rootDir, relativePath) {
|
|
2155
2317
|
try {
|
|
2156
|
-
return await
|
|
2318
|
+
return await readdir8(path12.join(rootDir, relativePath), { withFileTypes: true });
|
|
2157
2319
|
} catch (error) {
|
|
2158
2320
|
const nodeError = error;
|
|
2159
2321
|
if (nodeError.code === "ENOENT") {
|
|
@@ -2162,12 +2324,12 @@ async function readDirIfExists4(rootDir, relativePath) {
|
|
|
2162
2324
|
throw error;
|
|
2163
2325
|
}
|
|
2164
2326
|
}
|
|
2165
|
-
async function
|
|
2327
|
+
async function readFileIfExists3(rootDir, relativePath) {
|
|
2166
2328
|
try {
|
|
2167
2329
|
if (!await isFile3(rootDir, relativePath)) {
|
|
2168
2330
|
return void 0;
|
|
2169
2331
|
}
|
|
2170
|
-
return await
|
|
2332
|
+
return await readFile9(path12.join(rootDir, relativePath), "utf8");
|
|
2171
2333
|
} catch (error) {
|
|
2172
2334
|
const nodeError = error;
|
|
2173
2335
|
if (nodeError.code === "ENOENT") {
|
|
@@ -2178,7 +2340,7 @@ async function readFileIfExists2(rootDir, relativePath) {
|
|
|
2178
2340
|
}
|
|
2179
2341
|
async function isFile3(rootDir, relativePath) {
|
|
2180
2342
|
try {
|
|
2181
|
-
return (await lstat4(
|
|
2343
|
+
return (await lstat4(path12.join(rootDir, relativePath))).isFile();
|
|
2182
2344
|
} catch (error) {
|
|
2183
2345
|
const nodeError = error;
|
|
2184
2346
|
if (nodeError.code === "ENOENT") {
|
|
@@ -2203,6 +2365,7 @@ async function runDoctor(rootDir) {
|
|
|
2203
2365
|
findings.push(...await checkStandards(context));
|
|
2204
2366
|
findings.push(...await checkDrift(context));
|
|
2205
2367
|
findings.push(...await checkContent(context));
|
|
2368
|
+
findings.push(...await checkCodeReferences(context));
|
|
2206
2369
|
}
|
|
2207
2370
|
return createDoctorReport(findings);
|
|
2208
2371
|
}
|
|
@@ -2279,11 +2442,11 @@ function formatDoctorResult(result) {
|
|
|
2279
2442
|
}
|
|
2280
2443
|
|
|
2281
2444
|
// src/commands/init.ts
|
|
2282
|
-
import { existsSync as
|
|
2283
|
-
import
|
|
2445
|
+
import { existsSync as existsSync6 } from "fs";
|
|
2446
|
+
import path15 from "path";
|
|
2284
2447
|
|
|
2285
2448
|
// src/core/generator/generate-init.ts
|
|
2286
|
-
import
|
|
2449
|
+
import path13 from "path";
|
|
2287
2450
|
var neutralTemplates = [
|
|
2288
2451
|
{
|
|
2289
2452
|
path: "AGENTS.md",
|
|
@@ -2308,11 +2471,41 @@ Repository rules override model preferences. If instructions conflict, stop and
|
|
|
2308
2471
|
path: "CLAUDE.md",
|
|
2309
2472
|
content: `# {{repositoryName}} Claude Instructions
|
|
2310
2473
|
|
|
2311
|
-
|
|
2474
|
+
This file is loaded automatically every Claude session. The durable project memory lives in \`docs/\`;
|
|
2475
|
+
do not rely on chat history as source of truth, and repository rules override model preference.
|
|
2476
|
+
|
|
2477
|
+
@AGENTS.md
|
|
2478
|
+
|
|
2479
|
+
Read the docs that \`AGENTS.md\` routes to before changing code or repository memory. A SessionStart
|
|
2480
|
+
hook (\`.claude/hooks/session-start.sh\`) also injects a memory map at the start of each session.
|
|
2481
|
+
`
|
|
2482
|
+
},
|
|
2483
|
+
{
|
|
2484
|
+
// Cursor auto-applies rules under .cursor/rules. alwaysApply makes this the portable equivalent
|
|
2485
|
+
// of the Claude Code SessionStart hook: Cursor injects it into every request so the agent loads
|
|
2486
|
+
// repository memory even though it cannot run the Claude-specific hook.
|
|
2487
|
+
path: ".cursor/rules/recall-memory.mdc",
|
|
2488
|
+
content: `---
|
|
2489
|
+
description: {{repositoryName}} repository memory and rules (Recall OS). Read before non-trivial work.
|
|
2490
|
+
globs:
|
|
2491
|
+
alwaysApply: true
|
|
2492
|
+
---
|
|
2493
|
+
|
|
2494
|
+
# {{repositoryName}} repository memory
|
|
2495
|
+
|
|
2496
|
+
This repository uses Recall OS. Durable memory lives in \`docs/\` and is the source of truth over chat
|
|
2497
|
+
history. Do not treat chat history as truth, and repository rules override model preference.
|
|
2312
2498
|
|
|
2313
|
-
|
|
2499
|
+
Before non-trivial work:
|
|
2314
2500
|
|
|
2315
|
-
Read \`AGENTS.md\` and the
|
|
2501
|
+
- Read \`AGENTS.md\` and the docs it routes to.
|
|
2502
|
+
- Accepted decisions live in \`docs/adrs/\`; module memory lives in \`docs/30-modules/\`.
|
|
2503
|
+
- If an instruction conflicts with accepted repository memory, stop and report the conflict.
|
|
2504
|
+
|
|
2505
|
+
Source-of-truth order: accepted ADRs and repository decisions, then architecture docs, engineering
|
|
2506
|
+
standards, the current PRD, security and testing docs, module docs, feature plans, then chat history.
|
|
2507
|
+
|
|
2508
|
+
Before claiming work is complete, run \`recall doctor\` and fix reported errors.
|
|
2316
2509
|
`
|
|
2317
2510
|
},
|
|
2318
2511
|
{
|
|
@@ -2668,14 +2861,38 @@ Agents should not implement meaningful feature work without a feature plan or cl
|
|
|
2668
2861
|
path: "docs/adrs/README.md",
|
|
2669
2862
|
content: `# Architecture Decision Records
|
|
2670
2863
|
|
|
2671
|
-
Accepted
|
|
2864
|
+
Accepted ADRs live in this directory as \`ADR-####-<slug>.md\` with \`## Status\` set to \`Accepted\`.
|
|
2865
|
+
Proposed ADRs live under \`docs/adrs/proposed/\`.
|
|
2672
2866
|
|
|
2673
|
-
|
|
2867
|
+
There is no \`accepted/\` subdirectory: accepted ADRs sit at the top level of \`docs/adrs/\`.
|
|
2868
|
+
|
|
2869
|
+
Presets and AI agents may propose decisions; humans accept them with \`recall adr accept <name>\`,
|
|
2870
|
+
which promotes a proposal into an accepted ADR here.
|
|
2871
|
+
`
|
|
2872
|
+
},
|
|
2873
|
+
{
|
|
2874
|
+
path: ".github/workflows/recall.yml",
|
|
2875
|
+
content: `name: Recall OS
|
|
2876
|
+
|
|
2877
|
+
on:
|
|
2878
|
+
push:
|
|
2879
|
+
pull_request:
|
|
2880
|
+
|
|
2881
|
+
jobs:
|
|
2882
|
+
doctor:
|
|
2883
|
+
runs-on: ubuntu-latest
|
|
2884
|
+
steps:
|
|
2885
|
+
- uses: actions/checkout@v4
|
|
2886
|
+
- uses: actions/setup-node@v4
|
|
2887
|
+
with:
|
|
2888
|
+
node-version: 20
|
|
2889
|
+
- name: Validate repository memory
|
|
2890
|
+
run: npx --yes recall-os@latest doctor
|
|
2674
2891
|
`
|
|
2675
2892
|
}
|
|
2676
2893
|
];
|
|
2677
2894
|
function generateInitFiles(options) {
|
|
2678
|
-
const repositoryName =
|
|
2895
|
+
const repositoryName = path13.basename(path13.resolve(options.rootDir)) || "repository";
|
|
2679
2896
|
const context = createTemplateContext({ repositoryName });
|
|
2680
2897
|
const files = neutralTemplates.map((template) => ({
|
|
2681
2898
|
path: template.path,
|
|
@@ -2694,24 +2911,25 @@ function generatePresetFiles(preset) {
|
|
|
2694
2911
|
})),
|
|
2695
2912
|
...preset.proposedDecisions.map((decision) => ({
|
|
2696
2913
|
path: decision.destination,
|
|
2697
|
-
|
|
2914
|
+
// Normalize every preset's proposed ADR so it stays Doctor-healthy once accepted.
|
|
2915
|
+
content: ensureRequiredAdrSections(decision.body)
|
|
2698
2916
|
}))
|
|
2699
2917
|
];
|
|
2700
2918
|
}
|
|
2701
2919
|
|
|
2702
2920
|
// src/core/hooks/detect-gates.ts
|
|
2703
|
-
import { existsSync as
|
|
2704
|
-
import { readFile as
|
|
2705
|
-
import
|
|
2921
|
+
import { existsSync as existsSync5 } from "fs";
|
|
2922
|
+
import { readFile as readFile10 } from "fs/promises";
|
|
2923
|
+
import path14 from "path";
|
|
2706
2924
|
var KNOWN_SCRIPTS = ["test", "typecheck", "lint"];
|
|
2707
2925
|
async function detectPreCommitGates(rootDir) {
|
|
2708
|
-
const packageJsonPath =
|
|
2709
|
-
if (!
|
|
2926
|
+
const packageJsonPath = path14.join(rootDir, "package.json");
|
|
2927
|
+
if (!existsSync5(packageJsonPath)) {
|
|
2710
2928
|
return [];
|
|
2711
2929
|
}
|
|
2712
2930
|
let scripts;
|
|
2713
2931
|
try {
|
|
2714
|
-
const raw = await
|
|
2932
|
+
const raw = await readFile10(packageJsonPath, "utf8");
|
|
2715
2933
|
const parsed = JSON.parse(raw);
|
|
2716
2934
|
scripts = parsed.scripts ?? {};
|
|
2717
2935
|
} catch {
|
|
@@ -2726,10 +2944,10 @@ async function detectPreCommitGates(rootDir) {
|
|
|
2726
2944
|
);
|
|
2727
2945
|
}
|
|
2728
2946
|
function detectPackageManager(rootDir) {
|
|
2729
|
-
if (
|
|
2947
|
+
if (existsSync5(path14.join(rootDir, "pnpm-lock.yaml"))) {
|
|
2730
2948
|
return "pnpm";
|
|
2731
2949
|
}
|
|
2732
|
-
if (
|
|
2950
|
+
if (existsSync5(path14.join(rootDir, "yarn.lock"))) {
|
|
2733
2951
|
return "yarn";
|
|
2734
2952
|
}
|
|
2735
2953
|
return "npm";
|
|
@@ -2738,6 +2956,39 @@ function detectPackageManager(rootDir) {
|
|
|
2738
2956
|
// src/core/hooks/generate-hook.ts
|
|
2739
2957
|
var PRE_COMMIT_HOOK_PATH = ".recall/hooks/pre-commit";
|
|
2740
2958
|
var HOOKS_PATH_ACTIVATION_COMMAND = "git config core.hooksPath .recall/hooks";
|
|
2959
|
+
var SESSION_START_HOOK_PATH = ".claude/hooks/session-start.sh";
|
|
2960
|
+
var CLAUDE_SETTINGS_PATH = ".claude/settings.json";
|
|
2961
|
+
function renderSessionStartHook() {
|
|
2962
|
+
return `#!/bin/sh
|
|
2963
|
+
# Recall OS Claude Code SessionStart hook.
|
|
2964
|
+
# Generated by \`recall init\`. Injects a repository-memory map into every Claude Code session so a
|
|
2965
|
+
# fresh agent reliably loads durable memory. Wired in .claude/settings.json. Read-only.
|
|
2966
|
+
|
|
2967
|
+
adrs=$(ls docs/adrs/ADR-*.md 2>/dev/null | sed 's|.*/||;s|\\.md$||' | tr '\\n' ' ')
|
|
2968
|
+
modules=$(ls -d docs/30-modules/*/ 2>/dev/null | sed 's|docs/30-modules/||;s|/$||' | tr '\\n' ' ')
|
|
2969
|
+
|
|
2970
|
+
context="Recall OS repository memory is the source of truth over chat history. Before non-trivial work, read AGENTS.md and the docs it routes to; repository rules override model preference. Accepted ADRs (docs/adrs/): \${adrs:-none yet}. Modules (docs/30-modules/): \${modules:-none yet}. Run 'recall doctor' before claiming work complete."
|
|
2971
|
+
|
|
2972
|
+
printf '{"hookSpecificOutput":{"hookEventName":"SessionStart","additionalContext":"%s"}}\\n' "$context"
|
|
2973
|
+
`;
|
|
2974
|
+
}
|
|
2975
|
+
function renderClaudeSettings() {
|
|
2976
|
+
return `${JSON.stringify(
|
|
2977
|
+
{
|
|
2978
|
+
hooks: {
|
|
2979
|
+
SessionStart: [
|
|
2980
|
+
{
|
|
2981
|
+
matcher: "startup",
|
|
2982
|
+
hooks: [{ type: "command", command: `./${SESSION_START_HOOK_PATH}` }]
|
|
2983
|
+
}
|
|
2984
|
+
]
|
|
2985
|
+
}
|
|
2986
|
+
},
|
|
2987
|
+
null,
|
|
2988
|
+
2
|
|
2989
|
+
)}
|
|
2990
|
+
`;
|
|
2991
|
+
}
|
|
2741
2992
|
function renderPreCommitHook(gates) {
|
|
2742
2993
|
const lines = [
|
|
2743
2994
|
"#!/bin/sh",
|
|
@@ -3249,73 +3500,129 @@ Consider MVVM with unidirectional state from ViewModels, awaiting human acceptan
|
|
|
3249
3500
|
]
|
|
3250
3501
|
};
|
|
3251
3502
|
|
|
3252
|
-
// src/presets/
|
|
3253
|
-
var
|
|
3503
|
+
// src/presets/laravel/shared.ts
|
|
3504
|
+
var VARIANTS = {
|
|
3505
|
+
react: {
|
|
3506
|
+
id: "laravel-react",
|
|
3507
|
+
label: "React via Inertia",
|
|
3508
|
+
description: "Opinionated Laravel + Inertia + React opinion pack (proposed decisions only). Matches the official Laravel React starter kit.",
|
|
3509
|
+
frontendLine: "Frontend: Inertia 2 + React 19 + TypeScript + Tailwind, built with Vite (the official React starter kit, with shadcn/ui for components).",
|
|
3510
|
+
deliveryLine: "The app is a server-driven SPA: Laravel controllers return Inertia responses with typed props; there is no separate REST client for first-party screens."
|
|
3511
|
+
},
|
|
3512
|
+
vue: {
|
|
3513
|
+
id: "laravel-vue",
|
|
3514
|
+
label: "Vue via Inertia",
|
|
3515
|
+
description: "Opinionated Laravel + Inertia + Vue opinion pack (proposed decisions only). Matches the official Laravel Vue starter kit.",
|
|
3516
|
+
frontendLine: "Frontend: Inertia 2 + Vue 3 (script setup) + TypeScript + Tailwind, built with Vite (the official Vue starter kit).",
|
|
3517
|
+
deliveryLine: "The app is a server-driven SPA: Laravel controllers return Inertia responses with typed props; there is no separate REST client for first-party screens."
|
|
3518
|
+
},
|
|
3519
|
+
api: {
|
|
3520
|
+
id: "laravel-api",
|
|
3521
|
+
label: "API / SPA backend",
|
|
3522
|
+
description: "Opinionated Laravel API-only opinion pack (proposed decisions only) for a decoupled SPA or mobile client.",
|
|
3523
|
+
frontendLine: "No server-rendered frontend: Laravel is an HTTP JSON API consumed by a separate SPA or mobile app.",
|
|
3524
|
+
deliveryLine: "Controllers return JSON via API Resources; first-party SPAs authenticate with Sanctum cookies, mobile clients with Sanctum tokens."
|
|
3525
|
+
}
|
|
3526
|
+
};
|
|
3527
|
+
function adr(presetId, topic, title, body) {
|
|
3528
|
+
return {
|
|
3529
|
+
id: `${presetId}-${topic}`,
|
|
3530
|
+
title,
|
|
3531
|
+
status: "proposed",
|
|
3532
|
+
destination: `docs/adrs/proposed/ADR-PROPOSED-${presetId}-${topic}.md`,
|
|
3533
|
+
body
|
|
3534
|
+
};
|
|
3535
|
+
}
|
|
3536
|
+
function related(presetId, ...extra) {
|
|
3537
|
+
return [
|
|
3538
|
+
`## Related Documents`,
|
|
3539
|
+
``,
|
|
3540
|
+
`- \`docs/ai/presets/${presetId}-guidance.md\` \u2014 the proposed Laravel stack guidance.`,
|
|
3541
|
+
`- \`docs/10-architecture/ARCHITECTURE.md\` \u2014 record the accepted architecture here once promoted.`,
|
|
3542
|
+
...extra.map((line) => `- ${line}`),
|
|
3543
|
+
``
|
|
3544
|
+
].join("\n");
|
|
3545
|
+
}
|
|
3546
|
+
function laravelGuidance(variant) {
|
|
3547
|
+
const profile = VARIANTS[variant];
|
|
3548
|
+
return `# Laravel Preset Guidance (${profile.label})
|
|
3254
3549
|
|
|
3255
3550
|
This is proposed guidance, not accepted. Convert any architecture choice into a proposed ADR, then an
|
|
3256
|
-
accepted ADR, before treating it as repository truth.
|
|
3551
|
+
accepted ADR, before treating it as repository truth. Repository rules override model preference.
|
|
3552
|
+
|
|
3553
|
+
## The stack (proposed)
|
|
3554
|
+
|
|
3555
|
+
- Laravel 12 on PHP 8.3+, using the official conventions and directory layout.
|
|
3556
|
+
- ${profile.frontendLine}
|
|
3557
|
+
- Database: PostgreSQL (MySQL is the alternative) through Eloquent and migrations.
|
|
3558
|
+
- Auth: Laravel Sanctum for first-party SPA and mobile clients (Passport only if you need third-party OAuth2).
|
|
3559
|
+
- Background work: queues, with Redis and Laravel Horizon when throughput grows.
|
|
3560
|
+
- Tests: Pest, with database factories and feature tests over real routes.
|
|
3561
|
+
|
|
3562
|
+
${profile.deliveryLine}
|
|
3257
3563
|
|
|
3258
3564
|
## Decision forks this stack forces
|
|
3259
3565
|
|
|
3260
|
-
-
|
|
3261
|
-
-
|
|
3262
|
-
-
|
|
3263
|
-
-
|
|
3264
|
-
-
|
|
3566
|
+
- Frontend delivery: Inertia (server-driven SPA) vs a decoupled API + separate SPA vs Blade + Livewire.
|
|
3567
|
+
- Auth: Sanctum (first-party SPA and mobile) vs Passport (third-party OAuth2) vs a managed identity provider.
|
|
3568
|
+
- Database: PostgreSQL vs MySQL, and where read scaling and queues live (Redis vs database driver).
|
|
3569
|
+
- Authorization: Policies and Gates vs ad-hoc checks; validation via Form Requests vs inline.
|
|
3570
|
+
- Business logic: thin controllers with Action/Service classes vs fat controllers and models.
|
|
3571
|
+
- Testing: Pest vs PHPUnit.
|
|
3265
3572
|
|
|
3266
3573
|
## Recommended structure (proposed)
|
|
3267
3574
|
|
|
3268
|
-
-
|
|
3269
|
-
-
|
|
3270
|
-
-
|
|
3575
|
+
- Keep controllers thin: they validate, authorize, delegate, and return a response \u2014 nothing more.
|
|
3576
|
+
- Put request validation **and** authorization in Form Requests (\`authorize()\` + \`rules()\`).
|
|
3577
|
+
- Put per-model and per-action permission logic in Policies and Gates, not in controllers.
|
|
3578
|
+
- Put business logic in single-purpose Action or Service classes, not in controllers or models.
|
|
3579
|
+
- Shape every outbound payload with API Resources (or typed Inertia props), never raw models.
|
|
3580
|
+
- Declare \`$fillable\` (or \`$guarded\`) explicitly on every Eloquent model to stop mass assignment.
|
|
3581
|
+
|
|
3582
|
+
## Data and performance (proposed)
|
|
3583
|
+
|
|
3584
|
+
- Eager-load relationships (\`with(...)\`) to avoid N+1 queries; enable \`Model::preventLazyLoading()\` in local and CI.
|
|
3585
|
+
- Wrap multi-write operations in database transactions.
|
|
3586
|
+
- Paginate list endpoints; never return unbounded collections.
|
|
3587
|
+
- Move email, exports, third-party calls, and other slow work into queued jobs.
|
|
3588
|
+
- Cache expensive reads deliberately, with explicit invalidation.
|
|
3271
3589
|
|
|
3272
3590
|
## Testing (proposed)
|
|
3273
3591
|
|
|
3274
|
-
-
|
|
3275
|
-
-
|
|
3276
|
-
-
|
|
3592
|
+
- Write Pest feature tests that exercise real routes end to end, using \`RefreshDatabase\`.
|
|
3593
|
+
- Build state with model factories, not hand-rolled fixtures.
|
|
3594
|
+
- Test authorization explicitly: a forbidden action must assert a 403, not just a happy path.
|
|
3595
|
+
- Cover validation failures, not only the success case.
|
|
3277
3596
|
|
|
3278
3597
|
## Security considerations (proposed)
|
|
3279
3598
|
|
|
3280
|
-
-
|
|
3281
|
-
-
|
|
3282
|
-
-
|
|
3283
|
-
|
|
3284
|
-
|
|
3285
|
-
|
|
3286
|
-
id: `nextjs-${topic}`,
|
|
3287
|
-
title,
|
|
3288
|
-
status: "proposed",
|
|
3289
|
-
destination: `docs/adrs/proposed/ADR-PROPOSED-nextjs-${topic}.md`,
|
|
3290
|
-
body
|
|
3291
|
-
};
|
|
3599
|
+
- Validate every inbound request through Form Requests; persist only validated data.
|
|
3600
|
+
- Authorize every state-changing action through a Policy or Gate.
|
|
3601
|
+
- Keep secrets in \`.env\`; never commit \`.env\` or hardcode credentials.
|
|
3602
|
+
- Apply rate limiting to auth and write endpoints.
|
|
3603
|
+
- Keep mass assignment locked down and never trust client-supplied IDs without an ownership check.
|
|
3604
|
+
${variant === "api" ? "- Scope Sanctum tokens to least privilege; SPA clients use the cookie guard with CSRF protection.\n" : "- Inertia uses Laravel's session and CSRF protection; keep auth and authorization on the server, never the client.\n"}`;
|
|
3292
3605
|
}
|
|
3293
|
-
|
|
3294
|
-
|
|
3295
|
-
name: "Next.js",
|
|
3296
|
-
description: "Opinionated Next.js opinion pack with proposed decisions only.",
|
|
3297
|
-
templates: [
|
|
3298
|
-
{
|
|
3299
|
-
destination: "docs/ai/presets/nextjs-guidance.md",
|
|
3300
|
-
description: "Next.js guidance that remains proposed until accepted.",
|
|
3301
|
-
content: guidance3
|
|
3302
|
-
}
|
|
3303
|
-
],
|
|
3304
|
-
guidance: [
|
|
3606
|
+
function laravelGuidanceItems() {
|
|
3607
|
+
return [
|
|
3305
3608
|
{
|
|
3306
|
-
title: "Keep
|
|
3307
|
-
body: "
|
|
3609
|
+
title: "Keep stack choices proposed",
|
|
3610
|
+
body: "Framework, frontend delivery, database, auth, and testing choices stay proposed until accepted in repository memory."
|
|
3308
3611
|
},
|
|
3309
3612
|
{
|
|
3310
|
-
title: "
|
|
3311
|
-
body: "
|
|
3613
|
+
title: "Thin controllers, explicit authorization",
|
|
3614
|
+
body: "Validate and authorize in Form Requests and Policies, keep business logic in Action or Service classes, and shape output with Resources \u2014 propose these as decisions before treating them as truth."
|
|
3312
3615
|
}
|
|
3313
|
-
]
|
|
3314
|
-
|
|
3315
|
-
|
|
3616
|
+
];
|
|
3617
|
+
}
|
|
3618
|
+
function laravelProposedDecisions(variant) {
|
|
3619
|
+
const presetId = VARIANTS[variant].id;
|
|
3620
|
+
const base = [
|
|
3621
|
+
adr(
|
|
3622
|
+
presetId,
|
|
3316
3623
|
"framework",
|
|
3317
|
-
"Use
|
|
3318
|
-
`# Proposed ADR: Use
|
|
3624
|
+
"Use Laravel",
|
|
3625
|
+
`# Proposed ADR: Use Laravel
|
|
3319
3626
|
|
|
3320
3627
|
## Status
|
|
3321
3628
|
|
|
@@ -3323,28 +3630,30 @@ Proposed
|
|
|
3323
3630
|
|
|
3324
3631
|
## Context
|
|
3325
3632
|
|
|
3326
|
-
The team needs a
|
|
3633
|
+
The team needs a productive, batteries-included PHP framework for a production web application.
|
|
3327
3634
|
|
|
3328
3635
|
## Decision
|
|
3329
3636
|
|
|
3330
|
-
Consider
|
|
3331
|
-
it.
|
|
3637
|
+
Consider Laravel 12 on PHP 8.3+ as the application framework, following its standard conventions and
|
|
3638
|
+
directory structure. This is not accepted until a human reviews and accepts it.
|
|
3332
3639
|
|
|
3333
3640
|
## Alternatives Considered
|
|
3334
3641
|
|
|
3335
|
-
-
|
|
3336
|
-
-
|
|
3642
|
+
- Symfony for a more component-assembled approach.
|
|
3643
|
+
- A different language or framework entirely.
|
|
3337
3644
|
|
|
3338
3645
|
## Consequences
|
|
3339
3646
|
|
|
3340
|
-
-
|
|
3341
|
-
- Couples the
|
|
3342
|
-
|
|
3647
|
+
- A mature ecosystem (Eloquent, queues, Sanctum, Horizon) and strong conventions.
|
|
3648
|
+
- Couples the application to Laravel's conventions and release cadence.
|
|
3649
|
+
|
|
3650
|
+
${related(presetId)}`
|
|
3343
3651
|
),
|
|
3344
|
-
|
|
3345
|
-
|
|
3346
|
-
"
|
|
3347
|
-
|
|
3652
|
+
adr(
|
|
3653
|
+
presetId,
|
|
3654
|
+
"database-eloquent",
|
|
3655
|
+
"Use Eloquent and migrations on PostgreSQL",
|
|
3656
|
+
`# Proposed ADR: Use Eloquent and migrations on PostgreSQL
|
|
3348
3657
|
|
|
3349
3658
|
## Status
|
|
3350
3659
|
|
|
@@ -3352,27 +3661,30 @@ Proposed
|
|
|
3352
3661
|
|
|
3353
3662
|
## Context
|
|
3354
3663
|
|
|
3355
|
-
|
|
3664
|
+
The application needs a relational database and a schema workflow.
|
|
3356
3665
|
|
|
3357
3666
|
## Decision
|
|
3358
3667
|
|
|
3359
|
-
Consider the
|
|
3668
|
+
Consider PostgreSQL (MySQL as the alternative) accessed through Eloquent and versioned migrations,
|
|
3669
|
+
awaiting human acceptance.
|
|
3360
3670
|
|
|
3361
3671
|
## Alternatives Considered
|
|
3362
3672
|
|
|
3363
|
-
-
|
|
3364
|
-
-
|
|
3673
|
+
- MySQL or MariaDB.
|
|
3674
|
+
- The query builder or raw SQL without Eloquent.
|
|
3365
3675
|
|
|
3366
3676
|
## Consequences
|
|
3367
3677
|
|
|
3368
|
-
-
|
|
3369
|
-
- Requires
|
|
3370
|
-
|
|
3678
|
+
- Expressive models, relationships, and reproducible schema migrations.
|
|
3679
|
+
- Requires discipline against N+1 queries and unbounded result sets.
|
|
3680
|
+
|
|
3681
|
+
${related(presetId, "`docs/50-quality/TESTING_STRATEGY.md` \u2014 how database tests use factories and a disposable database.")}`
|
|
3371
3682
|
),
|
|
3372
|
-
|
|
3373
|
-
|
|
3374
|
-
"
|
|
3375
|
-
|
|
3683
|
+
adr(
|
|
3684
|
+
presetId,
|
|
3685
|
+
"auth-sanctum",
|
|
3686
|
+
"Use Laravel Sanctum for authentication",
|
|
3687
|
+
`# Proposed ADR: Use Laravel Sanctum for authentication
|
|
3376
3688
|
|
|
3377
3689
|
## Status
|
|
3378
3690
|
|
|
@@ -3380,27 +3692,30 @@ Proposed
|
|
|
3380
3692
|
|
|
3381
3693
|
## Context
|
|
3382
3694
|
|
|
3383
|
-
The
|
|
3695
|
+
The application needs authentication for first-party clients (${variant === "api" ? "a separate SPA and mobile apps" : "an Inertia SPA, and possibly mobile apps"}).
|
|
3384
3696
|
|
|
3385
3697
|
## Decision
|
|
3386
3698
|
|
|
3387
|
-
Consider
|
|
3699
|
+
Consider Laravel Sanctum: the cookie-based guard for first-party SPAs and API tokens for mobile or
|
|
3700
|
+
scripted clients. This is not accepted until a human reviews and accepts it.
|
|
3388
3701
|
|
|
3389
3702
|
## Alternatives Considered
|
|
3390
3703
|
|
|
3391
|
-
-
|
|
3392
|
-
-
|
|
3704
|
+
- Laravel Passport for full OAuth2 (third-party delegated access).
|
|
3705
|
+
- A managed identity provider.
|
|
3393
3706
|
|
|
3394
3707
|
## Consequences
|
|
3395
3708
|
|
|
3396
|
-
-
|
|
3397
|
-
-
|
|
3398
|
-
|
|
3709
|
+
- Lightweight first-party auth without standing up a full OAuth2 server.
|
|
3710
|
+
- If third-party delegated access is ever required, revisit with Passport.
|
|
3711
|
+
|
|
3712
|
+
${related(presetId, "`docs/20-security/SECURITY_MODEL.md` \u2014 record the accepted auth and session model here.")}`
|
|
3399
3713
|
),
|
|
3400
|
-
|
|
3401
|
-
|
|
3402
|
-
"
|
|
3403
|
-
|
|
3714
|
+
adr(
|
|
3715
|
+
presetId,
|
|
3716
|
+
"validation-authorization",
|
|
3717
|
+
"Validate with Form Requests and authorize with Policies",
|
|
3718
|
+
`# Proposed ADR: Validate with Form Requests and authorize with Policies
|
|
3404
3719
|
|
|
3405
3720
|
## Status
|
|
3406
3721
|
|
|
@@ -3408,27 +3723,31 @@ Proposed
|
|
|
3408
3723
|
|
|
3409
3724
|
## Context
|
|
3410
3725
|
|
|
3411
|
-
|
|
3726
|
+
Input validation and authorization must be consistent and centralized, not scattered across
|
|
3727
|
+
controllers.
|
|
3412
3728
|
|
|
3413
3729
|
## Decision
|
|
3414
3730
|
|
|
3415
|
-
Consider
|
|
3731
|
+
Consider Form Requests for validation (and request-level authorization) plus Policies and Gates for
|
|
3732
|
+
per-model and per-action permission checks, awaiting human acceptance.
|
|
3416
3733
|
|
|
3417
3734
|
## Alternatives Considered
|
|
3418
3735
|
|
|
3419
|
-
-
|
|
3420
|
-
- A
|
|
3736
|
+
- Inline validation and authorization in controllers.
|
|
3737
|
+
- A third-party permissions package layered on top.
|
|
3421
3738
|
|
|
3422
3739
|
## Consequences
|
|
3423
3740
|
|
|
3424
|
-
-
|
|
3425
|
-
-
|
|
3426
|
-
|
|
3741
|
+
- Controllers stay thin; validation and authorization are testable in isolation.
|
|
3742
|
+
- Every state-changing action must have an explicit authorization path.
|
|
3743
|
+
|
|
3744
|
+
${related(presetId)}`
|
|
3427
3745
|
),
|
|
3428
|
-
|
|
3429
|
-
|
|
3430
|
-
"
|
|
3431
|
-
|
|
3746
|
+
adr(
|
|
3747
|
+
presetId,
|
|
3748
|
+
"application-structure",
|
|
3749
|
+
"Keep controllers thin with Action and Service classes",
|
|
3750
|
+
`# Proposed ADR: Keep controllers thin with Action and Service classes
|
|
3432
3751
|
|
|
3433
3752
|
## Status
|
|
3434
3753
|
|
|
@@ -3436,93 +3755,278 @@ Proposed
|
|
|
3436
3755
|
|
|
3437
3756
|
## Context
|
|
3438
3757
|
|
|
3439
|
-
|
|
3758
|
+
Business logic tends to accumulate in controllers and models, which makes it hard to test and reuse.
|
|
3440
3759
|
|
|
3441
3760
|
## Decision
|
|
3442
3761
|
|
|
3443
|
-
Consider
|
|
3762
|
+
Consider thin controllers that delegate to single-purpose Action or Service classes, with outbound
|
|
3763
|
+
payloads shaped by API Resources (or typed Inertia props). This is not accepted until a human accepts
|
|
3764
|
+
it.
|
|
3444
3765
|
|
|
3445
3766
|
## Alternatives Considered
|
|
3446
3767
|
|
|
3447
|
-
-
|
|
3448
|
-
-
|
|
3768
|
+
- Fat controllers.
|
|
3769
|
+
- Fat models holding business logic.
|
|
3449
3770
|
|
|
3450
3771
|
## Consequences
|
|
3451
3772
|
|
|
3452
|
-
-
|
|
3453
|
-
-
|
|
3454
|
-
|
|
3773
|
+
- Reusable, unit-testable business logic and consistent response shapes.
|
|
3774
|
+
- More classes and a convention the team must follow.
|
|
3775
|
+
|
|
3776
|
+
${related(presetId)}`
|
|
3777
|
+
),
|
|
3778
|
+
adr(
|
|
3779
|
+
presetId,
|
|
3780
|
+
"queues-horizon",
|
|
3781
|
+
"Run slow work on queues",
|
|
3782
|
+
`# Proposed ADR: Run slow work on queues
|
|
3783
|
+
|
|
3784
|
+
## Status
|
|
3785
|
+
|
|
3786
|
+
Proposed
|
|
3787
|
+
|
|
3788
|
+
## Context
|
|
3789
|
+
|
|
3790
|
+
Email, exports, and third-party calls slow down requests and can fail independently.
|
|
3791
|
+
|
|
3792
|
+
## Decision
|
|
3793
|
+
|
|
3794
|
+
Consider queued jobs for slow or failure-prone work, using the database driver early and Redis with
|
|
3795
|
+
Laravel Horizon as throughput grows. This is not accepted until a human reviews and accepts it.
|
|
3796
|
+
|
|
3797
|
+
## Alternatives Considered
|
|
3798
|
+
|
|
3799
|
+
- Doing the work synchronously in the request.
|
|
3800
|
+
- An external task queue or serverless functions.
|
|
3801
|
+
|
|
3802
|
+
## Consequences
|
|
3803
|
+
|
|
3804
|
+
- Faster responses and isolated, retryable background work.
|
|
3805
|
+
- Adds a worker process and queue infrastructure to operate and monitor.
|
|
3806
|
+
|
|
3807
|
+
${related(presetId)}`
|
|
3808
|
+
),
|
|
3809
|
+
adr(
|
|
3810
|
+
presetId,
|
|
3811
|
+
"testing-pest",
|
|
3812
|
+
"Use Pest for testing",
|
|
3813
|
+
`# Proposed ADR: Use Pest for testing
|
|
3814
|
+
|
|
3815
|
+
## Status
|
|
3816
|
+
|
|
3817
|
+
Proposed
|
|
3818
|
+
|
|
3819
|
+
## Context
|
|
3820
|
+
|
|
3821
|
+
The application needs a fast, readable testing workflow.
|
|
3822
|
+
|
|
3823
|
+
## Decision
|
|
3824
|
+
|
|
3825
|
+
Consider Pest with model factories and feature tests that exercise real routes against a disposable
|
|
3826
|
+
database, awaiting human acceptance.
|
|
3827
|
+
|
|
3828
|
+
## Alternatives Considered
|
|
3829
|
+
|
|
3830
|
+
- PHPUnit directly.
|
|
3831
|
+
- A thinner test suite focused only on unit tests.
|
|
3832
|
+
|
|
3833
|
+
## Consequences
|
|
3834
|
+
|
|
3835
|
+
- Concise, expressive tests that cover routes, validation, and authorization.
|
|
3836
|
+
- The team standardizes on Pest's syntax and plugins.
|
|
3837
|
+
|
|
3838
|
+
${related(presetId, "`docs/50-quality/TESTING_STRATEGY.md` \u2014 record the accepted testing approach here.")}`
|
|
3455
3839
|
)
|
|
3456
|
-
]
|
|
3840
|
+
];
|
|
3841
|
+
return [...base, frontendDecision(variant)];
|
|
3842
|
+
}
|
|
3843
|
+
function frontendDecision(variant) {
|
|
3844
|
+
const presetId = VARIANTS[variant].id;
|
|
3845
|
+
if (variant === "api") {
|
|
3846
|
+
return adr(
|
|
3847
|
+
presetId,
|
|
3848
|
+
"api-design-rest",
|
|
3849
|
+
"Expose a versioned REST API with API Resources",
|
|
3850
|
+
`# Proposed ADR: Expose a versioned REST API with API Resources
|
|
3851
|
+
|
|
3852
|
+
## Status
|
|
3853
|
+
|
|
3854
|
+
Proposed
|
|
3855
|
+
|
|
3856
|
+
## Context
|
|
3857
|
+
|
|
3858
|
+
A decoupled SPA or mobile client consumes Laravel over HTTP, so the API contract must be stable and
|
|
3859
|
+
explicit.
|
|
3860
|
+
|
|
3861
|
+
## Decision
|
|
3862
|
+
|
|
3863
|
+
Consider a versioned REST API (for example \`/api/v1\`) whose responses are shaped by API Resources,
|
|
3864
|
+
authenticated with Sanctum, and documented (OpenAPI). This is not accepted until a human accepts it.
|
|
3865
|
+
|
|
3866
|
+
## Alternatives Considered
|
|
3867
|
+
|
|
3868
|
+
- GraphQL.
|
|
3869
|
+
- Server-driven Inertia pages instead of a decoupled API.
|
|
3870
|
+
|
|
3871
|
+
## Consequences
|
|
3872
|
+
|
|
3873
|
+
- A stable, documented contract that multiple clients can rely on.
|
|
3874
|
+
- Versioning and serialization become an explicit, maintained concern.
|
|
3875
|
+
|
|
3876
|
+
${related(presetId, "`docs/20-security/SECURITY_MODEL.md` \u2014 record token scopes and the SPA cookie guard here.")}`
|
|
3877
|
+
);
|
|
3878
|
+
}
|
|
3879
|
+
const framework = variant === "react" ? "React 19" : "Vue 3";
|
|
3880
|
+
const components = variant === "react" ? "shadcn/ui components on Tailwind" : "Tailwind with single-file components (script setup)";
|
|
3881
|
+
return adr(
|
|
3882
|
+
presetId,
|
|
3883
|
+
`frontend-inertia-${variant}`,
|
|
3884
|
+
`Use Inertia with ${framework}`,
|
|
3885
|
+
`# Proposed ADR: Use Inertia with ${framework}
|
|
3886
|
+
|
|
3887
|
+
## Status
|
|
3888
|
+
|
|
3889
|
+
Proposed
|
|
3890
|
+
|
|
3891
|
+
## Context
|
|
3892
|
+
|
|
3893
|
+
The application needs a modern SPA experience without standing up and securing a separate API for
|
|
3894
|
+
first-party screens.
|
|
3895
|
+
|
|
3896
|
+
## Decision
|
|
3897
|
+
|
|
3898
|
+
Consider Inertia 2 with ${framework} and TypeScript, built with Vite, using ${components}. Controllers
|
|
3899
|
+
return Inertia responses with typed props. This is not accepted until a human reviews and accepts it.
|
|
3900
|
+
|
|
3901
|
+
## Alternatives Considered
|
|
3902
|
+
|
|
3903
|
+
- A decoupled REST or GraphQL API with a standalone SPA.
|
|
3904
|
+
- Blade with Livewire.
|
|
3905
|
+
|
|
3906
|
+
## Consequences
|
|
3907
|
+
|
|
3908
|
+
- Server-driven routing and auth with a reactive ${framework} frontend and no duplicate API layer.
|
|
3909
|
+
- Couples the frontend to Inertia's model and the ${framework} ecosystem.
|
|
3910
|
+
|
|
3911
|
+
${related(presetId)}`
|
|
3912
|
+
);
|
|
3913
|
+
}
|
|
3914
|
+
|
|
3915
|
+
// src/presets/laravel-api/preset.ts
|
|
3916
|
+
var laravelApiPreset = {
|
|
3917
|
+
id: "laravel-api",
|
|
3918
|
+
name: "Laravel API",
|
|
3919
|
+
description: "Opinionated Laravel API-only opinion pack with proposed decisions only.",
|
|
3920
|
+
templates: [
|
|
3921
|
+
{
|
|
3922
|
+
destination: "docs/ai/presets/laravel-api-guidance.md",
|
|
3923
|
+
description: "Laravel API-only guidance that remains proposed until accepted.",
|
|
3924
|
+
content: laravelGuidance("api")
|
|
3925
|
+
}
|
|
3926
|
+
],
|
|
3927
|
+
guidance: laravelGuidanceItems(),
|
|
3928
|
+
proposedDecisions: laravelProposedDecisions("api")
|
|
3457
3929
|
};
|
|
3458
3930
|
|
|
3459
|
-
// src/presets/
|
|
3460
|
-
var
|
|
3931
|
+
// src/presets/laravel-react/preset.ts
|
|
3932
|
+
var laravelReactPreset = {
|
|
3933
|
+
id: "laravel-react",
|
|
3934
|
+
name: "Laravel + React",
|
|
3935
|
+
description: "Opinionated Laravel + Inertia + React opinion pack with proposed decisions only.",
|
|
3936
|
+
templates: [
|
|
3937
|
+
{
|
|
3938
|
+
destination: "docs/ai/presets/laravel-react-guidance.md",
|
|
3939
|
+
description: "Laravel + React (Inertia) guidance that remains proposed until accepted.",
|
|
3940
|
+
content: laravelGuidance("react")
|
|
3941
|
+
}
|
|
3942
|
+
],
|
|
3943
|
+
guidance: laravelGuidanceItems(),
|
|
3944
|
+
proposedDecisions: laravelProposedDecisions("react")
|
|
3945
|
+
};
|
|
3461
3946
|
|
|
3462
|
-
|
|
3463
|
-
|
|
3947
|
+
// src/presets/laravel-vue/preset.ts
|
|
3948
|
+
var laravelVuePreset = {
|
|
3949
|
+
id: "laravel-vue",
|
|
3950
|
+
name: "Laravel + Vue",
|
|
3951
|
+
description: "Opinionated Laravel + Inertia + Vue opinion pack with proposed decisions only.",
|
|
3952
|
+
templates: [
|
|
3953
|
+
{
|
|
3954
|
+
destination: "docs/ai/presets/laravel-vue-guidance.md",
|
|
3955
|
+
description: "Laravel + Vue (Inertia) guidance that remains proposed until accepted.",
|
|
3956
|
+
content: laravelGuidance("vue")
|
|
3957
|
+
}
|
|
3958
|
+
],
|
|
3959
|
+
guidance: laravelGuidanceItems(),
|
|
3960
|
+
proposedDecisions: laravelProposedDecisions("vue")
|
|
3961
|
+
};
|
|
3962
|
+
|
|
3963
|
+
// src/presets/nextjs/preset.ts
|
|
3964
|
+
var guidance3 = `# Next.js Preset Guidance
|
|
3965
|
+
|
|
3966
|
+
This is proposed guidance, not accepted. Convert any architecture choice into a proposed ADR, then an
|
|
3967
|
+
accepted ADR, before treating it as repository truth.
|
|
3464
3968
|
|
|
3465
3969
|
## Decision forks this stack forces
|
|
3466
3970
|
|
|
3467
|
-
-
|
|
3468
|
-
-
|
|
3469
|
-
-
|
|
3470
|
-
-
|
|
3471
|
-
-
|
|
3971
|
+
- Routing: App Router vs Pages Router.
|
|
3972
|
+
- Rendering: Server Components and server actions vs client-heavy rendering.
|
|
3973
|
+
- Data layer: Drizzle or Prisma with PostgreSQL vs a hosted backend.
|
|
3974
|
+
- Styling: Tailwind CSS vs CSS Modules vs a component library.
|
|
3975
|
+
- Testing: Vitest with Testing Library and Playwright vs other runners.
|
|
3472
3976
|
|
|
3473
3977
|
## Recommended structure (proposed)
|
|
3474
3978
|
|
|
3475
|
-
-
|
|
3476
|
-
-
|
|
3477
|
-
-
|
|
3979
|
+
- The App Router with route groups and colocated server components.
|
|
3980
|
+
- A typed data layer isolated from UI components.
|
|
3981
|
+
- Shared UI primitives and a consistent styling system.
|
|
3478
3982
|
|
|
3479
3983
|
## Testing (proposed)
|
|
3480
3984
|
|
|
3481
|
-
-
|
|
3482
|
-
-
|
|
3483
|
-
-
|
|
3985
|
+
- Unit and component tests with Vitest and Testing Library.
|
|
3986
|
+
- End-to-end tests with Playwright for critical flows.
|
|
3987
|
+
- Type-safe data access tested against a disposable database.
|
|
3484
3988
|
|
|
3485
3989
|
## Security considerations (proposed)
|
|
3486
3990
|
|
|
3487
|
-
-
|
|
3488
|
-
- Validate
|
|
3489
|
-
- Scope authentication and authorization
|
|
3991
|
+
- Keep secrets in server-only environment variables, never in client bundles.
|
|
3992
|
+
- Validate input on the server, including server actions and route handlers.
|
|
3993
|
+
- Scope authentication and authorization on the server, not the client.
|
|
3490
3994
|
`;
|
|
3491
|
-
function
|
|
3995
|
+
function proposedAdr3(topic, title, body) {
|
|
3492
3996
|
return {
|
|
3493
|
-
id: `
|
|
3997
|
+
id: `nextjs-${topic}`,
|
|
3494
3998
|
title,
|
|
3495
3999
|
status: "proposed",
|
|
3496
|
-
destination: `docs/adrs/proposed/ADR-PROPOSED-
|
|
4000
|
+
destination: `docs/adrs/proposed/ADR-PROPOSED-nextjs-${topic}.md`,
|
|
3497
4001
|
body
|
|
3498
4002
|
};
|
|
3499
4003
|
}
|
|
3500
|
-
var
|
|
3501
|
-
id: "
|
|
3502
|
-
name: "
|
|
3503
|
-
description: "Opinionated
|
|
4004
|
+
var nextjsPreset = {
|
|
4005
|
+
id: "nextjs",
|
|
4006
|
+
name: "Next.js",
|
|
4007
|
+
description: "Opinionated Next.js opinion pack with proposed decisions only.",
|
|
3504
4008
|
templates: [
|
|
3505
4009
|
{
|
|
3506
|
-
destination: "docs/ai/presets/
|
|
3507
|
-
description: "
|
|
3508
|
-
content:
|
|
4010
|
+
destination: "docs/ai/presets/nextjs-guidance.md",
|
|
4011
|
+
description: "Next.js guidance that remains proposed until accepted.",
|
|
4012
|
+
content: guidance3
|
|
3509
4013
|
}
|
|
3510
4014
|
],
|
|
3511
4015
|
guidance: [
|
|
3512
4016
|
{
|
|
3513
|
-
title: "Keep framework
|
|
3514
|
-
body: "
|
|
4017
|
+
title: "Keep framework choices proposed",
|
|
4018
|
+
body: "Routing, rendering, data layer, styling, and testing choices must remain proposed until accepted in repository memory."
|
|
3515
4019
|
},
|
|
3516
4020
|
{
|
|
3517
|
-
title: "
|
|
3518
|
-
body: "
|
|
4021
|
+
title: "Keep secrets server-side",
|
|
4022
|
+
body: "Never expose secrets to the client bundle, and record the data and auth approach as proposed decisions before acceptance."
|
|
3519
4023
|
}
|
|
3520
4024
|
],
|
|
3521
4025
|
proposedDecisions: [
|
|
3522
|
-
|
|
4026
|
+
proposedAdr3(
|
|
3523
4027
|
"framework",
|
|
3524
|
-
"Use
|
|
3525
|
-
`# Proposed ADR: Use
|
|
4028
|
+
"Use Next.js",
|
|
4029
|
+
`# Proposed ADR: Use Next.js
|
|
3526
4030
|
|
|
3527
4031
|
## Status
|
|
3528
4032
|
|
|
@@ -3530,27 +4034,28 @@ Proposed
|
|
|
3530
4034
|
|
|
3531
4035
|
## Context
|
|
3532
4036
|
|
|
3533
|
-
The
|
|
4037
|
+
The team needs a React framework for a production web application.
|
|
3534
4038
|
|
|
3535
4039
|
## Decision
|
|
3536
4040
|
|
|
3537
|
-
Consider
|
|
4041
|
+
Consider Next.js as the application framework. This is not accepted until a human reviews and accepts
|
|
4042
|
+
it.
|
|
3538
4043
|
|
|
3539
4044
|
## Alternatives Considered
|
|
3540
4045
|
|
|
3541
|
-
-
|
|
3542
|
-
-
|
|
4046
|
+
- A Vite single-page app with a separate API.
|
|
4047
|
+
- Remix or another framework.
|
|
3543
4048
|
|
|
3544
4049
|
## Consequences
|
|
3545
4050
|
|
|
3546
|
-
-
|
|
3547
|
-
-
|
|
4051
|
+
- Server rendering, routing, and a large ecosystem.
|
|
4052
|
+
- Couples the app to Next.js conventions.
|
|
3548
4053
|
`
|
|
3549
4054
|
),
|
|
3550
|
-
|
|
3551
|
-
"
|
|
3552
|
-
"Use
|
|
3553
|
-
`# Proposed ADR: Use
|
|
4055
|
+
proposedAdr3(
|
|
4056
|
+
"routing-app-router",
|
|
4057
|
+
"Use the App Router",
|
|
4058
|
+
`# Proposed ADR: Use the App Router
|
|
3554
4059
|
|
|
3555
4060
|
## Status
|
|
3556
4061
|
|
|
@@ -3558,27 +4063,27 @@ Proposed
|
|
|
3558
4063
|
|
|
3559
4064
|
## Context
|
|
3560
4065
|
|
|
3561
|
-
|
|
4066
|
+
Next.js offers the App Router and the legacy Pages Router.
|
|
3562
4067
|
|
|
3563
4068
|
## Decision
|
|
3564
4069
|
|
|
3565
|
-
Consider
|
|
4070
|
+
Consider the App Router with Server Components, awaiting human acceptance.
|
|
3566
4071
|
|
|
3567
4072
|
## Alternatives Considered
|
|
3568
4073
|
|
|
3569
|
-
-
|
|
3570
|
-
-
|
|
4074
|
+
- The Pages Router.
|
|
4075
|
+
- A mix during migration.
|
|
3571
4076
|
|
|
3572
4077
|
## Consequences
|
|
3573
4078
|
|
|
3574
|
-
-
|
|
3575
|
-
- Requires
|
|
4079
|
+
- Server Components and nested layouts.
|
|
4080
|
+
- Requires understanding server and client boundaries.
|
|
3576
4081
|
`
|
|
3577
4082
|
),
|
|
3578
|
-
|
|
3579
|
-
"
|
|
3580
|
-
"Use
|
|
3581
|
-
`# Proposed ADR: Use
|
|
4083
|
+
proposedAdr3(
|
|
4084
|
+
"data-layer",
|
|
4085
|
+
"Use a typed data layer with PostgreSQL",
|
|
4086
|
+
`# Proposed ADR: Use a typed data layer with PostgreSQL
|
|
3582
4087
|
|
|
3583
4088
|
## Status
|
|
3584
4089
|
|
|
@@ -3586,22 +4091,228 @@ Proposed
|
|
|
3586
4091
|
|
|
3587
4092
|
## Context
|
|
3588
4093
|
|
|
3589
|
-
The
|
|
4094
|
+
The app needs a database and a typed access layer.
|
|
3590
4095
|
|
|
3591
4096
|
## Decision
|
|
3592
4097
|
|
|
3593
|
-
Consider
|
|
4098
|
+
Consider Drizzle or Prisma with PostgreSQL, awaiting human acceptance.
|
|
3594
4099
|
|
|
3595
4100
|
## Alternatives Considered
|
|
3596
4101
|
|
|
3597
|
-
-
|
|
3598
|
-
-
|
|
4102
|
+
- A hosted backend or BaaS.
|
|
4103
|
+
- Raw SQL.
|
|
3599
4104
|
|
|
3600
4105
|
## Consequences
|
|
3601
4106
|
|
|
3602
|
-
-
|
|
3603
|
-
- Adds
|
|
3604
|
-
`
|
|
4107
|
+
- Type-safe queries and migrations.
|
|
4108
|
+
- Adds an ORM and schema workflow.
|
|
4109
|
+
`
|
|
4110
|
+
),
|
|
4111
|
+
proposedAdr3(
|
|
4112
|
+
"styling-tailwind",
|
|
4113
|
+
"Use Tailwind CSS",
|
|
4114
|
+
`# Proposed ADR: Use Tailwind CSS
|
|
4115
|
+
|
|
4116
|
+
## Status
|
|
4117
|
+
|
|
4118
|
+
Proposed
|
|
4119
|
+
|
|
4120
|
+
## Context
|
|
4121
|
+
|
|
4122
|
+
The app needs a styling approach.
|
|
4123
|
+
|
|
4124
|
+
## Decision
|
|
4125
|
+
|
|
4126
|
+
Consider Tailwind CSS for styling, awaiting human acceptance.
|
|
4127
|
+
|
|
4128
|
+
## Alternatives Considered
|
|
4129
|
+
|
|
4130
|
+
- CSS Modules.
|
|
4131
|
+
- A component library with its own styling.
|
|
4132
|
+
|
|
4133
|
+
## Consequences
|
|
4134
|
+
|
|
4135
|
+
- Fast, consistent utility-based styling.
|
|
4136
|
+
- Markup includes utility classes that teams must standardize.
|
|
4137
|
+
`
|
|
4138
|
+
),
|
|
4139
|
+
proposedAdr3(
|
|
4140
|
+
"testing",
|
|
4141
|
+
"Use Vitest and Playwright",
|
|
4142
|
+
`# Proposed ADR: Use Vitest and Playwright
|
|
4143
|
+
|
|
4144
|
+
## Status
|
|
4145
|
+
|
|
4146
|
+
Proposed
|
|
4147
|
+
|
|
4148
|
+
## Context
|
|
4149
|
+
|
|
4150
|
+
The app needs unit, component, and end-to-end testing.
|
|
4151
|
+
|
|
4152
|
+
## Decision
|
|
4153
|
+
|
|
4154
|
+
Consider Vitest with Testing Library and Playwright, awaiting human acceptance.
|
|
4155
|
+
|
|
4156
|
+
## Alternatives Considered
|
|
4157
|
+
|
|
4158
|
+
- Jest.
|
|
4159
|
+
- Cypress for end-to-end tests.
|
|
4160
|
+
|
|
4161
|
+
## Consequences
|
|
4162
|
+
|
|
4163
|
+
- Fast unit and component tests plus reliable end-to-end coverage.
|
|
4164
|
+
- Teams maintain two test toolchains.
|
|
4165
|
+
`
|
|
4166
|
+
)
|
|
4167
|
+
]
|
|
4168
|
+
};
|
|
4169
|
+
|
|
4170
|
+
// src/presets/python-fastapi/preset.ts
|
|
4171
|
+
var guidance4 = `# Python FastAPI Preset Guidance
|
|
4172
|
+
|
|
4173
|
+
This guidance is proposed, not accepted. Convert any choice you adopt into an accepted ADR in
|
|
4174
|
+
repository memory. Until then, treat everything here as a recommendation awaiting human review.
|
|
4175
|
+
|
|
4176
|
+
## Decision forks this stack forces
|
|
4177
|
+
|
|
4178
|
+
- Web framework: FastAPI vs Flask vs Django REST.
|
|
4179
|
+
- Database and access: PostgreSQL with SQLAlchemy and Alembic vs an async ORM vs raw SQL.
|
|
4180
|
+
- Validation and settings: Pydantic v2 models and settings.
|
|
4181
|
+
- Testing: pytest with httpx vs unittest.
|
|
4182
|
+
- Background work and caching: Redis, task queues, and async workers.
|
|
4183
|
+
|
|
4184
|
+
## Recommended structure (proposed)
|
|
4185
|
+
|
|
4186
|
+
- A layered layout: \`api/\` routers, \`services/\` logic, \`repositories/\` data access, \`models/\` schemas.
|
|
4187
|
+
- Dependency injection through FastAPI dependencies.
|
|
4188
|
+
- Configuration via Pydantic settings loaded from environment variables.
|
|
4189
|
+
|
|
4190
|
+
## Testing (proposed)
|
|
4191
|
+
|
|
4192
|
+
- pytest with the FastAPI test client or httpx \`AsyncClient\`.
|
|
4193
|
+
- A disposable test database and transactional fixtures.
|
|
4194
|
+
- Contract tests for request and response schemas.
|
|
4195
|
+
|
|
4196
|
+
## Security considerations (proposed)
|
|
4197
|
+
|
|
4198
|
+
- Load secrets from environment or a secret manager, never from source.
|
|
4199
|
+
- Validate and constrain all input with Pydantic models.
|
|
4200
|
+
- Scope authentication and authorization at the dependency layer.
|
|
4201
|
+
`;
|
|
4202
|
+
function proposedAdr4(topic, title, body) {
|
|
4203
|
+
return {
|
|
4204
|
+
id: `python-fastapi-${topic}`,
|
|
4205
|
+
title,
|
|
4206
|
+
status: "proposed",
|
|
4207
|
+
destination: `docs/adrs/proposed/ADR-PROPOSED-python-fastapi-${topic}.md`,
|
|
4208
|
+
body
|
|
4209
|
+
};
|
|
4210
|
+
}
|
|
4211
|
+
var pythonFastapiPreset = {
|
|
4212
|
+
id: "python-fastapi",
|
|
4213
|
+
name: "Python FastAPI",
|
|
4214
|
+
description: "Opinionated Python FastAPI opinion pack with proposed decisions only.",
|
|
4215
|
+
templates: [
|
|
4216
|
+
{
|
|
4217
|
+
destination: "docs/ai/presets/python-fastapi-guidance.md",
|
|
4218
|
+
description: "Python FastAPI guidance that remains proposed until accepted.",
|
|
4219
|
+
content: guidance4
|
|
4220
|
+
}
|
|
4221
|
+
],
|
|
4222
|
+
guidance: [
|
|
4223
|
+
{
|
|
4224
|
+
title: "Keep framework and data choices proposed",
|
|
4225
|
+
body: "FastAPI, the database and ORM, validation, and testing choices must remain proposed until accepted in repository memory."
|
|
4226
|
+
},
|
|
4227
|
+
{
|
|
4228
|
+
title: "Validate all input",
|
|
4229
|
+
body: "Use Pydantic models at the boundary, but record the validation approach as a proposed decision before treating it as accepted."
|
|
4230
|
+
}
|
|
4231
|
+
],
|
|
4232
|
+
proposedDecisions: [
|
|
4233
|
+
proposedAdr4(
|
|
4234
|
+
"framework",
|
|
4235
|
+
"Use FastAPI",
|
|
4236
|
+
`# Proposed ADR: Use FastAPI
|
|
4237
|
+
|
|
4238
|
+
## Status
|
|
4239
|
+
|
|
4240
|
+
Proposed
|
|
4241
|
+
|
|
4242
|
+
## Context
|
|
4243
|
+
|
|
4244
|
+
The service needs a Python web framework for an async API.
|
|
4245
|
+
|
|
4246
|
+
## Decision
|
|
4247
|
+
|
|
4248
|
+
Consider FastAPI as the web framework, awaiting human acceptance.
|
|
4249
|
+
|
|
4250
|
+
## Alternatives Considered
|
|
4251
|
+
|
|
4252
|
+
- Flask.
|
|
4253
|
+
- Django REST Framework.
|
|
4254
|
+
|
|
4255
|
+
## Consequences
|
|
4256
|
+
|
|
4257
|
+
- Async support and automatic OpenAPI docs.
|
|
4258
|
+
- Requires comfort with type hints and dependency injection.
|
|
4259
|
+
`
|
|
4260
|
+
),
|
|
4261
|
+
proposedAdr4(
|
|
4262
|
+
"database-postgres",
|
|
4263
|
+
"Use PostgreSQL with SQLAlchemy and Alembic",
|
|
4264
|
+
`# Proposed ADR: Use PostgreSQL with SQLAlchemy
|
|
4265
|
+
|
|
4266
|
+
## Status
|
|
4267
|
+
|
|
4268
|
+
Proposed
|
|
4269
|
+
|
|
4270
|
+
## Context
|
|
4271
|
+
|
|
4272
|
+
The service needs a relational database and a migration strategy.
|
|
4273
|
+
|
|
4274
|
+
## Decision
|
|
4275
|
+
|
|
4276
|
+
Consider PostgreSQL with SQLAlchemy and Alembic migrations, awaiting human acceptance.
|
|
4277
|
+
|
|
4278
|
+
## Alternatives Considered
|
|
4279
|
+
|
|
4280
|
+
- An async ORM such as Tortoise or SQLModel only.
|
|
4281
|
+
- Raw SQL with a lightweight driver.
|
|
4282
|
+
|
|
4283
|
+
## Consequences
|
|
4284
|
+
|
|
4285
|
+
- Mature tooling and explicit migrations.
|
|
4286
|
+
- Requires session and connection management discipline.
|
|
4287
|
+
`
|
|
4288
|
+
),
|
|
4289
|
+
proposedAdr4(
|
|
4290
|
+
"validation-pydantic",
|
|
4291
|
+
"Use Pydantic for validation and settings",
|
|
4292
|
+
`# Proposed ADR: Use Pydantic
|
|
4293
|
+
|
|
4294
|
+
## Status
|
|
4295
|
+
|
|
4296
|
+
Proposed
|
|
4297
|
+
|
|
4298
|
+
## Context
|
|
4299
|
+
|
|
4300
|
+
The service needs request validation and typed configuration.
|
|
4301
|
+
|
|
4302
|
+
## Decision
|
|
4303
|
+
|
|
4304
|
+
Consider Pydantic v2 models for validation and settings, awaiting human acceptance.
|
|
4305
|
+
|
|
4306
|
+
## Alternatives Considered
|
|
4307
|
+
|
|
4308
|
+
- Marshmallow.
|
|
4309
|
+
- Hand-written validation.
|
|
4310
|
+
|
|
4311
|
+
## Consequences
|
|
4312
|
+
|
|
4313
|
+
- Strong typing at the boundary and clear settings.
|
|
4314
|
+
- Adds Pydantic to the dependency surface.
|
|
4315
|
+
`
|
|
3605
4316
|
),
|
|
3606
4317
|
proposedAdr4(
|
|
3607
4318
|
"testing-pytest",
|
|
@@ -3741,8 +4452,8 @@ function parsePreset(value) {
|
|
|
3741
4452
|
if (!result.success) {
|
|
3742
4453
|
throw new PresetValidationError(
|
|
3743
4454
|
result.error.issues.map((issue) => {
|
|
3744
|
-
const
|
|
3745
|
-
return `${
|
|
4455
|
+
const path17 = issue.path.length > 0 ? `${issue.path.join(".")}: ` : "";
|
|
4456
|
+
return `${path17}${issue.message}`;
|
|
3746
4457
|
})
|
|
3747
4458
|
);
|
|
3748
4459
|
}
|
|
@@ -3768,6 +4479,9 @@ var builtInPresets = validatePresetRegistry([
|
|
|
3768
4479
|
genericPreset,
|
|
3769
4480
|
iosSwiftPreset,
|
|
3770
4481
|
kotlinAndroidPreset,
|
|
4482
|
+
laravelApiPreset,
|
|
4483
|
+
laravelReactPreset,
|
|
4484
|
+
laravelVuePreset,
|
|
3771
4485
|
nextjsPreset,
|
|
3772
4486
|
pythonFastapiPreset
|
|
3773
4487
|
]);
|
|
@@ -3778,302 +4492,52 @@ function getPreset(id) {
|
|
|
3778
4492
|
return builtInPresets.find((preset) => preset.id === id);
|
|
3779
4493
|
}
|
|
3780
4494
|
|
|
3781
|
-
// src/
|
|
3782
|
-
|
|
3783
|
-
|
|
3784
|
-
|
|
3785
|
-
|
|
3786
|
-
|
|
3787
|
-
|
|
3788
|
-
|
|
3789
|
-
|
|
3790
|
-
|
|
3791
|
-
}
|
|
3792
|
-
|
|
3793
|
-
|
|
3794
|
-
|
|
3795
|
-
|
|
3796
|
-
|
|
3797
|
-
|
|
3798
|
-
|
|
3799
|
-
|
|
3800
|
-
|
|
3801
|
-
|
|
3802
|
-
|
|
3803
|
-
|
|
3804
|
-
|
|
3805
|
-
|
|
3806
|
-
|
|
3807
|
-
|
|
3808
|
-
|
|
3809
|
-
|
|
3810
|
-
|
|
3811
|
-
|
|
3812
|
-
|
|
3813
|
-
|
|
3814
|
-
|
|
3815
|
-
|
|
3816
|
-
"Recall OS init write plan contains errors.",
|
|
3817
|
-
plan.entries.filter((entry) => entry.action === "error").map((entry) => `${entry.path}: ${entry.reason}`)
|
|
3818
|
-
);
|
|
3819
|
-
}
|
|
3820
|
-
const writeResult = await executeWritePlan(plan, { dryRun: options.dryRun });
|
|
3821
|
-
return {
|
|
3822
|
-
preset: preset?.id ?? null,
|
|
3823
|
-
dryRun: options.dryRun ?? false,
|
|
3824
|
-
plan,
|
|
3825
|
-
writeResult
|
|
3826
|
-
};
|
|
3827
|
-
}
|
|
3828
|
-
function formatInitResult(result) {
|
|
3829
|
-
const lines = [
|
|
3830
|
-
result.dryRun ? "Recall OS init dry run complete." : "Recall OS init complete.",
|
|
3831
|
-
`Preset: ${result.preset ?? "none"}`
|
|
3832
|
-
];
|
|
3833
|
-
appendWriteSummary(lines, {
|
|
3834
|
-
dryRun: result.dryRun,
|
|
3835
|
-
writeResult: result.writeResult
|
|
3836
|
-
});
|
|
3837
|
-
const hookWritten = result.writeResult.created.includes(PRE_COMMIT_HOOK_PATH) || result.writeResult.overwritten.includes(PRE_COMMIT_HOOK_PATH);
|
|
3838
|
-
if (hookWritten) {
|
|
3839
|
-
lines.push("");
|
|
3840
|
-
lines.push(
|
|
3841
|
-
result.dryRun ? "Pre-commit hook will be written to .recall/hooks/pre-commit." : "Pre-commit hook written to .recall/hooks/pre-commit."
|
|
3842
|
-
);
|
|
3843
|
-
lines.push(`Enable it once per clone: ${HOOKS_PATH_ACTIVATION_COMMAND}`);
|
|
3844
|
-
}
|
|
3845
|
-
if (!result.dryRun) {
|
|
3846
|
-
appendNextSteps(lines, [
|
|
3847
|
-
"Read CLAUDE.md and AGENTS.md, then the docs/ memory they point to.",
|
|
3848
|
-
"Plan your first feature: `recall feature create <name>`.",
|
|
3849
|
-
"Record a decision: `recall adr create <title>`.",
|
|
3850
|
-
"Check repository memory health anytime: `recall doctor`."
|
|
3851
|
-
]);
|
|
3852
|
-
}
|
|
3853
|
-
return `${lines.join("\n")}
|
|
3854
|
-
`;
|
|
3855
|
-
}
|
|
3856
|
-
function resolvePreset(presetId) {
|
|
3857
|
-
if (presetId === void 0) {
|
|
3858
|
-
return null;
|
|
3859
|
-
}
|
|
3860
|
-
const preset = getPreset(presetId);
|
|
3861
|
-
if (preset === void 0) {
|
|
3862
|
-
throw new InitError("UNKNOWN_PRESET", `Unknown preset "${presetId}".`);
|
|
3863
|
-
}
|
|
3864
|
-
return preset;
|
|
3865
|
-
}
|
|
3866
|
-
function createInitWriteFiles(rootDir, config, preset) {
|
|
3867
|
-
return [
|
|
3868
|
-
{
|
|
3869
|
-
path: CONFIG_PATH,
|
|
3870
|
-
content: `${JSON.stringify(config, null, 2)}
|
|
3871
|
-
`
|
|
3872
|
-
},
|
|
3873
|
-
...generateInitFiles({ rootDir, preset }),
|
|
3874
|
-
{
|
|
3875
|
-
path: PRE_COMMIT_HOOK_PATH,
|
|
3876
|
-
content: renderPreCommitHook(config.preCommitGates),
|
|
3877
|
-
executable: true
|
|
3878
|
-
}
|
|
3879
|
-
];
|
|
3880
|
-
}
|
|
3881
|
-
|
|
3882
|
-
// src/core/mcp/known-servers.ts
|
|
3883
|
-
var KNOWN_SERVERS = {
|
|
3884
|
-
figma: {
|
|
3885
|
-
title: "Figma",
|
|
3886
|
-
purpose: "Design variables, components, and layout metadata for building consistent UI.",
|
|
3887
|
-
dataAccessed: [
|
|
3888
|
-
"Design tokens and variables.",
|
|
3889
|
-
"Component and layout metadata.",
|
|
3890
|
-
"Frames and styles."
|
|
3891
|
-
]
|
|
3892
|
-
},
|
|
3893
|
-
linear: {
|
|
3894
|
-
title: "Linear",
|
|
3895
|
-
purpose: "Tickets, project status, and acceptance criteria.",
|
|
3896
|
-
dataAccessed: [
|
|
3897
|
-
"Issues and tickets.",
|
|
3898
|
-
"Project and cycle status.",
|
|
3899
|
-
"Acceptance criteria in issues."
|
|
3900
|
-
]
|
|
3901
|
-
},
|
|
3902
|
-
jira: {
|
|
3903
|
-
title: "Jira",
|
|
3904
|
-
purpose: "Tickets, sprints, and acceptance criteria for knocking out tasks.",
|
|
3905
|
-
dataAccessed: [
|
|
3906
|
-
"Issues and tickets.",
|
|
3907
|
-
"Sprint and board status.",
|
|
3908
|
-
"Acceptance criteria in issues."
|
|
3909
|
-
]
|
|
3910
|
-
},
|
|
3911
|
-
github: {
|
|
3912
|
-
title: "GitHub",
|
|
3913
|
-
purpose: "Pull requests, issues, and review comments.",
|
|
3914
|
-
dataAccessed: ["Pull requests and diffs.", "Issues.", "Review comments."]
|
|
3915
|
-
},
|
|
3916
|
-
sentry: {
|
|
3917
|
-
title: "Sentry",
|
|
3918
|
-
purpose: "Crash reports and production errors.",
|
|
3919
|
-
dataAccessed: ["Error events and stack traces.", "Release health.", "Issue frequency."]
|
|
3920
|
-
},
|
|
3921
|
-
notion: {
|
|
3922
|
-
title: "Notion",
|
|
3923
|
-
purpose: "Product background and documentation.",
|
|
3924
|
-
dataAccessed: ["Product docs and pages.", "Project background.", "Specifications."]
|
|
3925
|
-
}
|
|
3926
|
-
};
|
|
3927
|
-
function getKnownServer(id) {
|
|
3928
|
-
return KNOWN_SERVERS[id];
|
|
3929
|
-
}
|
|
3930
|
-
|
|
3931
|
-
// src/core/mcp/generate-mcp.ts
|
|
3932
|
-
function mcpDocPath(server) {
|
|
3933
|
-
return `docs/ai/mcp/${server}.md`;
|
|
3934
|
-
}
|
|
3935
|
-
function generateMcpFiles(options) {
|
|
3936
|
-
const known = getKnownServer(options.server);
|
|
3937
|
-
const title = known?.title ?? titleize(options.server);
|
|
3938
|
-
const purpose = known?.purpose ?? "Describe why this MCP server is used.";
|
|
3939
|
-
const dataAccessed = known?.dataAccessed ?? ["Describe the data this MCP server exposes."];
|
|
3940
|
-
return [
|
|
3941
|
-
{
|
|
3942
|
-
path: mcpDocPath(options.server),
|
|
3943
|
-
content: renderMcpDoc(title, purpose, dataAccessed)
|
|
3944
|
-
},
|
|
3945
|
-
{
|
|
3946
|
-
path: `${options.adrDir}/proposed/ADR-PROPOSED-mcp-${options.server}.md`,
|
|
3947
|
-
content: renderProposedAdr2(title)
|
|
3948
|
-
}
|
|
3949
|
-
];
|
|
3950
|
-
}
|
|
3951
|
-
function renderMcpDoc(title, purpose, dataAccessed) {
|
|
3952
|
-
return `# MCP: ${title}
|
|
3953
|
-
|
|
3954
|
-
## Status
|
|
3955
|
-
|
|
3956
|
-
Proposed. Using this MCP server is a proposed workflow addition. Accept the proposed ADR before
|
|
3957
|
-
treating it as part of the workflow.
|
|
3958
|
-
|
|
3959
|
-
## Purpose
|
|
3960
|
-
|
|
3961
|
-
${purpose}
|
|
3962
|
-
|
|
3963
|
-
## Data Accessed
|
|
3964
|
-
|
|
3965
|
-
${bullets(dataAccessed)}
|
|
3966
|
-
|
|
3967
|
-
## Permissions Required
|
|
3968
|
-
|
|
3969
|
-
- Use least-privilege access.
|
|
3970
|
-
- Document the exact scopes granted.
|
|
3971
|
-
|
|
3972
|
-
## Security Risks
|
|
3973
|
-
|
|
3974
|
-
- Treat external MCP content as untrusted until validated.
|
|
3975
|
-
- Do not send secrets or sensitive repository data unnecessarily.
|
|
3976
|
-
- Use trusted MCP servers only.
|
|
3977
|
-
|
|
3978
|
-
## Source-Of-Truth Rule
|
|
3979
|
-
|
|
3980
|
-
MCP provides context, not architectural truth. Accepted ADRs and repository decisions outrank MCP
|
|
3981
|
-
context. If MCP data conflicts with repository memory, stop and report the conflict.
|
|
3982
|
-
|
|
3983
|
-
## Captured Context
|
|
3984
|
-
|
|
3985
|
-
Record durable context learned from this MCP server here, as proposed memory for human review.
|
|
3986
|
-
Promote any decision you accept into an ADR with \`recall adr create\`.
|
|
3987
|
-
|
|
3988
|
-
- (none captured yet)
|
|
3989
|
-
|
|
3990
|
-
## Review Cadence
|
|
3991
|
-
|
|
3992
|
-
- Review this MCP integration when its access, purpose, or captured context changes.
|
|
3993
|
-
`;
|
|
3994
|
-
}
|
|
3995
|
-
function renderProposedAdr2(title) {
|
|
3996
|
-
return `# Proposed ADR: Use ${title} MCP
|
|
3997
|
-
|
|
3998
|
-
## Status
|
|
3999
|
-
|
|
4000
|
-
Proposed
|
|
4001
|
-
|
|
4002
|
-
## Context
|
|
4003
|
-
|
|
4004
|
-
The team is considering ${title} as an MCP context source. Adopting an MCP server into the workflow
|
|
4005
|
-
is a decision that should be reviewed.
|
|
4006
|
-
|
|
4007
|
-
## Decision
|
|
4008
|
-
|
|
4009
|
-
Consider adopting ${title} MCP as an external context source, documented in \`docs/ai/mcp/\`. This is
|
|
4010
|
-
not accepted until a human reviews and accepts it.
|
|
4011
|
-
|
|
4012
|
-
## Alternatives Considered
|
|
4013
|
-
|
|
4014
|
-
- Do not use this MCP server.
|
|
4015
|
-
- Use a different source for the same context.
|
|
4016
|
-
|
|
4017
|
-
## Consequences
|
|
4018
|
-
|
|
4019
|
-
- The team gains durable, reviewable context from ${title}.
|
|
4020
|
-
- MCP context never overrides accepted repository memory.
|
|
4021
|
-
- Captured context remains proposed until promoted to an ADR.
|
|
4022
|
-
`;
|
|
4023
|
-
}
|
|
4024
|
-
function bullets(values) {
|
|
4025
|
-
return values.map((value) => `- ${value}`).join("\n");
|
|
4026
|
-
}
|
|
4027
|
-
function titleize(value) {
|
|
4028
|
-
return value.split("-").filter((part) => part.length > 0).map((part) => part.charAt(0).toUpperCase() + part.slice(1)).join(" ");
|
|
4029
|
-
}
|
|
4030
|
-
|
|
4031
|
-
// src/core/skills/render-skill.ts
|
|
4032
|
-
function renderSkill(skill) {
|
|
4033
|
-
const lines = [
|
|
4034
|
-
"---",
|
|
4035
|
-
`name: ${skill.name}`,
|
|
4036
|
-
// JSON-stringify yields a valid double-quoted YAML scalar, so descriptions with any punctuation
|
|
4037
|
-
// stay valid Agent Skills frontmatter.
|
|
4038
|
-
`description: ${JSON.stringify(skill.description)}`,
|
|
4039
|
-
"---",
|
|
4040
|
-
"",
|
|
4041
|
-
`# Skill: ${skill.title}`,
|
|
4042
|
-
"",
|
|
4043
|
-
"## Purpose",
|
|
4044
|
-
"",
|
|
4045
|
-
...paragraphs(skill.purpose),
|
|
4046
|
-
"",
|
|
4047
|
-
"## Inputs",
|
|
4048
|
-
"",
|
|
4049
|
-
...bullets2(skill.inputs),
|
|
4050
|
-
"",
|
|
4051
|
-
"## Required Reading",
|
|
4052
|
-
"",
|
|
4053
|
-
...bullets2(skill.requiredReading),
|
|
4054
|
-
"",
|
|
4055
|
-
"## Output Files",
|
|
4056
|
-
"",
|
|
4057
|
-
...bullets2(skill.outputFiles),
|
|
4058
|
-
"",
|
|
4059
|
-
"## Process",
|
|
4060
|
-
"",
|
|
4061
|
-
...numbered(skill.process),
|
|
4062
|
-
""
|
|
4063
|
-
];
|
|
4064
|
-
for (const section of skill.extraSections ?? []) {
|
|
4065
|
-
lines.push(`## ${section.heading}`, "", ...bullets2(section.bullets), "");
|
|
4495
|
+
// src/core/skills/render-skill.ts
|
|
4496
|
+
function renderSkill(skill) {
|
|
4497
|
+
const lines = [
|
|
4498
|
+
"---",
|
|
4499
|
+
`name: ${skill.name}`,
|
|
4500
|
+
// JSON-stringify yields a valid double-quoted YAML scalar, so descriptions with any punctuation
|
|
4501
|
+
// stay valid Agent Skills frontmatter.
|
|
4502
|
+
`description: ${JSON.stringify(skill.description)}`,
|
|
4503
|
+
"---",
|
|
4504
|
+
"",
|
|
4505
|
+
`# Skill: ${skill.title}`,
|
|
4506
|
+
"",
|
|
4507
|
+
"## Purpose",
|
|
4508
|
+
"",
|
|
4509
|
+
...paragraphs(skill.purpose),
|
|
4510
|
+
"",
|
|
4511
|
+
"## Inputs",
|
|
4512
|
+
"",
|
|
4513
|
+
...bullets(skill.inputs),
|
|
4514
|
+
"",
|
|
4515
|
+
"## Required Reading",
|
|
4516
|
+
"",
|
|
4517
|
+
...bullets(skill.requiredReading),
|
|
4518
|
+
"",
|
|
4519
|
+
"## Output Files",
|
|
4520
|
+
"",
|
|
4521
|
+
...bullets(skill.outputFiles),
|
|
4522
|
+
"",
|
|
4523
|
+
"## Process",
|
|
4524
|
+
"",
|
|
4525
|
+
...numbered(skill.process),
|
|
4526
|
+
""
|
|
4527
|
+
];
|
|
4528
|
+
for (const section of skill.extraSections ?? []) {
|
|
4529
|
+
lines.push(`## ${section.heading}`, "", ...bullets(section.bullets), "");
|
|
4066
4530
|
}
|
|
4067
4531
|
lines.push(
|
|
4068
4532
|
"## Stop Conditions",
|
|
4069
4533
|
"",
|
|
4070
4534
|
"Stop and request human decision if:",
|
|
4071
4535
|
"",
|
|
4072
|
-
...
|
|
4536
|
+
...bullets(skill.stopConditions),
|
|
4073
4537
|
"",
|
|
4074
4538
|
"## Quality Bar",
|
|
4075
4539
|
"",
|
|
4076
|
-
...
|
|
4540
|
+
...bullets(skill.qualityBar)
|
|
4077
4541
|
);
|
|
4078
4542
|
return `${lines.join("\n")}
|
|
4079
4543
|
`;
|
|
@@ -4088,7 +4552,7 @@ function paragraphs(values) {
|
|
|
4088
4552
|
});
|
|
4089
4553
|
return out;
|
|
4090
4554
|
}
|
|
4091
|
-
function
|
|
4555
|
+
function bullets(values) {
|
|
4092
4556
|
return values.map((value) => `- ${value}`);
|
|
4093
4557
|
}
|
|
4094
4558
|
function numbered(values) {
|
|
@@ -4627,6 +5091,9 @@ var SKILL_CATALOG = [
|
|
|
4627
5091
|
function getCatalogSkill(name) {
|
|
4628
5092
|
return SKILL_CATALOG.find((skill) => skill.name === name);
|
|
4629
5093
|
}
|
|
5094
|
+
function listCatalogSkillNames() {
|
|
5095
|
+
return SKILL_CATALOG.map((skill) => skill.name);
|
|
5096
|
+
}
|
|
4630
5097
|
|
|
4631
5098
|
// src/core/skills/generate-skill.ts
|
|
4632
5099
|
var SKILL_TARGETS = [".claude/skills", ".agents/skills"];
|
|
@@ -4645,7 +5112,7 @@ function generateSkillFiles(name) {
|
|
|
4645
5112
|
function skeletonSkill(name) {
|
|
4646
5113
|
return {
|
|
4647
5114
|
name,
|
|
4648
|
-
title:
|
|
5115
|
+
title: titleize(name),
|
|
4649
5116
|
description: `Describe what the ${name} skill does and when to use it. Use when ... (replace this with concrete trigger keywords).`,
|
|
4650
5117
|
purpose: ["Describe the single job this skill performs."],
|
|
4651
5118
|
inputs: ["List the inputs this skill needs."],
|
|
@@ -4659,10 +5126,287 @@ function skeletonSkill(name) {
|
|
|
4659
5126
|
qualityBar: ["State how to tell the skill did its job well."]
|
|
4660
5127
|
};
|
|
4661
5128
|
}
|
|
4662
|
-
function
|
|
5129
|
+
function titleize(name) {
|
|
4663
5130
|
return name.split("-").filter((part) => part.length > 0).map((part) => part.charAt(0).toUpperCase() + part.slice(1)).join(" ");
|
|
4664
5131
|
}
|
|
4665
5132
|
|
|
5133
|
+
// src/commands/init.ts
|
|
5134
|
+
var InitError = class extends Error {
|
|
5135
|
+
code;
|
|
5136
|
+
details;
|
|
5137
|
+
constructor(code, message, details = []) {
|
|
5138
|
+
super(message);
|
|
5139
|
+
this.name = "InitError";
|
|
5140
|
+
this.code = code;
|
|
5141
|
+
this.details = details;
|
|
5142
|
+
}
|
|
5143
|
+
};
|
|
5144
|
+
async function initProject(options) {
|
|
5145
|
+
if (options.force === true && options.reinit !== true && existsSync6(path15.join(options.rootDir, CONFIG_PATH))) {
|
|
5146
|
+
throw new InitError(
|
|
5147
|
+
"EXISTING_INSTALLATION",
|
|
5148
|
+
"Refusing to re-initialize an existing Recall OS installation.",
|
|
5149
|
+
[
|
|
5150
|
+
"An existing .recall/config.json was found in this directory.",
|
|
5151
|
+
"Running init --force here would overwrite existing repository memory.",
|
|
5152
|
+
"Pass --reinit together with --force to overwrite an existing installation."
|
|
5153
|
+
]
|
|
5154
|
+
);
|
|
5155
|
+
}
|
|
5156
|
+
const preset = resolvePreset(options.preset);
|
|
5157
|
+
const preCommitGates = await detectPreCommitGates(options.rootDir);
|
|
5158
|
+
const config = createDefaultConfig({ preset: preset?.id ?? null, preCommitGates });
|
|
5159
|
+
const files = createInitWriteFiles(options.rootDir, config, preset);
|
|
5160
|
+
const plan = createWritePlan({
|
|
5161
|
+
rootDir: options.rootDir,
|
|
5162
|
+
files,
|
|
5163
|
+
force: options.force
|
|
5164
|
+
});
|
|
5165
|
+
if (plan.hasErrors) {
|
|
5166
|
+
throw new InitError(
|
|
5167
|
+
"WRITE_PLAN_ERROR",
|
|
5168
|
+
"Recall OS init write plan contains errors.",
|
|
5169
|
+
plan.entries.filter((entry) => entry.action === "error").map((entry) => `${entry.path}: ${entry.reason}`)
|
|
5170
|
+
);
|
|
5171
|
+
}
|
|
5172
|
+
const writeResult = await executeWritePlan(plan, { dryRun: options.dryRun });
|
|
5173
|
+
return {
|
|
5174
|
+
preset: preset?.id ?? null,
|
|
5175
|
+
dryRun: options.dryRun ?? false,
|
|
5176
|
+
plan,
|
|
5177
|
+
writeResult
|
|
5178
|
+
};
|
|
5179
|
+
}
|
|
5180
|
+
function formatInitResult(result) {
|
|
5181
|
+
const lines = [
|
|
5182
|
+
result.dryRun ? "Recall OS init dry run complete." : "Recall OS init complete.",
|
|
5183
|
+
`Preset: ${result.preset ?? "none"}`
|
|
5184
|
+
];
|
|
5185
|
+
if (!result.dryRun) {
|
|
5186
|
+
lines.push(
|
|
5187
|
+
`Generated repository memory, ${listCatalogSkillNames().length} agent skills, a pre-commit hook, a CI workflow, a Claude SessionStart hook, and a Cursor rule that load memory automatically.`
|
|
5188
|
+
);
|
|
5189
|
+
}
|
|
5190
|
+
appendWriteSummary(lines, {
|
|
5191
|
+
dryRun: result.dryRun,
|
|
5192
|
+
writeResult: result.writeResult
|
|
5193
|
+
});
|
|
5194
|
+
const hookWritten = result.writeResult.created.includes(PRE_COMMIT_HOOK_PATH) || result.writeResult.overwritten.includes(PRE_COMMIT_HOOK_PATH);
|
|
5195
|
+
if (hookWritten) {
|
|
5196
|
+
lines.push("");
|
|
5197
|
+
lines.push(
|
|
5198
|
+
result.dryRun ? "Pre-commit hook will be written to .recall/hooks/pre-commit." : "Pre-commit hook written to .recall/hooks/pre-commit."
|
|
5199
|
+
);
|
|
5200
|
+
lines.push(`Enable it once per clone: ${HOOKS_PATH_ACTIVATION_COMMAND}`);
|
|
5201
|
+
}
|
|
5202
|
+
if (!result.dryRun) {
|
|
5203
|
+
appendNextSteps(lines, [
|
|
5204
|
+
"Read CLAUDE.md and AGENTS.md, then the docs/ memory they point to.",
|
|
5205
|
+
"AI agent skills are in .claude/skills/ and .agents/skills/ \u2014 restart your AI tool to load them.",
|
|
5206
|
+
"Memory loads automatically per tool: a Claude SessionStart hook (.claude/hooks/session-start.sh), a Cursor rule (.cursor/rules/recall-memory.mdc), and AGENTS.md for Codex.",
|
|
5207
|
+
"CI is wired in .github/workflows/recall.yml; the pre-commit hook is in .recall/hooks/.",
|
|
5208
|
+
"Plan your first feature: `recall feature create <name>`.",
|
|
5209
|
+
"Record a decision: `recall adr create <title>`, then accept it with `recall adr accept`.",
|
|
5210
|
+
"Check repository memory health anytime: `recall doctor`."
|
|
5211
|
+
]);
|
|
5212
|
+
}
|
|
5213
|
+
return `${lines.join("\n")}
|
|
5214
|
+
`;
|
|
5215
|
+
}
|
|
5216
|
+
function resolvePreset(presetId) {
|
|
5217
|
+
if (presetId === void 0) {
|
|
5218
|
+
return null;
|
|
5219
|
+
}
|
|
5220
|
+
const preset = getPreset(presetId);
|
|
5221
|
+
if (preset === void 0) {
|
|
5222
|
+
throw new InitError("UNKNOWN_PRESET", `Unknown preset "${presetId}".`);
|
|
5223
|
+
}
|
|
5224
|
+
return preset;
|
|
5225
|
+
}
|
|
5226
|
+
function createInitWriteFiles(rootDir, config, preset) {
|
|
5227
|
+
return [
|
|
5228
|
+
{
|
|
5229
|
+
path: CONFIG_PATH,
|
|
5230
|
+
content: `${JSON.stringify(config, null, 2)}
|
|
5231
|
+
`
|
|
5232
|
+
},
|
|
5233
|
+
...generateInitFiles({ rootDir, preset }),
|
|
5234
|
+
{
|
|
5235
|
+
path: PRE_COMMIT_HOOK_PATH,
|
|
5236
|
+
content: renderPreCommitHook(config.preCommitGates),
|
|
5237
|
+
executable: true
|
|
5238
|
+
},
|
|
5239
|
+
// A Claude Code SessionStart hook that injects a memory map every session, so a fresh agent
|
|
5240
|
+
// reliably loads durable memory, plus the settings that wire it (skipped if settings exist).
|
|
5241
|
+
{
|
|
5242
|
+
path: SESSION_START_HOOK_PATH,
|
|
5243
|
+
content: renderSessionStartHook(),
|
|
5244
|
+
executable: true
|
|
5245
|
+
},
|
|
5246
|
+
{
|
|
5247
|
+
path: CLAUDE_SETTINGS_PATH,
|
|
5248
|
+
content: renderClaudeSettings()
|
|
5249
|
+
},
|
|
5250
|
+
// Generate the agent skill set so a fresh repo has the workflows that guide AI agents,
|
|
5251
|
+
// not just the docs. Written to both the Claude and portable Agent Skills targets.
|
|
5252
|
+
...listCatalogSkillNames().flatMap((name) => generateSkillFiles(name).files)
|
|
5253
|
+
];
|
|
5254
|
+
}
|
|
5255
|
+
|
|
5256
|
+
// src/core/mcp/known-servers.ts
|
|
5257
|
+
var KNOWN_SERVERS = {
|
|
5258
|
+
figma: {
|
|
5259
|
+
title: "Figma",
|
|
5260
|
+
purpose: "Design variables, components, and layout metadata for building consistent UI.",
|
|
5261
|
+
dataAccessed: [
|
|
5262
|
+
"Design tokens and variables.",
|
|
5263
|
+
"Component and layout metadata.",
|
|
5264
|
+
"Frames and styles."
|
|
5265
|
+
]
|
|
5266
|
+
},
|
|
5267
|
+
linear: {
|
|
5268
|
+
title: "Linear",
|
|
5269
|
+
purpose: "Tickets, project status, and acceptance criteria.",
|
|
5270
|
+
dataAccessed: [
|
|
5271
|
+
"Issues and tickets.",
|
|
5272
|
+
"Project and cycle status.",
|
|
5273
|
+
"Acceptance criteria in issues."
|
|
5274
|
+
]
|
|
5275
|
+
},
|
|
5276
|
+
jira: {
|
|
5277
|
+
title: "Jira",
|
|
5278
|
+
purpose: "Tickets, sprints, and acceptance criteria for knocking out tasks.",
|
|
5279
|
+
dataAccessed: [
|
|
5280
|
+
"Issues and tickets.",
|
|
5281
|
+
"Sprint and board status.",
|
|
5282
|
+
"Acceptance criteria in issues."
|
|
5283
|
+
]
|
|
5284
|
+
},
|
|
5285
|
+
github: {
|
|
5286
|
+
title: "GitHub",
|
|
5287
|
+
purpose: "Pull requests, issues, and review comments.",
|
|
5288
|
+
dataAccessed: ["Pull requests and diffs.", "Issues.", "Review comments."]
|
|
5289
|
+
},
|
|
5290
|
+
sentry: {
|
|
5291
|
+
title: "Sentry",
|
|
5292
|
+
purpose: "Crash reports and production errors.",
|
|
5293
|
+
dataAccessed: ["Error events and stack traces.", "Release health.", "Issue frequency."]
|
|
5294
|
+
},
|
|
5295
|
+
notion: {
|
|
5296
|
+
title: "Notion",
|
|
5297
|
+
purpose: "Product background and documentation.",
|
|
5298
|
+
dataAccessed: ["Product docs and pages.", "Project background.", "Specifications."]
|
|
5299
|
+
}
|
|
5300
|
+
};
|
|
5301
|
+
function getKnownServer(id) {
|
|
5302
|
+
return KNOWN_SERVERS[id];
|
|
5303
|
+
}
|
|
5304
|
+
|
|
5305
|
+
// src/core/mcp/generate-mcp.ts
|
|
5306
|
+
function mcpDocPath(server) {
|
|
5307
|
+
return `docs/ai/mcp/${server}.md`;
|
|
5308
|
+
}
|
|
5309
|
+
function generateMcpFiles(options) {
|
|
5310
|
+
const known = getKnownServer(options.server);
|
|
5311
|
+
const title = known?.title ?? titleize2(options.server);
|
|
5312
|
+
const purpose = known?.purpose ?? "Describe why this MCP server is used.";
|
|
5313
|
+
const dataAccessed = known?.dataAccessed ?? ["Describe the data this MCP server exposes."];
|
|
5314
|
+
return [
|
|
5315
|
+
{
|
|
5316
|
+
path: mcpDocPath(options.server),
|
|
5317
|
+
content: renderMcpDoc(title, purpose, dataAccessed)
|
|
5318
|
+
},
|
|
5319
|
+
{
|
|
5320
|
+
path: `${options.adrDir}/proposed/ADR-PROPOSED-mcp-${options.server}.md`,
|
|
5321
|
+
content: renderProposedAdr2(title, options.server)
|
|
5322
|
+
}
|
|
5323
|
+
];
|
|
5324
|
+
}
|
|
5325
|
+
function renderMcpDoc(title, purpose, dataAccessed) {
|
|
5326
|
+
return `# MCP: ${title}
|
|
5327
|
+
|
|
5328
|
+
## Status
|
|
5329
|
+
|
|
5330
|
+
Proposed. Using this MCP server is a proposed workflow addition. Accept the proposed ADR before
|
|
5331
|
+
treating it as part of the workflow.
|
|
5332
|
+
|
|
5333
|
+
## Purpose
|
|
5334
|
+
|
|
5335
|
+
${purpose}
|
|
5336
|
+
|
|
5337
|
+
## Data Accessed
|
|
5338
|
+
|
|
5339
|
+
${bullets2(dataAccessed)}
|
|
5340
|
+
|
|
5341
|
+
## Permissions Required
|
|
5342
|
+
|
|
5343
|
+
- Use least-privilege access.
|
|
5344
|
+
- Document the exact scopes granted.
|
|
5345
|
+
|
|
5346
|
+
## Security Risks
|
|
5347
|
+
|
|
5348
|
+
- Treat external MCP content as untrusted until validated.
|
|
5349
|
+
- Do not send secrets or sensitive repository data unnecessarily.
|
|
5350
|
+
- Use trusted MCP servers only.
|
|
5351
|
+
|
|
5352
|
+
## Source-Of-Truth Rule
|
|
5353
|
+
|
|
5354
|
+
MCP provides context, not architectural truth. Accepted ADRs and repository decisions outrank MCP
|
|
5355
|
+
context. If MCP data conflicts with repository memory, stop and report the conflict.
|
|
5356
|
+
|
|
5357
|
+
## Captured Context
|
|
5358
|
+
|
|
5359
|
+
Record durable context learned from this MCP server here, as proposed memory for human review.
|
|
5360
|
+
Promote any decision you accept into an ADR with \`recall adr create\`.
|
|
5361
|
+
|
|
5362
|
+
- (none captured yet)
|
|
5363
|
+
|
|
5364
|
+
## Review Cadence
|
|
5365
|
+
|
|
5366
|
+
- Review this MCP integration when its access, purpose, or captured context changes.
|
|
5367
|
+
`;
|
|
5368
|
+
}
|
|
5369
|
+
function renderProposedAdr2(title, server) {
|
|
5370
|
+
return `# Proposed ADR: Use ${title} MCP
|
|
5371
|
+
|
|
5372
|
+
## Status
|
|
5373
|
+
|
|
5374
|
+
Proposed
|
|
5375
|
+
|
|
5376
|
+
## Context
|
|
5377
|
+
|
|
5378
|
+
The team is considering ${title} as an MCP context source. Adopting an MCP server into the workflow
|
|
5379
|
+
is a decision that should be reviewed.
|
|
5380
|
+
|
|
5381
|
+
## Decision
|
|
5382
|
+
|
|
5383
|
+
Consider adopting ${title} MCP as an external context source, documented in \`docs/ai/mcp/\`. This is
|
|
5384
|
+
not accepted until a human reviews and accepts it.
|
|
5385
|
+
|
|
5386
|
+
## Alternatives Considered
|
|
5387
|
+
|
|
5388
|
+
- Do not use this MCP server.
|
|
5389
|
+
- Use a different source for the same context.
|
|
5390
|
+
|
|
5391
|
+
## Consequences
|
|
5392
|
+
|
|
5393
|
+
- The team gains durable, reviewable context from ${title}.
|
|
5394
|
+
- MCP context never overrides accepted repository memory.
|
|
5395
|
+
- Captured context remains proposed until promoted to an ADR.
|
|
5396
|
+
|
|
5397
|
+
## Related Documents
|
|
5398
|
+
|
|
5399
|
+
- \`docs/ai/mcp/${server}.md\` \u2014 captured ${title} MCP context.
|
|
5400
|
+
- \`docs/ai/MCP_STRATEGY.md\` \u2014 how MCP context is captured and ranked.
|
|
5401
|
+
`;
|
|
5402
|
+
}
|
|
5403
|
+
function bullets2(values) {
|
|
5404
|
+
return values.map((value) => `- ${value}`).join("\n");
|
|
5405
|
+
}
|
|
5406
|
+
function titleize2(value) {
|
|
5407
|
+
return value.split("-").filter((part) => part.length > 0).map((part) => part.charAt(0).toUpperCase() + part.slice(1)).join(" ");
|
|
5408
|
+
}
|
|
5409
|
+
|
|
4666
5410
|
// src/commands/mcp/add.ts
|
|
4667
5411
|
var McpAddError = class extends Error {
|
|
4668
5412
|
code;
|
|
@@ -4744,7 +5488,7 @@ async function loadConfigOrDefault2(rootDir) {
|
|
|
4744
5488
|
}
|
|
4745
5489
|
|
|
4746
5490
|
// src/core/generator/generate-module.ts
|
|
4747
|
-
import
|
|
5491
|
+
import path16 from "path";
|
|
4748
5492
|
var moduleTemplates = [
|
|
4749
5493
|
{
|
|
4750
5494
|
fileName: "MODULE.md",
|
|
@@ -4817,14 +5561,14 @@ Record durable module decisions here.
|
|
|
4817
5561
|
];
|
|
4818
5562
|
function generateModuleFiles(options) {
|
|
4819
5563
|
const slug = slugify(options.moduleName);
|
|
4820
|
-
const moduleDir =
|
|
5564
|
+
const moduleDir = path16.posix.join(options.modulesDir, slug);
|
|
4821
5565
|
const title = titleizeModuleName(options.moduleName);
|
|
4822
5566
|
const context = createTemplateContext({
|
|
4823
5567
|
slug,
|
|
4824
5568
|
title
|
|
4825
5569
|
});
|
|
4826
5570
|
return moduleTemplates.map((template) => ({
|
|
4827
|
-
path:
|
|
5571
|
+
path: path16.posix.join(moduleDir, template.fileName),
|
|
4828
5572
|
content: renderTemplate(template.content, context)
|
|
4829
5573
|
}));
|
|
4830
5574
|
}
|