Release 1.5.1: drop the last dependency, add a help system, correct the docs - #13
Merged
Merged
Conversation
…he docs Remove the `undici-types` runtime dependency. Nothing imported it, but npm installed it with every copy of the package, which made "zero-dependency" a claim rather than a fact. Installing flare-redact now adds exactly one package. TypeScript consumers are unaffected: the type it existed to satisfy comes from their own @types/node. Add `flare-redact help [topic]`. Ten topics — detectors, modes, vault, scan, files, gateway, library, sdks, env and exit-codes — answer the question behind the flag rather than restating the flag. Any detector id is also a topic, an unknown name suggests the nearest one instead of failing with nothing to go on, and unresolved help goes to stderr so it never pollutes a piped report. Bare `help` now works on the gateway too, and an unknown flag on either CLI points at it. Correct the documentation. The Python and Rust engines are not on PyPI or crates.io, so the README, both SDK READMEs and `help sdks` were giving install commands that fail; they now give the repository installs that work, and say why. The README badge claimed 56 detectors where there are 82, the CI example and the docs site still pinned 1.4.1, and the playground bundle was still the 1.4.x build. Verified: 354 Node tests, 87 Python, 18 Go, 19 Rust, go vet, clippy -D warnings, the spec drift and conformance checks, all three example smokes, and a TypeScript consumer compiling against a clean install of the packed tarball with zero transitive packages.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Zero dependencies, for real this time
package.jsondeclaredundici-typesas a runtime dependency, sonpm install flare-redactpulled a package down with every copy — while theREADME carried a "dependencies 0" badge and the description said
"Zero-dependency". Nothing in
src/ever imported it.It is gone. A clean install now brings exactly one package, and a TypeScript
consumer still compiles: the type it existed to satisfy comes from the
consumer's own
@types/node, which is where it belonged.The npm package also carries no Python, Go or Rust code — the
fileslist neverincluded
sdk/, and this PR says so explicitly in the README so nobody has tocheck.
A CLI that answers questions
flare-redact help [topic]. A flag list tells you a flag exists and nothingabout when to reach for it, so there are ten topics that explain the thing
behind the flag:
detectors,modes,vault,scan,files,gateway,library,sdks,env,exit-codes.Any detector id is a topic too —
flare-redact help emailgives what it finds,whether it runs by default, its tags, and how to select or drop it. A name that
matches nothing suggests the nearest one rather than failing with nothing to go
on, goes to stderr, and exits 2 so it never lands in a piped report.
flare-gateway helpandflare-redact gateway helpnow work alongside--help, and an unknown flag on either CLI points at the help instead of onlycomplaining.
Documentation that was wrong
pip install flare-redactandflare-redact = "1.5"were documented in the README, both SDK READMEs and therelease notes, but neither package is on PyPI or crates.io — both return 404.
Replaced with the repository installs, which are now tested end to end:
pip installfrom the git subdirectory imports and redacts, and a Cargo gitdependency builds and runs. The Go module was and remains installable with
go get.bundle on the docs site was still the 1.4.x build. All three now track the
release, and the docs-site test that pinned the old label was updated with
them.
bin/flare-gateway.mjswas committed without the executable bit thatbin/flare-redact.mjshas.Verification
go vet,clippy --all-targets -D warningsnpm ci,npm audit,npm pack, and a TypeScript consumer compiling against a clean install of the tarball