ava 4.0.0 → 4.2.0

package/entrypoints/eslint-plugin-helper.cjs

@@ -90,7 +90,7 @@ function load(projectDir, overrides) {
 
 	const helper = Object.freeze({
 		classifyFile: classifyForESLint,
-		classifyImport: importPath => {
+		classifyImport(importPath) {
 			if (hasExtension(globs.extensions, importPath)) {
 				// The importPath has one of the test file extensions: we can classify
 				// it directly.

package/lib/api.js

@@ -177,13 +177,19 @@ export default class Api extends Emittery {
 				const fileCount = selectedFiles.length;
 
 				// The files must be in the same order across all runs, so sort them.
-				selectedFiles = selectedFiles.sort((a, b) => a.localeCompare(b, [], {numeric: true}));
+				const defaultComparator = (a, b) => a.localeCompare(b, [], {numeric: true});
+				selectedFiles = selectedFiles.sort(this.options.sortTestFiles || defaultComparator);
 				selectedFiles = chunkd(selectedFiles, currentIndex, totalRuns);
 
 				const currentFileCount = selectedFiles.length;
 
 				runStatus = new RunStatus(fileCount, {currentFileCount, currentIndex, totalRuns}, selectionInsights);
 			} else {
+				// If a custom sorter was configured, use it.
+				if (this.options.sortTestFiles) {
+					selectedFiles = selectedFiles.sort(this.options.sortTestFiles);
+				}
+
 				runStatus = new RunStatus(selectedFiles.length, null, selectionInsights);
 			}
 
@@ -261,8 +267,8 @@ export default class Api extends Emittery {
 				}
 
 				const lineNumbers = getApplicableLineNumbers(globs.normalizeFileForMatching(apiOptions.projectDir, file), filter);
-				// Removing `providers` field because they cannot be transfered to the worker threads.
-				const {providers, ...forkOptions} = apiOptions;
+				// Removing `providers` and `sortTestFiles` fields because they cannot be transferred to the worker threads.
+				const {providers, sortTestFiles, ...forkOptions} = apiOptions;
 				const options = {
 					...forkOptions,
 					providerStates,

package/lib/cli.js

@@ -21,6 +21,7 @@ import {splitPatternAndLineNumbers} from './line-numbers.js';
 import {loadConfig} from './load-config.js';
 import normalizeModuleTypes from './module-types.js';
 import normalizeNodeArguments from './node-arguments.js';
+import pkg from './pkg.cjs';
 import providerManager from './provider-manager.js';
 import DefaultReporter from './reporters/default.js';
 import TapReporter from './reporters/tap.js';
@@ -102,8 +103,15 @@ export default async function loadCli() { // eslint-disable-line complexity
 	let conf;
 	let confError;
 	try {
-		const {argv: {config: configFile}} = yargs(hideBin(process.argv)).help(false);
-		conf = await loadConfig({configFile});
+		const {argv: {config: configFile}} = yargs(hideBin(process.argv)).help(false).version(false);
+		const loaded = await loadConfig({configFile});
+		if (loaded.unsupportedFiles.length > 0) {
+			console.log(chalk.magenta(
+				`  ${figures.warning} AVA does not support JSON config, ignoring:\n\n    ${loaded.unsupportedFiles.join('\n    ')}`,
+			));
+		}
+
+		conf = loaded.config;
 		if (conf.configFile && path.basename(conf.configFile) !== path.relative(conf.projectDir, conf.configFile)) {
 			console.log(chalk.magenta(`  ${figures.warning} Using configuration from ${conf.configFile}`));
 		}
@@ -132,6 +140,7 @@ export default async function loadCli() { // eslint-disable-line complexity
 
 	let resetCache = false;
 	const {argv} = yargs(hideBin(process.argv))
+		.version(pkg.version)
 		.parserConfiguration({
 			'boolean-negation': true,
 			'camel-case-expansion': false,
@@ -161,7 +170,7 @@ export default async function loadCli() { // eslint-disable-line complexity
 		})
 		.command('* [<pattern>...]', 'Run tests', yargs => yargs.options(FLAGS).positional('pattern', {
 			array: true,
-			describe: 'Select which test files to run. Leave empty if you want AVA to run all test files as per your configuration. Accepts glob patterns, directories that (recursively) contain test files, and file paths. Add a colon and specify line numbers of specific tests to run',
+			describe: 'Select which test files to run. Leave empty if you want AVA to run all test files as per your configuration. Accepts glob patterns, directories that (recursively) contain test files, and file paths optionally suffixed with a colon and comma-separated numbers and/or ranges identifying the 1-based line(s) of specific tests to run',
 			type: 'string',
 		}), argv => {
 			if (activeInspector) {
@@ -188,7 +197,7 @@ export default async function loadCli() { // eslint-disable-line complexity
 				},
 			}).positional('pattern', {
 				demand: true,
-				describe: 'Glob patterns to select a single test file to debug. Add a colon and specify line numbers of specific tests to run',
+				describe: 'Glob pattern to select a single test file to debug, optionally suffixed with a colon and comma-separated numbers and/or ranges identifying the 1-based line(s) of specific tests to run',
 				type: 'string',
 			}),
 			argv => {
@@ -319,16 +328,20 @@ export default async function loadCli() { // eslint-disable-line complexity
 		exit('’sources’ has been removed. Use ’ignoredByWatcher’ to provide glob patterns of files that the watcher should ignore.');
 	}
 
-	let pkg;
+	if (Reflect.has(conf, 'sortTestFiles') && typeof conf.sortTestFiles !== 'function') {
+		exit('’sortTestFiles’ must be a comparator function.');
+	}
+
+	let projectPackageObject;
 	try {
-		pkg = JSON.parse(fs.readFileSync(path.resolve(projectDir, 'package.json')));
+		projectPackageObject = JSON.parse(fs.readFileSync(path.resolve(projectDir, 'package.json')));
 	} catch (error) {
 		if (error.code !== 'ENOENT') {
 			throw error;
 		}
 	}
 
-	const {type: defaultModuleType = 'commonjs'} = pkg || {};
+	const {type: defaultModuleType = 'commonjs'} = projectPackageObject || {};
 
 	const providers = [];
 	if (Reflect.has(conf, 'typescript')) {
@@ -380,7 +393,7 @@ export default async function loadCli() { // eslint-disable-line complexity
 	}
 
 	let parallelRuns = null;
-	if (isCi && ciParallelVars) {
+	if (isCi && ciParallelVars && combined.utilizeParallelBuilds !== false) {
 		const {index: currentIndex, total: totalRuns} = ciParallelVars;
 		parallelRuns = {currentIndex, totalRuns};
 	}
@@ -411,6 +424,7 @@ export default async function loadCli() { // eslint-disable-line complexity
 		moduleTypes,
 		nodeArguments,
 		parallelRuns,
+		sortTestFiles: conf.sortTestFiles,
 		projectDir,
 		providers,
 		ranFromCli: true,

package/lib/eslint-plugin-helper-worker.js

@@ -41,7 +41,7 @@ const buildGlobs = ({conf, providers, projectDir, overrideExtensions, overrideFi
 
 const resolveGlobs = async (projectDir, overrideExtensions, overrideFiles) => {
 	if (!configCache.has(projectDir)) {
-		configCache.set(projectDir, loadConfig({resolveFrom: projectDir}).then(async conf => {
+		configCache.set(projectDir, loadConfig({resolveFrom: projectDir}).then(async ({config: conf}) => {
 			const providers = await collectProviders({conf, projectDir});
 			return {conf, providers};
 		}));

package/lib/load-config.js

@@ -20,14 +20,15 @@ const importConfig = async ({configFile, fileForErrorMessage}) => {
 };
 
 const loadConfigFile = async ({projectDir, configFile}) => {
-	if (!fs.existsSync(configFile)) {
-		return null;
-	}
-
 	const fileForErrorMessage = path.relative(projectDir, configFile);
 	try {
+		await fs.promises.access(configFile);
 		return {config: await importConfig({configFile, fileForErrorMessage}), configFile, fileForErrorMessage};
 	} catch (error) {
+		if (error.code === 'ENOENT') {
+			return null;
+		}
+
 		throw Object.assign(new Error(`Error loading ${fileForErrorMessage}: ${error.message}`), {parent: error});
 	}
 };
@@ -63,6 +64,20 @@ async function findRepoRoot(fromDir) {
 	return root;
 }
 
+async function checkJsonFile(searchDir) {
+	const file = path.join(searchDir, 'ava.config.json');
+	try {
+		await fs.promises.access(file);
+		return file;
+	} catch (error) {
+		if (error.code === 'ENOENT') {
+			return null;
+		}
+
+		throw error;
+	}
+}
+
 export async function loadConfig({configFile, resolveFrom = process.cwd(), defaults = {}} = {}) {
 	let packageConf = await packageConfig('ava', {cwd: resolveFrom});
 	const filepath = packageJsonPath(packageConf);
@@ -74,6 +89,7 @@ export async function loadConfig({configFile, resolveFrom = process.cwd(), defau
 	const allowConflictWithPackageJson = Boolean(configFile);
 	configFile = resolveConfigFile(configFile);
 
+	const unsupportedFiles = [];
 	let fileConf = NO_SUCH_FILE;
 	let fileForErrorMessage;
 	let conflicting = [];
@@ -86,12 +102,17 @@ export async function loadConfig({configFile, resolveFrom = process.cwd(), defau
 		let searchDir = projectDir;
 		const stopAt = path.dirname(repoRoot);
 		do {
-			const results = await Promise.all([ // eslint-disable-line no-await-in-loop
+			const [jsonFile, ...results] = await Promise.all([ // eslint-disable-line no-await-in-loop
+				checkJsonFile(searchDir),
 				loadConfigFile({projectDir, configFile: path.join(searchDir, 'ava.config.js')}),
 				loadConfigFile({projectDir, configFile: path.join(searchDir, 'ava.config.cjs')}),
 				loadConfigFile({projectDir, configFile: path.join(searchDir, 'ava.config.mjs')}),
 			]);
 
+			if (jsonFile !== null) {
+				unsupportedFiles.push(jsonFile);
+			}
+
 			[{config: fileConf, fileForErrorMessage, configFile} = {config: NO_SUCH_FILE, fileForErrorMessage: undefined}, ...conflicting] = results.filter(result => result !== null);
 
 			searchDir = path.dirname(searchDir);
@@ -139,5 +160,5 @@ export async function loadConfig({configFile, resolveFrom = process.cwd(), defau
 		}
 	}
 
-	return config;
+	return {config, unsupportedFiles};
 }

package/lib/reporters/tap.js

@@ -4,7 +4,7 @@ import path from 'node:path';
 import indentString from 'indent-string';
 import plur from 'plur';
 import stripAnsi from 'strip-ansi';
-import supertap from 'supertap';
+import * as supertap from 'supertap';
 
 import beautifyStack from './beautify-stack.js';
 import prefixTitle from './prefix-title.js';

package/lib/runner.js

@@ -224,8 +224,8 @@ export default class Runner extends Emittery {
 		return this.snapshots.skipSnapshot(options);
 	}
 
-	saveSnapshotState() {
-		return {touchedFiles: this.snapshots.save()};
+	async saveSnapshotState() {
+		return {touchedFiles: await this.snapshots.save()};
 	}
 
 	onRun(runnable) {

package/lib/snapshot-manager.js

@@ -182,8 +182,8 @@ function sortBlocks(blocksByTitle, blockIndices) {
 	);
 }
 
-function encodeSnapshots(snapshotData) {
-	const encoded = cbor.encodeOne(snapshotData, {
+async function encodeSnapshots(snapshotData) {
+	const encoded = await cbor.encodeAsync(snapshotData, {
 		omitUndefinedProperties: true,
 		canonical: true,
 	});
@@ -351,7 +351,7 @@ class Manager {
 		this.recordSerialized({belongsTo, index, ...snapshot});
 	}
 
-	save() {
+	async save() {
 		const {dir, relFile, snapFile, snapPath, reportPath} = this;
 
 		if (this.updating && this.newBlocksByTitle.size === 0) {
@@ -371,15 +371,17 @@ class Manager {
 			),
 		};
 
-		const buffer = encodeSnapshots(snapshots);
+		const buffer = await encodeSnapshots(snapshots);
 		const reportBuffer = generateReport(relFile, snapFile, snapshots);
 
-		fs.mkdirSync(dir, {recursive: true});
+		await fs.promises.mkdir(dir, {recursive: true});
 
 		const temporaryFiles = [];
 		const tmpfileCreated = file => temporaryFiles.push(file);
-		writeFileAtomic.sync(snapPath, buffer, {tmpfileCreated});
-		writeFileAtomic.sync(reportPath, reportBuffer, {tmpfileCreated});
+		await Promise.all([
+			writeFileAtomic(snapPath, buffer, {tmpfileCreated}),
+			writeFileAtomic(reportPath, reportBuffer, {tmpfileCreated}),
+		]);
 		return {
 			changedFiles: [snapPath, reportPath],
 			temporaryFiles,

package/lib/test.js

@@ -24,16 +24,16 @@ const testMap = new WeakMap();
 class ExecutionContext extends Assertions {
 	constructor(test) {
 		super({
-			pass: () => {
+			pass() {
 				test.countPassedAssertion();
 			},
-			pending: promise => {
+			pending(promise) {
 				test.addPendingAssertion(promise);
 			},
-			fail: error => {
+			fail(error) {
 				test.addFailedAssertion(error);
 			},
-			skip: () => {
+			skip() {
 				test.countPassedAssertion();
 			},
 			compareWithSnapshot: options => test.compareWithSnapshot(options),
@@ -109,7 +109,7 @@ class ExecutionContext extends Assertions {
 				logs: [...logs], // Don't allow modification of logs.
 				passed,
 				title: attemptTitle,
-				commit: ({retainLogs = true} = {}) => {
+				commit({retainLogs = true} = {}) {
 					if (committed) {
 						return;
 					}
@@ -132,7 +132,7 @@ class ExecutionContext extends Assertions {
 						startingSnapshotCount,
 					});
 				},
-				discard: ({retainLogs = false} = {}) => {
+				discard({retainLogs = false} = {}) {
 					if (committed) {
 						test.saveFirstError(new Error('Can’t discard a result that was previously committed'));
 						return;

package/lib/worker/base.js

@@ -81,7 +81,7 @@ const run = async options => {
 
 	runner.on('finish', async () => {
 		try {
-			const {touchedFiles} = runner.saveSnapshotState();
+			const {touchedFiles} = await runner.saveSnapshotState();
 			if (touchedFiles) {
 				channel.send({type: 'touched-files', files: touchedFiles});
 			}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "ava",
-	"version": "4.0.0",
+	"version": "4.2.0",
 	"description": "Node.js test runner that lets you develop with confidence.",
 	"license": "MIT",
 	"repository": "avajs/ava",
@@ -78,32 +78,32 @@
 		"callsites": "^4.0.0",
 		"cbor": "^8.1.0",
 		"chalk": "^5.0.0",
-		"chokidar": "^3.5.2",
+		"chokidar": "^3.5.3",
 		"chunkd": "^2.0.1",
 		"ci-info": "^3.3.0",
 		"ci-parallel-vars": "^1.0.1",
 		"clean-yaml-object": "^0.1.0",
 		"cli-truncate": "^3.1.0",
-		"code-excerpt": "^3.0.0",
+		"code-excerpt": "^4.0.0",
 		"common-path-prefix": "^3.0.0",
 		"concordance": "^5.0.4",
 		"currently-unhandled": "^0.4.1",
 		"debug": "^4.3.3",
 		"del": "^6.0.0",
-		"emittery": "^0.10.0",
+		"emittery": "^0.10.1",
 		"figures": "^4.0.0",
-		"globby": "^12.0.2",
+		"globby": "^13.1.1",
 		"ignore-by-default": "^2.0.0",
 		"indent-string": "^5.0.0",
 		"is-error": "^2.2.2",
 		"is-plain-object": "^5.0.0",
 		"is-promise": "^4.0.0",
 		"matcher": "^5.0.0",
-		"mem": "^9.0.1",
+		"mem": "^9.0.2",
 		"ms": "^2.1.3",
 		"p-event": "^5.0.1",
 		"p-map": "^5.3.0",
-		"picomatch": "^2.3.0",
+		"picomatch": "^2.3.1",
 		"pkg-conf": "^4.0.0",
 		"plur": "^5.1.0",
 		"pretty-ms": "^7.0.1",
@@ -111,30 +111,30 @@
 		"slash": "^3.0.0",
 		"stack-utils": "^2.0.5",
 		"strip-ansi": "^7.0.1",
-		"supertap": "^2.0.0",
+		"supertap": "^3.0.1",
 		"temp-dir": "^2.0.0",
-		"write-file-atomic": "^3.0.3",
+		"write-file-atomic": "^4.0.1",
 		"yargs": "^17.3.1"
 	},
 	"devDependencies": {
 		"@ava/test": "github:avajs/test",
 		"@ava/typescript": "^3.0.1",
-		"@sinonjs/fake-timers": "^8.1.0",
+		"@sinonjs/fake-timers": "^9.1.1",
 		"ansi-escapes": "^5.0.0",
 		"c8": "^7.11.0",
 		"delay": "^5.0.0",
-		"execa": "^6.0.0",
-		"fs-extra": "^10.0.0",
+		"execa": "^6.1.0",
+		"fs-extra": "^10.0.1",
 		"get-stream": "^6.0.1",
 		"replace-string": "^4.0.0",
-		"sinon": "^12.0.1",
-		"tap": "^15.1.5",
+		"sinon": "^13.0.1",
+		"tap": "^16.0.0",
 		"temp-write": "^5.0.0",
 		"tempy": "^2.0.0",
 		"touch": "^3.1.0",
 		"tsd": "^0.19.1",
-		"typescript": "^4.4.4",
-		"xo": "^0.47.0",
+		"typescript": "^4.6.2",
+		"xo": "^0.48.0",
 		"zen-observable": "^0.8.15"
 	},
 	"peerDependencies": {

package/plugin.d.ts

@@ -41,7 +41,7 @@ export namespace SharedWorker {
 		readonly file: string;
 		publish: (data: Data) => PublishedMessage<Data>;
 		subscribe: () => AsyncIterableIterator<ReceivedMessage<Data>>;
-		teardown: <TeardownFn extends () => void> (fn: TeardownFn) => TeardownFn;
+		teardown: (fn: (() => Promise<void>) | (() => void)) => () => Promise<void>;
 	};
 
 	export namespace Plugin {

package/readme.md

@@ -1,3 +1,5 @@
+[![SWUbanner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://vshymanskyy.github.io/StandWithUkraine/)
+
 # <img src="media/header.png" title="AVA" alt="AVA logo" width="530">
 
 AVA is a test runner for Node.js with a concise API, detailed error output, embrace of new language features and process isolation that lets you develop with confidence 🚀
@@ -71,7 +73,7 @@ Don't forget to configure the `test` script in your `package.json` as per above.
 Create a file named `test.js` in the project root directory:
 
 ```js
-const test = require('ava');
+import test from 'ava';
 
 test('foo', t => {
 	t.pass();
@@ -139,15 +141,16 @@ We have a growing list of [common pitfalls](docs/08-common-pitfalls.md) you may
 
 ### Recipes
 
-- [Shared workers](docs/recipes/shared-workers.md)
 - [Test setup](docs/recipes/test-setup.md)
-- [Code coverage](docs/recipes/code-coverage.md)
+- [TypeScript](docs/recipes/typescript.md)
+- [Shared workers](docs/recipes/shared-workers.md)
 - [Watch mode](docs/recipes/watch-mode.md)
-- [Endpoint testing](docs/recipes/endpoint-testing.md)
 - [When to use `t.plan()`](docs/recipes/when-to-use-plan.md)
-- [Browser testing](docs/recipes/browser-testing.md)
-- [TypeScript](docs/recipes/typescript.md)
 - [Passing arguments to your test files](docs/recipes/passing-arguments-to-your-test-files.md)
+- [Splitting tests in CI](docs/recipes/splitting-tests-ci.md)
+- [Code coverage](docs/recipes/code-coverage.md)
+- [Endpoint testing](docs/recipes/endpoint-testing.md)
+- [Browser testing](docs/recipes/browser-testing.md)
 - [Testing Vue.js components](docs/recipes/vue.md)
 - [Debugging tests with Chrome DevTools](docs/recipes/debugging-with-chrome-devtools.md)
 - [Debugging tests with VSCode](docs/recipes/debugging-with-vscode.md)

package/types/assertions.d.ts

@@ -138,6 +138,18 @@ export interface DeepEqualAssertion {
 	 */
 	<Actual, Expected extends Actual>(actual: Actual, expected: Expected, message?: string): actual is Expected;
 
+	/**
+	 * Assert that `actual` is [deeply equal](https://github.com/concordancejs/concordance#comparison-details) to
+	 * `expected`, returning a boolean indicating whether the assertion passed.
+	 */
+	<Actual extends Expected, Expected>(actual: Actual, expected: Expected, message?: string): expected is Actual;
+
+	/**
+	 * Assert that `actual` is [deeply equal](https://github.com/concordancejs/concordance#comparison-details) to
+	 * `expected`, returning a boolean indicating whether the assertion passed.
+	 */
+	<Actual, Expected>(actual: Actual, expected: Expected, message?: string): boolean;
+
 	/** Skip this assertion. */
 	skip(actual: any, expected: any, message?: string): void;
 }

package/types/test-fn.d.ts

@@ -46,7 +46,7 @@ export interface PlanFn {
 export type TimeoutFn = (ms: number, message?: string) => void;
 
 /** Declare a function to be run after the test has ended. */
-export type TeardownFn = (fn: () => void) => void;
+export type TeardownFn = (fn: (() => Promise<void>) | (() => void)) => void;
 
 export type ImplementationFn<Args extends unknown[], Context = unknown> =
 	((t: ExecutionContext<Context>, ...args: Args) => PromiseLike<void>) |