agent-rulebook 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +4 -0
- package/README.md +66 -0
- package/dist/cli.d.ts +2 -0
- package/dist/cli.js +4 -0
- package/dist/cli.js.map +1 -0
- package/dist/commands/add.d.ts +2 -0
- package/dist/commands/add.js +134 -0
- package/dist/commands/add.js.map +1 -0
- package/dist/commands/index.d.ts +3 -0
- package/dist/commands/index.js +41 -0
- package/dist/commands/index.js.map +1 -0
- package/dist/commands/init.d.ts +2 -0
- package/dist/commands/init.js +17 -0
- package/dist/commands/init.js.map +1 -0
- package/dist/commands/mcp.d.ts +2 -0
- package/dist/commands/mcp.js +17 -0
- package/dist/commands/mcp.js.map +1 -0
- package/dist/commands/migrate.d.ts +2 -0
- package/dist/commands/migrate.js +73 -0
- package/dist/commands/migrate.js.map +1 -0
- package/dist/commands/output.d.ts +6 -0
- package/dist/commands/output.js +49 -0
- package/dist/commands/output.js.map +1 -0
- package/dist/commands/search.d.ts +2 -0
- package/dist/commands/search.js +57 -0
- package/dist/commands/search.js.map +1 -0
- package/dist/core/compatibility-matcher.d.ts +17 -0
- package/dist/core/compatibility-matcher.js +146 -0
- package/dist/core/compatibility-matcher.js.map +1 -0
- package/dist/core/dedup.d.ts +22 -0
- package/dist/core/dedup.js +54 -0
- package/dist/core/dedup.js.map +1 -0
- package/dist/core/error-signature.d.ts +15 -0
- package/dist/core/error-signature.js +59 -0
- package/dist/core/error-signature.js.map +1 -0
- package/dist/core/facets.d.ts +9 -0
- package/dist/core/facets.js +46 -0
- package/dist/core/facets.js.map +1 -0
- package/dist/core/index.d.ts +30 -0
- package/dist/core/index.js +16 -0
- package/dist/core/index.js.map +1 -0
- package/dist/core/lesson-importer.d.ts +22 -0
- package/dist/core/lesson-importer.js +94 -0
- package/dist/core/lesson-importer.js.map +1 -0
- package/dist/core/paths.d.ts +5 -0
- package/dist/core/paths.js +11 -0
- package/dist/core/paths.js.map +1 -0
- package/dist/core/project-environment-detector.d.ts +43 -0
- package/dist/core/project-environment-detector.js +464 -0
- package/dist/core/project-environment-detector.js.map +1 -0
- package/dist/core/ranker.d.ts +3 -0
- package/dist/core/ranker.js +47 -0
- package/dist/core/ranker.js.map +1 -0
- package/dist/core/redaction.d.ts +35 -0
- package/dist/core/redaction.js +149 -0
- package/dist/core/redaction.js.map +1 -0
- package/dist/core/rule-compatibility.d.ts +66 -0
- package/dist/core/rule-compatibility.js +53 -0
- package/dist/core/rule-compatibility.js.map +1 -0
- package/dist/core/rule-parser.d.ts +25 -0
- package/dist/core/rule-parser.js +81 -0
- package/dist/core/rule-parser.js.map +1 -0
- package/dist/core/rule-schema.d.ts +231 -0
- package/dist/core/rule-schema.js +184 -0
- package/dist/core/rule-schema.js.map +1 -0
- package/dist/core/rule-writer.d.ts +35 -0
- package/dist/core/rule-writer.js +63 -0
- package/dist/core/rule-writer.js.map +1 -0
- package/dist/core/search-types.d.ts +51 -0
- package/dist/core/search-types.js +2 -0
- package/dist/core/search-types.js.map +1 -0
- package/dist/core/slug.d.ts +13 -0
- package/dist/core/slug.js +42 -0
- package/dist/core/slug.js.map +1 -0
- package/dist/core/stack-detector.d.ts +56 -0
- package/dist/core/stack-detector.js +358 -0
- package/dist/core/stack-detector.js.map +1 -0
- package/dist/index.d.ts +5 -0
- package/dist/index.js +4 -0
- package/dist/index.js.map +1 -0
- package/dist/mcp/index.d.ts +7 -0
- package/dist/mcp/index.js +5 -0
- package/dist/mcp/index.js.map +1 -0
- package/dist/mcp/lesson-capture.d.ts +30 -0
- package/dist/mcp/lesson-capture.js +146 -0
- package/dist/mcp/lesson-capture.js.map +1 -0
- package/dist/mcp/rules-add-lesson-tool.d.ts +4 -0
- package/dist/mcp/rules-add-lesson-tool.js +73 -0
- package/dist/mcp/rules-add-lesson-tool.js.map +1 -0
- package/dist/mcp/rules-dedup-lesson-tool.d.ts +4 -0
- package/dist/mcp/rules-dedup-lesson-tool.js +69 -0
- package/dist/mcp/rules-dedup-lesson-tool.js.map +1 -0
- package/dist/mcp/rules-list-facets-tool.d.ts +3 -0
- package/dist/mcp/rules-list-facets-tool.js +31 -0
- package/dist/mcp/rules-list-facets-tool.js.map +1 -0
- package/dist/mcp/rules-prepare-lesson-tool.d.ts +4 -0
- package/dist/mcp/rules-prepare-lesson-tool.js +7 -0
- package/dist/mcp/rules-prepare-lesson-tool.js.map +1 -0
- package/dist/mcp/rules-search-error-tool.d.ts +4 -0
- package/dist/mcp/rules-search-error-tool.js +99 -0
- package/dist/mcp/rules-search-error-tool.js.map +1 -0
- package/dist/mcp/rules-search-for-project-tool.d.ts +4 -0
- package/dist/mcp/rules-search-for-project-tool.js +103 -0
- package/dist/mcp/rules-search-for-project-tool.js.map +1 -0
- package/dist/mcp/rules-search-tool.d.ts +7 -0
- package/dist/mcp/rules-search-tool.js +65 -0
- package/dist/mcp/rules-search-tool.js.map +1 -0
- package/dist/mcp/schemas.d.ts +222 -0
- package/dist/mcp/schemas.js +99 -0
- package/dist/mcp/schemas.js.map +1 -0
- package/dist/mcp/server.d.ts +5 -0
- package/dist/mcp/server.js +29 -0
- package/dist/mcp/server.js.map +1 -0
- package/dist/mcp/tool-output.d.ts +32 -0
- package/dist/mcp/tool-output.js +74 -0
- package/dist/mcp/tool-output.js.map +1 -0
- package/dist/mcp/tools.d.ts +300 -0
- package/dist/mcp/tools.js +123 -0
- package/dist/mcp/tools.js.map +1 -0
- package/dist/migration/adapters/fenced-lessons.d.ts +2 -0
- package/dist/migration/adapters/fenced-lessons.js +55 -0
- package/dist/migration/adapters/fenced-lessons.js.map +1 -0
- package/dist/migration/adapters/global-rules.d.ts +2 -0
- package/dist/migration/adapters/global-rules.js +72 -0
- package/dist/migration/adapters/global-rules.js.map +1 -0
- package/dist/migration/adapters/index.d.ts +2 -0
- package/dist/migration/adapters/index.js +13 -0
- package/dist/migration/adapters/index.js.map +1 -0
- package/dist/migration/adapters/markdown-lessons.d.ts +2 -0
- package/dist/migration/adapters/markdown-lessons.js +36 -0
- package/dist/migration/adapters/markdown-lessons.js.map +1 -0
- package/dist/migration/adapters/structured-lessons.d.ts +2 -0
- package/dist/migration/adapters/structured-lessons.js +8 -0
- package/dist/migration/adapters/structured-lessons.js.map +1 -0
- package/dist/migration/adapters/structured-shared.d.ts +3 -0
- package/dist/migration/adapters/structured-shared.js +97 -0
- package/dist/migration/adapters/structured-shared.js.map +1 -0
- package/dist/migration/applier.d.ts +32 -0
- package/dist/migration/applier.js +469 -0
- package/dist/migration/applier.js.map +1 -0
- package/dist/migration/index.d.ts +11 -0
- package/dist/migration/index.js +7 -0
- package/dist/migration/index.js.map +1 -0
- package/dist/migration/manifest.d.ts +262 -0
- package/dist/migration/manifest.js +89 -0
- package/dist/migration/manifest.js.map +1 -0
- package/dist/migration/migration-report.d.ts +147 -0
- package/dist/migration/migration-report.js +81 -0
- package/dist/migration/migration-report.js.map +1 -0
- package/dist/migration/scanner.d.ts +2 -0
- package/dist/migration/scanner.js +314 -0
- package/dist/migration/scanner.js.map +1 -0
- package/dist/migration/source-adapter.d.ts +37 -0
- package/dist/migration/source-adapter.js +2 -0
- package/dist/migration/source-adapter.js.map +1 -0
- package/dist/migration/verifier.d.ts +5 -0
- package/dist/migration/verifier.js +217 -0
- package/dist/migration/verifier.js.map +1 -0
- package/dist/program.d.ts +2 -0
- package/dist/program.js +21 -0
- package/dist/program.js.map +1 -0
- package/dist/storage/index-check.d.ts +19 -0
- package/dist/storage/index-check.js +114 -0
- package/dist/storage/index-check.js.map +1 -0
- package/dist/storage/index.d.ts +15 -0
- package/dist/storage/index.js +9 -0
- package/dist/storage/index.js.map +1 -0
- package/dist/storage/indexer.d.ts +19 -0
- package/dist/storage/indexer.js +354 -0
- package/dist/storage/indexer.js.map +1 -0
- package/dist/storage/migrations.d.ts +3 -0
- package/dist/storage/migrations.js +110 -0
- package/dist/storage/migrations.js.map +1 -0
- package/dist/storage/rule-discovery.d.ts +4 -0
- package/dist/storage/rule-discovery.js +34 -0
- package/dist/storage/rule-discovery.js.map +1 -0
- package/dist/storage/rule-store.d.ts +10 -0
- package/dist/storage/rule-store.js +12 -0
- package/dist/storage/rule-store.js.map +1 -0
- package/dist/storage/rulebook-home.d.ts +21 -0
- package/dist/storage/rulebook-home.js +75 -0
- package/dist/storage/rulebook-home.js.map +1 -0
- package/dist/storage/search-service.d.ts +17 -0
- package/dist/storage/search-service.js +252 -0
- package/dist/storage/search-service.js.map +1 -0
- package/dist/storage/sqlite-errors.d.ts +26 -0
- package/dist/storage/sqlite-errors.js +55 -0
- package/dist/storage/sqlite-errors.js.map +1 -0
- package/dist/storage/sqlite.d.ts +13 -0
- package/dist/storage/sqlite.js +34 -0
- package/dist/storage/sqlite.js.map +1 -0
- package/package.json +62 -0
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type Database from 'better-sqlite3';
|
|
2
|
+
export type RulebookDatabase = Database.Database;
|
|
3
|
+
export type OpenRulebookDatabaseOptions = {
|
|
4
|
+
databasePath: string;
|
|
5
|
+
};
|
|
6
|
+
export type RulebookDatabaseRuntime = {
|
|
7
|
+
userVersion: number;
|
|
8
|
+
fts5Available: boolean;
|
|
9
|
+
integrity: string;
|
|
10
|
+
};
|
|
11
|
+
export declare function openRulebookDatabase(options: OpenRulebookDatabaseOptions): RulebookDatabase;
|
|
12
|
+
export declare function closeRulebookDatabase(database: RulebookDatabase): void;
|
|
13
|
+
export declare function readRulebookDatabaseRuntime(database: RulebookDatabase): RulebookDatabaseRuntime;
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import BetterSqlite3 from 'better-sqlite3';
|
|
2
|
+
import { mkdirSync } from 'node:fs';
|
|
3
|
+
import { dirname } from 'node:path';
|
|
4
|
+
import { isSqliteCorruptionError, RulebookIndexCorruptError, } from './sqlite-errors.js';
|
|
5
|
+
export function openRulebookDatabase(options) {
|
|
6
|
+
mkdirSync(dirname(options.databasePath), { recursive: true });
|
|
7
|
+
const database = new BetterSqlite3(options.databasePath);
|
|
8
|
+
try {
|
|
9
|
+
database.pragma('foreign_keys = ON');
|
|
10
|
+
database.pragma('busy_timeout = 5000');
|
|
11
|
+
database.pragma('journal_mode = WAL');
|
|
12
|
+
return database;
|
|
13
|
+
}
|
|
14
|
+
catch (error) {
|
|
15
|
+
database.close();
|
|
16
|
+
if (isSqliteCorruptionError(error)) {
|
|
17
|
+
throw new RulebookIndexCorruptError(options.databasePath, error);
|
|
18
|
+
}
|
|
19
|
+
throw error;
|
|
20
|
+
}
|
|
21
|
+
}
|
|
22
|
+
export function closeRulebookDatabase(database) {
|
|
23
|
+
database.close();
|
|
24
|
+
}
|
|
25
|
+
export function readRulebookDatabaseRuntime(database) {
|
|
26
|
+
const userVersion = database.pragma('user_version', { simple: true });
|
|
27
|
+
const fts5Available = database
|
|
28
|
+
.prepare("SELECT EXISTS(SELECT 1 FROM pragma_module_list WHERE name = 'fts5') AS available")
|
|
29
|
+
.get()?.available === 1;
|
|
30
|
+
const integrityRows = database.pragma('integrity_check');
|
|
31
|
+
const integrity = integrityRows.map((row) => row.integrity_check).join('; ') || 'unknown';
|
|
32
|
+
return { userVersion, fts5Available, integrity };
|
|
33
|
+
}
|
|
34
|
+
//# sourceMappingURL=sqlite.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sqlite.js","sourceRoot":"","sources":["../../src/storage/sqlite.ts"],"names":[],"mappings":"AACA,OAAO,aAAa,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACpC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EACL,uBAAuB,EACvB,yBAAyB,GAC1B,MAAM,oBAAoB,CAAC;AAc5B,MAAM,UAAU,oBAAoB,CAAC,OAAoC;IACvE,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC9D,MAAM,QAAQ,GAAG,IAAI,aAAa,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAEzD,IAAI,CAAC;QACH,QAAQ,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;QACrC,QAAQ,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;QACvC,QAAQ,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC;QACtC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,QAAQ,CAAC,KAAK,EAAE,CAAC;QACjB,IAAI,uBAAuB,CAAC,KAAK,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,yBAAyB,CAAC,OAAO,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;QACnE,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,QAA0B;IAC9D,QAAQ,CAAC,KAAK,EAAE,CAAC;AACnB,CAAC;AAED,MAAM,UAAU,2BAA2B,CACzC,QAA0B;IAE1B,MAAM,WAAW,GAAG,QAAQ,CAAC,MAAM,CAAC,cAAc,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAW,CAAC;IAChF,MAAM,aAAa,GACjB,QAAQ;SACL,OAAO,CACN,kFAAkF,CACnF;SACA,GAAG,EAAE,EAAE,SAAS,KAAK,CAAC,CAAC;IAC5B,MAAM,aAAa,GAAG,QAAQ,CAAC,MAAM,CAAC,iBAAiB,CAErD,CAAC;IACH,MAAM,SAAS,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC;IAE1F,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,SAAS,EAAE,CAAC;AACnD,CAAC"}
|
package/package.json
ADDED
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "agent-rulebook",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Local-first CLI and MCP server for reusable agent engineering rules.",
|
|
5
|
+
"license": "UNLICENSED",
|
|
6
|
+
"keywords": [
|
|
7
|
+
"agent-rules",
|
|
8
|
+
"cli",
|
|
9
|
+
"codex",
|
|
10
|
+
"mcp",
|
|
11
|
+
"model-context-protocol"
|
|
12
|
+
],
|
|
13
|
+
"type": "module",
|
|
14
|
+
"files": [
|
|
15
|
+
"dist",
|
|
16
|
+
"README.md",
|
|
17
|
+
"LICENSE"
|
|
18
|
+
],
|
|
19
|
+
"main": "./dist/index.js",
|
|
20
|
+
"types": "./dist/index.d.ts",
|
|
21
|
+
"exports": {
|
|
22
|
+
".": {
|
|
23
|
+
"types": "./dist/index.d.ts",
|
|
24
|
+
"import": "./dist/index.js"
|
|
25
|
+
}
|
|
26
|
+
},
|
|
27
|
+
"bin": {
|
|
28
|
+
"agent-rulebook": "./dist/cli.js"
|
|
29
|
+
},
|
|
30
|
+
"engines": {
|
|
31
|
+
"node": "20.x || 22.x || 23.x || 24.x || 25.x || 26.x"
|
|
32
|
+
},
|
|
33
|
+
"scripts": {
|
|
34
|
+
"clean": "node -e \"require('node:fs').rmSync('dist', { recursive: true, force: true })\"",
|
|
35
|
+
"prebuild": "npm run clean",
|
|
36
|
+
"build": "tsc -p tsconfig.build.json",
|
|
37
|
+
"dev": "tsx src/cli.ts",
|
|
38
|
+
"pretest": "npm run build",
|
|
39
|
+
"acceptance": "node scripts/run-acceptance.mjs",
|
|
40
|
+
"check:package": "node scripts/check-package.mjs",
|
|
41
|
+
"smoke:package": "node scripts/smoke-packed-package.mjs",
|
|
42
|
+
"release:verify": "npm run build && npm run typecheck && npm test && npm run acceptance",
|
|
43
|
+
"prepack": "npm run release:verify && npm run check:package",
|
|
44
|
+
"prepublishOnly": "npm run release:verify",
|
|
45
|
+
"typecheck": "tsc --noEmit",
|
|
46
|
+
"test": "vitest run"
|
|
47
|
+
},
|
|
48
|
+
"dependencies": {
|
|
49
|
+
"@modelcontextprotocol/sdk": "^1.17.0",
|
|
50
|
+
"better-sqlite3": "12.11.1",
|
|
51
|
+
"commander": "^14.0.0",
|
|
52
|
+
"yaml": "^2.8.0",
|
|
53
|
+
"zod": "^4.0.0"
|
|
54
|
+
},
|
|
55
|
+
"devDependencies": {
|
|
56
|
+
"@types/better-sqlite3": "^7.6.13",
|
|
57
|
+
"@types/node": "^24.0.0",
|
|
58
|
+
"tsx": "^4.20.0",
|
|
59
|
+
"typescript": "^5.8.0",
|
|
60
|
+
"vitest": "^3.2.0"
|
|
61
|
+
}
|
|
62
|
+
}
|