Skip to content

Enhance transpiling.md with tsx setup details #2642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Enhance transpiling.md with tsx setup details #2642

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/transpiling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ For compiling TypeScript on the fly, you should install [ts-node](https://github
npm install --save-dev ts-node
```

> For an easier setup, one could use [tsx](https://github.com/privatenumber/tsx), and its `tsx/cjs` for commonjs transpilation or `tsx/esm` for esm transpilation. `tsx` bypasses typechecking and hence is not only faster, but also does not require a `tsconfig.json` to be setup.
> An example test script where step definitions are written in typescript would look like so:
>
> `"test": "cucumber-js --require-module tsx/cjs --require 'features/**/*.ts'"`

## Module format

The first thing you need to establish is the JavaScript module format you are compiling to. It'll be either of:
Expand Down
Loading