Typescript Expect Plugin
Be lazy, write simple tests in comments.
Editor support
✅ VS Code - flawlessly works in Problems panel.
⏹ Sublime Text - could not get it to work but it might be possible.
❔ Atom - not tested.
⛔ tsc - plugins are disabled during build. It should work with webpack ts loader.
Quick start
npm install typescript-expect-plugin
- Add plugin to
tsconfig.json:
{
"compilerOptions": {
"plugins": [{ "name": "typescript-expect-plugin" }]
},
}
- Change VS Code typescript to workspace version:

Usage
WARNING
⚠Tests are executed after each file change - not save. Be careful if you're going to test functions that remove or change files in your local system
This plugin adds support for @expect JSDoc tag. It has the following usage pattern:
/**
* @expect [PARAMS] CONDITION CONDITION_PARAMETER
*/
[PARAMS] - for example [2, 4] will spread two arguments to tested function.
CONDITION - check function from jest expect library. Use ctrl+space to see autocomplete suggestions.
CONDITION_PARAMETER - argument passed to CONDITION function.
Examples
/**
* @expect [2, 4] toBe 6
* @expect [2, 2] toBeGreaterThan 3
* @expect [2, 2] toBeLessThan 3
* @expect [2, 22] toEqual 24
*/
export function sum(a: number, b: number) {
return a + b;
}
/**
* @expect [[2, 4, 8], 4] toBeTruthy
* @expect [[2, 4, 8], 12] toBeFalsy
*/
export function has(haystack: any[], needle: any) {
return haystack.includes(needle);
}
Test objects

Test arrays

Author
Hey there, I'm Kasper. If you wish to get notified about more cool typescript or react projects/tips you can follow me on twitter.