Skip to content

Commit 63dd349

Browse files
committed
Tidy up @fedify/fixture docs
Drop the misleading deno.json snippet from the fixture README: the workspace already resolves @fedify/fixture from the in-tree source at the repository root, so contributors do not need to add an `imports` entry, and showing one suggested otherwise. Scope the LogTape buffering note to Deno, since the Bun and Node.js dispatchers do not configure LogTape, and replace the two separate `LOG=always` invocations with the single `mise run test:deno` form that contributors actually use. Fix the JSR reference link to point at jsr.io (the canonical host) rather than the jsr.dev redirect. Drop the gratuitous spaces around the slash separating `TestSpanExporter` and `createTestTracerProvider()` in CONTRIBUTING.md so the pair reads as a single label. Assisted-by: Claude Code:claude-opus-4-7
1 parent a4a18a5 commit 63dd349

2 files changed

Lines changed: 12 additions & 21 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ add or modify a unit test:
190190
- `mockDocumentLoader()`: A document loader that resolves
191191
ActivityPub/JSON-LD URLs from on-disk fixtures under
192192
*packages/fixture/src/fixtures/* instead of issuing real HTTP requests.
193-
- `TestSpanExporter` / `createTestTracerProvider()`: Helpers for asserting
193+
- `TestSpanExporter`/`createTestTracerProvider()`: Helpers for asserting
194194
on OpenTelemetry spans and events recorded by the code under test.
195195

196196
See *[packages/fixture/README.md]* for the full API, fixture layout, and

packages/fixture/README.md

Lines changed: 11 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -37,19 +37,11 @@ dependency to the package that needs it:
3737
}
3838
~~~~
3939

40-
~~~~ jsonc
41-
// packages/<your-package>/deno.json
42-
{
43-
"imports": {
44-
"@fedify/fixture": "jsr:@fedify/fixture@^2.0.0"
45-
}
46-
}
47-
~~~~
48-
4940
For Deno, the `imports` entry resolves to the in-tree source through the
50-
workspace at the repository root. For Node.js and Bun, pnpm links the local
51-
package by virtue of the `workspace:` specifier; remember to run
52-
`mise run install` (or `pnpm install`) at the repository root after the edit.
41+
workspace at the repository root, so you don't need to add it to *deno.json*.
42+
For Node.js and Bun, pnpm links the local package by virtue of the `workspace:`
43+
specifier; remember to run `mise run install` (or `pnpm install`) at the
44+
repository root after the edit.
5345

5446

5547
Usage
@@ -106,15 +98,14 @@ test("nested steps", async (t) => {
10698

10799
#### Logging behavior
108100

109-
`test()` configures [LogTape] before every test and resets it afterwards.
110-
By default log records are captured in memory and only flushed to the console
111-
if the test throws — this keeps successful runs quiet. Set the environment
112-
variable `LOG=always` to stream every log record to stdout regardless of test
113-
outcome, which is useful when you are debugging a flaky test:
101+
On Deno, `test()` configures [LogTape] before every test and resets it
102+
afterwards. By default log records are captured in memory and only flushed to
103+
the console if the test throws — this keeps successful runs quiet. Set the
104+
environment variable `LOG=always` to stream every log record to stdout
105+
regardless of test outcome, which is useful when you are debugging a flaky test:
114106

115107
~~~~ bash
116-
LOG=always deno task test
117-
LOG=always pnpm test
108+
LOG=always mise run test:deno
118109
~~~~
119110

120111
[`Deno.test()`]: https://docs.deno.com/api/deno/~/Deno.test
@@ -307,7 +298,7 @@ Genuinely justified exceptions can be added to the `ALLOWLIST` constant in
307298
together with an inline comment explaining why.
308299

309300
[npm]: https://www.npmjs.com/
310-
[JSR]: https://jsr.dev/
301+
[JSR]: https://jsr.io/
311302

312303

313304
Repository layout

0 commit comments

Comments
 (0)