Skip to content

Breaking: Convert coverage-dir from flag to positional argument #100

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
bartveneman merged 2 commits into from
Mar 18, 2026
+23 −25
Merged

Breaking: Convert coverage-dir from flag to positional argument #100

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
620402c
Convert coverage-dir from named option to positional argument
claude Mar 17, 2026
ddf03cb
Fix TS2345: restore non-null assertion on coverage_dir in return
claude Mar 17, 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
28 changes: 12 additions & 16 deletions src/cli/arguments.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,29 @@ import { test, expect } from '@playwright/test'
import { resolve } from 'node:path'
import { parse_arguments } from './arguments'

test.describe('--coverage-dir', () => {
test.describe('<coverage-dir>', () => {
let cov = '--min-coverage=1'

test('missing --coverage-dir', () => {
test('missing coverage-dir', () => {
expect(() => parse_arguments([cov])).toThrowError()
})

test('empty --coverage-dir', () => {
expect(() => parse_arguments([cov, '--coverage-dir'])).toThrowError()
})

test('valid --coverage-dir=coverage', () => {
let result = parse_arguments([cov, '--coverage-dir=coverage'])
test('valid coverage-dir positional', () => {
let result = parse_arguments(['coverage', cov])
expect(result['coverage-dir']).toEqual(resolve('coverage'))
})

test('path traversal --coverage-dir=../../etc', () => {
expect(() => parse_arguments([cov, '--coverage-dir=../../etc'])).toThrowError()
test('path traversal ../../etc', () => {
expect(() => parse_arguments(['../../etc', cov])).toThrowError()
})

test('path traversal --coverage-dir=../sibling', () => {
expect(() => parse_arguments([cov, '--coverage-dir=../sibling'])).toThrowError()
test('path traversal ../sibling', () => {
expect(() => parse_arguments(['../sibling', cov])).toThrowError()
})
})

test.describe('--min-coverage', () => {
let dir = '--coverage-dir=coverage'
let dir = 'coverage'

test('missing --min-coverage', () => {
expect(() => parse_arguments([dir])).toThrowError()
Expand All @@ -49,7 +45,7 @@ test.describe('--min-coverage', () => {
})

test.describe('--min-file-coverage', () => {
let args = ['--coverage-dir=coverage', '--min-coverage=1']
let args = ['coverage', '--min-coverage=1']

test('missing --min-file-coverage defaults to 0', () => {
let result = parse_arguments([...args])
Expand All @@ -71,7 +67,7 @@ test.describe('--min-file-coverage', () => {
})

test.describe('--reporter', () => {
let args = ['--coverage-dir=coverage', '--min-coverage=1']
let args = ['coverage', '--min-coverage=1']

test('missing --reporter defaults to pretty', () => {
let result = parse_arguments([...args])
Expand All @@ -98,7 +94,7 @@ test.describe('--reporter', () => {
})

test.describe('--show-uncovered', () => {
let args = ['--coverage-dir=coverage', '--min-coverage=1']
let args = ['coverage', '--min-coverage=1']

test('missing --show-uncovered defaults to violations', () => {
let result = parse_arguments([...args])
Expand Down
8 changes: 4 additions & 4 deletions src/cli/arguments.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ export type CliArguments = {
}

export function parse_arguments(args: string[]): CliArguments {
let { values } = parseArgs({
let { values, positionals } = parseArgs({
args,
allowPositionals: true,
options: {
'coverage-dir': { type: 'string' },
'min-coverage': { type: 'string' },
'min-file-coverage': { type: 'string', default: '0' },
'show-uncovered': { type: 'string', default: 'violations' },
Expand All @@ -29,9 +29,9 @@ export function parse_arguments(args: string[]): CliArguments {

let issues: string[] = []

let coverage_dir = values['coverage-dir']
let coverage_dir = positionals[0]
if (!coverage_dir) {
issues.push('--coverage-dir is required')
issues.push('<coverage-dir> is required')
} else {
let resolved = resolve(coverage_dir)
let cwd = process.cwd()
Expand Down
12 changes: 7 additions & 5 deletions src/cli/help.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,13 @@ import { styleText } from 'node:util'
export function help() {
return `
${styleText(['bold'], 'USAGE')}
$ css-coverage --coverage-dir=<dir> --min-coverage=<number> [options]
$ css-coverage <coverage-dir> --min-coverage=<number> [options]

${styleText('bold', 'ARGUMENTS')}
<coverage-dir> Where your Coverage JSON files are

${styleText('bold', 'OPTIONS')}
Required:
--coverage-dir Where your Coverage JSON files are
--min-coverage Minimum overall CSS coverage [0-1]

Optional:
Expand All @@ -26,12 +28,12 @@ Optional:

${styleText('bold', 'EXAMPLES')}
${styleText('dim', '# analyze all .json files in ./coverage; require 80% overall coverage')}
$ css-coverage --coverage-dir=./coverage --min-coverage=0.8
$ css-coverage ./coverage --min-coverage=0.8

${styleText('dim', '# Require 50% coverage per file')}
$ css-coverage --coverage-dir=./coverage --min-coverage=0.8 --min-file-coverage=0.5
$ css-coverage ./coverage --min-coverage=0.8 --min-file-coverage=0.5

${styleText('dim', 'Report JSON')}
$ css-coverage --coverage-dir=./coverage --min-coverage=0.8 --reporter=json
$ css-coverage ./coverage --min-coverage=0.8 --reporter=json
`.trim()
}
Loading