typings-tester
v0.3.2
Published
TypeScript definition testing library
Downloads
45,235
Maintainers
Readme
Typings Tester
A library aimed to aid testing of TypeScript definitions. Checks TypeScript files for syntactic, expected and unexpected semantic (type) errors.
Installation
$ npm install -D typings-tester
Any version of TypeScript must be installed separately.
CLI Usage
$ typings-tester --config path/to/tsconfig.json **/*.ts
$ typings-tester --dir path/to/directory
API Usage
import test from "tape";
import {check, checkDirectory} from "typings-tester";
test('typings', assert => {
assert.doesNotThrow(() => check(['test.ts'], 'tsconfig.json'));
assert.doesNotThrow(() => checkDirectory('src'));
});
Flags
typings:expect-error
: expect next line or block to contain semantic error.typings-tester
will fail if no error is produced.
// typings:expect-error
function shouldFail(a: number): string {
return a;
}
What's next
- Testing against multiple versions of TypeScript
- Inferred type assertions