Skip to content

Latest commit

 

History

History
43 lines (29 loc) · 3.08 KB

README.md

File metadata and controls

43 lines (29 loc) · 3.08 KB
Raw

Mocha test runner

Creates code lens before each describe, it, suite and test function call in test files.

Lense on it and test function shows last test result and can be used to run given test (using mocha --grep pattern - tests titles needs to be unique otherwise more than one test will be executed).

Lense on describe and suite shows aggregated results from nested it and test and can be used to run all tests in given group / only test with specific status.

To run tests that need to be transpiled (es6 with imports, typescript, ..) are supported using one of the two following methods:

To ensure Mocha test runner works property don't forget to set the mocha.nodeExec variable in your settings. You must provide an absolute path.

Map a source directory to a build directory

This method is useful if you want to provide your own transpile command, and want to map the resulting build directory to your source directory. see example projects in .vscode-test directory. Mocha is searching for transpiled scripts **/*.test.js (configurable - mocha.glob) in project root directory or in mocha.sourceDir (appended to project root directory - used in tandem with mocha.outputDir for non es5 sources - see examples).

Automatically transpile them

If you want to automatically run a transpiler on your source, using the equivalent of the --require mocha parameter, set the mocha.requires variable in your project settings.

For example you can use the following:

  • babel: mocha.requires: ['babel-register']
  • typescript: mocha.requires: ['ts-node/register']
  • coffeescript: mocha.requires: ['coffee-script/register']

Preview:

preview

Examples:

  • es5 project: basic usage - no config or transpiling, just plain old javascript
  • es6 project: tests uses es6 import command - is transpiled to es5 with babel, this configuration can handle jsx syntax - react.js needs to be included via mocha.files.setup)
  • typescript project tests writen in typescript - transpiled to es6 without use of import command by tsc, this configuration can handle tsx syntax - react.js needs to be included via mocha.files.setup
  • typescript+react project test writen in tsx syntax, tests transpiled with tsc - CURRENTLY BROKEN no need explicitly import react.js for test to work
  • electron+nightmare test using nightmare - NOT WORKING ... still trying to figure out why ... (if anyone crack it please send me how)
  • other project types: gulp, grunt-based transpiling, etc. may work too (not tested)
  • I welcome any other usage examples ...

Known issues:

  • (Wont fix) Tests not wrapped by describe function are ignored. (mocha is not returning file path for these - no way to unique identify tests with same title in different files)
  • Debugger won't see breakpoints in ts file when compiled with webpack (source maps issue)