Skip to content

docs(scan): drop stale NPM caveat from --reach-concurrency help#1351

Merged
Martin Torp (mtorp) merged 1 commit into
v1.xfrom
martin/out-of-date-concurrency-description
Jun 1, 2026
Merged

docs(scan): drop stale NPM caveat from --reach-concurrency help#1351
Martin Torp (mtorp) merged 1 commit into
v1.xfrom
martin/out-of-date-concurrency-description

Conversation

@mtorp
Copy link
Copy Markdown
Contributor

@mtorp Martin Torp (mtorp) commented Jun 1, 2026

What

Removes the now-stale sentence from the --reach-concurrency flag help:

NPM reachability analysis does not support concurrent execution, so the concurrency level is ignored for NPM.

NPM reachability now supports concurrent execution, so the caveat is no longer accurate. The flag description now reads:

Set the maximum number of concurrent reachability analysis runs. It is recommended to choose a concurrency level that ensures each analysis run has at least the --reach-analysis-memory-limit amount of memory available.

Changes

  • src/commands/scan/reachability-flags.mts — drop the NPM caveat from the reachConcurrency description.
  • src/commands/scan/cmd-scan-create.test.mts / src/commands/scan/cmd-scan-reach.test.mts — update the inline --help output expectations to match.

Notes

The matching caveat is also being removed upstream in @coana-tech/cli (which is where this CLI's text mirrors). Once a coana release carrying that change lands, the bundled INLINED_SOCKET_CLI_COANA_TECH_CLI_VERSION should be bumped so the runtime help printed by the coana binary matches this flag help too.

Test

pnpm test:unit src/commands/scan/cmd-scan-create.test.mts src/commands/scan/cmd-scan-reach.test.mts — 85/85 pass.


Note

Low Risk
User-facing help text and test expectations only; no reachability execution or API behavior changes.

Overview
Updates --reach-concurrency help so it no longer claims NPM reachability ignores concurrency. The flag text now only describes the concurrent run limit and the recommendation to size concurrency against --reach-analysis-memory-limit.

reachability-flags.mts carries the description change; cmd-scan-create and cmd-scan-reach unit tests that snapshot --help output are aligned with the new wording.

Reviewed by Cursor Bugbot for commit 476c7e7. Configure here.

NPM reachability now supports concurrent execution, so the note that
the concurrency level is ignored for NPM is no longer accurate. Remove
that sentence from the --reach-concurrency flag description and update
the two inline help-output expectations in the scan create/reach tests.
@mtorp Martin Torp (mtorp) changed the base branch from main to v1.x June 1, 2026 08:26
@mtorp Martin Torp (mtorp) enabled auto-merge (squash) June 1, 2026 08:33
auto-merge was automatically disabled June 1, 2026 09:02

Pull request was closed

@mtorp Martin Torp (mtorp) merged commit 3763fb2 into v1.x Jun 1, 2026
13 checks passed
@mtorp Martin Torp (mtorp) deleted the martin/out-of-date-concurrency-description branch June 1, 2026 11:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants