docbridge 0.11.0 → 0.13.0

package/CHANGELOG.md

@@ -7,6 +7,84 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.13.0] - 2026-10-01
+
+### Added
+
+- Java is a first-party code language. Configure `include.code.java` with
+  `.java` patterns and put `@doc` in the Javadoc comment of a class,
+  interface, enum, record, annotation type, method, constructor, field, or
+  enum constant. The bundled worker runs on the JDK 17 or later installed on
+  the machine, on any platform, and parses with the JDK's own `jdk.compiler`
+  module; it never compiles, loads, or runs project code. Canonical IDs are
+  dot-qualified without the package, and methods and constructors add their
+  parameter types (`AuthService.login(String,char[])`,
+  `AuthService.AuthService(Authenticator)`), so each overload is its own
+  endpoint. Visibility accepts `public`, `protected`, `package`, and
+  `private` and defaults to `public`; interface members without a modifier
+  are `public`. Projects that run `javadoc` with `-Xdoclint` register the tag
+  with `-tag doc:a:"DocBridge:"`.
+- `scanners.java.command` or `DOCBRIDGE_JAVA_RUNTIME` names the JDK's `java`;
+  otherwise DocBridge uses `java` on `PATH`. A missing or too-old JDK, or a
+  Java runtime without `jdk.compiler` such as a JRE, is
+  `code_scanner_unavailable` naming what was found.
+- The VS Code extension activates for Java files, and `docbridge init`
+  proposes `src/main/java` when it holds Java files, else `src`.
+
+## [0.12.0] - 2026-10-01
+
+### Added
+
+- JavaScript is a first-party code language. Configure
+  `include.code.javascript` with `.js`, `.jsx`, `.mjs`, or `.cjs` patterns and
+  put `@doc` in the JSDoc comment of an exported declaration or a member of an
+  exported class. The built-in TypeScript scanner reads these files, so the
+  declarations, canonical IDs, and `visibility` values match TypeScript, and
+  JSX parses in every JavaScript file. CommonJS assignments such as
+  `module.exports = ...` are not endpoints; an `@doc` on one is
+  `unsupported_declaration`.
+- `include.code.typescript` accepts `.tsx`, `.mts`, and `.cts` patterns, and
+  `.d.mts` and `.d.cts` declaration files are skipped like `.d.ts`. JSX parses
+  in `.tsx` files, and hover and `context` fence their declarations as `tsx`.
+- Python is a first-party code language. Configure `include.code.python` and
+  put `@doc` in the docstring of a `def`, `async def`, or `class`, or in the
+  `#` comment block above it. The bundled worker runs on the CPython 3.10 or
+  later installed on the machine, on any platform, and parses with the
+  standard library alone; it never imports project code. Canonical IDs are
+  dot-qualified (`AuthService.login`), and a property's accessors and an
+  `@overload` group each share one endpoint. Visibility defaults to `public`;
+  `private` adds names that start with `_`.
+- Ruby is a first-party code language. Configure `include.code.ruby` and put
+  `@doc` in the `#` comment block above a `class`, `module`, constant, or
+  method. The bundled worker runs on the CRuby 3.3 or later installed on the
+  machine with its bundled Prism parser. Canonical IDs use `::` between
+  constants and `.` before a method (`Auth::Service.login`, and
+  `Auth::Service.self.build` for a singleton method). Visibility follows
+  `private`, `protected`, and `public` calls and defaults to `public`.
+- An optional top-level `scanners` key names the interpreter that runs the
+  Python or Ruby worker, for example
+  `"scanners": { "python": { "command": ["/opt/py/bin/python3"] } }`. Without
+  it, `DOCBRIDGE_PYTHON_RUNTIME` or `DOCBRIDGE_RUBY_RUNTIME` can name one, and
+  otherwise DocBridge tries `python3` and then `python` (`py -3` and then
+  `python` on Windows), and `ruby`, on `PATH`. A missing or too-old interpreter
+  is `code_scanner_unavailable` naming what was found, and a configured
+  interpreter is never replaced by another.
+- The VS Code extension activates for JavaScript, JavaScript React, Python,
+  and Ruby files. `docbridge init` proposes JavaScript and TypeScript source
+  roots for every suffix, `src/` and each top-level Python package, and Ruby's
+  `lib/` and `app/`.
+
+### Changed
+
+- A scan sends every file of a worker-backed language to its scanner in one
+  request instead of starting a process per file, which speeds up checking
+  large Swift, Dart, Rust, and Go projects. A failed request reports its
+  diagnostic on every file it carried, and each request may run for 30
+  seconds plus 1 second per file.
+- The editor language server rescans in the background: it keeps answering
+  hover, definition, and references from the last completed scan, rescans only
+  files that changed, and drops a scan that a newer edit made stale.
+
 ## [0.11.0] - 2026-09-30
 
 ### Added
@@ -469,7 +547,9 @@ Initial release of the SpecLink CLI.
 - `speclink check` command with `--root`, `--json`, and `--audit` options.
 - `speclink --version` (alias `-v`) and `speclink --help` (alias `-h`).
 
-[Unreleased]: https://github.com/salan70/docbridge/compare/v0.11.0...HEAD
+[Unreleased]: https://github.com/salan70/docbridge/compare/v0.13.0...HEAD
+[0.13.0]: https://github.com/salan70/docbridge/releases/tag/v0.13.0
+[0.12.0]: https://github.com/salan70/docbridge/releases/tag/v0.12.0
 [0.11.0]: https://github.com/salan70/docbridge/releases/tag/v0.11.0
 [0.10.1]: https://github.com/salan70/docbridge/releases/tag/v0.10.1
 [0.10.0]: https://github.com/salan70/docbridge/releases/tag/v0.10.0

package/README.md

@@ -6,8 +6,8 @@
 
 DocBridge keeps Markdown documentation and the code that implements it linked
 in both directions. It validates `@doc` annotations on supported TypeScript,
-Swift, Dart, Rust, and Go declarations against `@code` annotations on Markdown
-headings, so humans and coding agents can find the right counterpart before a
+JavaScript, Swift, Dart, Rust, Go, Python, Ruby, and Java declarations against
+`@code` annotations on Markdown headings, so humans and coding agents can find the right counterpart before a
 change drifts.
 
 ## Requirements
@@ -15,9 +15,11 @@ change drifts.
 - Node.js 22 or later, or Bun 1.1.31 or later
 - A project containing Markdown and supported source files
 
-Prebuilt Swift, Dart, Rust, and Go scanners are included for supported macOS and
-Linux platforms. See [Releases](https://github.com/salan70/docbridge/releases)
-for packaged-platform details.
+Prebuilt Swift, Dart, Rust, and Go scanners are included for `darwin-arm64` and
+`linux-x64`. Python, Ruby, and Java projects need CPython 3.10 or later,
+CRuby 3.3 or later, or a JDK 17 or later on the machine, on any platform. See
+[Languages](docs/user/configuration.md#languages) for each language's file
+extensions, visibility defaults, and scanner.
 
 ## Install
 
@@ -41,7 +43,8 @@ Create a starting configuration interactively:
 npx docbridge init
 ```
 
-Or write the minimal TypeScript configuration yourself:
+Or write the minimal TypeScript configuration yourself as
+`docbridge.config.json` in the project root:
 
 ```json
 {
@@ -57,14 +60,15 @@ Or write the minimal TypeScript configuration yourself:
 }
 ```
 
-Add a documentation target to a supported declaration:
+Add a documentation target to a supported declaration in `src/auth.ts`:
 
 ```ts
 /** @doc docs/auth.md#login-flow */
 export function login(): void {}
 ```
 
-Add the reciprocal code target immediately before the Markdown heading:
+Add the reciprocal code target immediately before the heading in
+`docs/auth.md`:
 
 ```md
 <!-- @code src/auth.ts#login -->
@@ -79,7 +83,8 @@ npx docbridge check
 ```
 
 A valid graph exits `0`. Invalid configuration, unresolved targets, and missing
-backlinks produce diagnostics and exit `1`.
+backlinks produce diagnostics and exit `1`. Paths in annotations are relative
+to the project root, and each file must match a configured pattern.
 
 ## Choose the next guide
 
@@ -96,6 +101,8 @@ backlinks produce diagnostics and exit `1`.
 - [Automation](docs/user/automation.md) — coding agents, Git hooks, and CI
 - [Troubleshooting](docs/user/troubleshooting.md) — diagnose configuration,
   scanning, and link failures
+- [Examples](examples/) — one small project per supported language
+- [Changelog](CHANGELOG.md) — release history
 - [日本語ドキュメント](docs/ja/README.md)
 
 The CLI ships the English task guides with its own version. Run

package/dist/bin/darwin-arm64/SHA256SUMS

@@ -1,4 +1,4 @@
-5db695997d6c32f0fd69722d43aabacd38b0ca67ce46f3f80160aff132d9b5d1  docbridge-swift-scanner
-f0218c70949d7fae587d0e208cf9e959ff51fae4bceb7d60b92325c65723af37  docbridge_dart_scanner
+bb2e127396b445a443c6d9958430b9af7e992ecca54cac49ce8feb88c199f460  docbridge-swift-scanner
+32032f9e2c703f4ab4976361f15f723a58c675545edce90fdc673d3094fe154e  docbridge_dart_scanner
 7fc3e6842b3e1bf425b8fd63e241eee7e64875f16be7ba8d1ae4a25baa7f2338  docbridge-rust-scanner
-2779c979bd91996bd0075afbed097fe7c9e2bf71ec331073a09b305e6a8ac510  docbridge-go-scanner
+1a7160cf70cb6ff1517d72685b6ecbfe1878ed1fed013fef706e5f2405ddbce0  docbridge-go-scanner

package/dist/bin/linux-x64/SHA256SUMS

@@ -1,4 +1,4 @@
-ce42be3326a3c7fa127709edbca34056f9e5eda8af3dba1623b51a1c41050328  docbridge-swift-scanner
+6e78c1c79c16572ed0759bfcf24ddd4cc77c7d1d699d19dc0279a9abca38d248  docbridge-swift-scanner
 b75b14006ca792ed3ca8faf7ceee9e4d33c895f27dd416b640818cf8a4bdd9c8  docbridge_dart_scanner
 e0da7b8cc6ee23704f5fe8514cc309f0bb60380c77b55e3bc5ed113abd1f3478  docbridge-rust-scanner
-4b8b52ff6c806bdd7096afcce59fb05dcdf1cb27a3c5f0ffc8f1908a01085194  docbridge-go-scanner
+af845c263f65cc5db5beb01b4f4f7251ce449391986b4e288c03abfa04f7e708  docbridge-go-scanner

package/dist/bin/linux-x64/docbridge-swift-scanner

@@ -1,4 +1,4 @@
 [diffend] Oversized file quarantined before diffing.
 name: package/dist/bin/linux-x64/docbridge-swift-scanner
 size: 40932352 bytes
-sha256: ce42be3326a3c7fa127709edbca34056f9e5eda8af3dba1623b51a1c41050328
+sha256: 6e78c1c79c16572ed0759bfcf24ddd4cc77c7d1d699d19dc0279a9abca38d248