docbridge 0.12.0 → 0.13.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 +38 -1
- package/README.md +3 -3
- package/dist/bin/darwin-arm64/SHA256SUMS +3 -3
- package/dist/bin/darwin-arm64/docbridge-go-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 +2 -2
- package/dist/bin/linux-x64/docbridge-go-scanner +0 -0
- package/dist/bin/linux-x64/docbridge-swift-scanner +1 -1
- package/dist/index.js +199 -325
- package/dist/workers/java/docbridge-java-scanner.jar +0 -0
- package/docs/README.md +1 -1
- package/docs/user/configuration.md +37 -30
- package/docs/user/getting-started.md +1 -1
- package/docs/user/linking.md +28 -1
- package/docs/user/troubleshooting.md +16 -12
- package/package.json +1 -1
- package/schemas/context-output.schema.json +11 -1
- package/schemas/docbridge.schema.json +24 -1
- package/schemas/graph-output.schema.json +11 -1
package/CHANGELOG.md
CHANGED
|
@@ -7,6 +7,41 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
7
7
|
|
|
8
8
|
## [Unreleased]
|
|
9
9
|
|
|
10
|
+
## [0.13.1] - 2026-10-06
|
|
11
|
+
|
|
12
|
+
### Fixed
|
|
13
|
+
|
|
14
|
+
- A worker that a scan started no longer outlives the CLI. On POSIX systems
|
|
15
|
+
each worker runs in its own process group, a time or output limit kills the
|
|
16
|
+
whole group, and `check`, `related`, `context`, and `graph` kill their
|
|
17
|
+
running workers when the CLI receives `SIGINT`, `SIGTERM`, or `SIGHUP`
|
|
18
|
+
during a scan, then end by that signal. Before, a worker that ran past the
|
|
19
|
+
CLI, or a process the worker started, could keep running.
|
|
20
|
+
|
|
21
|
+
## [0.13.0] - 2026-10-01
|
|
22
|
+
|
|
23
|
+
### Added
|
|
24
|
+
|
|
25
|
+
- Java is a first-party code language. Configure `include.code.java` with
|
|
26
|
+
`.java` patterns and put `@doc` in the Javadoc comment of a class,
|
|
27
|
+
interface, enum, record, annotation type, method, constructor, field, or
|
|
28
|
+
enum constant. The bundled worker runs on the JDK 17 or later installed on
|
|
29
|
+
the machine, on any platform, and parses with the JDK's own `jdk.compiler`
|
|
30
|
+
module; it never compiles, loads, or runs project code. Canonical IDs are
|
|
31
|
+
dot-qualified without the package, and methods and constructors add their
|
|
32
|
+
parameter types (`AuthService.login(String,char[])`,
|
|
33
|
+
`AuthService.AuthService(Authenticator)`), so each overload is its own
|
|
34
|
+
endpoint. Visibility accepts `public`, `protected`, `package`, and
|
|
35
|
+
`private` and defaults to `public`; interface members without a modifier
|
|
36
|
+
are `public`. Projects that run `javadoc` with `-Xdoclint` register the tag
|
|
37
|
+
with `-tag doc:a:"DocBridge:"`.
|
|
38
|
+
- `scanners.java.command` or `DOCBRIDGE_JAVA_RUNTIME` names the JDK's `java`;
|
|
39
|
+
otherwise DocBridge uses `java` on `PATH`. A missing or too-old JDK, or a
|
|
40
|
+
Java runtime without `jdk.compiler` such as a JRE, is
|
|
41
|
+
`code_scanner_unavailable` naming what was found.
|
|
42
|
+
- The VS Code extension activates for Java files, and `docbridge init`
|
|
43
|
+
proposes `src/main/java` when it holds Java files, else `src`.
|
|
44
|
+
|
|
10
45
|
## [0.12.0] - 2026-10-01
|
|
11
46
|
|
|
12
47
|
### Added
|
|
@@ -523,7 +558,9 @@ Initial release of the SpecLink CLI.
|
|
|
523
558
|
- `speclink check` command with `--root`, `--json`, and `--audit` options.
|
|
524
559
|
- `speclink --version` (alias `-v`) and `speclink --help` (alias `-h`).
|
|
525
560
|
|
|
526
|
-
[Unreleased]: https://github.com/salan70/docbridge/compare/v0.
|
|
561
|
+
[Unreleased]: https://github.com/salan70/docbridge/compare/v0.13.1...HEAD
|
|
562
|
+
[0.13.1]: https://github.com/salan70/docbridge/releases/tag/v0.13.1
|
|
563
|
+
[0.13.0]: https://github.com/salan70/docbridge/releases/tag/v0.13.0
|
|
527
564
|
[0.12.0]: https://github.com/salan70/docbridge/releases/tag/v0.12.0
|
|
528
565
|
[0.11.0]: https://github.com/salan70/docbridge/releases/tag/v0.11.0
|
|
529
566
|
[0.10.1]: https://github.com/salan70/docbridge/releases/tag/v0.10.1
|
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
|
-
JavaScript, Swift, Dart, Rust, Go, Python, and
|
|
9
|
+
JavaScript, Swift, Dart, Rust, Go, Python, Ruby, and Java declarations against
|
|
10
10
|
`@code` annotations on Markdown headings, so humans and coding agents can find the right counterpart before a
|
|
11
11
|
change drifts.
|
|
12
12
|
|
|
@@ -16,8 +16,8 @@ change drifts.
|
|
|
16
16
|
- A project containing Markdown and supported source files
|
|
17
17
|
|
|
18
18
|
Prebuilt Swift, Dart, Rust, and Go scanners are included for `darwin-arm64` and
|
|
19
|
-
`linux-x64`. Python and
|
|
20
|
-
or later on the machine, on any platform. See
|
|
19
|
+
`linux-x64`. Python, Ruby, and Java projects need CPython 3.10 or later,
|
|
20
|
+
CRuby 3.3 or later, or a JDK 17 or later on the machine, on any platform. See
|
|
21
21
|
[Languages](docs/user/configuration.md#languages) for each language's file
|
|
22
22
|
extensions, visibility defaults, and scanner.
|
|
23
23
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
41027ff70b494c96a27c0a4e373a070b47222323d0fb8941f4e694eeaa2f2ad9 docbridge-swift-scanner
|
|
2
|
+
42e6858926db804a07efc8b370b0744e9b23c691b8a363461e5286115c7950ef docbridge_dart_scanner
|
|
3
3
|
7fc3e6842b3e1bf425b8fd63e241eee7e64875f16be7ba8d1ae4a25baa7f2338 docbridge-rust-scanner
|
|
4
|
-
|
|
4
|
+
720b5a88fda4a2ffd10660bae19dd5070989fbe5c9463421a180f17bb50b7915 docbridge-go-scanner
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
3f2005f4df20fcf6001111724eac5a9ece412edb5457e3450bd67420e85ba8e3 docbridge-swift-scanner
|
|
2
2
|
b75b14006ca792ed3ca8faf7ceee9e4d33c895f27dd416b640818cf8a4bdd9c8 docbridge_dart_scanner
|
|
3
3
|
e0da7b8cc6ee23704f5fe8514cc309f0bb60380c77b55e3bc5ed113abd1f3478 docbridge-rust-scanner
|
|
4
|
-
|
|
4
|
+
2b8820630246507cdaca9de288dc8a0eb5d870db36287cf8ffd6ec31ce13b328 docbridge-go-scanner
|
|
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
3
|
size: 40932352 bytes
|
|
4
|
-
sha256:
|
|
4
|
+
sha256: 3f2005f4df20fcf6001111724eac5a9ece412edb5457e3450bd67420e85ba8e3
|