Skip to content

BREAKING: rename CLI args #46

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
merged 1 commit into from
Nov 4, 2025
+51 −57
Merged

BREAKING: rename CLI args #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
46 changes: 23 additions & 23 deletions src/cli/arguments.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { test, expect } from '@playwright/test'
import { parse_arguments, validate_arguments } from './arguments'

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

test('missing --coverage-dir', () => {
expect(() => validate_arguments(parse_arguments([cov]))).toThrowError()
Expand All @@ -18,51 +18,51 @@ test.describe('--coverage-dir', () => {
})
})

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

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

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

test('invalid --min-line-coverage=-1', () => {
expect(() => validate_arguments(parse_arguments([dir, '--min-line-coverage=-1']))).toThrowError()
test('invalid --min-coverage=-1', () => {
expect(() => validate_arguments(parse_arguments([dir, '--min-coverage=-1']))).toThrowError()
})

test('valid --min-line-coverage=.8', () => {
let result = validate_arguments(parse_arguments([dir, '--min-line-coverage=.8']))
expect(result['min-line-coverage']).toEqual(0.8)
test('valid --min-coverage=.8', () => {
let result = validate_arguments(parse_arguments([dir, '--min-coverage=.8']))
expect(result['min-coverage']).toEqual(0.8)
})
})

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

test('missing --min-file-line-coverage', () => {
test('missing --min-file-coverage', () => {
expect.soft(() => validate_arguments(parse_arguments([...args]))).not.toThrowError()
expect.soft(validate_arguments(parse_arguments([...args]))['min-file-line-coverage']).toEqual(0)
expect.soft(validate_arguments(parse_arguments([...args]))['min-file-coverage']).toEqual(0)
})

test('empty --min-file-line-coverage', () => {
expect.soft(() => validate_arguments(parse_arguments([...args, '--min-file-line-coverage']))).toThrowError()
test('empty --min-file-coverage', () => {
expect.soft(() => validate_arguments(parse_arguments([...args, '--min-file-coverage']))).toThrowError()
})

test('invalid --min-file-line-coverage=-1', () => {
expect(() => validate_arguments(parse_arguments([...args, '--min-file-line-coverage=-1']))).toThrowError()
test('invalid --min-file-coverage=-1', () => {
expect(() => validate_arguments(parse_arguments([...args, '--min-file-coverage=-1']))).toThrowError()
})

test('valid --min-file-line-coverage=.8', () => {
let result = validate_arguments(parse_arguments([...args, '--min-file-line-coverage=.8']))
expect(result['min-file-line-coverage']).toEqual(0.8)
test('valid --min-file-coverage=.8', () => {
let result = validate_arguments(parse_arguments([...args, '--min-file-coverage=.8']))
expect(result['min-file-coverage']).toEqual(0.8)
})
})

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

test('missing --reporter', () => {
expect.soft(() => validate_arguments(parse_arguments([...args]))).not.toThrowError()
Expand All @@ -89,7 +89,7 @@ test.describe('--reporter', () => {
})

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

test('missing --show-uncovered', () => {
expect.soft(() => validate_arguments(parse_arguments([...args]))).not.toThrowError()
Expand Down
12 changes: 6 additions & 6 deletions src/cli/arguments.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,16 @@ let ReporterSchema = v.pipe(v.string(), v.enum(reporters))

let CliArgumentsSchema = v.object({
'coverage-dir': CoverageDirSchema,
'min-line-coverage': RatioPercentageSchema,
'min-file-line-coverage': v.optional(RatioPercentageSchema),
'min-coverage': RatioPercentageSchema,
'min-file-coverage': v.optional(RatioPercentageSchema),
'show-uncovered': v.optional(ShowUncoveredSchema, show_uncovered_options.violations),
reporter: v.optional(ReporterSchema, reporters.pretty),
})

export type CliArguments = {
'coverage-dir': string
'min-line-coverage': number
'min-file-line-coverage'?: number
'min-coverage': number
'min-file-coverage'?: number
'show-uncovered': keyof typeof show_uncovered_options
reporter: keyof typeof reporters
}
Expand Down Expand Up @@ -69,10 +69,10 @@ export function parse_arguments(args: string[]) {
'coverage-dir': {
type: 'string',
},
'min-line-coverage': {
'min-coverage': {
type: 'string',
},
'min-file-line-coverage': {
'min-file-coverage': {
type: 'string',
default: '0',
},
Expand Down
4 changes: 2 additions & 2 deletions src/cli/cli.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ async function cli(cli_args: string[]) {
let coverage_data = await read(params['coverage-dir'])
let report = program(
{
min_file_coverage: params['min-line-coverage'],
min_file_line_coverage: params['min-file-line-coverage'],
min_coverage: params['min-coverage'],
min_file_coverage: params['min-file-coverage'],
},
coverage_data,
)
Expand Down
22 changes: 11 additions & 11 deletions src/cli/program.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,31 +12,31 @@ let coverage = [
] satisfies Coverage[]

test('returns context', () => {
let result = program({ min_file_coverage: 0.5 }, coverage)
let result = program({ min_coverage: 0.5 }, coverage)
expect.soft(result.context.coverage.covered_lines).toEqual(4)
expect.soft(result.context.coverage.total_files_found).toEqual(1)
})

test.describe('--min-file-coverage', () => {
test('Success: --min-file-coverage=0.5', () => {
let result = program({ min_file_coverage: 0.5 }, coverage)
test.describe('--min-coverage', () => {
test('Success: --min-coverage=0.5', () => {
let result = program({ min_coverage: 0.5 }, coverage)
expect(result.report.ok).toBeTruthy()
})

test('Failure: --min-file-coverage=1', () => {
let result = program({ min_file_coverage: 1 }, coverage)
test('Failure: --min-coverage=1', () => {
let result = program({ min_coverage: 1 }, coverage)
expect(result.report.ok).toBeFalsy()
})
})

test.describe('--min-file-line-coverage', () => {
test('Success: --min-file-line-coverage=0.5', () => {
let result = program({ min_file_coverage: 0, min_file_line_coverage: 0.5 }, coverage)
test.describe('--min-file-coverage', () => {
test('Success: --min-file-coverage=0.5', () => {
let result = program({ min_coverage: 0, min_file_coverage: 0.5 }, coverage)
expect(result.report.ok).toBeTruthy()
})

test('Failure: --min-file-line-coverage=1', () => {
let result = program({ min_file_coverage: 0, min_file_line_coverage: 1 }, coverage)
test('Failure: --min-file-coverage=1', () => {
let result = program({ min_coverage: 0, min_file_coverage: 1 }, coverage)
expect(result.report.ok).toBeFalsy()
})
})
24 changes: 9 additions & 15 deletions src/cli/program.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,5 @@
import { calculate_coverage, type Coverage, type CoverageResult } from '../lib/index.js'

class MissingDataError extends Error {
constructor() {
super('No data to analyze')
}
}

export type Report = {
context: {
coverage: CoverageResult
Expand Down Expand Up @@ -51,29 +45,29 @@ function validate_min_file_line_coverage(actual: number, expected: number | unde

export function program(
{
min_coverage,
min_file_coverage,
min_file_line_coverage,
}: {
min_file_coverage: number
min_file_line_coverage?: number
min_coverage: number
min_file_coverage?: number
},
coverage_data: Coverage[],
) {
let coverage = calculate_coverage(coverage_data)
let min_line_coverage_result = validate_min_line_coverage(coverage.line_coverage_ratio, min_file_coverage)
let min_file_line_coverage_result = validate_min_file_line_coverage(
let min_coverage_result = validate_min_line_coverage(coverage.line_coverage_ratio, min_coverage)
let min_file_coverage_result = validate_min_file_line_coverage(
Math.min(...coverage.coverage_per_stylesheet.map((sheet) => sheet.line_coverage_ratio)),
min_file_line_coverage,
min_file_coverage,
)

let result: Report = {
context: {
coverage,
},
report: {
ok: min_line_coverage_result.ok && min_file_line_coverage_result.ok,
min_line_coverage: min_line_coverage_result,
min_file_line_coverage: min_file_line_coverage_result,
ok: min_coverage_result.ok && min_file_coverage_result.ok,
min_line_coverage: min_coverage_result,
min_file_line_coverage: min_file_coverage_result,
},
}

Expand Down