Use test/tsconfig.json with ts-node for testing.
This register library load tsconfig.json file by following priority.
project/{test}/tsconfig.test.jsonproject/{test}/tsconfig.jsonproject/tsconfig.test.jsonproject/tsconfig.json
{test} is test directory by default.
You can specified the {test} by directories of package.json.
"directories": {
"test": "test"
},
Notes: Why need to load different tsconfig.json between main and test?
In some times, we use different tsconfig.json between main code and test code.
For example, you can enable allowJs in test code.
It supports gradual migration that convert JavaScript to TypeScript.
ts-node(v4) disable type-check by default.
The motivation is based on so not good experience.
- Type error reporting · Issue #79 · kulshekhar/ts-jest
- test(textlint-formatter):
mocharuns fine whiletsccannot compile the script · Issue #448 · textlint/textlint
This register library supports Mike Haas's opinion.
test code is still code, if there's type errors in such test code, shouldn't it fail? -- kulshekhar/ts-jest#79 (comment)
Install with npm:
npm install ts-node ts-node-test-register --save-dev
You need to install ts-node.
Using with mocha.
mocha --require ts-node-test-register "test/**/*.ts"
Or define --require ts-node-test-register to .mocharc.{js,json,yml}.
├── package.json
├── .mocharc.json (--require ts-node-test-register)
├── src
│ └── index.ts
└── test
├── tsconfig.json // <= load this tsconfig.json
└── index-test.ts
For more details, see example.
See Releases page.
Install devDependencies and Run yarn test:
yarn test
yarn run test:example
Pull requests and stars are always welcome.
For bugs and feature requests, please create an issue.
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request :D
MIT © azu