headlamp 0.1.3 → 0.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,38 +1,36 @@
1
- # Headlamp
1
+ # Headlamp CLI
2
2
 
3
- Coverage-first, runner-agnostic test UX for Jest. Headlamp delegates test execution to your existing runner and focuses on clearer selection and better coverage insights.
3
+ Coverage-first, runner-agnostic test UX for Jest/Vitest. Delegates execution to your runner, focuses on better selection and coverage insights.
4
4
 
5
5
  ## Install
6
6
 
7
- ```bash
8
- npm i -D headlamp
9
- ```
7
+ Only in /Users/david/src/headlamp/src/lib: PLACEHOLDER
8
+ Only in /Users/david/src/headlamp/src/lib: _exec.ts
9
+ Files /Users/david/src/gigworx-node/scripts/cli/coverage-print.ts and /Users/david/src/headlamp/src/lib/coverage-print.ts differ
10
+ Files /Users/david/src/gigworx-node/scripts/cli/discovery.ts and /Users/david/src/headlamp/src/lib/discovery.ts differ
11
+ Only in /Users/david/src/headlamp/src/lib: env-utils.ts
12
+ Only in /Users/david/src/headlamp/src/lib: fast-related.ts
13
+ Files /Users/david/src/gigworx-node/scripts/cli/graph-distance.ts and /Users/david/src/headlamp/src/lib/graph-distance.ts differ
14
+ Files /Users/david/src/gigworx-node/scripts/cli/index.ts and /Users/david/src/headlamp/src/lib/index.ts differ
15
+ Files /Users/david/src/gigworx-node/scripts/cli/program.ts and /Users/david/src/headlamp/src/lib/program.ts differ
10
16
 
11
- ## Quick start
17
+ ## Usage
12
18
 
13
- ```bash
14
- npx headlamp --coverage [jest args]
15
- ```
19
+ removed
20
+ removed
16
21
 
17
- - Uses your local Jest install; pass your normal flags after `headlamp`
18
- - Renders improved coverage tables and hotspots in the terminal
19
- - Select files via CLI args; Headlamp smartly chooses tests to run and what coverage to show
22
+ - Delegates to your local Jest/Vitest install
23
+ - Renders improved coverage tables and hotspots
24
+ - Selects tests by import-graph when you pass production paths
20
25
 
21
- ## Features
26
+ ## Why
22
27
 
23
- - Coverage-first terminal UI: per-file summaries, hotspots, missed functions/branches, editor links
24
- - Intelligent selection:
25
- - Provide production paths; Headlamp finds direct tests by import graph
26
- - Falls back to resilient discovery when Jest listing times out
27
- - Alias-aware import resolution: tsconfig/jsconfig paths, Jest moduleNameMapper, Babel module-resolver, Metro extraNodeModules
28
- - Zero lock-in: delegates to Jest; Vitest support is planned but not required to use coverage UI
28
+ - Keep Jest/Vitest as-is. Get a better UI/UX for coverage and selection.
29
29
 
30
- ## CLI flags (selected)
30
+ ## Status
31
31
 
32
- - `--coverage`: enable coverage collection and UI
33
- - `--coverage-ui=jest|both`: choose minimal (jest) or extended (both) coverage UI
34
- - `--coverage.detail=<n|all|auto>`: deep-dive per-file hotspots (n = count)
35
- - `--coverage.showCode=true|false`: show snippet around hotspots
32
+ Alpha. API/CLI flags may change.
33
+ und hotspots
36
34
  - `--coverage.mode=compact|full|auto`: compact table vs full per-file details
37
35
  - `--coverage.maxFiles`, `--coverage.maxHotspots`: limit rows to fit your terminal
38
36
  - `--coverage.pageFit=true|false`: adapt output to terminal rows