docbridge 0.6.0 → 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 +30 -1
- package/README.md +7 -104
- 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 +319 -257
- package/package.json +23 -21
- 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/CHANGELOG.md
CHANGED
|
@@ -7,6 +7,34 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
7
7
|
|
|
8
8
|
## [Unreleased]
|
|
9
9
|
|
|
10
|
+
## [0.6.1] - 2026-07-27
|
|
11
|
+
|
|
12
|
+
### Changed
|
|
13
|
+
|
|
14
|
+
- The related-gate CI recipe in `docs/integrations/ci.md` now derives the PR
|
|
15
|
+
changed-file list from the checkout (`git diff BASE...HEAD` with
|
|
16
|
+
`fetch-depth: 0`) and falls back to a retried GitHub API call. Outcomes are
|
|
17
|
+
reported as `clean`, `violation`, or `infra-error`, and the sticky comment
|
|
18
|
+
updates on every outcome (including infrastructure failure). Adopters who
|
|
19
|
+
copied the previous recipe must re-copy it and set `fetch-depth: 0` on the
|
|
20
|
+
checkout step; a shallow checkout breaks the new primary path.
|
|
21
|
+
- Shipped Swift and Dart scanner executables are now named
|
|
22
|
+
`docbridge-swift-scanner` and `docbridge_dart_scanner`. Paths under
|
|
23
|
+
`dist/bin/<platform>/speclink-*` no longer exist; delete `chmod +x`
|
|
24
|
+
workarounds that hard-coded those names rather than updating the paths.
|
|
25
|
+
|
|
26
|
+
### Fixed
|
|
27
|
+
|
|
28
|
+
- Bundled Swift and Dart scanner binaries no longer have to be executable at
|
|
29
|
+
install time. Installers do not reliably preserve the executable bit on files
|
|
30
|
+
under `dist/bin/`, which made `docbridge check` fail on every Swift or Dart
|
|
31
|
+
project; DocBridge now restores the bit on its own bundled scanners when the
|
|
32
|
+
current process cannot execute them. Consumers can remove `chmod +x`
|
|
33
|
+
workarounds from their build recipes. When the bit cannot be restored, or when
|
|
34
|
+
the binary is executable but the filesystem refuses to execute it as a
|
|
35
|
+
`noexec` mount does, `code_scanner_unavailable` now names the cause and the
|
|
36
|
+
remedy instead of surfacing a bare spawn error.
|
|
37
|
+
|
|
10
38
|
## [0.6.0] - 2026-07-13
|
|
11
39
|
|
|
12
40
|
### Added
|
|
@@ -194,7 +222,8 @@ Initial release of the SpecLink CLI.
|
|
|
194
222
|
- `speclink check` command with `--root`, `--json`, and `--audit` options.
|
|
195
223
|
- `speclink --version` (alias `-v`) and `speclink --help` (alias `-h`).
|
|
196
224
|
|
|
197
|
-
[Unreleased]: https://github.com/salan70/docbridge/compare/v0.6.
|
|
225
|
+
[Unreleased]: https://github.com/salan70/docbridge/compare/v0.6.1...HEAD
|
|
226
|
+
[0.6.1]: https://github.com/salan70/docbridge/releases/tag/v0.6.1
|
|
198
227
|
[0.6.0]: https://github.com/salan70/docbridge/releases/tag/v0.6.0
|
|
199
228
|
[0.5.2]: https://github.com/salan70/docbridge/releases/tag/v0.5.2
|
|
200
229
|
[0.5.1]: https://github.com/salan70/docbridge/releases/tag/v0.5.1
|
package/README.md
CHANGED
|
@@ -84,6 +84,7 @@ Add the backlink in the Markdown file:
|
|
|
84
84
|
|
|
85
85
|
```md
|
|
86
86
|
<!-- @code src/auth/login.ts#login -->
|
|
87
|
+
|
|
87
88
|
## Login Spec
|
|
88
89
|
|
|
89
90
|
Login flow specification.
|
|
@@ -228,6 +229,7 @@ public struct AuthService {
|
|
|
228
229
|
|
|
229
230
|
```md
|
|
230
231
|
<!-- @code Sources/AuthService.swift#AuthService.login(email:password:) -->
|
|
232
|
+
|
|
231
233
|
## Login Spec
|
|
232
234
|
```
|
|
233
235
|
|
|
@@ -351,114 +353,14 @@ Exit code policy:
|
|
|
351
353
|
- `1` when any error exists
|
|
352
354
|
- `0` when there are only warnings or no diagnostics
|
|
353
355
|
|
|
354
|
-
##
|
|
355
|
-
|
|
356
|
-
### Prerequisites
|
|
357
|
-
|
|
358
|
-
Recommended:
|
|
359
|
-
|
|
360
|
-
- Nix
|
|
361
|
-
- direnv
|
|
362
|
-
|
|
363
|
-
The Nix development shell provides the tools used by this repository:
|
|
364
|
-
|
|
365
|
-
- Bun
|
|
366
|
-
- just
|
|
367
|
-
- Git
|
|
368
|
-
- Dart SDK
|
|
369
|
-
|
|
370
|
-
If you do not use Nix, install Bun and just locally before running the project
|
|
371
|
-
commands. Swift scanner development also requires a Swift 6 toolchain on
|
|
372
|
-
`PATH`; CI installs Swift separately from Nix.
|
|
373
|
-
|
|
374
|
-
### Setup
|
|
375
|
-
|
|
376
|
-
Enable the development environment with direnv:
|
|
377
|
-
|
|
378
|
-
```sh
|
|
379
|
-
direnv allow
|
|
380
|
-
```
|
|
381
|
-
|
|
382
|
-
Or enter the Nix development shell manually:
|
|
383
|
-
|
|
384
|
-
```sh
|
|
385
|
-
nix develop
|
|
386
|
-
```
|
|
387
|
-
|
|
388
|
-
Install dependencies:
|
|
389
|
-
|
|
390
|
-
```sh
|
|
391
|
-
bun install --frozen-lockfile
|
|
392
|
-
```
|
|
393
|
-
|
|
394
|
-
Install repository Git hooks:
|
|
395
|
-
|
|
396
|
-
```sh
|
|
397
|
-
just install-git-hooks
|
|
398
|
-
```
|
|
399
|
-
|
|
400
|
-
If `just` is not on `PATH` yet, run:
|
|
401
|
-
|
|
402
|
-
```sh
|
|
403
|
-
nix develop -c just install-git-hooks
|
|
404
|
-
```
|
|
405
|
-
|
|
406
|
-
The pre-commit hook runs `just check` and `just test`.
|
|
407
|
-
|
|
408
|
-
### Common Tasks
|
|
409
|
-
|
|
410
|
-
Run common tasks with `just`:
|
|
411
|
-
|
|
412
|
-
```sh
|
|
413
|
-
just --list
|
|
414
|
-
just check
|
|
415
|
-
just check-example
|
|
416
|
-
just check-swift-example
|
|
417
|
-
just check-dart-example
|
|
418
|
-
just check-fixture <code>
|
|
419
|
-
just audit
|
|
420
|
-
just related-gate
|
|
421
|
-
just test
|
|
422
|
-
just test-swift-scanner
|
|
423
|
-
just test-dart-scanner
|
|
424
|
-
just build
|
|
425
|
-
just verify-dist
|
|
426
|
-
```
|
|
427
|
-
|
|
428
|
-
`just check`, `just test`, and `just build` are the default local and CI gates.
|
|
429
|
-
`just test` includes TypeScript, Swift, and Dart end-to-end integration tests;
|
|
430
|
-
the Swift and Dart scanner binaries must be built before those integration
|
|
431
|
-
tests can spawn them. Scanner-native tests are mandatory in CI and are useful
|
|
432
|
-
locally when changing worker code. `just verify-dist` builds confidence in the
|
|
433
|
-
npm entry point by checking the Bun shebang, executable bit, `--version`,
|
|
434
|
-
`--help`, and a TypeScript example check from `dist/index.js`.
|
|
435
|
-
|
|
436
|
-
### Project Constraints
|
|
437
|
-
|
|
438
|
-
Runtime:
|
|
439
|
-
|
|
440
|
-
- Bun
|
|
441
|
-
|
|
442
|
-
Language:
|
|
443
|
-
|
|
444
|
-
- TypeScript
|
|
445
|
-
- Swift scanner worker package
|
|
446
|
-
- Dart scanner worker package
|
|
447
|
-
|
|
448
|
-
Task runner:
|
|
449
|
-
|
|
450
|
-
- just
|
|
451
|
-
|
|
452
|
-
Environment loader:
|
|
453
|
-
|
|
454
|
-
- direnv
|
|
356
|
+
## Contributing
|
|
455
357
|
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
inside their worker packages.
|
|
358
|
+
See [CONTRIBUTING.md](CONTRIBUTING.md) for the pinned development environment,
|
|
359
|
+
repository setup, testing matrix, commit convention, and pull request workflow.
|
|
459
360
|
|
|
460
361
|
## Documentation
|
|
461
362
|
|
|
363
|
+
- Contributor guide: [CONTRIBUTING.md](CONTRIBUTING.md)
|
|
462
364
|
- Japanese documentation: [docs/ja/README.md](docs/ja/README.md)
|
|
463
365
|
- Specifications: [docs/specs](docs/specs)
|
|
464
366
|
- v0.1 decisions: [docs/decisions/v0.1.md](docs/decisions/v0.1.md)
|
|
@@ -466,6 +368,7 @@ inside their worker packages.
|
|
|
466
368
|
- v0.3 decisions: [docs/decisions/v0.3.md](docs/decisions/v0.3.md)
|
|
467
369
|
- AI agent integration recipes: [docs/integrations](docs/integrations)
|
|
468
370
|
- Commit message convention: [docs/contributing/commits.md](docs/contributing/commits.md)
|
|
371
|
+
- Pull request convention: [docs/contributing/pull-requests.md](docs/contributing/pull-requests.md)
|
|
469
372
|
- Testing convention: [docs/contributing/testing.md](docs/contributing/testing.md)
|
|
470
373
|
|
|
471
374
|
## Roadmap
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
e5dc0117b9afe4e617fac20f9a8cf9797fa307f66d5a3f12e8ea6554639adce3 docbridge-swift-scanner
|
|
2
|
+
8268ae8b1d3329a96ce30590c8f177b0c19ea1a887a458647e04d8d295c74a71 docbridge_dart_scanner
|
|
Binary file
|
|
Binary file
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
396d365794cb5c427817b358bb3d9f2280000cd33fe3fc7d6d5a772a29ebcae4 docbridge-swift-scanner
|
|
2
|
+
b5de2b74d56c6d8c9f8edd859d4b0d8846ff32d8e1d50b6fa41683d9a310b9f5 docbridge_dart_scanner
|
|
Binary file
|
|
Binary file
|