You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 0eecf13
Browse filesBrowse the repository at this point in the historyBrowse files
📝 Let the README's commands be watched rather than swallowed
The runnable Development section was written against contracts that had not
landed. It declared a root `<Output />` because that was the only way a text
root could fail, ran every task `silent` because a rendered transcript was the
alternative to nothing, and redirected the changed-test report to /dev/null
because a journaled report of this repository's own scanner fixtures is
refused.
All three are merged now. #453 settles an uncaught failure at any text root, so
fail-fast needs no region. #441 forwards a command's output as it is produced
and displays each byte once, so an ordinary `exec` block shows a build or a
test run the way typing the command does. #442 keeps nothing without
`--journal`, so there is no retained report for the gate to scan and no reason
to discard one.
So the section says what it now does: the commands stream, the exit status
still decides, and `timeout=30m` still bounds the complete battery. The
regression that pinned "a successful target renders nothing" is replaced by the
one worth having — each command's output reaches the reader exactly once, in
order — and RM12 now proves a credential-shaped report reaches the reader
unscanned rather than proving a redirection hid it.
Copy file name to clipboardExpand all lines: README.md
+13-19Lines changed: 13 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,5 @@
1
1
# executable.md
2
2
3
-
<Output />
4
-
5
3
**executable.md** treats markdown documents as executable workflows. A document can expand markdown components, execute annotated code blocks, and evaluate in-process [Effection](https://frontside.com/effection) operations while staying a valid, readable markdown file in any viewer.
6
4
7
5
The command-line tool is called **`xmd`** (eXecutable MarkDown).
@@ -347,7 +345,7 @@ deno task xmd run README.md#Development/Verification/Complete # setup, then the
347
345
Preparing a checkout is common to all of them, so it lives here rather than in
348
346
each one, and runs before whichever heading you selected:
349
347
350
-
```bashsilent exec
348
+
```bash exec
351
349
deno task setup
352
350
```
353
351
@@ -377,9 +375,11 @@ restarted by invoking the target again, subject to each low-level command's own
377
375
idempotence.
378
376
379
377
A command that exits nonzero ends the document there: the blocks after it and
380
-
the sections beside it do not run, and `xmd run` exits nonzero. A run that
381
-
succeeds prints nothing, because these blocks are `silent` — the exit status is
382
-
the result.
378
+
the sections beside it do not run, and `xmd run` exits nonzero. Until then each
379
+
command's output reaches you as it is produced, exactly as it would if you had
380
+
typed the command yourself — you watch a build or a test run, you do not wait
381
+
for a transcript of one. Nothing is kept: without `--journal` the run records a
382
+
command's exit status and never accumulates its output.
383
383
384
384
`xmd run` is how these sections are meant to be entered. `xmd test README.md`
385
385
also executes this document — that command runs a document while looking for
@@ -411,7 +411,7 @@ changing a dependency.
411
411
Compiles the standalone `xmd` binary into `dist/`, after building the browser
412
412
bundle it embeds:
413
413
414
-
```bashsilent exec
414
+
```bash exec
415
415
deno task build
416
416
```
417
417
@@ -425,28 +425,22 @@ The short loop: lint and format, typecheck, the JSR publishability dry run, and
425
425
the tests this branch and worktree affect. Each command is its own block, so the
426
426
first one to fail is where the document stops.
427
427
428
-
```bashsilent exec
428
+
```bash exec
429
429
deno task lint
430
430
```
431
431
432
-
```bashsilent exec
432
+
```bash exec
433
433
deno task check
434
434
```
435
435
436
-
```bashsilent exec
436
+
```bash exec
437
437
deno task check:jsr
438
438
```
439
439
440
-
```bashsilent exec
441
-
deno task test --changed=origin/main>/dev/null
440
+
```bash exec
441
+
deno task test --changed=origin/main
442
442
```
443
443
444
-
The redirection is the block's, not the task's: a test report is long and this
445
-
repository's fixtures deliberately resemble credentials, so the report is
446
-
discarded rather than journaled and scanned. The exit status, stderr and failure
447
-
diagnostics are untouched, and `deno task test --changed=origin/main` on its own
448
-
still prints the complete report.
449
-
450
444
`deno task verify:focused` is the shorthand that enters this target:
451
445
452
446
```bash
@@ -458,7 +452,7 @@ deno task verify:focused
458
452
The whole applicable battery at once, which also fails if any of it leaves a
0 commit comments