Skip to content
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

Clarify use #24

Merged
merged 4 commits into from
May 2, 2020
+2 −2
Merged

Clarify use #24

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
84f53eb
README: pointing out that ES modules aren't supported yet
adam-lynch Apr 23, 2020
beba4a5
Point out that tests are precompiled instead
adam-lynch May 2, 2020
983ef8b
Improve description of how this package makes AVA behave
novemberborn May 2, 2020
486a522
paths
novemberborn May 2, 2020
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
Prev Previous commit
Next Next commit
Improve description of how this package makes AVA behave
@novemberborn
novemberborn committed May 2, 2020
commit 983ef8bc48c0c73acfcdec950254e01d5d70a9b3
4 changes: 2 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -2,9 +2,9 @@

Adds rudimentary [TypeScript](https://www.typescriptlang.org/) support to [AVA](https://avajs.dev).

This is designed to work for projects that precompile TypeScript (including tests). It allows AVA to load the compiled JavaScript, while configuring AVA to treat the TypeScript files as test files.
This is designed to work for projects that precompile their TypeScript code, including tests. It allows AVA to load the resulting JavaScript, while configuring AVA to use the TypeScript files.

In other words, say you have a test file at `src/test.ts`. You've configured TypeScript to output to `build/`. Using `@ava/typescript` you can run the test using `npx ava src/test.ts`.
In other words, say you have a test file at `src/test.ts`. You've configured TypeScript to output to `build/`. Using `@ava/typescript` you can run the `build/test.js` file using `npx ava src/test.ts`. AVA won't pick up any of the JavaScript files present in the `build/` directory, unless they have a TypeScript counterpart in `src/`.

## Enabling TypeScript support