Remove Babel support, and therefore enhanced assertions

This removes support for @ava/babel. Since enhanced assertions (power assert) are provided through that package this also removes support for those. Same for improper throws detection. @ava/babel has seen no meaningful contributions since it was released at the start of 2020. It's not clear how we'd make it work with ESM. It's clearer if we can recommend tools like @babel/register and otherwise focus on plain Node.js & TypeScript support.
avajs · Sep 19, 2021 · 678f9ca · 678f9ca
1 parent 6d9c4d7
commit 678f9ca
Show file tree

Hide file tree

Showing 57 changed files with 249 additions and 1,965 deletions.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -5,4 +5,4 @@ contact_links:
     about: Questions? Ideas? Something to share?
   - name: Babel
     url: https://github.com/avajs/babel/issues
-    about: Report a bug with AVA's Babel integration
+    about: Report a bug with AVA 3's Babel integration
diff --git a/docs/03-assertions.md b/docs/03-assertions.md
@@ -77,7 +77,7 @@ test('skip assertion', t => {
 
 ## Enhanced assertion messages
 
-Enabling [Babel](./recipes/babel.md) will also enable [`power-assert`](https://github.com/power-assert-js/power-assert), giving you more descriptive assertion messages.
+With AVA 3, enabling [Babel](./recipes/babel.md) will also enable [`power-assert`](https://github.com/power-assert-js/power-assert), giving you more descriptive assertion messages.
 
 Let's take this example, using Node's standard [`assert` library](https://nodejs.org/api/assert.html):
 

diff --git a/docs/05-command-line.md b/docs/05-command-line.md
@@ -11,7 +11,8 @@ Commands:
   ava [<pattern>...]        Run tests                                  [default]
   ava debug [<pattern>...]  Activate Node.js inspector and run a single test
                             file
-  ava reset-cache           Reset AVA's compilation cache and exit
+  ava reset-cache           Delete any temporary files and state kept by AVA,
+	                          then exit
 
 Positionals:
   pattern  Glob patterns to select what test files to run. Leave empty if you
@@ -162,7 +163,7 @@ AVA lets you run tests exclusively by referring to their line numbers. Target a
 
 The format is a comma-separated list of `[X|Y-Z]` where `X`, `Y` and `Z` are integers between `1` and the last line number of the file.
 
-This feature is only available from the command line. It won't work if you use tools like `ts-node/register` or `@babel/register`, and it does not currently work with `@ava/babel` and `@ava/typescript`.
+This feature is only available from the command line. It won't work if you use tools like `ts-node/register` or `@babel/register`, and it does not currently work with `@ava/babel` (available for AVA 3) and `@ava/typescript`.
 
 ### Running a single test
 
@@ -218,7 +219,7 @@ When running a file with and without line numbers, line numbers take precedence.
 
 ## Resetting AVA's cache
 
-AVA itself does not cache files unless used with our [`@ava/babel`](https://github.com/avajs/babel) provider. If it seems like your latest changes aren't being picked up by AVA you can try resetting the cache by running:
+AVA 3 itself does not cache files unless used with our [`@ava/babel`](https://github.com/avajs/babel) provider. If it seems like your latest changes aren't being picked up by AVA you can try resetting the cache by running:
 
 ```console
 npx ava reset-cache

diff --git a/docs/06-configuration.md b/docs/06-configuration.md
@@ -61,7 +61,7 @@ Arguments passed to the CLI will always take precedence over the CLI options con
 
 Note that providing files on the CLI overrides the `files` option.
 
-Provide the `babel` option (and install [`@ava/babel`](https://github.com/avajs/babel) as an additional dependency) to enable Babel compilation.
+When using AVA 3, provide the `babel` option (and install [`@ava/babel`](https://github.com/avajs/babel) as an additional dependency) to enable Babel compilation.
 
 Provide the `typescript` option (and install [`@ava/typescript`](https://github.com/avajs/typescript) as an additional dependency) to enable (rudimentary) TypeScript support.
 

diff --git a/docs/08-common-pitfalls.md b/docs/08-common-pitfalls.md
@@ -56,6 +56,8 @@ AVA [can't trace uncaught exceptions](https://github.com/avajs/ava/issues/214) b
 
 ## Why are the enhanced assertion messages not shown?
 
+Enhanced assertion messages are no longer supported in AVA 4.
+
 Ensure that the first parameter passed into your test is named `t`. This is a requirement of [`power-assert`](https://github.com/power-assert-js/power-assert), the library that provides the [enhanced messages](./03-assertions.md#enhanced-assertion-messages).
 
 ```js

diff --git a/docs/recipes/babel.md b/docs/recipes/babel.md
@@ -2,6 +2,8 @@
 
 Translations: [Français](https://github.com/avajs/ava-docs/blob/master/fr_FR/docs/recipes/babel.md)
 
+This is no longer available in AVA 4.
+
 You can enable Babel support by installing `@ava/babel`, and then in AVA's configuration setting `babel` to `true`:
 
 **`package.json`:**

diff --git a/docs/recipes/react.md b/docs/recipes/react.md
@@ -4,7 +4,7 @@ Translations: [Español](https://github.com/avajs/ava-docs/blob/master/es_ES/doc
 
 ## Setting up Babel
 
-When you [enable Babel](https://github.com/avajs/babel), AVA will automatically extend your regular (project-level) Babel configuration. You should be able to use React in your test files without any additional configuration.
+When you [enable Babel](https://github.com/avajs/babel), AVA 3 will automatically extend your regular (project-level) Babel configuration. You should be able to use React in your test files without any additional configuration.
 
 However if you want to set it up explicitly, add the preset to the test options in AVA's Babel pipeline by modifying your `package.json` or `ava.config.*` file.
 

diff --git a/docs/recipes/vue.md b/docs/recipes/vue.md
@@ -53,7 +53,7 @@ hooks(['vue', 'js']).exclude(({filename}) => filename.match(/\/node_modules\//))
 
 **Note:** If you are using _babel-plugin-webpack-alias-7_, you must also exclude your webpack file - e.g. `filename.includes(/\/node_modules\//) || filename.includes('webpack.config.test.js')`
 
-You can find more information about setting up Babel with AVA in [`@ava/babel`](https://github.com/avajs/babel).
+You can find more information about setting up Babel with AVA 3 in [`@ava/babel`](https://github.com/avajs/babel).
 
 ## Sample snapshot test
 

diff --git a/lib/assert.js b/lib/assert.js
@@ -25,10 +25,6 @@ function formatWithLabel(label, value) {
 	return formatDescriptorWithLabel(label, concordance.describe(value, concordanceOptions));
 }
 
-function formatPowerAssertValue(value) {
-	return concordance.format(value, concordanceOptions);
-}
-
 const hasOwnProperty = (object, prop) => Object.prototype.hasOwnProperty.call(object, prop);
 const noop = () => {};
 const notImplemented = () => {
@@ -52,9 +48,6 @@ export class AssertionError extends Error {
 		// use the values for custom diff views
 		this.raw = options.raw;
 
-		// Reserved for power-assert statements
-		this.statements = [];
-
 		this.savedError = options.savedError ? options.savedError : getErrorWithLongStackTrace();
 	}
 }
@@ -258,7 +251,6 @@ export class Assertions {
 		fail = notImplemented,
 		skip = notImplemented,
 		compareWithSnapshot = notImplemented,
-		powerAssert,
 		experiments = {},
 		disableSnapshots = false,
 	} = {}) {
@@ -267,35 +259,12 @@ export class Assertions {
 			return assertionFn;
 		};
 
-		// When adding new enhanced functions with new patterns, don't forget to
-		// enable the pattern in the power-assert compilation step in @ava/babel.
-		const withPowerAssert = (pattern, assertionFn) => powerAssert.empower(assertionFn, {
-			onError: event => {
-				if (event.powerAssertContext) {
-					event.error.statements = powerAssert.format(event.powerAssertContext, formatPowerAssertValue);
-				}
-
-				fail(event.error);
-				return false;
-			},
-			onSuccess: () => {
-				pass();
-				return true;
-			},
-			bindReceiver: false,
-			patterns: [pattern],
-		});
-
-		const checkMessage = (assertion, message, powerAssert = false) => {
+		const checkMessage = (assertion, message) => {
 			const result = checkAssertionMessage(assertion, message);
 			if (result === true) {
 				return true;
 			}
 
-			if (powerAssert) {
-				throw result;
-			}
-
 			fail(result);
 			return false;
 		};
@@ -948,41 +917,23 @@ export class Assertions {
 			return true;
 		});
 
-		if (powerAssert === undefined) {
-			this.assert = withSkip((actual, message) => {
-				if (!checkMessage('assert', message)) {
-					return false;
-				}
+		this.assert = withSkip((actual, message) => {
+			if (!checkMessage('assert', message)) {
+				return false;
+			}
 
-				if (!actual) {
-					fail(new AssertionError({
-						assertion: 'assert',
-						message,
-						operator: '!!',
-						values: [formatWithLabel('Value is not truthy:', actual)],
-					}));
-					return false;
-				}
+			if (!actual) {
+				fail(new AssertionError({
+					assertion: 'assert',
+					message,
+					operator: '!!',
+					values: [formatWithLabel('Value is not truthy:', actual)],
+				}));
+				return false;
+			}
 
-				pass();
-				return true;
-			});
-		} else {
-			this.assert = withSkip(withPowerAssert(
-				'assert(value, [message])',
-				(actual, message) => {
-					checkMessage('assert', message, true);
-
-					if (!actual) {
-						throw new AssertionError({
-							assertion: 'assert',
-							message,
-							operator: '!!',
-							values: [formatWithLabel('Value is not truthy:', actual)],
-						});
-					}
-				}),
-			);
-		}
+			pass();
+			return true;
+		});
 	}
 }
diff --git a/lib/cli.js b/lib/cli.js
@@ -199,7 +199,7 @@ export default async function loadCli() { // eslint-disable-line complexity
 			})
 		.command(
 			'reset-cache',
-			'Reset AVA’s compilation cache and exit',
+			'Delete any temporary files and state kept by AVA, then exit',
 			yargs => yargs,
 			() => {
 				resetCache = true;
@@ -295,6 +295,10 @@ export default async function loadCli() { // eslint-disable-line complexity
 		console.log(chalk.magenta(`  ${figures.warning} Experiments are enabled. These are unsupported and may change or be removed at any time.`));
 	}
 
+	if (Reflect.has(conf, 'babel')) {
+		exit('Built-in Babel support has been removed.');
+	}
+
 	if (Reflect.has(conf, 'compileEnhancements')) {
 		exit('Enhancement compilation must be configured in AVA’s Babel options.');
 	}
@@ -319,19 +323,6 @@ export default async function loadCli() { // eslint-disable-line complexity
 	const {type: defaultModuleType = 'commonjs'} = pkg || {};
 
 	const providers = [];
-	if (Reflect.has(conf, 'babel')) {
-		try {
-			const {level, main} = await providerManager.babel(projectDir);
-			providers.push({
-				level,
-				main: main({config: conf.babel}),
-				type: 'babel',
-			});
-		} catch (error) {
-			exit(error.message);
-		}
-	}
-
 	if (Reflect.has(conf, 'typescript')) {
 		try {
 			const {level, main} = await providerManager.typescript(projectDir);

diff --git a/lib/eslint-plugin-helper-worker.js b/lib/eslint-plugin-helper-worker.js
@@ -12,15 +12,6 @@ const configCache = new Map();
 
 const collectProviders = async ({conf, projectDir}) => {
 	const providers = [];
-	if (Reflect.has(conf, 'babel')) {
-		const {level, main} = await providerManager.babel(projectDir);
-		providers.push({
-			level,
-			main: main({config: conf.babel}),
-			type: 'babel',
-		});
-	}
-
 	if (Reflect.has(conf, 'typescript')) {
 		const {level, main} = await providerManager.typescript(projectDir);
 		providers.push({

diff --git a/lib/provider-manager.js b/lib/provider-manager.js
@@ -51,9 +51,6 @@ async function load(providerModule, projectDir) {
 
 const providerManager = {
 	levels,
-	async babel(projectDir) {
-		return load('@ava/babel', projectDir);
-	},
 	async typescript(projectDir) {
 		return load('@ava/typescript', projectDir);
 	},

diff --git a/lib/reporters/beautify-stack.js b/lib/reporters/beautify-stack.js
@@ -2,12 +2,8 @@ import StackUtils from 'stack-utils';
 
 const stackUtils = new StackUtils({
 	ignoredPackages: [
-		'@ava/babel',
-		'@ava/require-precompiled',
 		'@ava/typescript',
-		'append-transform',
 		'ava',
-		'empower-core',
 		'nyc',
 	],
 	internals: [

diff --git a/lib/reporters/format-serialized-error.js b/lib/reporters/format-serialized-error.js
@@ -1,11 +1,9 @@
-import {chalk} from '../chalk.js';
-
 export default function formatSerializedError(error) {
 	const printMessage = error.values.length === 0
 		? Boolean(error.message)
 		: !error.values[0].label.startsWith(error.message);
 
-	if (error.statements.length === 0 && error.values.length === 0) {
+	if (error.values.length === 0) {
 		return {formatted: null, printMessage};
 	}
 
@@ -14,9 +12,5 @@ export default function formatSerializedError(error) {
 		formatted += `${value.label}\n\n${value.formatted}\n\n`;
 	}
 
-	for (const statement of error.statements) {
-		formatted += `${statement[0]}\n${chalk.grey('=>')} ${statement[1]}\n\n`;
-	}
-
 	return {formatted: formatted.trim(), printMessage};
 }
diff --git a/lib/runner.js b/lib/runner.js
@@ -23,7 +23,6 @@ export default class Runner extends Emittery {
 		this.file = options.file;
 		this.checkSelectedByLineNumbers = options.checkSelectedByLineNumbers;
 		this.match = options.match || [];
-		this.powerAssert = undefined; // Assigned later.
 		this.projectDir = options.projectDir;
 		this.recordNewSnapshots = options.recordNewSnapshots === true;
 		this.runOnlyExclusive = options.runOnlyExclusive === true;
@@ -224,16 +223,6 @@ export default class Runner extends Emittery {
 		this.activeRunnables.delete(runnable);
 	}
 
-	attributeLeakedError(error) {
-		for (const runnable of this.activeRunnables) {
-			if (runnable.attributeLeakedError(error)) {
-				return true;
-			}
-		}
-
-		return false;
-	}
-
 	beforeExitHandler() {
 		for (const runnable of this.activeRunnables) {
 			runnable.finishDueToInactivity();
@@ -299,7 +288,6 @@ export default class Runner extends Emittery {
 			skipSnapshot: this.boundSkipSnapshot,
 			updateSnapshots: this.updateSnapshots,
 			metadata: task.metadata,
-			powerAssert: this.powerAssert,
 			title: `${task.title}${titleSuffix || ''}`,
 			isHook: true,
 			testPassed,
@@ -352,7 +340,6 @@ export default class Runner extends Emittery {
 				skipSnapshot: this.boundSkipSnapshot,
 				updateSnapshots: this.updateSnapshots,
 				metadata: task.metadata,
-				powerAssert: this.powerAssert,
 				title: task.title,
 				registerUniqueTitle: this.registerUniqueTitle,
 				notifyTimeoutUpdate: this.notifyTimeoutUpdate,

diff --git a/lib/serialize-error.js b/lib/serialize-error.js
@@ -89,7 +89,6 @@ function trySerializeError(error, shouldBeautifyStack, testFile) {
 		retval.improperUsage = error.improperUsage;
 		retval.message = error.message;
 		retval.name = error.name;
-		retval.statements = error.statements;
 		retval.values = error.values;
 
 		if (error.fixedSource) {
-Original file line number
+Diff line change
@@ Expand Up @@
     ## Why are the enhanced assertion messages not shown?
+    Enhanced assertion messages are no longer supported in AVA 4.
     Ensure that the first parameter passed into your test is named `t`. This is a requirement of [`power-assert`](https://github.com/power-assert-js/power-assert), the library that provides the [enhanced messages](./03-assertions.md#enhanced-assertion-messages).
     ```js
@@ Expand Down @@