Skip to content

CHANGELOG.md

Latest commit

 

History

History
728 lines (474 loc) · 34.2 KB

CHANGELOG.md

File metadata and controls

728 lines (474 loc) · 34.2 KB

Changelog

All notable changes to this project will be documented in this auto-generated file. The format is based on Conventional Commits; this project adheres to Semantic Versioning.


babel-plugin-tester@12.0.0 (2025-06-14)

💥 BREAKING CHANGES 💥

  • Minimum supported Node.js version is now 20.18.0

  • Default exports are no longer available. See usage instructions for details on proper import syntax.

  • ResultFormatter is no longer synchronous and can now return a Promise.

  • Adoption of prettier@3 requires some versions of Node to be executed with the --experimental-vm-modules option. E.g. NODE_OPTIONS="--no-warnings --experimental-vm-modules" npx jest.

  • Attempting to install babel-plugin-tester alongside jest@<30 will cause NPM to fail with ERESOLVE. This is because only jest@>=30 (jest-snapshot) supports the prettier@3 asynchronous interface.

✨ Features

  • Allow testing entire babel transform result via outputRaw (e9d5aa1) see #186
  • Support collapsing/overwriting technically-illegal duplicate plugin/preset PluginItems (bf0a088)
  • Upgrade to prettier@3 (3334248)

🪄 Fixes

  • readme: use proper codecov coverage badge (1047e5c)

⚙️ Build System

  • Adopt @-xun/symbiote (89ec951)
  • deps: bump core-js from 3.40.0 to 3.42.0 (879dd6b)
  • deps: bump core-js from 3.42.0 to 3.43.0 (7590b87)
  • deps: bump debug from 4.4.0 to 4.4.1 (3c2538c)
  • deps: bump prettier from 3.4.2 to 3.5.3 (e0a29da)
  • deps: bump pretty-format from 29.7.0 to 30.0.0 (7ea13c3)
  • deps: bump rejoinder from 1.2.5 to 2.0.1 (76dcccd)
  • deps: bump type-fest from 4.32.0 to 4.41.0 (bcbb568)
  • package: be more selective about which files are included during docs generation (cbb4215)
  • package: bump minimum supported node versions to maintained (ee6f7da)
  • release: add "master" branch to release branches (03734ea)
  • Upgrade typescript-babel toolchain to nodenext (d0b722f)

🧙🏿 Refactored

  • src: deprecated default exports are no longer available (b02d4f0)

babel-plugin-tester@11.0.0 (2023-01-18)

💥 BREAKING CHANGES 💥

  • error no longer accepts arbitrary class constructors

    error (aka throws) no longer accepts arbitrary class constructors. Any provided class constructor must extend Error, e.g. built-ins like SyntaxError or custom error classes like class MyError extends Error. Thanks to the nature of JavaScript, **providing a class constructor that does not extend Error will lead to undefined behavior**.

  • error only captures exceptions from Babel

    error (aka throws) no longer potentially captures exceptions thrown by the formatResult function. If the formatResult function throws, the entire test will fail immediately.

  • TypeError for config error; AssertionError for test error

    All configuration-related issues now throw TypeError instead of AssertionError. AssertionError is now exclusively used for failing tests. Additionally, the text of some error messages has been updated.

  • All test titles are now numbered

    All test titles are now numbered (e.g. "1. ...", "2. ...", etc), including fixtures tests and tests with custom titles.

  • Built-in TypeScript support

    TypeScript types are now included within the package itself, obviating the need to install a separate types package. Installing the old types package alongside this version of babel-plugin-tester will cause conflicts.

  • Fixture configuration schema is standardized

    In previous versions of babel-plugin-tester, you could provide any key to options.json and it would be passed as-is to the plugin under test. This made it impossible to allow fixtures to be configured with the same flexibility as test objects. In this version of babel-plugin-tester, fixture options.json (and options.js) files must return a standard set of options. Non-standard properties are silently ignored. For instance: to pass options to the plugin under test, they must be provided via pluginOptions.

  • Global describe and it functions must be defined

    Babel-plugin-tester will refuse to run if describe, it, it.only, or it.skip are not globally available.

  • Global setup/teardown no longer overwrites local versions

    In previous versions of babel-plugin-tester, test-level setup and teardown functions overrode global setup and teardown functions. In this version of babel-plugin-tester, the global setup and teardown functions will be called alongside their test-level counterparts for each test and in a well-defined order (see documentation).

  • Implicit "global" options merging is no longer supported

    In previous versions of babel-plugin-tester, any test object and fixture configuration option could be passed directly to babel-plugin-tester and apply "globally" across all test objects and fixtures. This was even the case for options that made no sense in a "global" context, such as only, skip, and code. In this version of babel-plugin-tester, only options explicitly listed in the documentation can be passed directly and applied globally. Unrecognized "rest" options are silently ignored.

  • Test/fixture configuration is resolved early and consistently

    In previous versions of babel-plugin-tester, test object and fixture configuration options were resolved in various places, with some options getting finalized before it(...) and describe(...) were called and others being determined as Jest was executing the test. In this version, all configuration options are resolved and finalized before it(...) and describe(...) are called. This also means configurations are finalized _before_ hooks like beforeAll get called by the testing framework.

  • babelOptions.filename is now set to filepath by default rather than undefined.

  • In previous versions, the lodash.mergeWith customizer skipped source properties that resolved to undefined. With this version, the customizer now unsets these properties (sets them to undefined), allowing the end user to easily unset defaults (e.g. filename).

  • Minimum recommended node version bumped from 10.13.0 to 14.20.0

  • Plugin names are once again automatically determined by analyzing the return value of the plugin function. Though this is implemented in a backwards-compatible way, there is a [small caveat](https://github.com/babel-utils/babel-plugin-tester#pluginname-inference-caveat).

✨ Features

  • Add support for testing presets (73b90b3)
  • Implement default filepath inference using Error stack trace (9d1b321)
  • src: add exec/execFixture support via Node's VM module (4754f42)
  • src: add support for "only", "skip", and "title" test options in fixtures (#90) (89b58b5)
  • src: add support for arbitrary run order of plugin under test (#91) (8c8b858)
  • src: add support for loading prettier configuration files in fixtures (f54deda)
  • src: add TEST_SKIP/TEST_NUM_SKIP/TEST_ONLY/TEST_NUM_ONLY env variable support (13626d1)
  • src: bring back (lightweight) plugin name inference (#92) (f9ad903)
  • src: implement titleNumbering and restartTitleNumbering options (09e792d)
  • src: implement standard setup/teardown run order (4ea283f)
  • src: provide debug output support via debug package (4c7c6e7)
  • Windows support (f214995)

🪄 Fixes

  • src: ensure test function errors are not swallowed by teardown function errors (2acfe37)
  • src: fix fixtureOutputExt being ignored in root options.json (#89) (481be19)
  • src: fix plugin run order for fixtures to match tests (#88) (fbb6c19)

⚙️ Build System

  • deps: bump prettier from 2.8.0 to 2.8.1 (#98) (0bdb351)
  • package: restore @babel/core@7.11.6 as minimum supported version (00712c0)
  • Transmute codebase to TypeScript (#96) (5f588e9)
  • Update tooling (d5b4d9c)

🧙🏿 Refactored

  • Lodash.mergeWith customizer now allows unsetting options by setting them to undefined (74af680)
  • Reorganize source into unified extensible tester pipeline w/ first-class fixtures support (0c44392)

🏗️ Patch babel-plugin-tester@11.0.4 (2023-01-25)

🪄 Fixes

  • Ensure exec realm has access to context-sensitive versions of __filename and __dirname globals (0306698)

🏗️ Patch babel-plugin-tester@11.0.3 (2023-01-24)

🪄 Fixes

  • Pass full file path to prettier::resolveConfig, not just the dirname (e9ebcdd)

🏗️ Patch babel-plugin-tester@11.0.2 (2023-01-23)

🪄 Fixes

  • src: use cross-realm symbols (330aa1e)
  • Use node-util import compatible with node@14 (2c4cd84)

⚙️ Build System

  • babel: explicitly include polyfills for shipped proposals (850d58c)

🏗️ Patch babel-plugin-tester@11.0.1 (2023-01-18)

🪄 Fixes

  • src: ensure deprecated config option is still supported by prettierFormatter (e48badf) see #139

babel-plugin-tester@10.1.0 (2021-05-29)

✨ Features

  • Use babel.transformAsync when it's available (#84) (969be11)

babel-plugin-tester@10.0.0 (2020-10-02)

💥 BREAKING CHANGES 💥

  • Plugin name inference is no longer supported

🪄 Fixes

  • pluginnameinference: remove the inference. Default to "unknown plugin" (#78) (91c22ec) see #60

babel-plugin-tester@9.2.0 (2020-05-27)

✨ Features

  • Add 'fixtureOutputExt' configuration option (#73) (ae67eee)

babel-plugin-tester@9.1.0 (2020-05-20)

✨ Features


babel-plugin-tester@9.0.0 (2020-03-23)

💥 BREAKING CHANGES 💥

  • Requires Node >= 10.13.0

🪄 Fixes

  • node: update to prettier@2 and drop Node < 10.13 (#66) (1e7ad06)

🏗️ Patch babel-plugin-tester@9.0.1 (2020-04-10)

🪄 Fixes

  • Apply fix line endings to code and output in two spots (#68) (f1c17ef)

babel-plugin-tester@8.0.0 (2019-11-15)

💥 BREAKING CHANGES 💥

  • Your snapshots will probably need to be updated with these changes. If you don't like the changes, then take a look at the README about overriding the formatResult and disabling the un-string snapshot serializer

✨ Features

  • Format result with prettier and unstring snapshots (#55) (60e5c07)

🏗️ Patch babel-plugin-tester@8.0.1 (2019-12-01)

🪄 Fixes

  • Avoid crash when importing without global expect (#56) (a134785)

babel-plugin-tester@7.0.0 (2019-08-19)

💥 BREAKING CHANGES 💥

  • Require Node 8

✨ Features


🏗️ Patch babel-plugin-tester@7.0.4 (2019-11-14)

🪄 Fixes

  • Set configFile to false by default (7b97a6f)

🏗️ Patch babel-plugin-tester@7.0.3 (2019-11-11)

🪄 Fixes


🏗️ Patch babel-plugin-tester@7.0.2 (2019-11-09)

🪄 Fixes


🏗️ Patch babel-plugin-tester@7.0.1 (2019-08-19)

🪄 Fixes


babel-plugin-tester@6.5.0 (2019-08-18)

✨ Features


babel-plugin-tester@6.4.0 (2019-06-12)

✨ Features

  • Control which linefeed character to use (#45) (8c38231)

babel-plugin-tester@6.3.0 (2019-06-12)

✨ Features


🏗️ Patch babel-plugin-tester@6.3.1 (2019-06-12)

🪄 Fixes


babel-plugin-tester@6.2.0 (2019-05-12)

✨ Features

  • fixtures: get plugin options for fixtures from options.json (#41) (7b9e76d)

🏗️ Patch babel-plugin-tester@6.2.1 (2019-05-12)

🪄 Fixes

  • fixtures: get options from root options.json (#42) (556ca0d)

babel-plugin-tester@6.1.0 (2019-05-04)

✨ Features

  • fixtures: allow formatting fixtures results (#39) (e6c219f)

babel-plugin-tester@6.0.0 (2019-02-14)

💥 BREAKING CHANGES 💥

  • This upgrades to babel 7. You'll need to use babel 7 as well.

✨ Features


🏗️ Patch babel-plugin-tester@6.0.1 (2019-03-14)

🪄 Fixes

  • Avoid returning values in describe blocks (#38) (f3d7b5b)

babel-plugin-tester@5.5.0 (2018-08-05)

✨ Features

  • Add typescript file extension support (#32) (c8e49be)

🏗️ Patch babel-plugin-tester@5.5.2 (2018-11-17)

🪄 Fixes


🏗️ Patch babel-plugin-tester@5.5.1 (2018-08-17)

🪄 Fixes

  • Change babel-core import to optional require in default param (#33) (2b33b36)

babel-plugin-tester@5.4.0 (2018-06-10)

✨ Features


babel-plugin-tester@5.3.0 (2018-06-04)

✨ Features

  • Create automatically fixtures output.js files for new tests (#27) (d48a8fc)

babel-plugin-tester@5.2.0 (2018-06-04)

✨ Features

  • Accept fixtureOutputName option for fixtures mode (#26) (f3e1ad2)

babel-plugin-tester@5.1.0 (2018-06-02)

✨ Features

  • Provide your own implementation of babel (#25) (cb230ec)

babel-plugin-tester@5.0.0 (2017-11-25)

💥 BREAKING CHANGES 💥

  • You'll have to install babel-core yourself now.

🪄 Fixes

  • Move babel-core to peerDependencies & devDependencies (#20) (46c70d1)

babel-plugin-tester@4.0.0 (2017-08-16)

💥 BREAKING CHANGES 💥

  • Your snapshots will break (for the better). Just update them. Nothing else changed.

✨ Features

  • test-numbers: only use numbers for tests without titles (#19) (6cd36d1)

babel-plugin-tester@3.3.0 (2017-07-18)

✨ Features

  • formatresult: add formatResult option (#17) (6085c16)

babel-plugin-tester@3.2.0 (2017-06-30)

✨ Features

  • tests: add setup/teardown functions (#14) (9b30ca3)

🏗️ Patch babel-plugin-tester@3.2.2 (2017-07-06)

🪄 Fixes


🏗️ Patch babel-plugin-tester@3.2.1 (2017-07-05)

🪄 Fixes

  • Assert should be (actual, expected) (9fcb418)

babel-plugin-tester@3.1.0 (2017-06-12)

✨ Features

  • Add ability to pass plugin options (#13) (d7aa18a)

babel-plugin-tester@3.0.0 (2017-05-23)

💥 BREAKING CHANGES 💥

  • Default parser options changed to remove recast

🪄 Fixes

  • release: manually release a major version (c78460b) see #11

babel-plugin-tester@2.0.0 (2017-05-19)

💥 BREAKING CHANGES 💥

  • fixtures has been repurposed. See the docs.

  • modifier has been removed, use only and skip instead

✨ Features

  • errors: add errors config (#5) (c157316)
  • fixtures: add fixtures directory (#6) (6e1554d)
  • tests: add only and skip, remove modifier (#7) (ad1d1b1)

babel-plugin-tester@1.1.0 (2017-05-16)

✨ Features


🏗️ Patch babel-plugin-tester@1.1.1 (2017-05-16)

🪄 Fixes

  • Properly deindent and trim code and output (eb60549)

babel-plugin-tester@1.0.0 (2017-05-16)

✨ Features