Skip to content

Commit 90819cd

Browse files
committed
docs(readme): add bpt 11 vs 12 concerns to install section; update usage section
1 parent e4378b8 commit 90819cd

1 file changed

Lines changed: 52 additions & 2 deletions

File tree

README.md

Lines changed: 52 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ This package is tested on both Windows and nix (Ubuntu) environments.
4949
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
5050

5151
- [Install](#install)
52+
- [`babel-plugin-tester@11`](#babel-plugin-tester11)
53+
- [`babel-plugin-tester@12`](#babel-plugin-tester12)
5254
- [Usage](#usage)
5355
- [Import](#import)
5456
- [Invoke](#invoke)
@@ -87,15 +89,63 @@ This package is tested on both Windows and nix (Ubuntu) environments.
8789

8890
<!-- symbiote-template-region-end -->
8991

90-
This module is distributed via [npm][npm] which is bundled with [node][node] and
91-
should be installed as one of your project's `devDependencies`:
92+
Currently, babel-plugin-tester comes in two flavors:
93+
94+
### `babel-plugin-tester@11`
9295

9396
```shell
9497
npm install --save-dev babel-plugin-tester
98+
# Alternatively:
99+
#npm install --save-dev babel-plugin-tester@11
100+
```
101+
102+
This version of babel-plugin-tester:
103+
104+
- Has a minimum Node version of `18.19.0`.
105+
106+
- Optionally works with `jest@<=29` (as an optional peer dependency).
107+
108+
- Works with `prettier@2` (as a dependency).
109+
110+
### `babel-plugin-tester@12`
111+
112+
```shell
113+
npm install --save-dev babel-plugin-tester@12.0.0-canary.2
114+
# May require --force in some situations:
115+
#npm install --save-dev babel-plugin-tester@12.0.0-canary.2 jest-extended
116+
#npm install --save-dev --force jest@30.0.0-alpha.6
95117
```
96118

119+
> [!TIP]
120+
>
121+
> Check [the registry][1] for the latest canary version number.
122+
123+
This version of babel-plugin-tester:
124+
125+
- Technically has a minimum Node version of `20.18.0`, but likely works with
126+
`node@18`.
127+
128+
- Optionally works with `jest@>=30` (as an optional peer dependency).
129+
130+
> [!CAUTION]
131+
>
132+
> You may need `--force` (i.e. `npm install ... --force`) if your project
133+
> depends on Jest ecosystem packages that don't yet recognize `jest@>=30`,
134+
> such as `jest-extended@<=4.0.2`.
135+
136+
- Works with `prettier@3` (as a dependency).
137+
138+
- Is stable and fully tested (despite the "canary" and "prerelease" monikers)
139+
but cannot be released until `jest@30` is released.
140+
97141
## Usage
98142

143+
To use babel-plugin-tester:
144+
145+
1. Import babel-plugin-tester into your test file.
146+
2. Invoke `pluginTester` in your test file.
147+
3. Execute your test file.
148+
99149
### Import
100150

101151
ESM:

0 commit comments

Comments
 (0)