Skip to content

Explain the layers of a run in the README to close #796 - #807

Merged
mathiasrw merged 1 commit into
mainfrom
fix/796
Oct 23, 2026
Merged

mathiasrw merged 1 commit into
mainfrom
fix/796

Conversation

@mathiasrw

Copy link
Copy Markdown
Owner

Closes #796

Stacked on #806.

Change

A new README section, "Hairy details", just before "Test". It is built on the layers of a run: each layer is optional, and works on what the layer before gives it, so the flags work together by their order.

  • On the way in: the pattern (3 layers), the replacement (5 layers) and the files (7 layers), each with small examples that were run to get the output. The replacement shows how -R, --js and --replacement-file stack.
  • On the way out: what is printed and where (a table of stdout and stderr), the delimiters and tails, --nl, the quiet and verbose flags, the status report, and the exit codes.
  • Other details: --rename and --rename-path, what --output-match turns off, and when the files are handled one at a time.

The devguide has a short "Layers" part: use the layers to understand a run, to write tests, and to challenge new flags.

Tests

Only docs. yarn test-format passes.

@mathiasrw
mathiasrw added this pull request to stack #787 October 23, 2026 09:45
@mathiasrw
mathiasrw force-pushed the fix/796 branch 5 times, most recently from 280bb85 to a4da6e2 Compare October 23, 2026 10:11
@mathiasrw
mathiasrw force-pushed the fix/796 branch 3 times, most recently from 36322cf to cbaf233 Compare October 23, 2026 10:49
Base automatically changed from fix/799 to main October 23, 2026 10:51
@mathiasrw
mathiasrw merged commit a69a719 into main Oct 23, 2026
6 of 7 checks passed
@mathiasrw
mathiasrw deleted the fix/796 branch October 23, 2026 11:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Explain the layers and the hairy details of how flags combine in the README

1 participant