docbridge 0.10.0 → 0.11.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/CHANGELOG.md +39 -1
- package/README.md +2 -2
- package/dist/bin/darwin-arm64/SHA256SUMS +4 -3
- package/dist/bin/darwin-arm64/docbridge-go-scanner +0 -0
- package/dist/bin/darwin-arm64/docbridge-rust-scanner +0 -0
- package/dist/bin/darwin-arm64/docbridge-swift-scanner +0 -0
- package/dist/bin/darwin-arm64/docbridge_dart_scanner +0 -0
- package/dist/bin/linux-x64/SHA256SUMS +4 -3
- package/dist/bin/linux-x64/docbridge-go-scanner +0 -0
- package/dist/bin/linux-x64/docbridge-rust-scanner +0 -0
- package/dist/bin/linux-x64/docbridge-swift-scanner +2 -2
- package/dist/bin/linux-x64/docbridge_dart_scanner +0 -0
- package/dist/index.js +15689 -15628
- package/docs/user/automation.md +2 -2
- package/docs/user/commands.md +4 -4
- package/docs/user/configuration.md +12 -7
- package/docs/user/getting-started.md +1 -1
- package/docs/user/linking.md +29 -3
- package/docs/user/troubleshooting.md +6 -4
- package/package.json +1 -1
- package/schemas/common-output.schema.json +1 -1
- package/schemas/context-output.schema.json +1 -1
- package/schemas/docbridge.schema.json +24 -1
- package/schemas/graph-output.schema.json +1 -1
- package/schemas/scanner-worker.schema.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -7,6 +7,42 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
7
7
|
|
|
8
8
|
## [Unreleased]
|
|
9
9
|
|
|
10
|
+
## [0.11.0] - 2026-09-30
|
|
11
|
+
|
|
12
|
+
### Added
|
|
13
|
+
|
|
14
|
+
- Go is a first-party code language. Configure `include.code.go`, put `@doc`
|
|
15
|
+
in the doc comment of a package-level `func`, `type`, `const`, or `var`, a
|
|
16
|
+
receiver method, or an interface method, and link back with `@code`. The
|
|
17
|
+
bundled `docbridge-go-scanner` worker (same platforms as Swift, Dart, and
|
|
18
|
+
Rust) uses the Go standard library parser only. Visibility defaults to
|
|
19
|
+
`exported`; `unexported` opts in unexported names, and a method is exported
|
|
20
|
+
only when both its name and its receiver or interface type name are.
|
|
21
|
+
Canonical IDs use `Type.Method` without type parameters. An `@doc` above a
|
|
22
|
+
`const (` / `var (` / `type (` group keyword or above a spec that declares
|
|
23
|
+
several names is `unsupported_declaration`. The VS Code extension activates
|
|
24
|
+
for Go files, and `docbridge init` proposes the conventional `cmd/`,
|
|
25
|
+
`internal/`, and `pkg/` layout.
|
|
26
|
+
|
|
27
|
+
## [0.10.1] - 2026-09-28
|
|
28
|
+
|
|
29
|
+
### Fixed
|
|
30
|
+
|
|
31
|
+
- `code_parse_error` for Swift, Dart, and Rust files now points at the first
|
|
32
|
+
syntax error the parser found and includes the parser's message. Before, it
|
|
33
|
+
always pointed at line 1, column 1 with a generic message.
|
|
34
|
+
- TypeScript link diagnostics such as `duplicate_link`, `doc_file_not_found`,
|
|
35
|
+
and `doc_backlink_not_found` now point at the `@doc` target that caused
|
|
36
|
+
them, as they already did for Swift, Dart, and Rust. Before, they pointed at
|
|
37
|
+
the declaration below the comment. TypeScript symbols now report the start
|
|
38
|
+
of their name, matching the other languages.
|
|
39
|
+
- Editor hover from a Markdown heading shows the linked declaration's whole
|
|
40
|
+
signature without its doc comment, fenced in the declaration's language.
|
|
41
|
+
Before, it showed only one line, always fenced as TypeScript.
|
|
42
|
+
- `context`, `graph --include-content`, and hover no longer include text past
|
|
43
|
+
the end of a declaration that starts mid-line and ends on the same line,
|
|
44
|
+
such as a declaration after a one-line doc comment followed by its body.
|
|
45
|
+
|
|
10
46
|
## [0.10.0] - 2026-09-28
|
|
11
47
|
|
|
12
48
|
### Changed
|
|
@@ -433,7 +469,9 @@ Initial release of the SpecLink CLI.
|
|
|
433
469
|
- `speclink check` command with `--root`, `--json`, and `--audit` options.
|
|
434
470
|
- `speclink --version` (alias `-v`) and `speclink --help` (alias `-h`).
|
|
435
471
|
|
|
436
|
-
[Unreleased]: https://github.com/salan70/docbridge/compare/v0.
|
|
472
|
+
[Unreleased]: https://github.com/salan70/docbridge/compare/v0.11.0...HEAD
|
|
473
|
+
[0.11.0]: https://github.com/salan70/docbridge/releases/tag/v0.11.0
|
|
474
|
+
[0.10.1]: https://github.com/salan70/docbridge/releases/tag/v0.10.1
|
|
437
475
|
[0.10.0]: https://github.com/salan70/docbridge/releases/tag/v0.10.0
|
|
438
476
|
[0.9.0]: https://github.com/salan70/docbridge/releases/tag/v0.9.0
|
|
439
477
|
[0.8.0]: https://github.com/salan70/docbridge/releases/tag/v0.8.0
|
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
DocBridge keeps Markdown documentation and the code that implements it linked
|
|
8
8
|
in both directions. It validates `@doc` annotations on supported TypeScript,
|
|
9
|
-
Swift, Dart, and
|
|
9
|
+
Swift, Dart, Rust, and Go declarations against `@code` annotations on Markdown
|
|
10
10
|
headings, so humans and coding agents can find the right counterpart before a
|
|
11
11
|
change drifts.
|
|
12
12
|
|
|
@@ -15,7 +15,7 @@ change drifts.
|
|
|
15
15
|
- Node.js 22 or later, or Bun 1.1.31 or later
|
|
16
16
|
- A project containing Markdown and supported source files
|
|
17
17
|
|
|
18
|
-
Prebuilt Swift, Dart, and
|
|
18
|
+
Prebuilt Swift, Dart, Rust, and Go scanners are included for supported macOS and
|
|
19
19
|
Linux platforms. See [Releases](https://github.com/salan70/docbridge/releases)
|
|
20
20
|
for packaged-platform details.
|
|
21
21
|
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
5db695997d6c32f0fd69722d43aabacd38b0ca67ce46f3f80160aff132d9b5d1 docbridge-swift-scanner
|
|
2
|
+
f0218c70949d7fae587d0e208cf9e959ff51fae4bceb7d60b92325c65723af37 docbridge_dart_scanner
|
|
3
|
+
7fc3e6842b3e1bf425b8fd63e241eee7e64875f16be7ba8d1ae4a25baa7f2338 docbridge-rust-scanner
|
|
4
|
+
2779c979bd91996bd0075afbed097fe7c9e2bf71ec331073a09b305e6a8ac510 docbridge-go-scanner
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
ce42be3326a3c7fa127709edbca34056f9e5eda8af3dba1623b51a1c41050328 docbridge-swift-scanner
|
|
2
|
+
b75b14006ca792ed3ca8faf7ceee9e4d33c895f27dd416b640818cf8a4bdd9c8 docbridge_dart_scanner
|
|
3
|
+
e0da7b8cc6ee23704f5fe8514cc309f0bb60380c77b55e3bc5ed113abd1f3478 docbridge-rust-scanner
|
|
4
|
+
4b8b52ff6c806bdd7096afcce59fb05dcdf1cb27a3c5f0ffc8f1908a01085194 docbridge-go-scanner
|
|
Binary file
|
|
Binary file
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
[diffend] Oversized file quarantined before diffing.
|
|
2
2
|
name: package/dist/bin/linux-x64/docbridge-swift-scanner
|
|
3
|
-
size:
|
|
4
|
-
sha256:
|
|
3
|
+
size: 40932352 bytes
|
|
4
|
+
sha256: ce42be3326a3c7fa127709edbca34056f9e5eda8af3dba1623b51a1c41050328
|
|
Binary file
|