lib/args/index.ts - qunitx-cli documentation

Functions

f

Classifies raw positional targets into flags, exactly as the CLI does with argv positionals: .html fixtures become htmlPaths, a trailing #34/:34 becomes a lineTargets entry, and everything else is an absolute path in inputs (deduplicated) plus a wholeInputPaths mention.

f

parse(

projectRoot: string,

argv?: readonly string[],

cwd?: string

): Result<ParsedFlags, ParseFailure>

Parses an argv into a qunitx flag object (inputs, debug, watch, failFast, timeout, output, port, before, after).

f

tokenize(args: readonly string[]): ArgToken[]

Classifies argv into query / flag / input tokens.

Interfaces

I

FlagToken

Any other flag (--watch, --timeout=5000, -o, …), passed through verbatim.

kind: "flag"
Discriminant.
raw: string
The exact argv entry, including leading dashes and any =value.

I

InputToken

A positional target: a file, folder, or glob (possibly with a #34 line suffix).

kind: "input"
Discriminant.
raw: string
The exact argv entry.

I

ParsedFlags

The flag object a successful parse() carries — CLI flags only, before package.json merge.

after: string | false
--after: module run after the tests, or false to disable a configured one.
before: string | false
--before: module run before the tests, or false to disable a configured one.
browser: "chromium" | "firefox" | "webkit"
--browser: the engine to run in.
changedSince: string
--since/--changed: run only files whose transitive imports changed since this git ref.
coverage: boolean
--coverage: collect V8 line coverage.
coverageFormats: string[]
Artifact formats beyond the terminal summary (lcov, html).
debug: boolean
--debug/--console: print the server URL and forward the page's console.
extensions: string[]
--extensions: file extensions treated as test files.
failFast: boolean
--failFast: stop at the first failing test.
filter: string
-t/--filter/-m/--module/-n: the one test-name matcher, in QUnit's own semantics.
htmlPaths: string[]
Positional .html fixtures the test bundle is injected into.
inputs: string[]
Absolute paths of the test targets, deduplicated. .html fixtures and #line suffixes are split out into htmlPaths and lineTargets rather than kept here.
junit: boolean | string
--junit: write a JUnit report. true uses the default path; a string overrides it.
lineTargets: Record<string, number[]>
Absolute path → the #34 line targets given for it.
onlyFailed: boolean
--only-failed/-f: run only the files that failed on the previous run.
open: boolean | string
--open/-o: open the output in a browser; a string names a specific binary.
output: string
--output: directory for the compiled bundle and HTML.
port: number
--port/-p: the port the local test server listens on.
portExplicit: boolean
true when --port was given explicitly, so a busy port fails instead of incrementing.
reporter: ReporterName
--reporter/-r: the single stdout format.
search: string | true
--search/--print mode: the expression to preview, or true to list everything.
timeout: number
--timeout: milliseconds a single test may take before the run is declared stalled.
watch: boolean
--watch/-w: re-run on every save instead of exiting after one run.
wholeInputPaths: string[]
Absolute paths mentioned WITHOUT a line target — whole-file requests that supersede a line target.

I

QueryToken

A query flag (-t/-m/-s/-p) with its resolved value.

action: "run" | "list"
What to do with the matches: run narrows which tests execute; list previews them instead.
greedy: boolean
True when the value was consumed from following argv entries (-t a b) rather than = glued.
kind: "query"
Discriminant.
value: string | null
The value, or null when the flag was given with nothing after it.