docs(adr): fix ADR-011 module table and pin it with a contract test#964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Chemaclass merged 2 commits into from
Aug 2, 2026
Merged

docs(adr): fix ADR-011 module table and pin it with a contract test #964

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c37f33d
docs(adr): fix ADR-011 module table and pin it with a contract test
Chemaclass Aug 2, 2026
0649988
fix(test): enumerate src/ with find so the Bash 3.0 container can run…
Chemaclass Aug 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 25 additions & 17 deletions adrs/adr-011-source-layout-and-build-pipeline.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,27 +44,35 @@ statement. That is load-bearing, not stylistic — see the build section — and

## The modules

Seventeen, in the order the `bashunit` entrypoint sources them. The order is the dependency
layering: leaves first.
Seventeen, in load order. The order is the dependency layering: leaves first.

| # | Module | Files | Lines | Owns |
|---|---|---|---|---|
| 1 | `dev/` | 1 | 18 | debug helpers; **excluded from the build** |
| 2 | `system/` | 4 | 192 | capability probing: OS, `command -v`, small I/O |
| 3 | `util/` | 4 | 476 | computation: strings, arithmetic, time |
| 4 | `api/` | 5 | 207 | the surface a user's test file calls (except assertions) |
| 5 | `config/` | 4 | 964 | `BASHUNIT_*` defaults, scratch dirs, parallel mode, rerun cache |
| 6 | `coverage/` | 13 | 2644 | line/branch tracking and the four report formats |
| 7 | `state/` | 6 | 477 | counters, per-test context, result payload, parallel aggregation |
| 8 | `console/` | 9 | 1281 | everything printed: palette, header, per-test lines, totals |
| 9 | `helper/` | 8 | 976 | naming, discovery, data providers, tags, encoding |
| 10 | `cli/` | 5 | 447 | the `doc`/`init`/`upgrade`/`watch` subcommand implementations |
| 11 | `assert/` | 11 | 2336 | every assertion |
| 12 | `reports/` | 7 | 467 | JUnit, TAP, JSON, GHA and HTML writers |
| 13 | `runner/` | 11 | 2172 | the file loop, per-test execution, retry, result parsing |
| 14 | `benchmark/` | 4 | 221 | the bench implementation (`runner/bench.sh` is its loop) |
| 15 | `learn/` | 5 | 240 | the interactive tutorial |
| 16 | `main/` | 8 | 1475 | flag parsing per subcommand and the run lifecycle |
| 2 | `system/` | 4 | 189 | capability probing: OS, `command -v`, small I/O |
| 3 | `util/` | 4 | 474 | computation: strings, arithmetic, time |
| 4 | `api/` | 5 | 205 | the surface a user's test file calls (except assertions) |
| 5 | `config/` | 4 | 961 | `BASHUNIT_*` defaults, scratch dirs, parallel mode, rerun cache |
| 6 | `coverage/` | 13 | 2640 | line/branch tracking and the four report formats |
| 7 | `state/` | 6 | 474 | counters, per-test context, result payload, parallel aggregation |
| 8 | `console/` | 9 | 1278 | everything printed: palette, header, per-test lines, totals |
| 9 | `helper/` | 8 | 948 | naming, discovery, data providers, tags, encoding |
| 10 | `cli/` | 5 | 445 | the `doc`/`init`/`upgrade`/`watch` subcommand implementations |
| 11 | `assert/` | 11 | 2326 | every assertion |
| 12 | `doubles/` | 4 | 505 | spies and mocks — **sourced by `assert/index.sh`, not the entrypoint** |
| 13 | `reports/` | 7 | 465 | JUnit, TAP, JSON, GHA and HTML writers |
| 14 | `runner/` | 11 | 2190 | the file loop, per-test execution, retry, result parsing |
| 15 | `benchmark/` | 4 | 219 | the bench implementation (`runner/bench.sh` is its loop) |
| 16 | `learn/` | 14 | 1296 | the interactive tutorial (9 of those files are `learn/lessons/`) |
| 17 | `main/` | 8 | 1473 | flag parsing per subcommand and the run lifecycle |

The file counts sum to 118, which is every `.sh` file in `src/` — that is the check to re-run
when editing this table, because both of its previous errors came from counting the wrong way.
`doubles/` was absent entirely: the table was generated from the entrypoint's `source` lines,
and `doubles/` is the one module the entrypoint does not source, so it fell through while the
prose above said "seventeen" from a directory count. And `learn/` was listed as 5 files / 240
lines because a one-level `src/learn/*.sh` glob does not descend into `learn/lessons/` — the
same one-level-glob mistake that `Makefile:67` made with nested tests. Count from the tree.

Namespaces track directories: `src/runner/` holds `bashunit::runner::*`. Two exceptions are
deliberate — `assert/` holds bare `assert_*` (the public API is unprefixed) and `console/`
Expand Down
4 changes: 4 additions & 0 deletions docs/project-overview.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,12 +34,16 @@ point holding **only `source` lines** — the code lives in the sibling files be
| `helper` | naming, test discovery, data providers, tags, encoding |
| `cli` | the `doc`, `init`, `upgrade` and `watch` subcommands |
| `assert` | every assertion |
| `doubles` | spies and mocks |
| `reports` | JUnit, TAP, JSON, GitHub Actions and HTML writers |
| `runner` | the file loop, per-test execution, retry, result parsing |
| `benchmark` | the bench implementation |
| `learn` | the interactive tutorial |
| `main` | flag parsing per subcommand and the run lifecycle |

There is also a `dev` module holding debug helpers, which is deliberately excluded from the
built binary.

The released `bashunit` is a **single file**: `build.sh` walks the `source` statements from the
entrypoint, inlines every module in dependency order, and strips the `source` lines.

Expand Down
61 changes: 61 additions & 0 deletions tests/unit/project/adr_module_table_test.sh
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
#!/usr/bin/env bash

# Anti-drift contract for ADR-011's module table.
#
# That table has been wrong twice, both times because it was counted with a
# one-level glob rather than from the tree:
#
# * `doubles/` was missing outright. The table was generated from the
# entrypoint's `source` lines, and `doubles/` is the one module the
# entrypoint does not source -- `assert/index.sh` does -- so it fell through
# while the prose above it said "seventeen" from a directory count.
# * `learn/` was listed at 5 files / 240 lines because `src/learn/*.sh` does
# not descend into `learn/lessons/`, which holds 9 more files.
#
# Neither is visible to a human reading the ADR, which is what makes a test the
# right tool. Checking the file counts *sum* to `src/` catches an under-count in
# any single row without pinning every number to an exact value.

ADR=""
ROOT_DIR=""

function set_up_before_script() {
ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/../../.." && pwd)"
ADR="$ROOT_DIR/adrs/adr-011-source-layout-and-build-pipeline.md"
}

# Without this, renaming the ADR would make every other assertion here compare
# empty output against empty output and pass while checking nothing -- the
# failure mode that let a layering contract rot unnoticed in #946.
function test_the_adr_being_checked_exists() {
assert_file_exists "$ADR"
}

function adr_table_modules() {
grep -E '^\| [0-9]+ \| `[a-z]+/`' "$ADR" |
sed 's/^| *[0-9]* *| *`\([a-z]*\)\/` *|.*/\1/' | LC_ALL=C sort
}

# Enumerated with `find`, not `git ls-files`: the Bash 3.0 jobs run in a container
# where git refuses to read the repo (dubious-ownership), so `git ls-files` exits
# non-zero and yields nothing -- which reads here as "src/ has no modules" and
# fails for a reason that has nothing to do with the ADR.
function src_modules() {
(cd "$ROOT_DIR" && find src -name '*.sh' | cut -d/ -f2 | LC_ALL=C sort -u)
}

function test_every_src_module_has_a_row_in_the_adr_table() {
assert_same "$(src_modules)" "$(adr_table_modules)"
}

function adr_table_file_total() {
grep -E '^\| [0-9]+ \| `[a-z]+/`' "$ADR" | awk -F'|' '{ sum += $4 } END { print sum + 0 }'
}

function src_file_total() {
(cd "$ROOT_DIR" && find src -name '*.sh' | wc -l | tr -d ' ')
}

function test_adr_table_file_counts_account_for_every_src_file() {
assert_same "$(src_file_total)" "$(adr_table_file_total)"
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
docs(adr): fix ADR-011 module table and pin it with a contract test#964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Chemaclass
merged 2 commits into

from

Aug 2, 2026
 Merged


docs(adr): fix ADR-011 module table and pin it with a contract test
#964
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
c37f33d

docs(adr): fix ADR-011 module table and pin it with a contract test


Chemaclass Aug 2, 2026
0649988

fix(test): enumerate src/ with find so the Bash 3.0 container can run…


Chemaclass Aug 2, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


42 changes: 25 additions & 17 deletions
adrs/adr-011-source-layout-and-build-pipeline.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,27 +44,35 @@ statement. That is load-bearing, not stylistic — see the build section — and

## The modules

Seventeen, in the order the `bashunit` entrypoint sources them. The order is the dependency
layering: leaves first.
Seventeen, in load order. The order is the dependency layering: leaves first.

| # | Module | Files | Lines | Owns |
|---|---|---|---|---|
| 1 | `dev/` | 1 | 18 | debug helpers; **excluded from the build** |
| 2 | `system/` | 4 | 192 | capability probing: OS, `command -v`, small I/O |
| 3 | `util/` | 4 | 476 | computation: strings, arithmetic, time |
| 4 | `api/` | 5 | 207 | the surface a user's test file calls (except assertions) |
| 5 | `config/` | 4 | 964 | `BASHUNIT_*` defaults, scratch dirs, parallel mode, rerun cache |
| 6 | `coverage/` | 13 | 2644 | line/branch tracking and the four report formats |
| 7 | `state/` | 6 | 477 | counters, per-test context, result payload, parallel aggregation |
| 8 | `console/` | 9 | 1281 | everything printed: palette, header, per-test lines, totals |
| 9 | `helper/` | 8 | 976 | naming, discovery, data providers, tags, encoding |
| 10 | `cli/` | 5 | 447 | the `doc`/`init`/`upgrade`/`watch` subcommand implementations |
| 11 | `assert/` | 11 | 2336 | every assertion |
| 12 | `reports/` | 7 | 467 | JUnit, TAP, JSON, GHA and HTML writers |
| 13 | `runner/` | 11 | 2172 | the file loop, per-test execution, retry, result parsing |
| 14 | `benchmark/` | 4 | 221 | the bench implementation (`runner/bench.sh` is its loop) |
| 15 | `learn/` | 5 | 240 | the interactive tutorial |
| 16 | `main/` | 8 | 1475 | flag parsing per subcommand and the run lifecycle |
| 2 | `system/` | 4 | 189 | capability probing: OS, `command -v`, small I/O |
| 3 | `util/` | 4 | 474 | computation: strings, arithmetic, time |
| 4 | `api/` | 5 | 205 | the surface a user's test file calls (except assertions) |
| 5 | `config/` | 4 | 961 | `BASHUNIT_*` defaults, scratch dirs, parallel mode, rerun cache |
| 6 | `coverage/` | 13 | 2640 | line/branch tracking and the four report formats |
| 7 | `state/` | 6 | 474 | counters, per-test context, result payload, parallel aggregation |
| 8 | `console/` | 9 | 1278 | everything printed: palette, header, per-test lines, totals |
| 9 | `helper/` | 8 | 948 | naming, discovery, data providers, tags, encoding |
| 10 | `cli/` | 5 | 445 | the `doc`/`init`/`upgrade`/`watch` subcommand implementations |
| 11 | `assert/` | 11 | 2326 | every assertion |
| 12 | `doubles/` | 4 | 505 | spies and mocks — **sourced by `assert/index.sh`, not the entrypoint** |
| 13 | `reports/` | 7 | 465 | JUnit, TAP, JSON, GHA and HTML writers |
| 14 | `runner/` | 11 | 2190 | the file loop, per-test execution, retry, result parsing |
| 15 | `benchmark/` | 4 | 219 | the bench implementation (`runner/bench.sh` is its loop) |
| 16 | `learn/` | 14 | 1296 | the interactive tutorial (9 of those files are `learn/lessons/`) |
| 17 | `main/` | 8 | 1473 | flag parsing per subcommand and the run lifecycle |

The file counts sum to 118, which is every `.sh` file in `src/` — that is the check to re-run
when editing this table, because both of its previous errors came from counting the wrong way.
`doubles/` was absent entirely: the table was generated from the entrypoint's `source` lines,
and `doubles/` is the one module the entrypoint does not source, so it fell through while the
prose above said "seventeen" from a directory count. And `learn/` was listed as 5 files / 240
lines because a one-level `src/learn/*.sh` glob does not descend into `learn/lessons/` — the
same one-level-glob mistake that `Makefile:67` made with nested tests. Count from the tree.

Namespaces track directories: `src/runner/` holds `bashunit::runner::*`. Two exceptions are
deliberate — `assert/` holds bare `assert_*` (the public API is unprefixed) and `console/`
Expand Down

4 changes: 4 additions & 0 deletions
docs/project-overview.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,12 +34,16 @@ point holding **only `source` lines** — the code lives in the sibling files be
| `helper` | naming, test discovery, data providers, tags, encoding |
| `cli` | the `doc`, `init`, `upgrade` and `watch` subcommands |
| `assert` | every assertion |
| `doubles` | spies and mocks |
| `reports` | JUnit, TAP, JSON, GitHub Actions and HTML writers |
| `runner` | the file loop, per-test execution, retry, result parsing |
| `benchmark` | the bench implementation |
| `learn` | the interactive tutorial |
| `main` | flag parsing per subcommand and the run lifecycle |

There is also a `dev` module holding debug helpers, which is deliberately excluded from the
built binary.

The released `bashunit` is a **single file**: `build.sh` walks the `source` statements from the
entrypoint, inlines every module in dependency order, and strips the `source` lines.

Expand Down

61 changes: 61 additions & 0 deletions
tests/unit/project/adr_module_table_test.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
#!/usr/bin/env bash

# Anti-drift contract for ADR-011's module table.
#
# That table has been wrong twice, both times because it was counted with a
# one-level glob rather than from the tree:
#
# * `doubles/` was missing outright. The table was generated from the
# entrypoint's `source` lines, and `doubles/` is the one module the
# entrypoint does not source -- `assert/index.sh` does -- so it fell through
# while the prose above it said "seventeen" from a directory count.
# * `learn/` was listed at 5 files / 240 lines because `src/learn/*.sh` does
# not descend into `learn/lessons/`, which holds 9 more files.
#
# Neither is visible to a human reading the ADR, which is what makes a test the
# right tool. Checking the file counts *sum* to `src/` catches an under-count in
# any single row without pinning every number to an exact value.

ADR=""
ROOT_DIR=""

function set_up_before_script() {
 ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/../../.." && pwd)"
 ADR="$ROOT_DIR/adrs/adr-011-source-layout-and-build-pipeline.md"
}

# Without this, renaming the ADR would make every other assertion here compare
# empty output against empty output and pass while checking nothing -- the
# failure mode that let a layering contract rot unnoticed in #946.
function test_the_adr_being_checked_exists() {
 assert_file_exists "$ADR"
}

function adr_table_modules() {
 grep -E '^\| [0-9]+ \| `[a-z]+/`' "$ADR" |
 sed 's/^| *[0-9]* *| *`\([a-z]*\)\/` *|.*/\1/' | LC_ALL=C sort
}

# Enumerated with `find`, not `git ls-files`: the Bash 3.0 jobs run in a container
# where git refuses to read the repo (dubious-ownership), so `git ls-files` exits
# non-zero and yields nothing -- which reads here as "src/ has no modules" and
# fails for a reason that has nothing to do with the ADR.
function src_modules() {
 (cd "$ROOT_DIR" && find src -name '*.sh' | cut -d/ -f2 | LC_ALL=C sort -u)
}

function test_every_src_module_has_a_row_in_the_adr_table() {
 assert_same "$(src_modules)" "$(adr_table_modules)"
}

function adr_table_file_total() {
 grep -E '^\| [0-9]+ \| `[a-z]+/`' "$ADR" | awk -F'|' '{ sum += $4 } END { print sum + 0 }'
}

function src_file_total() {
 (cd "$ROOT_DIR" && find src -name '*.sh' | wc -l | tr -d ' ')
}

function test_adr_table_file_counts_account_for_every_src_file() {
 assert_same "$(src_file_total)" "$(adr_table_file_total)"
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs(adr): fix ADR-011 module table and pin it with a contract test#964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Chemaclass
merged 2 commits into

from

Aug 2, 2026
 Merged


docs(adr): fix ADR-011 module table and pin it with a contract test
#964
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
c37f33d

docs(adr): fix ADR-011 module table and pin it with a contract test


Chemaclass Aug 2, 2026
0649988

fix(test): enumerate src/ with find so the Bash 3.0 container can run…


Chemaclass Aug 2, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


42 changes: 25 additions & 17 deletions
adrs/adr-011-source-layout-and-build-pipeline.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,27 +44,35 @@ statement. That is load-bearing, not stylistic — see the build section — and

## The modules

Seventeen, in the order the `bashunit` entrypoint sources them. The order is the dependency
layering: leaves first.
Seventeen, in load order. The order is the dependency layering: leaves first.

| # | Module | Files | Lines | Owns |
|---|---|---|---|---|
| 1 | `dev/` | 1 | 18 | debug helpers; **excluded from the build** |
| 2 | `system/` | 4 | 192 | capability probing: OS, `command -v`, small I/O |
| 3 | `util/` | 4 | 476 | computation: strings, arithmetic, time |
| 4 | `api/` | 5 | 207 | the surface a user's test file calls (except assertions) |
| 5 | `config/` | 4 | 964 | `BASHUNIT_*` defaults, scratch dirs, parallel mode, rerun cache |
| 6 | `coverage/` | 13 | 2644 | line/branch tracking and the four report formats |
| 7 | `state/` | 6 | 477 | counters, per-test context, result payload, parallel aggregation |
| 8 | `console/` | 9 | 1281 | everything printed: palette, header, per-test lines, totals |
| 9 | `helper/` | 8 | 976 | naming, discovery, data providers, tags, encoding |
| 10 | `cli/` | 5 | 447 | the `doc`/`init`/`upgrade`/`watch` subcommand implementations |
| 11 | `assert/` | 11 | 2336 | every assertion |
| 12 | `reports/` | 7 | 467 | JUnit, TAP, JSON, GHA and HTML writers |
| 13 | `runner/` | 11 | 2172 | the file loop, per-test execution, retry, result parsing |
| 14 | `benchmark/` | 4 | 221 | the bench implementation (`runner/bench.sh` is its loop) |
| 15 | `learn/` | 5 | 240 | the interactive tutorial |
| 16 | `main/` | 8 | 1475 | flag parsing per subcommand and the run lifecycle |
| 2 | `system/` | 4 | 189 | capability probing: OS, `command -v`, small I/O |
| 3 | `util/` | 4 | 474 | computation: strings, arithmetic, time |
| 4 | `api/` | 5 | 205 | the surface a user's test file calls (except assertions) |
| 5 | `config/` | 4 | 961 | `BASHUNIT_*` defaults, scratch dirs, parallel mode, rerun cache |
| 6 | `coverage/` | 13 | 2640 | line/branch tracking and the four report formats |
| 7 | `state/` | 6 | 474 | counters, per-test context, result payload, parallel aggregation |
| 8 | `console/` | 9 | 1278 | everything printed: palette, header, per-test lines, totals |
| 9 | `helper/` | 8 | 948 | naming, discovery, data providers, tags, encoding |
| 10 | `cli/` | 5 | 445 | the `doc`/`init`/`upgrade`/`watch` subcommand implementations |
| 11 | `assert/` | 11 | 2326 | every assertion |
| 12 | `doubles/` | 4 | 505 | spies and mocks — **sourced by `assert/index.sh`, not the entrypoint** |
| 13 | `reports/` | 7 | 465 | JUnit, TAP, JSON, GHA and HTML writers |
| 14 | `runner/` | 11 | 2190 | the file loop, per-test execution, retry, result parsing |
| 15 | `benchmark/` | 4 | 219 | the bench implementation (`runner/bench.sh` is its loop) |
| 16 | `learn/` | 14 | 1296 | the interactive tutorial (9 of those files are `learn/lessons/`) |
| 17 | `main/` | 8 | 1473 | flag parsing per subcommand and the run lifecycle |

The file counts sum to 118, which is every `.sh` file in `src/` — that is the check to re-run
when editing this table, because both of its previous errors came from counting the wrong way.
`doubles/` was absent entirely: the table was generated from the entrypoint's `source` lines,
and `doubles/` is the one module the entrypoint does not source, so it fell through while the
prose above said "seventeen" from a directory count. And `learn/` was listed as 5 files / 240
lines because a one-level `src/learn/*.sh` glob does not descend into `learn/lessons/` — the
same one-level-glob mistake that `Makefile:67` made with nested tests. Count from the tree.

Namespaces track directories: `src/runner/` holds `bashunit::runner::*`. Two exceptions are
deliberate — `assert/` holds bare `assert_*` (the public API is unprefixed) and `console/`
Expand Down

4 changes: 4 additions & 0 deletions
docs/project-overview.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,12 +34,16 @@ point holding **only `source` lines** — the code lives in the sibling files be
| `helper` | naming, test discovery, data providers, tags, encoding |
| `cli` | the `doc`, `init`, `upgrade` and `watch` subcommands |
| `assert` | every assertion |
| `doubles` | spies and mocks |
| `reports` | JUnit, TAP, JSON, GitHub Actions and HTML writers |
| `runner` | the file loop, per-test execution, retry, result parsing |
| `benchmark` | the bench implementation |
| `learn` | the interactive tutorial |
| `main` | flag parsing per subcommand and the run lifecycle |

There is also a `dev` module holding debug helpers, which is deliberately excluded from the
built binary.

The released `bashunit` is a **single file**: `build.sh` walks the `source` statements from the
entrypoint, inlines every module in dependency order, and strips the `source` lines.

Expand Down

61 changes: 61 additions & 0 deletions
tests/unit/project/adr_module_table_test.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
#!/usr/bin/env bash

# Anti-drift contract for ADR-011's module table.
#
# That table has been wrong twice, both times because it was counted with a
# one-level glob rather than from the tree:
#
# * `doubles/` was missing outright. The table was generated from the
# entrypoint's `source` lines, and `doubles/` is the one module the
# entrypoint does not source -- `assert/index.sh` does -- so it fell through
# while the prose above it said "seventeen" from a directory count.
# * `learn/` was listed at 5 files / 240 lines because `src/learn/*.sh` does
# not descend into `learn/lessons/`, which holds 9 more files.
#
# Neither is visible to a human reading the ADR, which is what makes a test the
# right tool. Checking the file counts *sum* to `src/` catches an under-count in
# any single row without pinning every number to an exact value.

ADR=""
ROOT_DIR=""

function set_up_before_script() {
 ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/../../.." && pwd)"
 ADR="$ROOT_DIR/adrs/adr-011-source-layout-and-build-pipeline.md"
}

# Without this, renaming the ADR would make every other assertion here compare
# empty output against empty output and pass while checking nothing -- the
# failure mode that let a layering contract rot unnoticed in #946.
function test_the_adr_being_checked_exists() {
 assert_file_exists "$ADR"
}

function adr_table_modules() {
 grep -E '^\| [0-9]+ \| `[a-z]+/`' "$ADR" |
 sed 's/^| *[0-9]* *| *`\([a-z]*\)\/` *|.*/\1/' | LC_ALL=C sort
}

# Enumerated with `find`, not `git ls-files`: the Bash 3.0 jobs run in a container
# where git refuses to read the repo (dubious-ownership), so `git ls-files` exits
# non-zero and yields nothing -- which reads here as "src/ has no modules" and
# fails for a reason that has nothing to do with the ADR.
function src_modules() {
 (cd "$ROOT_DIR" && find src -name '*.sh' | cut -d/ -f2 | LC_ALL=C sort -u)
}

function test_every_src_module_has_a_row_in_the_adr_table() {
 assert_same "$(src_modules)" "$(adr_table_modules)"
}

function adr_table_file_total() {
 grep -E '^\| [0-9]+ \| `[a-z]+/`' "$ADR" | awk -F'|' '{ sum += $4 } END { print sum + 0 }'
}

function src_file_total() {
 (cd "$ROOT_DIR" && find src -name '*.sh' | wc -l | tr -d ' ')
}

function test_adr_table_file_counts_account_for_every_src_file() {
 assert_same "$(src_file_total)" "$(adr_table_file_total)"
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs(adr): fix ADR-011 module table and pin it with a contract test#964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Chemaclass
merged 2 commits into

from

Aug 2, 2026
 Merged


docs(adr): fix ADR-011 module table and pin it with a contract test
#964
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
c37f33d

docs(adr): fix ADR-011 module table and pin it with a contract test


Chemaclass Aug 2, 2026
0649988

fix(test): enumerate src/ with find so the Bash 3.0 container can run…


Chemaclass Aug 2, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


42 changes: 25 additions & 17 deletions
adrs/adr-011-source-layout-and-build-pipeline.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,27 +44,35 @@ statement. That is load-bearing, not stylistic — see the build section — and

## The modules

Seventeen, in the order the `bashunit` entrypoint sources them. The order is the dependency
layering: leaves first.
Seventeen, in load order. The order is the dependency layering: leaves first.

| # | Module | Files | Lines | Owns |
|---|---|---|---|---|
| 1 | `dev/` | 1 | 18 | debug helpers; **excluded from the build** |
| 2 | `system/` | 4 | 192 | capability probing: OS, `command -v`, small I/O |
| 3 | `util/` | 4 | 476 | computation: strings, arithmetic, time |
| 4 | `api/` | 5 | 207 | the surface a user's test file calls (except assertions) |
| 5 | `config/` | 4 | 964 | `BASHUNIT_*` defaults, scratch dirs, parallel mode, rerun cache |
| 6 | `coverage/` | 13 | 2644 | line/branch tracking and the four report formats |
| 7 | `state/` | 6 | 477 | counters, per-test context, result payload, parallel aggregation |
| 8 | `console/` | 9 | 1281 | everything printed: palette, header, per-test lines, totals |
| 9 | `helper/` | 8 | 976 | naming, discovery, data providers, tags, encoding |
| 10 | `cli/` | 5 | 447 | the `doc`/`init`/`upgrade`/`watch` subcommand implementations |
| 11 | `assert/` | 11 | 2336 | every assertion |
| 12 | `reports/` | 7 | 467 | JUnit, TAP, JSON, GHA and HTML writers |
| 13 | `runner/` | 11 | 2172 | the file loop, per-test execution, retry, result parsing |
| 14 | `benchmark/` | 4 | 221 | the bench implementation (`runner/bench.sh` is its loop) |
| 15 | `learn/` | 5 | 240 | the interactive tutorial |
| 16 | `main/` | 8 | 1475 | flag parsing per subcommand and the run lifecycle |
| 2 | `system/` | 4 | 189 | capability probing: OS, `command -v`, small I/O |
| 3 | `util/` | 4 | 474 | computation: strings, arithmetic, time |
| 4 | `api/` | 5 | 205 | the surface a user's test file calls (except assertions) |
| 5 | `config/` | 4 | 961 | `BASHUNIT_*` defaults, scratch dirs, parallel mode, rerun cache |
| 6 | `coverage/` | 13 | 2640 | line/branch tracking and the four report formats |
| 7 | `state/` | 6 | 474 | counters, per-test context, result payload, parallel aggregation |
| 8 | `console/` | 9 | 1278 | everything printed: palette, header, per-test lines, totals |
| 9 | `helper/` | 8 | 948 | naming, discovery, data providers, tags, encoding |
| 10 | `cli/` | 5 | 445 | the `doc`/`init`/`upgrade`/`watch` subcommand implementations |
| 11 | `assert/` | 11 | 2326 | every assertion |
| 12 | `doubles/` | 4 | 505 | spies and mocks — **sourced by `assert/index.sh`, not the entrypoint** |
| 13 | `reports/` | 7 | 465 | JUnit, TAP, JSON, GHA and HTML writers |
| 14 | `runner/` | 11 | 2190 | the file loop, per-test execution, retry, result parsing |
| 15 | `benchmark/` | 4 | 219 | the bench implementation (`runner/bench.sh` is its loop) |
| 16 | `learn/` | 14 | 1296 | the interactive tutorial (9 of those files are `learn/lessons/`) |
| 17 | `main/` | 8 | 1473 | flag parsing per subcommand and the run lifecycle |

The file counts sum to 118, which is every `.sh` file in `src/` — that is the check to re-run
when editing this table, because both of its previous errors came from counting the wrong way.
`doubles/` was absent entirely: the table was generated from the entrypoint's `source` lines,
and `doubles/` is the one module the entrypoint does not source, so it fell through while the
prose above said "seventeen" from a directory count. And `learn/` was listed as 5 files / 240
lines because a one-level `src/learn/*.sh` glob does not descend into `learn/lessons/` — the
same one-level-glob mistake that `Makefile:67` made with nested tests. Count from the tree.

Namespaces track directories: `src/runner/` holds `bashunit::runner::*`. Two exceptions are
deliberate — `assert/` holds bare `assert_*` (the public API is unprefixed) and `console/`
Expand Down

4 changes: 4 additions & 0 deletions
docs/project-overview.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,12 +34,16 @@ point holding **only `source` lines** — the code lives in the sibling files be
| `helper` | naming, test discovery, data providers, tags, encoding |
| `cli` | the `doc`, `init`, `upgrade` and `watch` subcommands |
| `assert` | every assertion |
| `doubles` | spies and mocks |
| `reports` | JUnit, TAP, JSON, GitHub Actions and HTML writers |
| `runner` | the file loop, per-test execution, retry, result parsing |
| `benchmark` | the bench implementation |
| `learn` | the interactive tutorial |
| `main` | flag parsing per subcommand and the run lifecycle |

There is also a `dev` module holding debug helpers, which is deliberately excluded from the
built binary.

The released `bashunit` is a **single file**: `build.sh` walks the `source` statements from the
entrypoint, inlines every module in dependency order, and strips the `source` lines.

Expand Down

61 changes: 61 additions & 0 deletions
tests/unit/project/adr_module_table_test.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
#!/usr/bin/env bash

# Anti-drift contract for ADR-011's module table.
#
# That table has been wrong twice, both times because it was counted with a
# one-level glob rather than from the tree:
#
# * `doubles/` was missing outright. The table was generated from the
# entrypoint's `source` lines, and `doubles/` is the one module the
# entrypoint does not source -- `assert/index.sh` does -- so it fell through
# while the prose above it said "seventeen" from a directory count.
# * `learn/` was listed at 5 files / 240 lines because `src/learn/*.sh` does
# not descend into `learn/lessons/`, which holds 9 more files.
#
# Neither is visible to a human reading the ADR, which is what makes a test the
# right tool. Checking the file counts *sum* to `src/` catches an under-count in
# any single row without pinning every number to an exact value.

ADR=""
ROOT_DIR=""

function set_up_before_script() {
 ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/../../.." && pwd)"
 ADR="$ROOT_DIR/adrs/adr-011-source-layout-and-build-pipeline.md"
}

# Without this, renaming the ADR would make every other assertion here compare
# empty output against empty output and pass while checking nothing -- the
# failure mode that let a layering contract rot unnoticed in #946.
function test_the_adr_being_checked_exists() {
 assert_file_exists "$ADR"
}

function adr_table_modules() {
 grep -E '^\| [0-9]+ \| `[a-z]+/`' "$ADR" |
 sed 's/^| *[0-9]* *| *`\([a-z]*\)\/` *|.*/\1/' | LC_ALL=C sort
}

# Enumerated with `find`, not `git ls-files`: the Bash 3.0 jobs run in a container
# where git refuses to read the repo (dubious-ownership), so `git ls-files` exits
# non-zero and yields nothing -- which reads here as "src/ has no modules" and
# fails for a reason that has nothing to do with the ADR.
function src_modules() {
 (cd "$ROOT_DIR" && find src -name '*.sh' | cut -d/ -f2 | LC_ALL=C sort -u)
}

function test_every_src_module_has_a_row_in_the_adr_table() {
 assert_same "$(src_modules)" "$(adr_table_modules)"
}

function adr_table_file_total() {
 grep -E '^\| [0-9]+ \| `[a-z]+/`' "$ADR" | awk -F'|' '{ sum += $4 } END { print sum + 0 }'
}

function src_file_total() {
 (cd "$ROOT_DIR" && find src -name '*.sh' | wc -l | tr -d ' ')
}

function test_adr_table_file_counts_account_for_every_src_file() {
 assert_same "$(src_file_total)" "$(adr_table_file_total)"
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
docs(adr): fix ADR-011 module table and pin it with a contract test#964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Chemaclass
merged 2 commits into

from

Aug 2, 2026
 Merged


docs(adr): fix ADR-011 module table and pin it with a contract test
#964
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
c37f33d

docs(adr): fix ADR-011 module table and pin it with a contract test


Chemaclass Aug 2, 2026
0649988

fix(test): enumerate src/ with find so the Bash 3.0 container can run…


Chemaclass Aug 2, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


42 changes: 25 additions & 17 deletions
adrs/adr-011-source-layout-and-build-pipeline.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,27 +44,35 @@ statement. That is load-bearing, not stylistic — see the build section — and

## The modules

Seventeen, in the order the `bashunit` entrypoint sources them. The order is the dependency
layering: leaves first.
Seventeen, in load order. The order is the dependency layering: leaves first.

| # | Module | Files | Lines | Owns |
|---|---|---|---|---|
| 1 | `dev/` | 1 | 18 | debug helpers; **excluded from the build** |
| 2 | `system/` | 4 | 192 | capability probing: OS, `command -v`, small I/O |
| 3 | `util/` | 4 | 476 | computation: strings, arithmetic, time |
| 4 | `api/` | 5 | 207 | the surface a user's test file calls (except assertions) |
| 5 | `config/` | 4 | 964 | `BASHUNIT_*` defaults, scratch dirs, parallel mode, rerun cache |
| 6 | `coverage/` | 13 | 2644 | line/branch tracking and the four report formats |
| 7 | `state/` | 6 | 477 | counters, per-test context, result payload, parallel aggregation |
| 8 | `console/` | 9 | 1281 | everything printed: palette, header, per-test lines, totals |
| 9 | `helper/` | 8 | 976 | naming, discovery, data providers, tags, encoding |
| 10 | `cli/` | 5 | 447 | the `doc`/`init`/`upgrade`/`watch` subcommand implementations |
| 11 | `assert/` | 11 | 2336 | every assertion |
| 12 | `reports/` | 7 | 467 | JUnit, TAP, JSON, GHA and HTML writers |
| 13 | `runner/` | 11 | 2172 | the file loop, per-test execution, retry, result parsing |
| 14 | `benchmark/` | 4 | 221 | the bench implementation (`runner/bench.sh` is its loop) |
| 15 | `learn/` | 5 | 240 | the interactive tutorial |
| 16 | `main/` | 8 | 1475 | flag parsing per subcommand and the run lifecycle |
| 2 | `system/` | 4 | 189 | capability probing: OS, `command -v`, small I/O |
| 3 | `util/` | 4 | 474 | computation: strings, arithmetic, time |
| 4 | `api/` | 5 | 205 | the surface a user's test file calls (except assertions) |
| 5 | `config/` | 4 | 961 | `BASHUNIT_*` defaults, scratch dirs, parallel mode, rerun cache |
| 6 | `coverage/` | 13 | 2640 | line/branch tracking and the four report formats |
| 7 | `state/` | 6 | 474 | counters, per-test context, result payload, parallel aggregation |
| 8 | `console/` | 9 | 1278 | everything printed: palette, header, per-test lines, totals |
| 9 | `helper/` | 8 | 948 | naming, discovery, data providers, tags, encoding |
| 10 | `cli/` | 5 | 445 | the `doc`/`init`/`upgrade`/`watch` subcommand implementations |
| 11 | `assert/` | 11 | 2326 | every assertion |
| 12 | `doubles/` | 4 | 505 | spies and mocks — **sourced by `assert/index.sh`, not the entrypoint** |
| 13 | `reports/` | 7 | 465 | JUnit, TAP, JSON, GHA and HTML writers |
| 14 | `runner/` | 11 | 2190 | the file loop, per-test execution, retry, result parsing |
| 15 | `benchmark/` | 4 | 219 | the bench implementation (`runner/bench.sh` is its loop) |
| 16 | `learn/` | 14 | 1296 | the interactive tutorial (9 of those files are `learn/lessons/`) |
| 17 | `main/` | 8 | 1473 | flag parsing per subcommand and the run lifecycle |

The file counts sum to 118, which is every `.sh` file in `src/` — that is the check to re-run
when editing this table, because both of its previous errors came from counting the wrong way.
`doubles/` was absent entirely: the table was generated from the entrypoint's `source` lines,
and `doubles/` is the one module the entrypoint does not source, so it fell through while the
prose above said "seventeen" from a directory count. And `learn/` was listed as 5 files / 240
lines because a one-level `src/learn/*.sh` glob does not descend into `learn/lessons/` — the
same one-level-glob mistake that `Makefile:67` made with nested tests. Count from the tree.

Namespaces track directories: `src/runner/` holds `bashunit::runner::*`. Two exceptions are
deliberate — `assert/` holds bare `assert_*` (the public API is unprefixed) and `console/`
Expand Down

4 changes: 4 additions & 0 deletions
docs/project-overview.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,12 +34,16 @@ point holding **only `source` lines** — the code lives in the sibling files be
| `helper` | naming, test discovery, data providers, tags, encoding |
| `cli` | the `doc`, `init`, `upgrade` and `watch` subcommands |
| `assert` | every assertion |
| `doubles` | spies and mocks |
| `reports` | JUnit, TAP, JSON, GitHub Actions and HTML writers |
| `runner` | the file loop, per-test execution, retry, result parsing |
| `benchmark` | the bench implementation |
| `learn` | the interactive tutorial |
| `main` | flag parsing per subcommand and the run lifecycle |

There is also a `dev` module holding debug helpers, which is deliberately excluded from the
built binary.

The released `bashunit` is a **single file**: `build.sh` walks the `source` statements from the
entrypoint, inlines every module in dependency order, and strips the `source` lines.

Expand Down

61 changes: 61 additions & 0 deletions
tests/unit/project/adr_module_table_test.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
#!/usr/bin/env bash

# Anti-drift contract for ADR-011's module table.
#
# That table has been wrong twice, both times because it was counted with a
# one-level glob rather than from the tree:
#
# * `doubles/` was missing outright. The table was generated from the
# entrypoint's `source` lines, and `doubles/` is the one module the
# entrypoint does not source -- `assert/index.sh` does -- so it fell through
# while the prose above it said "seventeen" from a directory count.
# * `learn/` was listed at 5 files / 240 lines because `src/learn/*.sh` does
# not descend into `learn/lessons/`, which holds 9 more files.
#
# Neither is visible to a human reading the ADR, which is what makes a test the
# right tool. Checking the file counts *sum* to `src/` catches an under-count in
# any single row without pinning every number to an exact value.

ADR=""
ROOT_DIR=""

function set_up_before_script() {
 ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/../../.." && pwd)"
 ADR="$ROOT_DIR/adrs/adr-011-source-layout-and-build-pipeline.md"
}

# Without this, renaming the ADR would make every other assertion here compare
# empty output against empty output and pass while checking nothing -- the
# failure mode that let a layering contract rot unnoticed in #946.
function test_the_adr_being_checked_exists() {
 assert_file_exists "$ADR"
}

function adr_table_modules() {
 grep -E '^\| [0-9]+ \| `[a-z]+/`' "$ADR" |
 sed 's/^| *[0-9]* *| *`\([a-z]*\)\/` *|.*/\1/' | LC_ALL=C sort
}

# Enumerated with `find`, not `git ls-files`: the Bash 3.0 jobs run in a container
# where git refuses to read the repo (dubious-ownership), so `git ls-files` exits
# non-zero and yields nothing -- which reads here as "src/ has no modules" and
# fails for a reason that has nothing to do with the ADR.
function src_modules() {
 (cd "$ROOT_DIR" && find src -name '*.sh' | cut -d/ -f2 | LC_ALL=C sort -u)
}

function test_every_src_module_has_a_row_in_the_adr_table() {
 assert_same "$(src_modules)" "$(adr_table_modules)"
}

function adr_table_file_total() {
 grep -E '^\| [0-9]+ \| `[a-z]+/`' "$ADR" | awk -F'|' '{ sum += $4 } END { print sum + 0 }'
}

function src_file_total() {
 (cd "$ROOT_DIR" && find src -name '*.sh' | wc -l | tr -d ' ')
}

function test_adr_table_file_counts_account_for_every_src_file() {
 assert_same "$(src_file_total)" "$(adr_table_file_total)"
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs(adr): fix ADR-011 module table and pin it with a contract test#964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Chemaclass
merged 2 commits into

from

Aug 2, 2026
 Merged


docs(adr): fix ADR-011 module table and pin it with a contract test
#964
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
c37f33d

docs(adr): fix ADR-011 module table and pin it with a contract test


Chemaclass Aug 2, 2026
0649988

fix(test): enumerate src/ with find so the Bash 3.0 container can run…


Chemaclass Aug 2, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


42 changes: 25 additions & 17 deletions
adrs/adr-011-source-layout-and-build-pipeline.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,27 +44,35 @@ statement. That is load-bearing, not stylistic — see the build section — and

## The modules

Seventeen, in the order the `bashunit` entrypoint sources them. The order is the dependency
layering: leaves first.
Seventeen, in load order. The order is the dependency layering: leaves first.

| # | Module | Files | Lines | Owns |
|---|---|---|---|---|
| 1 | `dev/` | 1 | 18 | debug helpers; **excluded from the build** |
| 2 | `system/` | 4 | 192 | capability probing: OS, `command -v`, small I/O |
| 3 | `util/` | 4 | 476 | computation: strings, arithmetic, time |
| 4 | `api/` | 5 | 207 | the surface a user's test file calls (except assertions) |
| 5 | `config/` | 4 | 964 | `BASHUNIT_*` defaults, scratch dirs, parallel mode, rerun cache |
| 6 | `coverage/` | 13 | 2644 | line/branch tracking and the four report formats |
| 7 | `state/` | 6 | 477 | counters, per-test context, result payload, parallel aggregation |
| 8 | `console/` | 9 | 1281 | everything printed: palette, header, per-test lines, totals |
| 9 | `helper/` | 8 | 976 | naming, discovery, data providers, tags, encoding |
| 10 | `cli/` | 5 | 447 | the `doc`/`init`/`upgrade`/`watch` subcommand implementations |
| 11 | `assert/` | 11 | 2336 | every assertion |
| 12 | `reports/` | 7 | 467 | JUnit, TAP, JSON, GHA and HTML writers |
| 13 | `runner/` | 11 | 2172 | the file loop, per-test execution, retry, result parsing |
| 14 | `benchmark/` | 4 | 221 | the bench implementation (`runner/bench.sh` is its loop) |
| 15 | `learn/` | 5 | 240 | the interactive tutorial |
| 16 | `main/` | 8 | 1475 | flag parsing per subcommand and the run lifecycle |
| 2 | `system/` | 4 | 189 | capability probing: OS, `command -v`, small I/O |
| 3 | `util/` | 4 | 474 | computation: strings, arithmetic, time |
| 4 | `api/` | 5 | 205 | the surface a user's test file calls (except assertions) |
| 5 | `config/` | 4 | 961 | `BASHUNIT_*` defaults, scratch dirs, parallel mode, rerun cache |
| 6 | `coverage/` | 13 | 2640 | line/branch tracking and the four report formats |
| 7 | `state/` | 6 | 474 | counters, per-test context, result payload, parallel aggregation |
| 8 | `console/` | 9 | 1278 | everything printed: palette, header, per-test lines, totals |
| 9 | `helper/` | 8 | 948 | naming, discovery, data providers, tags, encoding |
| 10 | `cli/` | 5 | 445 | the `doc`/`init`/`upgrade`/`watch` subcommand implementations |
| 11 | `assert/` | 11 | 2326 | every assertion |
| 12 | `doubles/` | 4 | 505 | spies and mocks — **sourced by `assert/index.sh`, not the entrypoint** |
| 13 | `reports/` | 7 | 465 | JUnit, TAP, JSON, GHA and HTML writers |
| 14 | `runner/` | 11 | 2190 | the file loop, per-test execution, retry, result parsing |
| 15 | `benchmark/` | 4 | 219 | the bench implementation (`runner/bench.sh` is its loop) |
| 16 | `learn/` | 14 | 1296 | the interactive tutorial (9 of those files are `learn/lessons/`) |
| 17 | `main/` | 8 | 1473 | flag parsing per subcommand and the run lifecycle |

The file counts sum to 118, which is every `.sh` file in `src/` — that is the check to re-run
when editing this table, because both of its previous errors came from counting the wrong way.
`doubles/` was absent entirely: the table was generated from the entrypoint's `source` lines,
and `doubles/` is the one module the entrypoint does not source, so it fell through while the
prose above said "seventeen" from a directory count. And `learn/` was listed as 5 files / 240
lines because a one-level `src/learn/*.sh` glob does not descend into `learn/lessons/` — the
same one-level-glob mistake that `Makefile:67` made with nested tests. Count from the tree.

Namespaces track directories: `src/runner/` holds `bashunit::runner::*`. Two exceptions are
deliberate — `assert/` holds bare `assert_*` (the public API is unprefixed) and `console/`
Expand Down

4 changes: 4 additions & 0 deletions
docs/project-overview.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,12 +34,16 @@ point holding **only `source` lines** — the code lives in the sibling files be
| `helper` | naming, test discovery, data providers, tags, encoding |
| `cli` | the `doc`, `init`, `upgrade` and `watch` subcommands |
| `assert` | every assertion |
| `doubles` | spies and mocks |
| `reports` | JUnit, TAP, JSON, GitHub Actions and HTML writers |
| `runner` | the file loop, per-test execution, retry, result parsing |
| `benchmark` | the bench implementation |
| `learn` | the interactive tutorial |
| `main` | flag parsing per subcommand and the run lifecycle |

There is also a `dev` module holding debug helpers, which is deliberately excluded from the
built binary.

The released `bashunit` is a **single file**: `build.sh` walks the `source` statements from the
entrypoint, inlines every module in dependency order, and strips the `source` lines.

Expand Down

61 changes: 61 additions & 0 deletions
tests/unit/project/adr_module_table_test.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
#!/usr/bin/env bash

# Anti-drift contract for ADR-011's module table.
#
# That table has been wrong twice, both times because it was counted with a
# one-level glob rather than from the tree:
#
# * `doubles/` was missing outright. The table was generated from the
# entrypoint's `source` lines, and `doubles/` is the one module the
# entrypoint does not source -- `assert/index.sh` does -- so it fell through
# while the prose above it said "seventeen" from a directory count.
# * `learn/` was listed at 5 files / 240 lines because `src/learn/*.sh` does
# not descend into `learn/lessons/`, which holds 9 more files.
#
# Neither is visible to a human reading the ADR, which is what makes a test the
# right tool. Checking the file counts *sum* to `src/` catches an under-count in
# any single row without pinning every number to an exact value.

ADR=""
ROOT_DIR=""

function set_up_before_script() {
 ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/../../.." && pwd)"
 ADR="$ROOT_DIR/adrs/adr-011-source-layout-and-build-pipeline.md"
}

# Without this, renaming the ADR would make every other assertion here compare
# empty output against empty output and pass while checking nothing -- the
# failure mode that let a layering contract rot unnoticed in #946.
function test_the_adr_being_checked_exists() {
 assert_file_exists "$ADR"
}

function adr_table_modules() {
 grep -E '^\| [0-9]+ \| `[a-z]+/`' "$ADR" |
 sed 's/^| *[0-9]* *| *`\([a-z]*\)\/` *|.*/\1/' | LC_ALL=C sort
}

# Enumerated with `find`, not `git ls-files`: the Bash 3.0 jobs run in a container
# where git refuses to read the repo (dubious-ownership), so `git ls-files` exits
# non-zero and yields nothing -- which reads here as "src/ has no modules" and
# fails for a reason that has nothing to do with the ADR.
function src_modules() {
 (cd "$ROOT_DIR" && find src -name '*.sh' | cut -d/ -f2 | LC_ALL=C sort -u)
}

function test_every_src_module_has_a_row_in_the_adr_table() {
 assert_same "$(src_modules)" "$(adr_table_modules)"
}

function adr_table_file_total() {
 grep -E '^\| [0-9]+ \| `[a-z]+/`' "$ADR" | awk -F'|' '{ sum += $4 } END { print sum + 0 }'
}

function src_file_total() {
 (cd "$ROOT_DIR" && find src -name '*.sh' | wc -l | tr -d ' ')
}

function test_adr_table_file_counts_account_for_every_src_file() {
 assert_same "$(src_file_total)" "$(adr_table_file_total)"
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs(adr): fix ADR-011 module table and pin it with a contract test#964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Chemaclass
merged 2 commits into

from

Aug 2, 2026
 Merged


docs(adr): fix ADR-011 module table and pin it with a contract test
#964
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
c37f33d

docs(adr): fix ADR-011 module table and pin it with a contract test


Chemaclass Aug 2, 2026
0649988

fix(test): enumerate src/ with find so the Bash 3.0 container can run…


Chemaclass Aug 2, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


42 changes: 25 additions & 17 deletions
adrs/adr-011-source-layout-and-build-pipeline.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,27 +44,35 @@ statement. That is load-bearing, not stylistic — see the build section — and

## The modules

Seventeen, in the order the `bashunit` entrypoint sources them. The order is the dependency
layering: leaves first.
Seventeen, in load order. The order is the dependency layering: leaves first.

| # | Module | Files | Lines | Owns |
|---|---|---|---|---|
| 1 | `dev/` | 1 | 18 | debug helpers; **excluded from the build** |
| 2 | `system/` | 4 | 192 | capability probing: OS, `command -v`, small I/O |
| 3 | `util/` | 4 | 476 | computation: strings, arithmetic, time |
| 4 | `api/` | 5 | 207 | the surface a user's test file calls (except assertions) |
| 5 | `config/` | 4 | 964 | `BASHUNIT_*` defaults, scratch dirs, parallel mode, rerun cache |
| 6 | `coverage/` | 13 | 2644 | line/branch tracking and the four report formats |
| 7 | `state/` | 6 | 477 | counters, per-test context, result payload, parallel aggregation |
| 8 | `console/` | 9 | 1281 | everything printed: palette, header, per-test lines, totals |
| 9 | `helper/` | 8 | 976 | naming, discovery, data providers, tags, encoding |
| 10 | `cli/` | 5 | 447 | the `doc`/`init`/`upgrade`/`watch` subcommand implementations |
| 11 | `assert/` | 11 | 2336 | every assertion |
| 12 | `reports/` | 7 | 467 | JUnit, TAP, JSON, GHA and HTML writers |
| 13 | `runner/` | 11 | 2172 | the file loop, per-test execution, retry, result parsing |
| 14 | `benchmark/` | 4 | 221 | the bench implementation (`runner/bench.sh` is its loop) |
| 15 | `learn/` | 5 | 240 | the interactive tutorial |
| 16 | `main/` | 8 | 1475 | flag parsing per subcommand and the run lifecycle |
| 2 | `system/` | 4 | 189 | capability probing: OS, `command -v`, small I/O |
| 3 | `util/` | 4 | 474 | computation: strings, arithmetic, time |
| 4 | `api/` | 5 | 205 | the surface a user's test file calls (except assertions) |
| 5 | `config/` | 4 | 961 | `BASHUNIT_*` defaults, scratch dirs, parallel mode, rerun cache |
| 6 | `coverage/` | 13 | 2640 | line/branch tracking and the four report formats |
| 7 | `state/` | 6 | 474 | counters, per-test context, result payload, parallel aggregation |
| 8 | `console/` | 9 | 1278 | everything printed: palette, header, per-test lines, totals |
| 9 | `helper/` | 8 | 948 | naming, discovery, data providers, tags, encoding |
| 10 | `cli/` | 5 | 445 | the `doc`/`init`/`upgrade`/`watch` subcommand implementations |
| 11 | `assert/` | 11 | 2326 | every assertion |
| 12 | `doubles/` | 4 | 505 | spies and mocks — **sourced by `assert/index.sh`, not the entrypoint** |
| 13 | `reports/` | 7 | 465 | JUnit, TAP, JSON, GHA and HTML writers |
| 14 | `runner/` | 11 | 2190 | the file loop, per-test execution, retry, result parsing |
| 15 | `benchmark/` | 4 | 219 | the bench implementation (`runner/bench.sh` is its loop) |
| 16 | `learn/` | 14 | 1296 | the interactive tutorial (9 of those files are `learn/lessons/`) |
| 17 | `main/` | 8 | 1473 | flag parsing per subcommand and the run lifecycle |

The file counts sum to 118, which is every `.sh` file in `src/` — that is the check to re-run
when editing this table, because both of its previous errors came from counting the wrong way.
`doubles/` was absent entirely: the table was generated from the entrypoint's `source` lines,
and `doubles/` is the one module the entrypoint does not source, so it fell through while the
prose above said "seventeen" from a directory count. And `learn/` was listed as 5 files / 240
lines because a one-level `src/learn/*.sh` glob does not descend into `learn/lessons/` — the
same one-level-glob mistake that `Makefile:67` made with nested tests. Count from the tree.

Namespaces track directories: `src/runner/` holds `bashunit::runner::*`. Two exceptions are
deliberate — `assert/` holds bare `assert_*` (the public API is unprefixed) and `console/`
Expand Down

4 changes: 4 additions & 0 deletions
docs/project-overview.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,12 +34,16 @@ point holding **only `source` lines** — the code lives in the sibling files be
| `helper` | naming, test discovery, data providers, tags, encoding |
| `cli` | the `doc`, `init`, `upgrade` and `watch` subcommands |
| `assert` | every assertion |
| `doubles` | spies and mocks |
| `reports` | JUnit, TAP, JSON, GitHub Actions and HTML writers |
| `runner` | the file loop, per-test execution, retry, result parsing |
| `benchmark` | the bench implementation |
| `learn` | the interactive tutorial |
| `main` | flag parsing per subcommand and the run lifecycle |

There is also a `dev` module holding debug helpers, which is deliberately excluded from the
built binary.

The released `bashunit` is a **single file**: `build.sh` walks the `source` statements from the
entrypoint, inlines every module in dependency order, and strips the `source` lines.

Expand Down

61 changes: 61 additions & 0 deletions
tests/unit/project/adr_module_table_test.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
#!/usr/bin/env bash

# Anti-drift contract for ADR-011's module table.
#
# That table has been wrong twice, both times because it was counted with a
# one-level glob rather than from the tree:
#
# * `doubles/` was missing outright. The table was generated from the
# entrypoint's `source` lines, and `doubles/` is the one module the
# entrypoint does not source -- `assert/index.sh` does -- so it fell through
# while the prose above it said "seventeen" from a directory count.
# * `learn/` was listed at 5 files / 240 lines because `src/learn/*.sh` does
# not descend into `learn/lessons/`, which holds 9 more files.
#
# Neither is visible to a human reading the ADR, which is what makes a test the
# right tool. Checking the file counts *sum* to `src/` catches an under-count in
# any single row without pinning every number to an exact value.

ADR=""
ROOT_DIR=""

function set_up_before_script() {
 ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/../../.." && pwd)"
 ADR="$ROOT_DIR/adrs/adr-011-source-layout-and-build-pipeline.md"
}

# Without this, renaming the ADR would make every other assertion here compare
# empty output against empty output and pass while checking nothing -- the
# failure mode that let a layering contract rot unnoticed in #946.
function test_the_adr_being_checked_exists() {
 assert_file_exists "$ADR"
}

function adr_table_modules() {
 grep -E '^\| [0-9]+ \| `[a-z]+/`' "$ADR" |
 sed 's/^| *[0-9]* *| *`\([a-z]*\)\/` *|.*/\1/' | LC_ALL=C sort
}

# Enumerated with `find`, not `git ls-files`: the Bash 3.0 jobs run in a container
# where git refuses to read the repo (dubious-ownership), so `git ls-files` exits
# non-zero and yields nothing -- which reads here as "src/ has no modules" and
# fails for a reason that has nothing to do with the ADR.
function src_modules() {
 (cd "$ROOT_DIR" && find src -name '*.sh' | cut -d/ -f2 | LC_ALL=C sort -u)
}

function test_every_src_module_has_a_row_in_the_adr_table() {
 assert_same "$(src_modules)" "$(adr_table_modules)"
}

function adr_table_file_total() {
 grep -E '^\| [0-9]+ \| `[a-z]+/`' "$ADR" | awk -F'|' '{ sum += $4 } END { print sum + 0 }'
}

function src_file_total() {
 (cd "$ROOT_DIR" && find src -name '*.sh' | wc -l | tr -d ' ')
}

function test_adr_table_file_counts_account_for_every_src_file() {
 assert_same "$(src_file_total)" "$(adr_table_file_total)"
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
docs(adr): fix ADR-011 module table and pin it with a contract test#964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

Chemaclass
merged 2 commits into

from

Aug 2, 2026
 Merged


docs(adr): fix ADR-011 module table and pin it with a contract test
#964
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
c37f33d

docs(adr): fix ADR-011 module table and pin it with a contract test


Chemaclass Aug 2, 2026
0649988

fix(test): enumerate src/ with find so the Bash 3.0 container can run…


Chemaclass Aug 2, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


42 changes: 25 additions & 17 deletions
adrs/adr-011-source-layout-and-build-pipeline.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,27 +44,35 @@ statement. That is load-bearing, not stylistic — see the build section — and

## The modules

Seventeen, in the order the `bashunit` entrypoint sources them. The order is the dependency
layering: leaves first.
Seventeen, in load order. The order is the dependency layering: leaves first.

| # | Module | Files | Lines | Owns |
|---|---|---|---|---|
| 1 | `dev/` | 1 | 18 | debug helpers; **excluded from the build** |
| 2 | `system/` | 4 | 192 | capability probing: OS, `command -v`, small I/O |
| 3 | `util/` | 4 | 476 | computation: strings, arithmetic, time |
| 4 | `api/` | 5 | 207 | the surface a user's test file calls (except assertions) |
| 5 | `config/` | 4 | 964 | `BASHUNIT_*` defaults, scratch dirs, parallel mode, rerun cache |
| 6 | `coverage/` | 13 | 2644 | line/branch tracking and the four report formats |
| 7 | `state/` | 6 | 477 | counters, per-test context, result payload, parallel aggregation |
| 8 | `console/` | 9 | 1281 | everything printed: palette, header, per-test lines, totals |
| 9 | `helper/` | 8 | 976 | naming, discovery, data providers, tags, encoding |
| 10 | `cli/` | 5 | 447 | the `doc`/`init`/`upgrade`/`watch` subcommand implementations |
| 11 | `assert/` | 11 | 2336 | every assertion |
| 12 | `reports/` | 7 | 467 | JUnit, TAP, JSON, GHA and HTML writers |
| 13 | `runner/` | 11 | 2172 | the file loop, per-test execution, retry, result parsing |
| 14 | `benchmark/` | 4 | 221 | the bench implementation (`runner/bench.sh` is its loop) |
| 15 | `learn/` | 5 | 240 | the interactive tutorial |
| 16 | `main/` | 8 | 1475 | flag parsing per subcommand and the run lifecycle |
| 2 | `system/` | 4 | 189 | capability probing: OS, `command -v`, small I/O |
| 3 | `util/` | 4 | 474 | computation: strings, arithmetic, time |
| 4 | `api/` | 5 | 205 | the surface a user's test file calls (except assertions) |
| 5 | `config/` | 4 | 961 | `BASHUNIT_*` defaults, scratch dirs, parallel mode, rerun cache |
| 6 | `coverage/` | 13 | 2640 | line/branch tracking and the four report formats |
| 7 | `state/` | 6 | 474 | counters, per-test context, result payload, parallel aggregation |
| 8 | `console/` | 9 | 1278 | everything printed: palette, header, per-test lines, totals |
| 9 | `helper/` | 8 | 948 | naming, discovery, data providers, tags, encoding |
| 10 | `cli/` | 5 | 445 | the `doc`/`init`/`upgrade`/`watch` subcommand implementations |
| 11 | `assert/` | 11 | 2326 | every assertion |
| 12 | `doubles/` | 4 | 505 | spies and mocks — **sourced by `assert/index.sh`, not the entrypoint** |
| 13 | `reports/` | 7 | 465 | JUnit, TAP, JSON, GHA and HTML writers |
| 14 | `runner/` | 11 | 2190 | the file loop, per-test execution, retry, result parsing |
| 15 | `benchmark/` | 4 | 219 | the bench implementation (`runner/bench.sh` is its loop) |
| 16 | `learn/` | 14 | 1296 | the interactive tutorial (9 of those files are `learn/lessons/`) |
| 17 | `main/` | 8 | 1473 | flag parsing per subcommand and the run lifecycle |

The file counts sum to 118, which is every `.sh` file in `src/` — that is the check to re-run
when editing this table, because both of its previous errors came from counting the wrong way.
`doubles/` was absent entirely: the table was generated from the entrypoint's `source` lines,
and `doubles/` is the one module the entrypoint does not source, so it fell through while the
prose above said "seventeen" from a directory count. And `learn/` was listed as 5 files / 240
lines because a one-level `src/learn/*.sh` glob does not descend into `learn/lessons/` — the
same one-level-glob mistake that `Makefile:67` made with nested tests. Count from the tree.

Namespaces track directories: `src/runner/` holds `bashunit::runner::*`. Two exceptions are
deliberate — `assert/` holds bare `assert_*` (the public API is unprefixed) and `console/`
Expand Down

4 changes: 4 additions & 0 deletions
docs/project-overview.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,12 +34,16 @@ point holding **only `source` lines** — the code lives in the sibling files be
| `helper` | naming, test discovery, data providers, tags, encoding |
| `cli` | the `doc`, `init`, `upgrade` and `watch` subcommands |
| `assert` | every assertion |
| `doubles` | spies and mocks |
| `reports` | JUnit, TAP, JSON, GitHub Actions and HTML writers |
| `runner` | the file loop, per-test execution, retry, result parsing |
| `benchmark` | the bench implementation |
| `learn` | the interactive tutorial |
| `main` | flag parsing per subcommand and the run lifecycle |

There is also a `dev` module holding debug helpers, which is deliberately excluded from the
built binary.

The released `bashunit` is a **single file**: `build.sh` walks the `source` statements from the
entrypoint, inlines every module in dependency order, and strips the `source` lines.

Expand Down

61 changes: 61 additions & 0 deletions
tests/unit/project/adr_module_table_test.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
#!/usr/bin/env bash

# Anti-drift contract for ADR-011's module table.
#
# That table has been wrong twice, both times because it was counted with a
# one-level glob rather than from the tree:
#
# * `doubles/` was missing outright. The table was generated from the
# entrypoint's `source` lines, and `doubles/` is the one module the
# entrypoint does not source -- `assert/index.sh` does -- so it fell through
# while the prose above it said "seventeen" from a directory count.
# * `learn/` was listed at 5 files / 240 lines because `src/learn/*.sh` does
# not descend into `learn/lessons/`, which holds 9 more files.
#
# Neither is visible to a human reading the ADR, which is what makes a test the
# right tool. Checking the file counts *sum* to `src/` catches an under-count in
# any single row without pinning every number to an exact value.

ADR=""
ROOT_DIR=""

function set_up_before_script() {
 ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/../../.." && pwd)"
 ADR="$ROOT_DIR/adrs/adr-011-source-layout-and-build-pipeline.md"
}

# Without this, renaming the ADR would make every other assertion here compare
# empty output against empty output and pass while checking nothing -- the
# failure mode that let a layering contract rot unnoticed in #946.
function test_the_adr_being_checked_exists() {
 assert_file_exists "$ADR"
}

function adr_table_modules() {
 grep -E '^\| [0-9]+ \| `[a-z]+/`' "$ADR" |
 sed 's/^| *[0-9]* *| *`\([a-z]*\)\/` *|.*/\1/' | LC_ALL=C sort
}

# Enumerated with `find`, not `git ls-files`: the Bash 3.0 jobs run in a container
# where git refuses to read the repo (dubious-ownership), so `git ls-files` exits
# non-zero and yields nothing -- which reads here as "src/ has no modules" and
# fails for a reason that has nothing to do with the ADR.
function src_modules() {
 (cd "$ROOT_DIR" && find src -name '*.sh' | cut -d/ -f2 | LC_ALL=C sort -u)
}

function test_every_src_module_has_a_row_in_the_adr_table() {
 assert_same "$(src_modules)" "$(adr_table_modules)"
}

function adr_table_file_total() {
 grep -E '^\| [0-9]+ \| `[a-z]+/`' "$ADR" | awk -F'|' '{ sum += $4 } END { print sum + 0 }'
}

function src_file_total() {
 (cd "$ROOT_DIR" && find src -name '*.sh' | wc -l | tr -d ' ')
}

function test_adr_table_file_counts_account_for_every_src_file() {
 assert_same "$(src_file_total)" "$(adr_table_file_total)"
}
Loading