docbridge 0.5.2 → 0.6.1
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/CHANGELOG.md +40 -1
- package/README.md +12 -108
- package/dist/bin/darwin-arm64/SHA256SUMS +2 -2
- package/dist/bin/darwin-arm64/{speclink-swift-scanner → docbridge-swift-scanner} +0 -0
- package/dist/bin/darwin-arm64/{speclink_dart_scanner → docbridge_dart_scanner} +0 -0
- package/dist/bin/linux-x64/SHA256SUMS +2 -2
- package/dist/bin/linux-x64/{speclink-swift-scanner → docbridge-swift-scanner} +0 -0
- package/dist/bin/linux-x64/{speclink_dart_scanner → docbridge_dart_scanner} +0 -0
- package/dist/index.js +386 -310
- package/package.json +24 -20
- package/schemas/context-output.schema.json +9 -1
- package/templates/skills/docbridge-adopt/SKILL.md +5 -5
- package/templates/skills/docbridge-annotate/SKILL.md +9 -8
- package/templates/skills/docbridge-sync/SKILL.md +2 -2
package/package.json
CHANGED
|
@@ -1,30 +1,27 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "docbridge",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"description": "A
|
|
5
|
-
"
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
"
|
|
3
|
+
"version": "0.6.1",
|
|
4
|
+
"description": "A CLI that links Markdown specifications and code declarations. Runs on Node.js and Bun.",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"bun",
|
|
7
|
+
"cli",
|
|
8
|
+
"documentation",
|
|
9
|
+
"lsp",
|
|
10
|
+
"markdown",
|
|
11
|
+
"node",
|
|
12
|
+
"specification"
|
|
13
|
+
],
|
|
14
|
+
"homepage": "https://github.com/salan70/docbridge#readme",
|
|
15
|
+
"bugs": {
|
|
16
|
+
"url": "https://github.com/salan70/docbridge/issues"
|
|
9
17
|
},
|
|
18
|
+
"license": "MIT",
|
|
10
19
|
"repository": {
|
|
11
20
|
"type": "git",
|
|
12
21
|
"url": "git+https://github.com/salan70/docbridge.git"
|
|
13
22
|
},
|
|
14
|
-
"
|
|
15
|
-
"
|
|
16
|
-
},
|
|
17
|
-
"homepage": "https://github.com/salan70/docbridge#readme",
|
|
18
|
-
"keywords": [
|
|
19
|
-
"documentation",
|
|
20
|
-
"markdown",
|
|
21
|
-
"specification",
|
|
22
|
-
"cli",
|
|
23
|
-
"bun",
|
|
24
|
-
"lsp"
|
|
25
|
-
],
|
|
26
|
-
"engines": {
|
|
27
|
-
"bun": ">=1.1.31"
|
|
23
|
+
"bin": {
|
|
24
|
+
"docbridge": "./dist/index.js"
|
|
28
25
|
},
|
|
29
26
|
"files": [
|
|
30
27
|
"dist",
|
|
@@ -34,6 +31,7 @@
|
|
|
34
31
|
"CHANGELOG.md",
|
|
35
32
|
"LICENSE"
|
|
36
33
|
],
|
|
34
|
+
"type": "module",
|
|
37
35
|
"scripts": {
|
|
38
36
|
"docbridge": "bun run src/cli/index.ts",
|
|
39
37
|
"check": "bun run src/cli/index.ts check",
|
|
@@ -43,6 +41,12 @@
|
|
|
43
41
|
},
|
|
44
42
|
"devDependencies": {
|
|
45
43
|
"@types/bun": "^1.3.14",
|
|
44
|
+
"oxfmt": "0.57.0",
|
|
45
|
+
"oxlint": "1.73.0",
|
|
46
46
|
"typescript": "^5.9.0"
|
|
47
|
+
},
|
|
48
|
+
"engines": {
|
|
49
|
+
"bun": ">=1.1.31",
|
|
50
|
+
"node": ">=22"
|
|
47
51
|
}
|
|
48
52
|
}
|
|
@@ -11,7 +11,15 @@
|
|
|
11
11
|
"items": {
|
|
12
12
|
"type": "object",
|
|
13
13
|
"additionalProperties": false,
|
|
14
|
-
"required": [
|
|
14
|
+
"required": [
|
|
15
|
+
"endpoint",
|
|
16
|
+
"kind",
|
|
17
|
+
"filePath",
|
|
18
|
+
"startLine",
|
|
19
|
+
"endLine",
|
|
20
|
+
"linkedFrom",
|
|
21
|
+
"content"
|
|
22
|
+
],
|
|
15
23
|
"properties": {
|
|
16
24
|
"endpoint": {
|
|
17
25
|
"type": "string",
|
|
@@ -52,11 +52,11 @@ repo recipe such as `just check`, or
|
|
|
52
52
|
- After scope is confirmed and `docbridge.config.json` exists or has been
|
|
53
53
|
intentionally left unchanged, install the rest of the distributable
|
|
54
54
|
DocBridge skills for the same agent target.
|
|
55
|
-
- Prefer the project-native DocBridge invocation.
|
|
56
|
-
`docbridge init --yes --agent-target codex
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
`.agents/` and/or `.claude/` setup.
|
|
55
|
+
- Prefer the project-native DocBridge invocation. From the project root, run
|
|
56
|
+
`docbridge init --yes --agent-target codex` for Codex,
|
|
57
|
+
`docbridge init --yes --agent-target claude` for Claude Code, or
|
|
58
|
+
`docbridge init --yes --agent-target both` for both. Use the target that
|
|
59
|
+
matches the existing `.agents/` and/or `.claude/` setup.
|
|
60
60
|
- This command should leave an existing `docbridge.config.json` unchanged
|
|
61
61
|
and copy any missing `docbridge-annotate`, `docbridge-link`,
|
|
62
62
|
`docbridge-review`, and `docbridge-sync` skill directories. Do not use
|
|
@@ -37,6 +37,7 @@ section:
|
|
|
37
37
|
|
|
38
38
|
```md
|
|
39
39
|
<!-- @code src/auth/login.ts#login -->
|
|
40
|
+
|
|
40
41
|
## Login Spec
|
|
41
42
|
```
|
|
42
43
|
|
|
@@ -88,11 +89,11 @@ required. Optional text after the target is allowed and ignored
|
|
|
88
89
|
|
|
89
90
|
## Diagnosing check failures
|
|
90
91
|
|
|
91
|
-
| Diagnostic
|
|
92
|
-
|
|
|
93
|
-
| `doc_file_not_found` / `code_file_not_found`
|
|
94
|
-
| `doc_anchor_not_found`
|
|
95
|
-
| `doc_backlink_not_found` / `code_backlink_not_found` | one direction missing
|
|
96
|
-
| `unsupported_declaration`
|
|
97
|
-
| `dangling_code_annotation`
|
|
98
|
-
| `invalid_link_target`
|
|
92
|
+
| Diagnostic | Meaning | Usual fix |
|
|
93
|
+
| ---------------------------------------------------- | ------------------------------------ | ----------------------------------------------------- |
|
|
94
|
+
| `doc_file_not_found` / `code_file_not_found` | target file not in the managed set | fix the path, or extend `docbridge.config.json` globs |
|
|
95
|
+
| `doc_anchor_not_found` | file found, anchor wrong | regenerate the anchor from the exact heading text |
|
|
96
|
+
| `doc_backlink_not_found` / `code_backlink_not_found` | one direction missing | add the missing `@code` or `@doc` side |
|
|
97
|
+
| `unsupported_declaration` | `@doc` on an unsupported declaration | move the tag to a supported declaration |
|
|
98
|
+
| `dangling_code_annotation` | text between `@code` and the heading | move the comment directly above the heading |
|
|
99
|
+
| `invalid_link_target` | malformed `file#fragment` | rewrite the target per the rules above |
|
|
@@ -62,7 +62,7 @@ repo recipe such as `just related-gate`, or
|
|
|
62
62
|
the link; that defeats the graph the gate protects.
|
|
63
63
|
- Do not rubber-stamp: if the counterpart content was not read, the judgment
|
|
64
64
|
has no basis.
|
|
65
|
-
- Updating a spec section to match changed code is a
|
|
66
|
-
|
|
65
|
+
- Updating a spec section to match changed code is a _decision about the
|
|
66
|
+
contract_, not bookkeeping — when the change contradicts an explicit
|
|
67
67
|
documented promise, surface it to the user instead of quietly rewriting the
|
|
68
68
|
promise.
|