Skip to content

refactor(src): finish the module split — 9 large files still flat #931

Description

@Chemaclass

Summary

src/ is half-migrated. runner and coverage are module directories (#924, #925); the
other 37 files are still flat, and nine of them are large enough to deserve the same
treatment. Finish the migration, one module per PR.

Measured on main (7eecc45): 40 flat .sh files + 3 module directories, 15,614 lines total.

Convention: settled

The aggregator lives inside the module directory as index.sh:

src/runner/index.sh <- entry point
src/runner/exec.sh
src/coverage/index.sh
src/coverage/engine.sh

Decided and applied to both existing modules in #934; ADR-010 amended with the reasoning.
The original "beside" choice (src/runner.sh + src/runner/*.sh) rested on matching the
src/assertions.sh precedent, which does not apply — assertions.sh aggregates flat files
and has no directory. What settled it: the "aggregators hold only source lines" rule was
enforced against a hand-maintained list that had already drifted (#928 added src/coverage.sh
and never appended it), and a predictable src/*/index.sh lets that test discover modules by
glob instead.

Every new module in this issue uses index.sh. Do not mix placements.

What is left to split

FileLinesFnsNote
src/main.sh142224flag parsing + every subcommand's cmd_* in one file
src/learn.sh121382the interactive tutorial; self-contained, lowest risk
src/assert.sh97042the core assertion catalogue — cohesive, may not want splitting
src/helpers.sh90930discovery, fn filtering, provider map, duplicate check, ids
src/console_results.sh82827totals rendering + deferred failure/skip blocks
src/env.sh75451BASHUNIT_* defaults, config files, scratch dirs
src/test_doubles.sh47017spies + mocks
src/reports.sh43418JUnit/HTML/TAP/JSON writers — one per format is the obvious seam
src/state.sh40442counters + payload encode/decode + TAP conversion

Separately, ~20 files under 120 lines (colors, str, math, io, globals,
check_os, dependencies, …) could group into a src/util/ module. Lower value than the
big files — grouping small cohesive files buys navigation, not comprehension. Treat as
optional and last.

Do not split all nine in one PR. One module per PR, same as #924 and #925, so each stays
reviewable as a pure relocation.

Per-module process (proven by #924 and #925)

  1. Post a responsibility map on the issue and get it agreed before moving code: one-line
    summary per function, the internal call graph, every _BASHUNIT_* global with who assigns
    and who reads it, and a proposed acyclic layering. Generate it from the file, do not
    eyeball it.
  2. Split. git diff must show only relocations — no renamed functions, no changed logic.
  3. Verify (below), then open the PR.

Constraints — all of these have already drawn blood

  • Aggregators may contain only source lines and comments.build::process_file emits a
    file's body and then recurses into its sources, so any statement in an aggregator runs
    before its dependencies in the built binary but after them in dev mode. Enforced by
    test_module_aggregators_hold_only_source_lines_and_comments.
  • File-scope initialisers must move with their module, and order-dependent ones must stay
    contiguous.
    In refactor(coverage): split src/coverage.sh into a src/coverage/ module #928, _BASHUNIT_COVERAGE_XTRACE_PS4 expands $_BASHUNIT_COVERAGE_XTRACE_FS
    at file scope, and _NONEXEC_PATTERN is built across 7 successive lines. Grep for
    file-scope assignments that read another file-scope variable before splitting.
  • .gitignore can silently swallow a new module directory.coverage/ was unanchored, so
    it matched src/coverage/ and excluded all twelve new files from git — git status showed
    no ?? entries at all. Fixed in refactor(coverage): split src/coverage.sh into a src/coverage/ module #928 by anchoring to /coverage/, but check
    git check-ignore -v src/<newmodule>/<file>.sh before committing any new module.
  • CI runs ShellCheck per file without -x, so it cannot follow source. A monolith hides
    cross-file variable use; splitting exposes it as SC2034. In refactor(coverage): split src/coverage.sh into a src/coverage/ module #928 this surfaced a genuinely
    dead local. Reproduce CI's mode locally before pushing:
    for f in $(git ls-files '*.sh') bashunit; do shellcheck --format=gcc "$f"; done
    with SHELLCHECK_OPTS="-e SC1091 -e SC2155 -e SC2016".
  • Check .editorconfig for per-file rules on the file being split.[src/coverage.sh] max_line_length = unset would have been lost by the split; refactor(coverage): split src/coverage.sh into a src/coverage/ module #928 rescoped it to the two
    files that actually needed it and reflowed the rest. Decide deliberately and state the
    decision in the PR.
  • Dynamic-scope helper groups cannot be separated. Functions that mutate a caller's locals
    must land in the same file as their caller, with the justification comment
    (.claude/rules/bash-style.md). src/coverage/branches.sh is the precedent.
  • Tests stay flat.make test globs exactly one level — never create tests/unit/<module>/.
  • Bash 3.0+ floor; per-test paths stay fork-free (.claude/rules/perf-fork-budget.md).

Verification, per PR

Prove the change is a relocation by comparing the non-blank line multiset before and after —
it must differ only by the new shebangs and module header comments — plus an unchanged
function count:

git show main:src/<file>.sh | grep -vE '^[[:space:]]*$'| sort > /tmp/before.txt
cat src/<module>/*.sh | grep -vE '^[[:space:]]*$'| sort > /tmp/after.txt
comm -3 /tmp/before.txt /tmp/after.txt

Then: ./bashunit tests/ · ./bashunit --parallel tests/ ·
./bashunit --parallel --simple --strict tests/ · make sa · make lint ·
fork-budget acceptance tests · bash build.sh bin -v printing ✅ Build verified ✅.
Add ./bashunit --coverage --parallel tests/ when the module touches coverage.

Acceptance criteria (per module PR)

  • Responsibility map posted and agreed before code moves
  • git diff shows only relocations — no renamed functions, no changed logic
  • Aggregator contains only source lines and comments
  • Every new file's first line is #!/usr/bin/env bash
  • git check-ignore -v confirms the new directory is not ignored
  • CI-mode ShellCheck (per file, no -x) clean
  • .editorconfig per-file rules reviewed; decision stated in the PR
  • All suites above green, including bash build.sh bin -v
  • .claude/rules/architecture-map.md module table updated
  • No CHANGELOG entry — internal, no user-visible behaviour change

Do not

  • Do not start moving code before the responsibility map is posted
  • Do not rename functions or change behaviour
  • Do not split more than one module per PR
  • Do not create tests/unit/<module>/
  • Do not run shfmt -w; make lint is the format gate

Note on build.sh — no work needed

build.sh already handles arbitrary nesting. build::process_file is a depth-first walk of
source statements, not a directory walk: it emits a file's body, recurses into every
^source line, dedupes on repo-relative path (#923), and strips all source lines from the
artifact. Verified on main with a throwaway three-level module
(src/x.sh → src/x/mid.sh → src/x/deep/leaf.sh): all three bodies embedded in DFS order,
zero source lines left in the output. Depth is pinned by a regression test in a separate
issue.

Metadata

Metadata

Assignees

Labels

refactoringRefactoring or cleaning related

Projects

  • Status
    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
refactor(src): finish the module split — 9 large files still flat · Issue #931 · TypedDevs/bashunit · GitHub
Skip to content

refactor(src): finish the module split — 9 large files still flat #931

Description

@Chemaclass

Summary

src/ is half-migrated. runner and coverage are module directories (#924, #925); the
other 37 files are still flat, and nine of them are large enough to deserve the same
treatment. Finish the migration, one module per PR.

Measured on main (7eecc45): 40 flat .sh files + 3 module directories, 15,614 lines total.

Convention: settled

The aggregator lives inside the module directory as index.sh:

src/runner/index.sh <- entry point
src/runner/exec.sh
src/coverage/index.sh
src/coverage/engine.sh

Decided and applied to both existing modules in #934; ADR-010 amended with the reasoning.
The original "beside" choice (src/runner.sh + src/runner/*.sh) rested on matching the
src/assertions.sh precedent, which does not apply — assertions.sh aggregates flat files
and has no directory. What settled it: the "aggregators hold only source lines" rule was
enforced against a hand-maintained list that had already drifted (#928 added src/coverage.sh
and never appended it), and a predictable src/*/index.sh lets that test discover modules by
glob instead.

Every new module in this issue uses index.sh. Do not mix placements.

What is left to split

FileLinesFnsNote
src/main.sh142224flag parsing + every subcommand's cmd_* in one file
src/learn.sh121382the interactive tutorial; self-contained, lowest risk
src/assert.sh97042the core assertion catalogue — cohesive, may not want splitting
src/helpers.sh90930discovery, fn filtering, provider map, duplicate check, ids
src/console_results.sh82827totals rendering + deferred failure/skip blocks
src/env.sh75451BASHUNIT_* defaults, config files, scratch dirs
src/test_doubles.sh47017spies + mocks
src/reports.sh43418JUnit/HTML/TAP/JSON writers — one per format is the obvious seam
src/state.sh40442counters + payload encode/decode + TAP conversion

Separately, ~20 files under 120 lines (colors, str, math, io, globals,
check_os, dependencies, …) could group into a src/util/ module. Lower value than the
big files — grouping small cohesive files buys navigation, not comprehension. Treat as
optional and last.

Do not split all nine in one PR. One module per PR, same as #924 and #925, so each stays
reviewable as a pure relocation.

Per-module process (proven by #924 and #925)

  1. Post a responsibility map on the issue and get it agreed before moving code: one-line
    summary per function, the internal call graph, every _BASHUNIT_* global with who assigns
    and who reads it, and a proposed acyclic layering. Generate it from the file, do not
    eyeball it.
  2. Split. git diff must show only relocations — no renamed functions, no changed logic.
  3. Verify (below), then open the PR.

Constraints — all of these have already drawn blood

  • Aggregators may contain only source lines and comments.build::process_file emits a
    file's body and then recurses into its sources, so any statement in an aggregator runs
    before its dependencies in the built binary but after them in dev mode. Enforced by
    test_module_aggregators_hold_only_source_lines_and_comments.
  • File-scope initialisers must move with their module, and order-dependent ones must stay
    contiguous.
    In refactor(coverage): split src/coverage.sh into a src/coverage/ module #928, _BASHUNIT_COVERAGE_XTRACE_PS4 expands $_BASHUNIT_COVERAGE_XTRACE_FS
    at file scope, and _NONEXEC_PATTERN is built across 7 successive lines. Grep for
    file-scope assignments that read another file-scope variable before splitting.
  • .gitignore can silently swallow a new module directory.coverage/ was unanchored, so
    it matched src/coverage/ and excluded all twelve new files from git — git status showed
    no ?? entries at all. Fixed in refactor(coverage): split src/coverage.sh into a src/coverage/ module #928 by anchoring to /coverage/, but check
    git check-ignore -v src/<newmodule>/<file>.sh before committing any new module.
  • CI runs ShellCheck per file without -x, so it cannot follow source. A monolith hides
    cross-file variable use; splitting exposes it as SC2034. In refactor(coverage): split src/coverage.sh into a src/coverage/ module #928 this surfaced a genuinely
    dead local. Reproduce CI's mode locally before pushing:
    for f in $(git ls-files '*.sh') bashunit; do shellcheck --format=gcc "$f"; done
    with SHELLCHECK_OPTS="-e SC1091 -e SC2155 -e SC2016".
  • Check .editorconfig for per-file rules on the file being split.[src/coverage.sh] max_line_length = unset would have been lost by the split; refactor(coverage): split src/coverage.sh into a src/coverage/ module #928 rescoped it to the two
    files that actually needed it and reflowed the rest. Decide deliberately and state the
    decision in the PR.
  • Dynamic-scope helper groups cannot be separated. Functions that mutate a caller's locals
    must land in the same file as their caller, with the justification comment
    (.claude/rules/bash-style.md). src/coverage/branches.sh is the precedent.
  • Tests stay flat.make test globs exactly one level — never create tests/unit/<module>/.
  • Bash 3.0+ floor; per-test paths stay fork-free (.claude/rules/perf-fork-budget.md).

Verification, per PR

Prove the change is a relocation by comparing the non-blank line multiset before and after —
it must differ only by the new shebangs and module header comments — plus an unchanged
function count:

git show main:src/<file>.sh | grep -vE '^[[:space:]]*$'| sort > /tmp/before.txt
cat src/<module>/*.sh | grep -vE '^[[:space:]]*$'| sort > /tmp/after.txt
comm -3 /tmp/before.txt /tmp/after.txt

Then: ./bashunit tests/ · ./bashunit --parallel tests/ ·
./bashunit --parallel --simple --strict tests/ · make sa · make lint ·
fork-budget acceptance tests · bash build.sh bin -v printing ✅ Build verified ✅.
Add ./bashunit --coverage --parallel tests/ when the module touches coverage.

Acceptance criteria (per module PR)

  • Responsibility map posted and agreed before code moves
  • git diff shows only relocations — no renamed functions, no changed logic
  • Aggregator contains only source lines and comments
  • Every new file's first line is #!/usr/bin/env bash
  • git check-ignore -v confirms the new directory is not ignored
  • CI-mode ShellCheck (per file, no -x) clean
  • .editorconfig per-file rules reviewed; decision stated in the PR
  • All suites above green, including bash build.sh bin -v
  • .claude/rules/architecture-map.md module table updated
  • No CHANGELOG entry — internal, no user-visible behaviour change

Do not

  • Do not start moving code before the responsibility map is posted
  • Do not rename functions or change behaviour
  • Do not split more than one module per PR
  • Do not create tests/unit/<module>/
  • Do not run shfmt -w; make lint is the format gate

Note on build.sh — no work needed

build.sh already handles arbitrary nesting. build::process_file is a depth-first walk of
source statements, not a directory walk: it emits a file's body, recurses into every
^source line, dedupes on repo-relative path (#923), and strips all source lines from the
artifact. Verified on main with a throwaway three-level module
(src/x.sh → src/x/mid.sh → src/x/deep/leaf.sh): all three bodies embedded in DFS order,
zero source lines left in the output. Depth is pinned by a regression test in a separate
issue.

Metadata

Metadata

Assignees

Labels

refactoringRefactoring or cleaning related

Projects

  • Status
    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' refactor(src): finish the module split — 9 large files still flat · Issue #931 · TypedDevs/bashunit · GitHub
Skip to content

refactor(src): finish the module split — 9 large files still flat #931

Description

@Chemaclass

Summary

src/ is half-migrated. runner and coverage are module directories (#924, #925); the
other 37 files are still flat, and nine of them are large enough to deserve the same
treatment. Finish the migration, one module per PR.

Measured on main (7eecc45): 40 flat .sh files + 3 module directories, 15,614 lines total.

Convention: settled

The aggregator lives inside the module directory as index.sh:

src/runner/index.sh <- entry point
src/runner/exec.sh
src/coverage/index.sh
src/coverage/engine.sh

Decided and applied to both existing modules in #934; ADR-010 amended with the reasoning.
The original "beside" choice (src/runner.sh + src/runner/*.sh) rested on matching the
src/assertions.sh precedent, which does not apply — assertions.sh aggregates flat files
and has no directory. What settled it: the "aggregators hold only source lines" rule was
enforced against a hand-maintained list that had already drifted (#928 added src/coverage.sh
and never appended it), and a predictable src/*/index.sh lets that test discover modules by
glob instead.

Every new module in this issue uses index.sh. Do not mix placements.

What is left to split

FileLinesFnsNote
src/main.sh142224flag parsing + every subcommand's cmd_* in one file
src/learn.sh121382the interactive tutorial; self-contained, lowest risk
src/assert.sh97042the core assertion catalogue — cohesive, may not want splitting
src/helpers.sh90930discovery, fn filtering, provider map, duplicate check, ids
src/console_results.sh82827totals rendering + deferred failure/skip blocks
src/env.sh75451BASHUNIT_* defaults, config files, scratch dirs
src/test_doubles.sh47017spies + mocks
src/reports.sh43418JUnit/HTML/TAP/JSON writers — one per format is the obvious seam
src/state.sh40442counters + payload encode/decode + TAP conversion

Separately, ~20 files under 120 lines (colors, str, math, io, globals,
check_os, dependencies, …) could group into a src/util/ module. Lower value than the
big files — grouping small cohesive files buys navigation, not comprehension. Treat as
optional and last.

Do not split all nine in one PR. One module per PR, same as #924 and #925, so each stays
reviewable as a pure relocation.

Per-module process (proven by #924 and #925)

  1. Post a responsibility map on the issue and get it agreed before moving code: one-line
    summary per function, the internal call graph, every _BASHUNIT_* global with who assigns
    and who reads it, and a proposed acyclic layering. Generate it from the file, do not
    eyeball it.
  2. Split. git diff must show only relocations — no renamed functions, no changed logic.
  3. Verify (below), then open the PR.

Constraints — all of these have already drawn blood

  • Aggregators may contain only source lines and comments.build::process_file emits a
    file's body and then recurses into its sources, so any statement in an aggregator runs
    before its dependencies in the built binary but after them in dev mode. Enforced by
    test_module_aggregators_hold_only_source_lines_and_comments.
  • File-scope initialisers must move with their module, and order-dependent ones must stay
    contiguous.
    In refactor(coverage): split src/coverage.sh into a src/coverage/ module #928, _BASHUNIT_COVERAGE_XTRACE_PS4 expands $_BASHUNIT_COVERAGE_XTRACE_FS
    at file scope, and _NONEXEC_PATTERN is built across 7 successive lines. Grep for
    file-scope assignments that read another file-scope variable before splitting.
  • .gitignore can silently swallow a new module directory.coverage/ was unanchored, so
    it matched src/coverage/ and excluded all twelve new files from git — git status showed
    no ?? entries at all. Fixed in refactor(coverage): split src/coverage.sh into a src/coverage/ module #928 by anchoring to /coverage/, but check
    git check-ignore -v src/<newmodule>/<file>.sh before committing any new module.
  • CI runs ShellCheck per file without -x, so it cannot follow source. A monolith hides
    cross-file variable use; splitting exposes it as SC2034. In refactor(coverage): split src/coverage.sh into a src/coverage/ module #928 this surfaced a genuinely
    dead local. Reproduce CI's mode locally before pushing:
    for f in $(git ls-files '*.sh') bashunit; do shellcheck --format=gcc "$f"; done
    with SHELLCHECK_OPTS="-e SC1091 -e SC2155 -e SC2016".
  • Check .editorconfig for per-file rules on the file being split.[src/coverage.sh] max_line_length = unset would have been lost by the split; refactor(coverage): split src/coverage.sh into a src/coverage/ module #928 rescoped it to the two
    files that actually needed it and reflowed the rest. Decide deliberately and state the
    decision in the PR.
  • Dynamic-scope helper groups cannot be separated. Functions that mutate a caller's locals
    must land in the same file as their caller, with the justification comment
    (.claude/rules/bash-style.md). src/coverage/branches.sh is the precedent.
  • Tests stay flat.make test globs exactly one level — never create tests/unit/<module>/.
  • Bash 3.0+ floor; per-test paths stay fork-free (.claude/rules/perf-fork-budget.md).

Verification, per PR

Prove the change is a relocation by comparing the non-blank line multiset before and after —
it must differ only by the new shebangs and module header comments — plus an unchanged
function count:

git show main:src/<file>.sh | grep -vE '^[[:space:]]*$'| sort > /tmp/before.txt
cat src/<module>/*.sh | grep -vE '^[[:space:]]*$'| sort > /tmp/after.txt
comm -3 /tmp/before.txt /tmp/after.txt

Then: ./bashunit tests/ · ./bashunit --parallel tests/ ·
./bashunit --parallel --simple --strict tests/ · make sa · make lint ·
fork-budget acceptance tests · bash build.sh bin -v printing ✅ Build verified ✅.
Add ./bashunit --coverage --parallel tests/ when the module touches coverage.

Acceptance criteria (per module PR)

  • Responsibility map posted and agreed before code moves
  • git diff shows only relocations — no renamed functions, no changed logic
  • Aggregator contains only source lines and comments
  • Every new file's first line is #!/usr/bin/env bash
  • git check-ignore -v confirms the new directory is not ignored
  • CI-mode ShellCheck (per file, no -x) clean
  • .editorconfig per-file rules reviewed; decision stated in the PR
  • All suites above green, including bash build.sh bin -v
  • .claude/rules/architecture-map.md module table updated
  • No CHANGELOG entry — internal, no user-visible behaviour change

Do not

  • Do not start moving code before the responsibility map is posted
  • Do not rename functions or change behaviour
  • Do not split more than one module per PR
  • Do not create tests/unit/<module>/
  • Do not run shfmt -w; make lint is the format gate

Note on build.sh — no work needed

build.sh already handles arbitrary nesting. build::process_file is a depth-first walk of
source statements, not a directory walk: it emits a file's body, recurses into every
^source line, dedupes on repo-relative path (#923), and strips all source lines from the
artifact. Verified on main with a throwaway three-level module
(src/x.sh → src/x/mid.sh → src/x/deep/leaf.sh): all three bodies embedded in DFS order,
zero source lines left in the output. Depth is pinned by a regression test in a separate
issue.

Metadata

Metadata

Assignees

Labels

refactoringRefactoring or cleaning related

Projects

  • Status
    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

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

refactor(src): finish the module split — 9 large files still flat #931

Description

@Chemaclass

Summary

src/ is half-migrated. runner and coverage are module directories (#924, #925); the
other 37 files are still flat, and nine of them are large enough to deserve the same
treatment. Finish the migration, one module per PR.

Measured on main (7eecc45): 40 flat .sh files + 3 module directories, 15,614 lines total.

Convention: settled

The aggregator lives inside the module directory as index.sh:

src/runner/index.sh <- entry point
src/runner/exec.sh
src/coverage/index.sh
src/coverage/engine.sh

Decided and applied to both existing modules in #934; ADR-010 amended with the reasoning.
The original "beside" choice (src/runner.sh + src/runner/*.sh) rested on matching the
src/assertions.sh precedent, which does not apply — assertions.sh aggregates flat files
and has no directory. What settled it: the "aggregators hold only source lines" rule was
enforced against a hand-maintained list that had already drifted (#928 added src/coverage.sh
and never appended it), and a predictable src/*/index.sh lets that test discover modules by
glob instead.

Every new module in this issue uses index.sh. Do not mix placements.

What is left to split

FileLinesFnsNote
src/main.sh142224flag parsing + every subcommand's cmd_* in one file
src/learn.sh121382the interactive tutorial; self-contained, lowest risk
src/assert.sh97042the core assertion catalogue — cohesive, may not want splitting
src/helpers.sh90930discovery, fn filtering, provider map, duplicate check, ids
src/console_results.sh82827totals rendering + deferred failure/skip blocks
src/env.sh75451BASHUNIT_* defaults, config files, scratch dirs
src/test_doubles.sh47017spies + mocks
src/reports.sh43418JUnit/HTML/TAP/JSON writers — one per format is the obvious seam
src/state.sh40442counters + payload encode/decode + TAP conversion

Separately, ~20 files under 120 lines (colors, str, math, io, globals,
check_os, dependencies, …) could group into a src/util/ module. Lower value than the
big files — grouping small cohesive files buys navigation, not comprehension. Treat as
optional and last.

Do not split all nine in one PR. One module per PR, same as #924 and #925, so each stays
reviewable as a pure relocation.

Per-module process (proven by #924 and #925)

  1. Post a responsibility map on the issue and get it agreed before moving code: one-line
    summary per function, the internal call graph, every _BASHUNIT_* global with who assigns
    and who reads it, and a proposed acyclic layering. Generate it from the file, do not
    eyeball it.
  2. Split. git diff must show only relocations — no renamed functions, no changed logic.
  3. Verify (below), then open the PR.

Constraints — all of these have already drawn blood

  • Aggregators may contain only source lines and comments.build::process_file emits a
    file's body and then recurses into its sources, so any statement in an aggregator runs
    before its dependencies in the built binary but after them in dev mode. Enforced by
    test_module_aggregators_hold_only_source_lines_and_comments.
  • File-scope initialisers must move with their module, and order-dependent ones must stay
    contiguous.
    In refactor(coverage): split src/coverage.sh into a src/coverage/ module #928, _BASHUNIT_COVERAGE_XTRACE_PS4 expands $_BASHUNIT_COVERAGE_XTRACE_FS
    at file scope, and _NONEXEC_PATTERN is built across 7 successive lines. Grep for
    file-scope assignments that read another file-scope variable before splitting.
  • .gitignore can silently swallow a new module directory.coverage/ was unanchored, so
    it matched src/coverage/ and excluded all twelve new files from git — git status showed
    no ?? entries at all. Fixed in refactor(coverage): split src/coverage.sh into a src/coverage/ module #928 by anchoring to /coverage/, but check
    git check-ignore -v src/<newmodule>/<file>.sh before committing any new module.
  • CI runs ShellCheck per file without -x, so it cannot follow source. A monolith hides
    cross-file variable use; splitting exposes it as SC2034. In refactor(coverage): split src/coverage.sh into a src/coverage/ module #928 this surfaced a genuinely
    dead local. Reproduce CI's mode locally before pushing:
    for f in $(git ls-files '*.sh') bashunit; do shellcheck --format=gcc "$f"; done
    with SHELLCHECK_OPTS="-e SC1091 -e SC2155 -e SC2016".
  • Check .editorconfig for per-file rules on the file being split.[src/coverage.sh] max_line_length = unset would have been lost by the split; refactor(coverage): split src/coverage.sh into a src/coverage/ module #928 rescoped it to the two
    files that actually needed it and reflowed the rest. Decide deliberately and state the
    decision in the PR.
  • Dynamic-scope helper groups cannot be separated. Functions that mutate a caller's locals
    must land in the same file as their caller, with the justification comment
    (.claude/rules/bash-style.md). src/coverage/branches.sh is the precedent.
  • Tests stay flat.make test globs exactly one level — never create tests/unit/<module>/.
  • Bash 3.0+ floor; per-test paths stay fork-free (.claude/rules/perf-fork-budget.md).

Verification, per PR

Prove the change is a relocation by comparing the non-blank line multiset before and after —
it must differ only by the new shebangs and module header comments — plus an unchanged
function count:

git show main:src/<file>.sh | grep -vE '^[[:space:]]*$'| sort > /tmp/before.txt
cat src/<module>/*.sh | grep -vE '^[[:space:]]*$'| sort > /tmp/after.txt
comm -3 /tmp/before.txt /tmp/after.txt

Then: ./bashunit tests/ · ./bashunit --parallel tests/ ·
./bashunit --parallel --simple --strict tests/ · make sa · make lint ·
fork-budget acceptance tests · bash build.sh bin -v printing ✅ Build verified ✅.
Add ./bashunit --coverage --parallel tests/ when the module touches coverage.

Acceptance criteria (per module PR)

  • Responsibility map posted and agreed before code moves
  • git diff shows only relocations — no renamed functions, no changed logic
  • Aggregator contains only source lines and comments
  • Every new file's first line is #!/usr/bin/env bash
  • git check-ignore -v confirms the new directory is not ignored
  • CI-mode ShellCheck (per file, no -x) clean
  • .editorconfig per-file rules reviewed; decision stated in the PR
  • All suites above green, including bash build.sh bin -v
  • .claude/rules/architecture-map.md module table updated
  • No CHANGELOG entry — internal, no user-visible behaviour change

Do not

  • Do not start moving code before the responsibility map is posted
  • Do not rename functions or change behaviour
  • Do not split more than one module per PR
  • Do not create tests/unit/<module>/
  • Do not run shfmt -w; make lint is the format gate

Note on build.sh — no work needed

build.sh already handles arbitrary nesting. build::process_file is a depth-first walk of
source statements, not a directory walk: it emits a file's body, recurses into every
^source line, dedupes on repo-relative path (#923), and strips all source lines from the
artifact. Verified on main with a throwaway three-level module
(src/x.sh → src/x/mid.sh → src/x/deep/leaf.sh): all three bodies embedded in DFS order,
zero source lines left in the output. Depth is pinned by a regression test in a separate
issue.

Metadata

Metadata

Assignees

Labels

refactoringRefactoring or cleaning related

Projects

  • Status
    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

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

refactor(src): finish the module split — 9 large files still flat #931

Description

@Chemaclass

Summary

src/ is half-migrated. runner and coverage are module directories (#924, #925); the
other 37 files are still flat, and nine of them are large enough to deserve the same
treatment. Finish the migration, one module per PR.

Measured on main (7eecc45): 40 flat .sh files + 3 module directories, 15,614 lines total.

Convention: settled

The aggregator lives inside the module directory as index.sh:

src/runner/index.sh <- entry point
src/runner/exec.sh
src/coverage/index.sh
src/coverage/engine.sh

Decided and applied to both existing modules in #934; ADR-010 amended with the reasoning.
The original "beside" choice (src/runner.sh + src/runner/*.sh) rested on matching the
src/assertions.sh precedent, which does not apply — assertions.sh aggregates flat files
and has no directory. What settled it: the "aggregators hold only source lines" rule was
enforced against a hand-maintained list that had already drifted (#928 added src/coverage.sh
and never appended it), and a predictable src/*/index.sh lets that test discover modules by
glob instead.

Every new module in this issue uses index.sh. Do not mix placements.

What is left to split

FileLinesFnsNote
src/main.sh142224flag parsing + every subcommand's cmd_* in one file
src/learn.sh121382the interactive tutorial; self-contained, lowest risk
src/assert.sh97042the core assertion catalogue — cohesive, may not want splitting
src/helpers.sh90930discovery, fn filtering, provider map, duplicate check, ids
src/console_results.sh82827totals rendering + deferred failure/skip blocks
src/env.sh75451BASHUNIT_* defaults, config files, scratch dirs
src/test_doubles.sh47017spies + mocks
src/reports.sh43418JUnit/HTML/TAP/JSON writers — one per format is the obvious seam
src/state.sh40442counters + payload encode/decode + TAP conversion

Separately, ~20 files under 120 lines (colors, str, math, io, globals,
check_os, dependencies, …) could group into a src/util/ module. Lower value than the
big files — grouping small cohesive files buys navigation, not comprehension. Treat as
optional and last.

Do not split all nine in one PR. One module per PR, same as #924 and #925, so each stays
reviewable as a pure relocation.

Per-module process (proven by #924 and #925)

  1. Post a responsibility map on the issue and get it agreed before moving code: one-line
    summary per function, the internal call graph, every _BASHUNIT_* global with who assigns
    and who reads it, and a proposed acyclic layering. Generate it from the file, do not
    eyeball it.
  2. Split. git diff must show only relocations — no renamed functions, no changed logic.
  3. Verify (below), then open the PR.

Constraints — all of these have already drawn blood

  • Aggregators may contain only source lines and comments.build::process_file emits a
    file's body and then recurses into its sources, so any statement in an aggregator runs
    before its dependencies in the built binary but after them in dev mode. Enforced by
    test_module_aggregators_hold_only_source_lines_and_comments.
  • File-scope initialisers must move with their module, and order-dependent ones must stay
    contiguous.
    In refactor(coverage): split src/coverage.sh into a src/coverage/ module #928, _BASHUNIT_COVERAGE_XTRACE_PS4 expands $_BASHUNIT_COVERAGE_XTRACE_FS
    at file scope, and _NONEXEC_PATTERN is built across 7 successive lines. Grep for
    file-scope assignments that read another file-scope variable before splitting.
  • .gitignore can silently swallow a new module directory.coverage/ was unanchored, so
    it matched src/coverage/ and excluded all twelve new files from git — git status showed
    no ?? entries at all. Fixed in refactor(coverage): split src/coverage.sh into a src/coverage/ module #928 by anchoring to /coverage/, but check
    git check-ignore -v src/<newmodule>/<file>.sh before committing any new module.
  • CI runs ShellCheck per file without -x, so it cannot follow source. A monolith hides
    cross-file variable use; splitting exposes it as SC2034. In refactor(coverage): split src/coverage.sh into a src/coverage/ module #928 this surfaced a genuinely
    dead local. Reproduce CI's mode locally before pushing:
    for f in $(git ls-files '*.sh') bashunit; do shellcheck --format=gcc "$f"; done
    with SHELLCHECK_OPTS="-e SC1091 -e SC2155 -e SC2016".
  • Check .editorconfig for per-file rules on the file being split.[src/coverage.sh] max_line_length = unset would have been lost by the split; refactor(coverage): split src/coverage.sh into a src/coverage/ module #928 rescoped it to the two
    files that actually needed it and reflowed the rest. Decide deliberately and state the
    decision in the PR.
  • Dynamic-scope helper groups cannot be separated. Functions that mutate a caller's locals
    must land in the same file as their caller, with the justification comment
    (.claude/rules/bash-style.md). src/coverage/branches.sh is the precedent.
  • Tests stay flat.make test globs exactly one level — never create tests/unit/<module>/.
  • Bash 3.0+ floor; per-test paths stay fork-free (.claude/rules/perf-fork-budget.md).

Verification, per PR

Prove the change is a relocation by comparing the non-blank line multiset before and after —
it must differ only by the new shebangs and module header comments — plus an unchanged
function count:

git show main:src/<file>.sh | grep -vE '^[[:space:]]*$'| sort > /tmp/before.txt
cat src/<module>/*.sh | grep -vE '^[[:space:]]*$'| sort > /tmp/after.txt
comm -3 /tmp/before.txt /tmp/after.txt

Then: ./bashunit tests/ · ./bashunit --parallel tests/ ·
./bashunit --parallel --simple --strict tests/ · make sa · make lint ·
fork-budget acceptance tests · bash build.sh bin -v printing ✅ Build verified ✅.
Add ./bashunit --coverage --parallel tests/ when the module touches coverage.

Acceptance criteria (per module PR)

  • Responsibility map posted and agreed before code moves
  • git diff shows only relocations — no renamed functions, no changed logic
  • Aggregator contains only source lines and comments
  • Every new file's first line is #!/usr/bin/env bash
  • git check-ignore -v confirms the new directory is not ignored
  • CI-mode ShellCheck (per file, no -x) clean
  • .editorconfig per-file rules reviewed; decision stated in the PR
  • All suites above green, including bash build.sh bin -v
  • .claude/rules/architecture-map.md module table updated
  • No CHANGELOG entry — internal, no user-visible behaviour change

Do not

  • Do not start moving code before the responsibility map is posted
  • Do not rename functions or change behaviour
  • Do not split more than one module per PR
  • Do not create tests/unit/<module>/
  • Do not run shfmt -w; make lint is the format gate

Note on build.sh — no work needed

build.sh already handles arbitrary nesting. build::process_file is a depth-first walk of
source statements, not a directory walk: it emits a file's body, recurses into every
^source line, dedupes on repo-relative path (#923), and strips all source lines from the
artifact. Verified on main with a throwaway three-level module
(src/x.sh → src/x/mid.sh → src/x/deep/leaf.sh): all three bodies embedded in DFS order,
zero source lines left in the output. Depth is pinned by a regression test in a separate
issue.

Metadata

Metadata

Assignees

Labels

refactoringRefactoring or cleaning related

Projects

  • Status
    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' refactor(src): finish the module split — 9 large files still flat · Issue #931 · TypedDevs/bashunit · GitHub
Skip to content

refactor(src): finish the module split — 9 large files still flat #931

Description

@Chemaclass

Summary

src/ is half-migrated. runner and coverage are module directories (#924, #925); the
other 37 files are still flat, and nine of them are large enough to deserve the same
treatment. Finish the migration, one module per PR.

Measured on main (7eecc45): 40 flat .sh files + 3 module directories, 15,614 lines total.

Convention: settled

The aggregator lives inside the module directory as index.sh:

src/runner/index.sh <- entry point
src/runner/exec.sh
src/coverage/index.sh
src/coverage/engine.sh

Decided and applied to both existing modules in #934; ADR-010 amended with the reasoning.
The original "beside" choice (src/runner.sh + src/runner/*.sh) rested on matching the
src/assertions.sh precedent, which does not apply — assertions.sh aggregates flat files
and has no directory. What settled it: the "aggregators hold only source lines" rule was
enforced against a hand-maintained list that had already drifted (#928 added src/coverage.sh
and never appended it), and a predictable src/*/index.sh lets that test discover modules by
glob instead.

Every new module in this issue uses index.sh. Do not mix placements.

What is left to split

FileLinesFnsNote
src/main.sh142224flag parsing + every subcommand's cmd_* in one file
src/learn.sh121382the interactive tutorial; self-contained, lowest risk
src/assert.sh97042the core assertion catalogue — cohesive, may not want splitting
src/helpers.sh90930discovery, fn filtering, provider map, duplicate check, ids
src/console_results.sh82827totals rendering + deferred failure/skip blocks
src/env.sh75451BASHUNIT_* defaults, config files, scratch dirs
src/test_doubles.sh47017spies + mocks
src/reports.sh43418JUnit/HTML/TAP/JSON writers — one per format is the obvious seam
src/state.sh40442counters + payload encode/decode + TAP conversion

Separately, ~20 files under 120 lines (colors, str, math, io, globals,
check_os, dependencies, …) could group into a src/util/ module. Lower value than the
big files — grouping small cohesive files buys navigation, not comprehension. Treat as
optional and last.

Do not split all nine in one PR. One module per PR, same as #924 and #925, so each stays
reviewable as a pure relocation.

Per-module process (proven by #924 and #925)

  1. Post a responsibility map on the issue and get it agreed before moving code: one-line
    summary per function, the internal call graph, every _BASHUNIT_* global with who assigns
    and who reads it, and a proposed acyclic layering. Generate it from the file, do not
    eyeball it.
  2. Split. git diff must show only relocations — no renamed functions, no changed logic.
  3. Verify (below), then open the PR.

Constraints — all of these have already drawn blood

  • Aggregators may contain only source lines and comments.build::process_file emits a
    file's body and then recurses into its sources, so any statement in an aggregator runs
    before its dependencies in the built binary but after them in dev mode. Enforced by
    test_module_aggregators_hold_only_source_lines_and_comments.
  • File-scope initialisers must move with their module, and order-dependent ones must stay
    contiguous.
    In refactor(coverage): split src/coverage.sh into a src/coverage/ module #928, _BASHUNIT_COVERAGE_XTRACE_PS4 expands $_BASHUNIT_COVERAGE_XTRACE_FS
    at file scope, and _NONEXEC_PATTERN is built across 7 successive lines. Grep for
    file-scope assignments that read another file-scope variable before splitting.
  • .gitignore can silently swallow a new module directory.coverage/ was unanchored, so
    it matched src/coverage/ and excluded all twelve new files from git — git status showed
    no ?? entries at all. Fixed in refactor(coverage): split src/coverage.sh into a src/coverage/ module #928 by anchoring to /coverage/, but check
    git check-ignore -v src/<newmodule>/<file>.sh before committing any new module.
  • CI runs ShellCheck per file without -x, so it cannot follow source. A monolith hides
    cross-file variable use; splitting exposes it as SC2034. In refactor(coverage): split src/coverage.sh into a src/coverage/ module #928 this surfaced a genuinely
    dead local. Reproduce CI's mode locally before pushing:
    for f in $(git ls-files '*.sh') bashunit; do shellcheck --format=gcc "$f"; done
    with SHELLCHECK_OPTS="-e SC1091 -e SC2155 -e SC2016".
  • Check .editorconfig for per-file rules on the file being split.[src/coverage.sh] max_line_length = unset would have been lost by the split; refactor(coverage): split src/coverage.sh into a src/coverage/ module #928 rescoped it to the two
    files that actually needed it and reflowed the rest. Decide deliberately and state the
    decision in the PR.
  • Dynamic-scope helper groups cannot be separated. Functions that mutate a caller's locals
    must land in the same file as their caller, with the justification comment
    (.claude/rules/bash-style.md). src/coverage/branches.sh is the precedent.
  • Tests stay flat.make test globs exactly one level — never create tests/unit/<module>/.
  • Bash 3.0+ floor; per-test paths stay fork-free (.claude/rules/perf-fork-budget.md).

Verification, per PR

Prove the change is a relocation by comparing the non-blank line multiset before and after —
it must differ only by the new shebangs and module header comments — plus an unchanged
function count:

git show main:src/<file>.sh | grep -vE '^[[:space:]]*$'| sort > /tmp/before.txt
cat src/<module>/*.sh | grep -vE '^[[:space:]]*$'| sort > /tmp/after.txt
comm -3 /tmp/before.txt /tmp/after.txt

Then: ./bashunit tests/ · ./bashunit --parallel tests/ ·
./bashunit --parallel --simple --strict tests/ · make sa · make lint ·
fork-budget acceptance tests · bash build.sh bin -v printing ✅ Build verified ✅.
Add ./bashunit --coverage --parallel tests/ when the module touches coverage.

Acceptance criteria (per module PR)

  • Responsibility map posted and agreed before code moves
  • git diff shows only relocations — no renamed functions, no changed logic
  • Aggregator contains only source lines and comments
  • Every new file's first line is #!/usr/bin/env bash
  • git check-ignore -v confirms the new directory is not ignored
  • CI-mode ShellCheck (per file, no -x) clean
  • .editorconfig per-file rules reviewed; decision stated in the PR
  • All suites above green, including bash build.sh bin -v
  • .claude/rules/architecture-map.md module table updated
  • No CHANGELOG entry — internal, no user-visible behaviour change

Do not

  • Do not start moving code before the responsibility map is posted
  • Do not rename functions or change behaviour
  • Do not split more than one module per PR
  • Do not create tests/unit/<module>/
  • Do not run shfmt -w; make lint is the format gate

Note on build.sh — no work needed

build.sh already handles arbitrary nesting. build::process_file is a depth-first walk of
source statements, not a directory walk: it emits a file's body, recurses into every
^source line, dedupes on repo-relative path (#923), and strips all source lines from the
artifact. Verified on main with a throwaway three-level module
(src/x.sh → src/x/mid.sh → src/x/deep/leaf.sh): all three bodies embedded in DFS order,
zero source lines left in the output. Depth is pinned by a regression test in a separate
issue.

Metadata

Metadata

Assignees

Labels

refactoringRefactoring or cleaning related

Projects

  • Status
    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' refactor(src): finish the module split — 9 large files still flat · Issue #931 · TypedDevs/bashunit · GitHub
Skip to content

refactor(src): finish the module split — 9 large files still flat #931

Description

@Chemaclass

Summary

src/ is half-migrated. runner and coverage are module directories (#924, #925); the
other 37 files are still flat, and nine of them are large enough to deserve the same
treatment. Finish the migration, one module per PR.

Measured on main (7eecc45): 40 flat .sh files + 3 module directories, 15,614 lines total.

Convention: settled

The aggregator lives inside the module directory as index.sh:

src/runner/index.sh <- entry point
src/runner/exec.sh
src/coverage/index.sh
src/coverage/engine.sh

Decided and applied to both existing modules in #934; ADR-010 amended with the reasoning.
The original "beside" choice (src/runner.sh + src/runner/*.sh) rested on matching the
src/assertions.sh precedent, which does not apply — assertions.sh aggregates flat files
and has no directory. What settled it: the "aggregators hold only source lines" rule was
enforced against a hand-maintained list that had already drifted (#928 added src/coverage.sh
and never appended it), and a predictable src/*/index.sh lets that test discover modules by
glob instead.

Every new module in this issue uses index.sh. Do not mix placements.

What is left to split

FileLinesFnsNote
src/main.sh142224flag parsing + every subcommand's cmd_* in one file
src/learn.sh121382the interactive tutorial; self-contained, lowest risk
src/assert.sh97042the core assertion catalogue — cohesive, may not want splitting
src/helpers.sh90930discovery, fn filtering, provider map, duplicate check, ids
src/console_results.sh82827totals rendering + deferred failure/skip blocks
src/env.sh75451BASHUNIT_* defaults, config files, scratch dirs
src/test_doubles.sh47017spies + mocks
src/reports.sh43418JUnit/HTML/TAP/JSON writers — one per format is the obvious seam
src/state.sh40442counters + payload encode/decode + TAP conversion

Separately, ~20 files under 120 lines (colors, str, math, io, globals,
check_os, dependencies, …) could group into a src/util/ module. Lower value than the
big files — grouping small cohesive files buys navigation, not comprehension. Treat as
optional and last.

Do not split all nine in one PR. One module per PR, same as #924 and #925, so each stays
reviewable as a pure relocation.

Per-module process (proven by #924 and #925)

  1. Post a responsibility map on the issue and get it agreed before moving code: one-line
    summary per function, the internal call graph, every _BASHUNIT_* global with who assigns
    and who reads it, and a proposed acyclic layering. Generate it from the file, do not
    eyeball it.
  2. Split. git diff must show only relocations — no renamed functions, no changed logic.
  3. Verify (below), then open the PR.

Constraints — all of these have already drawn blood

  • Aggregators may contain only source lines and comments.build::process_file emits a
    file's body and then recurses into its sources, so any statement in an aggregator runs
    before its dependencies in the built binary but after them in dev mode. Enforced by
    test_module_aggregators_hold_only_source_lines_and_comments.
  • File-scope initialisers must move with their module, and order-dependent ones must stay
    contiguous.
    In refactor(coverage): split src/coverage.sh into a src/coverage/ module #928, _BASHUNIT_COVERAGE_XTRACE_PS4 expands $_BASHUNIT_COVERAGE_XTRACE_FS
    at file scope, and _NONEXEC_PATTERN is built across 7 successive lines. Grep for
    file-scope assignments that read another file-scope variable before splitting.
  • .gitignore can silently swallow a new module directory.coverage/ was unanchored, so
    it matched src/coverage/ and excluded all twelve new files from git — git status showed
    no ?? entries at all. Fixed in refactor(coverage): split src/coverage.sh into a src/coverage/ module #928 by anchoring to /coverage/, but check
    git check-ignore -v src/<newmodule>/<file>.sh before committing any new module.
  • CI runs ShellCheck per file without -x, so it cannot follow source. A monolith hides
    cross-file variable use; splitting exposes it as SC2034. In refactor(coverage): split src/coverage.sh into a src/coverage/ module #928 this surfaced a genuinely
    dead local. Reproduce CI's mode locally before pushing:
    for f in $(git ls-files '*.sh') bashunit; do shellcheck --format=gcc "$f"; done
    with SHELLCHECK_OPTS="-e SC1091 -e SC2155 -e SC2016".
  • Check .editorconfig for per-file rules on the file being split.[src/coverage.sh] max_line_length = unset would have been lost by the split; refactor(coverage): split src/coverage.sh into a src/coverage/ module #928 rescoped it to the two
    files that actually needed it and reflowed the rest. Decide deliberately and state the
    decision in the PR.
  • Dynamic-scope helper groups cannot be separated. Functions that mutate a caller's locals
    must land in the same file as their caller, with the justification comment
    (.claude/rules/bash-style.md). src/coverage/branches.sh is the precedent.
  • Tests stay flat.make test globs exactly one level — never create tests/unit/<module>/.
  • Bash 3.0+ floor; per-test paths stay fork-free (.claude/rules/perf-fork-budget.md).

Verification, per PR

Prove the change is a relocation by comparing the non-blank line multiset before and after —
it must differ only by the new shebangs and module header comments — plus an unchanged
function count:

git show main:src/<file>.sh | grep -vE '^[[:space:]]*$'| sort > /tmp/before.txt
cat src/<module>/*.sh | grep -vE '^[[:space:]]*$'| sort > /tmp/after.txt
comm -3 /tmp/before.txt /tmp/after.txt

Then: ./bashunit tests/ · ./bashunit --parallel tests/ ·
./bashunit --parallel --simple --strict tests/ · make sa · make lint ·
fork-budget acceptance tests · bash build.sh bin -v printing ✅ Build verified ✅.
Add ./bashunit --coverage --parallel tests/ when the module touches coverage.

Acceptance criteria (per module PR)

  • Responsibility map posted and agreed before code moves
  • git diff shows only relocations — no renamed functions, no changed logic
  • Aggregator contains only source lines and comments
  • Every new file's first line is #!/usr/bin/env bash
  • git check-ignore -v confirms the new directory is not ignored
  • CI-mode ShellCheck (per file, no -x) clean
  • .editorconfig per-file rules reviewed; decision stated in the PR
  • All suites above green, including bash build.sh bin -v
  • .claude/rules/architecture-map.md module table updated
  • No CHANGELOG entry — internal, no user-visible behaviour change

Do not

  • Do not start moving code before the responsibility map is posted
  • Do not rename functions or change behaviour
  • Do not split more than one module per PR
  • Do not create tests/unit/<module>/
  • Do not run shfmt -w; make lint is the format gate

Note on build.sh — no work needed

build.sh already handles arbitrary nesting. build::process_file is a depth-first walk of
source statements, not a directory walk: it emits a file's body, recurses into every
^source line, dedupes on repo-relative path (#923), and strips all source lines from the
artifact. Verified on main with a throwaway three-level module
(src/x.sh → src/x/mid.sh → src/x/deep/leaf.sh): all three bodies embedded in DFS order,
zero source lines left in the output. Depth is pinned by a regression test in a separate
issue.

Metadata

Metadata

Assignees

Labels

refactoringRefactoring or cleaning related

Projects

  • Status
    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

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

refactor(src): finish the module split — 9 large files still flat #931

Description

@Chemaclass

Summary

src/ is half-migrated. runner and coverage are module directories (#924, #925); the
other 37 files are still flat, and nine of them are large enough to deserve the same
treatment. Finish the migration, one module per PR.

Measured on main (7eecc45): 40 flat .sh files + 3 module directories, 15,614 lines total.

Convention: settled

The aggregator lives inside the module directory as index.sh:

src/runner/index.sh <- entry point
src/runner/exec.sh
src/coverage/index.sh
src/coverage/engine.sh

Decided and applied to both existing modules in #934; ADR-010 amended with the reasoning.
The original "beside" choice (src/runner.sh + src/runner/*.sh) rested on matching the
src/assertions.sh precedent, which does not apply — assertions.sh aggregates flat files
and has no directory. What settled it: the "aggregators hold only source lines" rule was
enforced against a hand-maintained list that had already drifted (#928 added src/coverage.sh
and never appended it), and a predictable src/*/index.sh lets that test discover modules by
glob instead.

Every new module in this issue uses index.sh. Do not mix placements.

What is left to split

FileLinesFnsNote
src/main.sh142224flag parsing + every subcommand's cmd_* in one file
src/learn.sh121382the interactive tutorial; self-contained, lowest risk
src/assert.sh97042the core assertion catalogue — cohesive, may not want splitting
src/helpers.sh90930discovery, fn filtering, provider map, duplicate check, ids
src/console_results.sh82827totals rendering + deferred failure/skip blocks
src/env.sh75451BASHUNIT_* defaults, config files, scratch dirs
src/test_doubles.sh47017spies + mocks
src/reports.sh43418JUnit/HTML/TAP/JSON writers — one per format is the obvious seam
src/state.sh40442counters + payload encode/decode + TAP conversion

Separately, ~20 files under 120 lines (colors, str, math, io, globals,
check_os, dependencies, …) could group into a src/util/ module. Lower value than the
big files — grouping small cohesive files buys navigation, not comprehension. Treat as
optional and last.

Do not split all nine in one PR. One module per PR, same as #924 and #925, so each stays
reviewable as a pure relocation.

Per-module process (proven by #924 and #925)

  1. Post a responsibility map on the issue and get it agreed before moving code: one-line
    summary per function, the internal call graph, every _BASHUNIT_* global with who assigns
    and who reads it, and a proposed acyclic layering. Generate it from the file, do not
    eyeball it.
  2. Split. git diff must show only relocations — no renamed functions, no changed logic.
  3. Verify (below), then open the PR.

Constraints — all of these have already drawn blood

  • Aggregators may contain only source lines and comments.build::process_file emits a
    file's body and then recurses into its sources, so any statement in an aggregator runs
    before its dependencies in the built binary but after them in dev mode. Enforced by
    test_module_aggregators_hold_only_source_lines_and_comments.
  • File-scope initialisers must move with their module, and order-dependent ones must stay
    contiguous.
    In refactor(coverage): split src/coverage.sh into a src/coverage/ module #928, _BASHUNIT_COVERAGE_XTRACE_PS4 expands $_BASHUNIT_COVERAGE_XTRACE_FS
    at file scope, and _NONEXEC_PATTERN is built across 7 successive lines. Grep for
    file-scope assignments that read another file-scope variable before splitting.
  • .gitignore can silently swallow a new module directory.coverage/ was unanchored, so
    it matched src/coverage/ and excluded all twelve new files from git — git status showed
    no ?? entries at all. Fixed in refactor(coverage): split src/coverage.sh into a src/coverage/ module #928 by anchoring to /coverage/, but check
    git check-ignore -v src/<newmodule>/<file>.sh before committing any new module.
  • CI runs ShellCheck per file without -x, so it cannot follow source. A monolith hides
    cross-file variable use; splitting exposes it as SC2034. In refactor(coverage): split src/coverage.sh into a src/coverage/ module #928 this surfaced a genuinely
    dead local. Reproduce CI's mode locally before pushing:
    for f in $(git ls-files '*.sh') bashunit; do shellcheck --format=gcc "$f"; done
    with SHELLCHECK_OPTS="-e SC1091 -e SC2155 -e SC2016".
  • Check .editorconfig for per-file rules on the file being split.[src/coverage.sh] max_line_length = unset would have been lost by the split; refactor(coverage): split src/coverage.sh into a src/coverage/ module #928 rescoped it to the two
    files that actually needed it and reflowed the rest. Decide deliberately and state the
    decision in the PR.
  • Dynamic-scope helper groups cannot be separated. Functions that mutate a caller's locals
    must land in the same file as their caller, with the justification comment
    (.claude/rules/bash-style.md). src/coverage/branches.sh is the precedent.
  • Tests stay flat.make test globs exactly one level — never create tests/unit/<module>/.
  • Bash 3.0+ floor; per-test paths stay fork-free (.claude/rules/perf-fork-budget.md).

Verification, per PR

Prove the change is a relocation by comparing the non-blank line multiset before and after —
it must differ only by the new shebangs and module header comments — plus an unchanged
function count:

git show main:src/<file>.sh | grep -vE '^[[:space:]]*$'| sort > /tmp/before.txt
cat src/<module>/*.sh | grep -vE '^[[:space:]]*$'| sort > /tmp/after.txt
comm -3 /tmp/before.txt /tmp/after.txt

Then: ./bashunit tests/ · ./bashunit --parallel tests/ ·
./bashunit --parallel --simple --strict tests/ · make sa · make lint ·
fork-budget acceptance tests · bash build.sh bin -v printing ✅ Build verified ✅.
Add ./bashunit --coverage --parallel tests/ when the module touches coverage.

Acceptance criteria (per module PR)

  • Responsibility map posted and agreed before code moves
  • git diff shows only relocations — no renamed functions, no changed logic
  • Aggregator contains only source lines and comments
  • Every new file's first line is #!/usr/bin/env bash
  • git check-ignore -v confirms the new directory is not ignored
  • CI-mode ShellCheck (per file, no -x) clean
  • .editorconfig per-file rules reviewed; decision stated in the PR
  • All suites above green, including bash build.sh bin -v
  • .claude/rules/architecture-map.md module table updated
  • No CHANGELOG entry — internal, no user-visible behaviour change

Do not

  • Do not start moving code before the responsibility map is posted
  • Do not rename functions or change behaviour
  • Do not split more than one module per PR
  • Do not create tests/unit/<module>/
  • Do not run shfmt -w; make lint is the format gate

Note on build.sh — no work needed

build.sh already handles arbitrary nesting. build::process_file is a depth-first walk of
source statements, not a directory walk: it emits a file's body, recurses into every
^source line, dedupes on repo-relative path (#923), and strips all source lines from the
artifact. Verified on main with a throwaway three-level module
(src/x.sh → src/x/mid.sh → src/x/deep/leaf.sh): all three bodies embedded in DFS order,
zero source lines left in the output. Depth is pinned by a regression test in a separate
issue.

Metadata

Metadata

Assignees

Labels

refactoringRefactoring or cleaning related

Projects

  • Status
    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions