test-progress-tracker 2.0.7 → 2.0.8

package/ts/interface.ts

@@ -1,36 +1,36 @@
-import fs from 'fs';
+import type fs from 'node:fs'
 
 export interface FSContext<FSKeys extends keyof typeof fs> {
-  fs: Pick<typeof fs, FSKeys>,
-  /**
-   * Root directory (of the project).
-   */
-  rootDir: string
+	fs: Pick<typeof fs, FSKeys>
+	/**
+	 * Root directory (of the project).
+	 */
+	rootDir: string
 }
 
 export interface TestResults {
-  startTime: number,
-  duration: number,
-  numFailedTests: number,
-  numFailedTestSuites: number,
-  numPassedTests: number,
-  numPassedTestSuites: number,
-  numTotalTests: number,
-  numTotalTestSuites: number,
-  filtered?: boolean,
-  coverage?: CoverageSummary
+	startTime: number
+	duration: number
+	numFailedTests: number
+	numFailedTestSuites: number
+	numPassedTests: number
+	numPassedTestSuites: number
+	numTotalTests: number
+	numTotalTestSuites: number
+	filtered?: boolean
+	coverage?: CoverageSummary
 }
 
 export interface FileCoverageTotal {
-  total: number,
-  covered: number,
-  skipped: number,
-  pct?: number;
+	total: number
+	covered: number
+	skipped: number
+	pct?: number
 }
 
 export interface CoverageSummary {
-  lines: FileCoverageTotal,
-  statements: FileCoverageTotal,
-  branches: FileCoverageTotal,
-  functions: FileCoverageTotal;
+	lines: FileCoverageTotal
+	statements: FileCoverageTotal
+	branches: FileCoverageTotal
+	functions: FileCoverageTotal
 }

package/ts/load.ts

@@ -1,38 +1,37 @@
-import fs from 'fs';
-import path from 'path';
-import { unpartial } from 'unpartial';
-import { promisify } from 'util';
-import { decompress } from './compress';
-import { PROGRESS_FOLDER, TEST_RESULT_FILENAME } from './constants';
-import { FSContext, TestResults } from './interface';
-import { unminify } from './minify';
-import { store } from './store';
+import fs from 'node:fs'
+import path from 'node:path'
+import { unpartial } from 'unpartial'
+import { promisify } from 'node:util'
+import { decompress } from './compress'
+import { PROGRESS_FOLDER, TEST_RESULT_FILENAME } from './constants'
+import type { FSContext, TestResults } from './interface'
+import { unminify } from './minify'
+import { store } from './store'
 
 let readFile = fs.readFile
 let promisifiedReadFile = promisify(fs.readFile)
 
 export async function load(context?: Partial<FSContext<'readFile'>>) {
-  const c = unpartial<FSContext<'readFile'>>({ fs, rootDir: store.value.rootDir }, context)
+	const c = unpartial<FSContext<'readFile'>>({ fs, rootDir: store.value.rootDir }, context)
 
-  const filepath = path.join(c.rootDir, PROGRESS_FOLDER, TEST_RESULT_FILENAME)
+	const filepath = path.join(c.rootDir, PROGRESS_FOLDER, TEST_RESULT_FILENAME)
 
-  // istanbul ignore next
-  if (c.fs.readFile !== readFile) {
-    readFile = c.fs.readFile
-    promisifiedReadFile = promisify(readFile)
-  }
+	// istanbul ignore next
+	if (c.fs.readFile !== readFile) {
+		readFile = c.fs.readFile
+		promisifiedReadFile = promisify(readFile)
+	}
 
-  try {
-    const content = await promisifiedReadFile(filepath, 'utf-8')
-    const entries = content.split('\n')
-    return entries.reduce<TestResults[]>((r, e) => {
-      if (!e) return r
-      const minified = decompress(e)
-      r.push(unminify(minified))
-      return r
-    }, [])
-  }
-  catch {
-    return []
-  }
+	try {
+		const content = await promisifiedReadFile(filepath, 'utf-8')
+		const entries = content.split('\n')
+		return entries.reduce<TestResults[]>((r, e) => {
+			if (!e) return r
+			const minified = decompress(e)
+			r.push(unminify(minified))
+			return r
+		}, [])
+	} catch {
+		return []
+	}
 }

package/ts/minify.ts

@@ -1,94 +1,105 @@
-import { TestResults, CoverageSummary } from './interface';
+import type { CoverageSummary, TestResults } from './interface'
 
 export interface MinifiedTestResult {
-  d: number,
-  fl?: boolean,
-  f: number,
-  fs: number,
-  p: number,
-  ps: number,
-  t: number,
-  ts: number,
-  s: number,
-  c?: MinifiedCoverageSummary
+	d: number
+	fl?: boolean
+	f: number
+	fs: number
+	p: number
+	ps: number
+	t: number
+	ts: number
+	s: number
+	c?: MinifiedCoverageSummary
 }
 export interface MinifiedCoverageSummary {
-  b: { c: number, s: number, t: number, p?: number },
-  f: { c: number, s: number, t: number, p?: number },
-  l: { c: number, s: number, t: number, p?: number },
-  s: { c: number, s: number, t: number, p?: number }
+	b: { c: number; s: number; t: number; p?: number }
+	f: { c: number; s: number; t: number; p?: number }
+	l: { c: number; s: number; t: number; p?: number }
+	s: { c: number; s: number; t: number; p?: number }
 }
 
 export function minify(testResults: TestResults) {
-  const { duration, filtered, numFailedTests, numFailedTestSuites, numPassedTests, numPassedTestSuites, numTotalTests, numTotalTestSuites, startTime, coverage } = testResults
+	const {
+		duration,
+		filtered,
+		numFailedTests,
+		numFailedTestSuites,
+		numPassedTests,
+		numPassedTestSuites,
+		numTotalTests,
+		numTotalTestSuites,
+		startTime,
+		coverage
+	} = testResults
 
-  const result: MinifiedTestResult = {
-    d: duration,
-    f: numFailedTests,
-    fs: numFailedTestSuites,
-    p: numPassedTests,
-    ps: numPassedTestSuites,
-    t: numTotalTests,
-    ts: numTotalTestSuites,
-    s: startTime
-  }
-  if (filtered) {
-    result.fl = filtered
-  }
-  if (coverage) {
-    result.c = minifyCoverage(coverage)
-  }
-  return result
+	const result: MinifiedTestResult = {
+		d: duration,
+		f: numFailedTests,
+		fs: numFailedTestSuites,
+		p: numPassedTests,
+		ps: numPassedTestSuites,
+		t: numTotalTests,
+		ts: numTotalTestSuites,
+		s: startTime
+	}
+	if (filtered) {
+		result.fl = filtered
+	}
+	if (coverage) {
+		result.c = minifyCoverage(coverage)
+	}
+	return result
 }
 
 function minifyCoverage(coverage: CoverageSummary) {
-  const { branches, functions, lines, statements } = coverage
+	const { branches, functions, lines, statements } = coverage
 
-  const result: MinifiedCoverageSummary = {
-    b: { c: branches.covered, s: branches.skipped, t: branches.total },
-    f: { c: functions.covered, s: functions.skipped, t: functions.total },
-    l: { c: lines.covered, s: lines.skipped, t: lines.total },
-    s: { c: statements.covered, s: statements.skipped, t: statements.total }
-  }
+	const result: MinifiedCoverageSummary = {
+		b: { c: branches.covered, s: branches.skipped, t: branches.total },
+		f: { c: functions.covered, s: functions.skipped, t: functions.total },
+		l: { c: lines.covered, s: lines.skipped, t: lines.total },
+		s: { c: statements.covered, s: statements.skipped, t: statements.total }
+	}
 
-  if (branches.pct) result.b.p = branches.pct
-  if (functions.pct) result.f.p = functions.pct
-  if (lines.pct) result.l.p = lines.pct
-  if (statements.pct) result.s.p = statements.pct
-  return result
+	if (branches.pct) result.b.p = branches.pct
+	if (functions.pct) result.f.p = functions.pct
+	if (lines.pct) result.l.p = lines.pct
+	if (statements.pct) result.s.p = statements.pct
+	return result
 }
 
 export function unminify(minified: MinifiedTestResult) {
-  const result: TestResults = {
-    duration: minified.d,
-    numFailedTests: minified.f,
-    numFailedTestSuites: minified.fs,
-    numPassedTests: minified.p,
-    numPassedTestSuites: minified.ps,
-    numTotalTests: minified.t,
-    numTotalTestSuites: minified.ts,
-    startTime: minified.s
-  }
-  if (minified.fl) {
-    result.filtered = minified.fl
-  }
-  if (minified.c) {
-    result.coverage = unminifyCoverage(minified.c)
-  }
-  return result
+	const result: TestResults = {
+		duration: minified.d,
+		numFailedTests: minified.f,
+		numFailedTestSuites: minified.fs,
+		numPassedTests: minified.p,
+		numPassedTestSuites: minified.ps,
+		numTotalTests: minified.t,
+		numTotalTestSuites: minified.ts,
+		startTime: minified.s
+	}
+	if (minified.fl) {
+		result.filtered = minified.fl
+	}
+	if (minified.c) {
+		result.coverage = unminifyCoverage(minified.c)
+	}
+	return result
 }
 
 function unminifyCoverage(c: MinifiedCoverageSummary) {
-  const result: CoverageSummary = {
-    branches: { covered: c.b.c, skipped: c.b.s, total: c.b.t },
-    functions: { covered: c.f.c, skipped: c.f.s, total: c.f.t },
-    lines: { covered: c.l.c, skipped: c.l.s, total: c.l.t },
-    statements: { covered: c.s.c, skipped: c.s.s, total: c.s.t }
-  }
+	const result: CoverageSummary = {
+		branches: { covered: c.b.c, skipped: c.b.s, total: c.b.t },
+		functions: { covered: c.f.c, skipped: c.f.s, total: c.f.t },
+		lines: { covered: c.l.c, skipped: c.l.s, total: c.l.t },
+		statements: { covered: c.s.c, skipped: c.s.s, total: c.s.t }
+	}
 
-  if (c.b.p !== undefined) result.branches.pct = c.b.p
-  if (c.f.p !== undefined) result.functions.pct = c.f.p
-  if (c.l.p !== undefined) result.lines.pct = c.l.p
-  if (c.s.p !== undefined) result.statements.pct = c.s.p
-  return result
+	if (c.b.p !== undefined) result.branches.pct = c.b.p
+	if (c.f.p !== undefined) result.functions.pct = c.f.p
+	if (c.l.p !== undefined) result.lines.pct = c.l.p
+	if (c.s.p !== undefined) result.statements.pct = c.s.p
+	return result
 }

package/ts/monitor.ts

@@ -1,73 +1,85 @@
 import chokidar from 'chokidar'
-import fs from 'fs'
-import path from 'path'
-import readline from 'readline'
+import fs from 'node:fs'
+import path from 'node:path'
+import readline from 'node:readline'
 import { unpartial } from 'unpartial'
 import { decompress } from './compress'
 import { PROGRESS_FOLDER, TEST_RESULT_FILENAME } from './constants'
-import { TestResults } from './interface'
+import type { TestResults } from './interface'
 import { unminify } from './minify'
 import { store } from './store'
 
 export interface MonitorContext {
-  fs: Pick<typeof fs, 'watch'>,
-  rootDir: string,
-  awaitWriteFinish: AwaitWriteFinishOptions | boolean;
+	fs: Pick<typeof fs, 'watch'>
+	rootDir: string
+	awaitWriteFinish: AwaitWriteFinishOptions | boolean
 }
 
 export interface AwaitWriteFinishOptions {
-  /**
-   * Amount of time in milliseconds for a file size to remain constant before emitting its event.
-   */
-  stabilityThreshold?: number,
+	/**
+	 * Amount of time in milliseconds for a file size to remain constant before emitting its event.
+	 */
+	stabilityThreshold?: number
 
-  /**
-   * File size polling interval.
-   */
-  pollInterval?: number
+	/**
+	 * File size polling interval.
+	 */
+	pollInterval?: number
 }
 
 export interface MonitorSubscription {
-  close(): Promise<void>
+	close(): Promise<void>
 }
 
-export function monitor(context: Partial<MonitorContext & GetLastLineContext> | undefined, callback: (err: any, testResults?: TestResults) => void): MonitorSubscription {
-  const c = unpartial<MonitorContext & GetLastLineContext>({
-    fs,
-    readline,
-    rootDir: store.value.rootDir,
-    awaitWriteFinish: true
-  }, context)
-  const filepath = path.join(c.rootDir, PROGRESS_FOLDER, TEST_RESULT_FILENAME)
+export function monitor(
+	context: Partial<MonitorContext & GetLastLineContext> | undefined,
+	callback: (err: any, testResults?: TestResults) => void
+): MonitorSubscription {
+	const c = unpartial<MonitorContext & GetLastLineContext>(
+		{
+			fs,
+			readline,
+			rootDir: store.value.rootDir,
+			awaitWriteFinish: true
+		},
+		context
+	)
+	const filepath = path.join(c.rootDir, PROGRESS_FOLDER, TEST_RESULT_FILENAME)
 
-  const w = chokidar.watch(filepath, { awaitWriteFinish: c.awaitWriteFinish })
-  w.on('add', path => invokeCallback(c, path, callback))
-  w.on('change', path => invokeCallback(c, path, callback))
-  return { close: () => w.close() }
+	const w = chokidar.watch(filepath, { awaitWriteFinish: c.awaitWriteFinish })
+	w.on('add', (path) => invokeCallback(c, path, callback))
+	w.on('change', (path) => invokeCallback(c, path, callback))
+	return { close: () => w.close() }
 }
 
-function invokeCallback(context: GetLastLineContext, filename: string, callback: (err: any, testResults?: TestResults) => void) {
-  getLastLine(context, filename).then(line => {
-    callback(undefined, unminify(decompress(line)))
-  }).catch((e) => callback(e))
+function invokeCallback(
+	context: GetLastLineContext,
+	filename: string,
+	callback: (err: any, testResults?: TestResults) => void
+) {
+	getLastLine(context, filename)
+		.then((line) => {
+			callback(undefined, unminify(decompress(line)))
+		})
+		.catch((e) => callback(e))
 }
 
 export interface GetLastLineContext {
-  fs: Pick<typeof fs, 'createReadStream' | 'WriteStream'>,
-  readline: Pick<typeof readline, 'createInterface'>
+	fs: Pick<typeof fs, 'createReadStream' | 'WriteStream'>
+	readline: Pick<typeof readline, 'createInterface'>
 }
 
 function getLastLine({ fs, readline }: GetLastLineContext, filename: string) {
-  const inStream = fs.createReadStream(filename)
-  return new Promise<string>((a, r) => {
-    const rl = readline.createInterface(inStream)
-    let lastline = ''
-    rl.on('line', (line: string) => {
-      if (line.length) {
-        lastline = line
-      }
-    })
-    rl.on('error', r)
-    rl.on('close', () => a(lastline))
-  })
+	const inStream = fs.createReadStream(filename)
+	return new Promise<string>((a, r) => {
+		const rl = readline.createInterface(inStream)
+		let lastline = ''
+		rl.on('line', (line: string) => {
+			if (line.length) {
+				lastline = line
+			}
+		})
+		rl.on('error', r)
+		rl.on('close', () => a(lastline))
+	})
 }

package/ts/store.ts

@@ -1,11 +1,11 @@
 import { createStore } from 'global-store'
 
 export const store = createStore<{ rootDir: string }>({
-  moduleName: 'test-progress-tracker',
-  version: '1.0.0',
-  key: 'eb969cee-8646-5b9c-9084-9093804d4121',
-  initializer: (current) => ({
-    rootDir: '.',
-    ...current
-  })
+	moduleName: 'test-progress-tracker',
+	version: '1.0.0',
+	key: 'eb969cee-8646-5b9c-9084-9093804d4121',
+	initializer: (current) => ({
+		rootDir: '.',
+		...current
+	})
 })

package/ts/testResultsExamples.ts

@@ -1,108 +1,108 @@
 export const noCoverage = {
-  duration: 1,
-  numFailedTests: 2,
-  numFailedTestSuites: 3,
-  numPassedTests: 4,
-  numPassedTestSuites: 5,
-  numTotalTests: 6,
-  numTotalTestSuites: 7,
-  startTime: 8
+	duration: 1,
+	numFailedTests: 2,
+	numFailedTestSuites: 3,
+	numPassedTests: 4,
+	numPassedTestSuites: 5,
+	numTotalTests: 6,
+	numTotalTestSuites: 7,
+	startTime: 8
 }
 
 export const noCoverageMinified = {
-  d: 1,
-  f: 2,
-  fs: 3,
-  p: 4,
-  ps: 5,
-  t: 6,
-  ts: 7,
-  s: 8
+	d: 1,
+	f: 2,
+	fs: 3,
+	p: 4,
+	ps: 5,
+	t: 6,
+	ts: 7,
+	s: 8
 }
 export const filtered = {
-  duration: 1,
-  filtered: true,
-  numFailedTests: 2,
-  numFailedTestSuites: 3,
-  numPassedTests: 4,
-  numPassedTestSuites: 5,
-  numTotalTests: 6,
-  numTotalTestSuites: 7,
-  startTime: 8
+	duration: 1,
+	filtered: true,
+	numFailedTests: 2,
+	numFailedTestSuites: 3,
+	numPassedTests: 4,
+	numPassedTestSuites: 5,
+	numTotalTests: 6,
+	numTotalTestSuites: 7,
+	startTime: 8
 }
 
 export const filteredMinified = {
-  d: 1,
-  fl: true,
-  f: 2,
-  fs: 3,
-  p: 4,
-  ps: 5,
-  t: 6,
-  ts: 7,
-  s: 8
+	d: 1,
+	fl: true,
+	f: 2,
+	fs: 3,
+	p: 4,
+	ps: 5,
+	t: 6,
+	ts: 7,
+	s: 8
 }
 export const coverageNoPercentage = {
-  duration: 1,
-  numFailedTests: 2,
-  numFailedTestSuites: 3,
-  numPassedTests: 4,
-  numPassedTestSuites: 5,
-  numTotalTests: 6,
-  numTotalTestSuites: 7,
-  startTime: 8,
-  coverage: {
-    branches: { covered: 0, skipped: 1, total: 2 },
-    functions: { covered: 3, skipped: 4, total: 5 },
-    lines: { covered: 6, skipped: 7, total: 8 },
-    statements: { covered: 9, skipped: 10, total: 11 }
-  }
+	duration: 1,
+	numFailedTests: 2,
+	numFailedTestSuites: 3,
+	numPassedTests: 4,
+	numPassedTestSuites: 5,
+	numTotalTests: 6,
+	numTotalTestSuites: 7,
+	startTime: 8,
+	coverage: {
+		branches: { covered: 0, skipped: 1, total: 2 },
+		functions: { covered: 3, skipped: 4, total: 5 },
+		lines: { covered: 6, skipped: 7, total: 8 },
+		statements: { covered: 9, skipped: 10, total: 11 }
+	}
 }
 export const coverageNoPercentageMinified = {
-  d: 1,
-  f: 2,
-  fs: 3,
-  p: 4,
-  ps: 5,
-  t: 6,
-  ts: 7,
-  s: 8,
-  c: {
-    b: { c: 0, s: 1, t: 2 },
-    f: { c: 3, s: 4, t: 5 },
-    l: { c: 6, s: 7, t: 8 },
-    s: { c: 9, s: 10, t: 11 }
-  }
+	d: 1,
+	f: 2,
+	fs: 3,
+	p: 4,
+	ps: 5,
+	t: 6,
+	ts: 7,
+	s: 8,
+	c: {
+		b: { c: 0, s: 1, t: 2 },
+		f: { c: 3, s: 4, t: 5 },
+		l: { c: 6, s: 7, t: 8 },
+		s: { c: 9, s: 10, t: 11 }
+	}
 }
 export const coverageWithPercentage = {
-  duration: 1,
-  numFailedTests: 2,
-  numFailedTestSuites: 3,
-  numPassedTests: 4,
-  numPassedTestSuites: 5,
-  numTotalTests: 6,
-  numTotalTestSuites: 7,
-  startTime: 8,
-  coverage: {
-    branches: { covered: 0, skipped: 1, total: 2, pct: 0.1 },
-    functions: { covered: 3, skipped: 4, total: 5, pct: 0.2 },
-    lines: { covered: 6, skipped: 7, total: 8, pct: 0.3 },
-    statements: { covered: 9, skipped: 10, total: 11, pct: 0.4 }
-  }
+	duration: 1,
+	numFailedTests: 2,
+	numFailedTestSuites: 3,
+	numPassedTests: 4,
+	numPassedTestSuites: 5,
+	numTotalTests: 6,
+	numTotalTestSuites: 7,
+	startTime: 8,
+	coverage: {
+		branches: { covered: 0, skipped: 1, total: 2, pct: 0.1 },
+		functions: { covered: 3, skipped: 4, total: 5, pct: 0.2 },
+		lines: { covered: 6, skipped: 7, total: 8, pct: 0.3 },
+		statements: { covered: 9, skipped: 10, total: 11, pct: 0.4 }
+	}
 }
 export const coverageWithPercentageMinified = {
-  d: 1,
-  f: 2,
-  fs: 3,
-  p: 4,
-  ps: 5,
-  t: 6,
-  ts: 7,
-  s: 8,
-  c: {
-    b: { c: 0, s: 1, t: 2, p: 0.1 },
-    f: { c: 3, s: 4, t: 5, p: 0.2 },
-    l: { c: 6, s: 7, t: 8, p: 0.3 },
-    s: { c: 9, s: 10, t: 11, p: 0.4 }
-  }
+	d: 1,
+	f: 2,
+	fs: 3,
+	p: 4,
+	ps: 5,
+	t: 6,
+	ts: 7,
+	s: 8,
+	c: {
+		b: { c: 0, s: 1, t: 2, p: 0.1 },
+		f: { c: 3, s: 4, t: 5, p: 0.2 },
+		l: { c: 6, s: 7, t: 8, p: 0.3 },
+		s: { c: 9, s: 10, t: 11, p: 0.4 }
+	}
 }

package/cjs/compress.d.ts

@@ -1,3 +0,0 @@
-import { MinifiedTestResult } from './minify';
-export declare function compress(obj: MinifiedTestResult): string;
-export declare function decompress(str: string): MinifiedTestResult;

package/cjs/constants.d.ts

@@ -1,2 +0,0 @@
-export declare const PROGRESS_FOLDER = ".progress";
-export declare const TEST_RESULT_FILENAME = "test.results";