From f15fb2b475dc635086e94cd30edf1ce61f0bdd66 Mon Sep 17 00:00:00 2001 From: Virgil Date: Thu, 26 Mar 2026 11:31:34 +0000 Subject: [PATCH] docs: finish AX review follow-ups Co-Authored-By: Virgil --- CLAUDE.md | 2 +- cmd/testcmd/cmd_main.go | 7 ++++++- docs/development.md | 15 ++++++++------- docs/index.md | 8 ++++---- 4 files changed, 19 insertions(+), 13 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 811c7b8..7acf703 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -48,7 +48,7 @@ workspace file instead. | `dappco.re/go/core` | `../go` | Framework: `core.Crypt` interface, `io.Medium` | | `dappco.re/go/core/log` | `../go-log` | `coreerr.E()` contextual error wrapping | | `dappco.re/go/core/io` | `../go-io` | `io.Medium` storage abstraction | -| `forge.lthn.ai/core/go-store` | `../go-store` | SQLite KV store (session persistence) | +| `dappco.re/go/core/store` | `../go-store` | SQLite KV store (session persistence) | | `forge.lthn.ai/core/cli` | `../cli` | CLI framework for `cmd/crypt` commands | No C toolchain or CGo required — all crypto uses pure Go implementations. diff --git a/cmd/testcmd/cmd_main.go b/cmd/testcmd/cmd_main.go index ec98b5b..17892a1 100644 --- a/cmd/testcmd/cmd_main.go +++ b/cmd/testcmd/cmd_main.go @@ -20,7 +20,7 @@ var ( testCovLowStyle = cli.NewStyle().Foreground(cli.ColourRed500) ) -// Flag variables for test command +// Flag variables for test command. var ( testVerbose bool testCoverage bool @@ -31,10 +31,15 @@ var ( testJSON bool ) +// testCmd wraps `go test`, defaulting to `./...` and keeping coverage enabled +// so both human-readable and JSON summaries can report package coverage. var testCmd = &cli.Command{ Use: "test", Short: i18n.T("cmd.test.short"), Long: i18n.T("cmd.test.long"), + Example: ` core test + core test --pkg ./auth --run TestLogin_Good + core test --race --json`, RunE: func(cmd *cli.Command, args []string) error { return runTest(testVerbose, testCoverage, testShort, testPkg, testRun, testRace, testJSON) }, diff --git a/docs/development.md b/docs/development.md index 71a2cf9..c7964d9 100644 --- a/docs/development.md +++ b/docs/development.md @@ -9,8 +9,8 @@ description: How to build, test, and contribute to go-crypt. - **Go 1.26** or later (the module declares `go 1.26.0`). - A Go workspace (`go.work`) that resolves the local dependencies: - `forge.lthn.ai/core/go`, `forge.lthn.ai/core/go-store`, - `forge.lthn.ai/core/go-io`, `forge.lthn.ai/core/go-log`, and + `dappco.re/go/core`, `dappco.re/go/core/store`, + `dappco.re/go/core/io`, `dappco.re/go/core/log`, and `forge.lthn.ai/core/cli`. If you are working outside the full monorepo, create a `go.work` at the parent directory pointing to your local checkouts. @@ -211,16 +211,17 @@ HTTPS authentication is not configured for this repository. ## Local Dependencies -The `go.mod` depends on several `forge.lthn.ai/core/*` modules. These are +The `go.mod` depends on several `dappco.re/go/core/*` modules plus the +remaining `forge.lthn.ai/core/cli` dependency. These are resolved through the Go workspace (`~/Code/go.work`). Do not modify the replace directives in `go.mod` directly -- use the workspace file instead. | Module | Local Path | Purpose | |--------|-----------|---------| -| `forge.lthn.ai/core/go` | `../go` | Framework: `core.Crypt` interface, `io.Medium` | -| `forge.lthn.ai/core/go-store` | `../go-store` | SQLite KV store for session persistence | -| `forge.lthn.ai/core/go-io` | `../go-io` | `io.Medium` storage abstraction | -| `forge.lthn.ai/core/go-log` | `../go-log` | `core.E()` contextual error wrapping | +| `dappco.re/go/core` | `../go` | Framework: `core.Crypt` interface, `io.Medium` | +| `dappco.re/go/core/store` | `../go-store` | SQLite KV store for session persistence | +| `dappco.re/go/core/io` | `../go-io` | `io.Medium` storage abstraction | +| `dappco.re/go/core/log` | `../go-log` | `core.E()` contextual error wrapping | | `forge.lthn.ai/core/cli` | `../cli` | CLI framework for `cmd/crypt` commands | ## Known Limitations diff --git a/docs/index.md b/docs/index.md index 3916142..49db429 100644 --- a/docs/index.md +++ b/docs/index.md @@ -144,10 +144,10 @@ core crypt checksum myfile.txt --verify "abc123..." | Module | Role | |--------|------| -| `forge.lthn.ai/core/go` | Framework: `core.E` error helper, `core.Crypt` interface, `io.Medium` storage abstraction | -| `forge.lthn.ai/core/go-store` | SQLite KV store for persistent session storage | -| `forge.lthn.ai/core/go-io` | `io.Medium` interface used by the auth package | -| `forge.lthn.ai/core/go-log` | Contextual error wrapping via `core.E()` | +| `dappco.re/go/core` | Framework: `core.E` error helper, `core.Crypt` interface, `io.Medium` storage abstraction | +| `dappco.re/go/core/store` | SQLite KV store for persistent session storage | +| `dappco.re/go/core/io` | `io.Medium` interface used by the auth package | +| `dappco.re/go/core/log` | Contextual error wrapping via `core.E()` | | `forge.lthn.ai/core/cli` | CLI framework for the `cmd/crypt` commands | | `github.com/ProtonMail/go-crypto` | OpenPGP implementation (actively maintained, post-quantum research) | | `golang.org/x/crypto` | Argon2id, ChaCha20-Poly1305, scrypt, HKDF, bcrypt |