quine-global/ava
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update TypeScript recipe to suggest --import flag and tsimp

Browse source
This commit is contained in:
Tommy 2024-01-28 13:46:46 -06:00 committed by GitHub
parent aae39b20ba
commit 735bf4172a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 11 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
docs/recipes/typescript.md
View file

@ -17,12 +17,21 @@ Broadly speaking, there are two ways to run tests written in TypeScript:
**You can use loaders, but you're largely on your own. [Please post questions to our Discussions forum if you're stuck](https://github.com/avajs/ava/discussions/categories/q-a).**
> [!NOTE]
> Custom loaders changed with the release of Node.js 20. This recipe assumes your Node.js version is equal to or higher than the following. For older versions, please see a [previous commit](https://github.com/avajs/ava/blob/aae39b20ba3ef80e5bedb1e5882432a3cd7c44eb/docs/recipes/typescript.md).
>
> | Node.js Major Version | Minimum Version |
> | --------------------- | --------------- |
> | 18 | 18.18.0 |
> | 20 | 20.8.0 |
> | 21 | 21.0.0 |
There are two components to a setup like this:
1. [Make sure AVA recognizes the extensions of your TypeScript files](../06-configuration.md#configuring-module-formats)
2. Install the loader [through `nodeArguments`](../06-configuration.md#node-arguments)
[`tsx`](https://github.com/esbuild-kit/tsx) may be the best loader available. The setup, assuming your TypeScript config outputs ES modules, would look like this:
[`tsimp`](https://github.com/tapjs/tsimp) may be the best loader available. The setup, assuming your TypeScript config outputs ES modules, would look like this:
`package.json`:
@ -32,41 +41,10 @@ There are two components to a setup like this:
"ts": "module"
},
"nodeArguments": [
"--loader=tsx"
"--import=tsimp"
]
}
```
### When using custom loaders
#### Mocking
Mocking with `tsx` (such as with [`esmock`](https://github.com/iambumblehead/esmock)) isn't currently possible (https://github.com/esbuild-kit/tsx/issues/264). [`ts-node`](https://github.com/TypeStrong/ts-node) can be used instead:
`package.json`:
```json
"ava": {
"extensions": {
"ts": "module"
},
"nodeArguments": [
"--loader=ts-node/esm",
"--loader=esmock"
]
}
```
#### Node.js 20
In Node.js 20, custom loaders must be specified via the `NODE_OPTIONS` environment variable:
`package.json`:
```json
"scripts": {
"test": "NODE_OPTIONS='--loader=tsx' ava"
}
```
## Writing tests