From edb8e6b76b64bfafbc198fba6ab83f42b6efda35 Mon Sep 17 00:00:00 2001 From: bcoe Date: Wed, 20 May 2020 20:29:48 -0700 Subject: [PATCH] docs: address review --- docs/index.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/index.md b/docs/index.md index b6ab1b4cdd..44d61519d2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -36,10 +36,10 @@ Mocha is a feature-rich JavaScript test framework running on [Node.js][] and in - [auto-exit to prevent "hanging" with an active loop](#-exit) - [easily meta-generate suites](#markdown) & [test-cases](#list) - [config file support](#-config-path) -- [source-map support](#--enable-source-maps) - clickable suite titles to filter test execution - [node debugger support](#-inspect-inspect-brk-inspect) - [node native ES modules support](#nodejs-native-esm-support) +- [source-map support](#-enable-source-maps) - [detects multiple calls to `done()`](#detects-multiple-calls-to-done) - [use any assertion library you want](#assertions) - [extensible reporting, bundled with 9+ reporters](#reporters) @@ -964,19 +964,6 @@ Specify an explicit path to a [`package.json` file](#configuring-mocha-nodejs) ( By default, Mocha looks for a `package.json` in the current working directory or nearest ancestor, and will use the first file found (regardless of whether it contains a `mocha` property); to suppress `package.json` lookup, use `--no-package`. -### `--enable-source-maps` - -> _New in Node.js v12.12.0_ - -If the [`--enable-source-maps`](https://nodejs.org/dist/latest-v12.x/docs/api/cli.html#cli_enable_source_maps) flag -is passed to mocha, source maps will be collected and used to provide accurate stack traces for transpiled code: - -```bash -Error: cool - at Object. (/Users/fake-user/bigco/nodejs-tasks/build/src/index.js:27:7) - -> /Users/fake-user/bigco/nodejs-tasks/src/index.ts:24:7 -``` - ### `--extension ` Files having this extension will be considered test files. Defaults to `js`. @@ -1128,6 +1115,19 @@ These flags vary depending on your version of Node.js. `node` flags can be defined in Mocha's [configuration](#configuring-mocha-nodejs). +### `--enable-source-maps` + +> _New in Node.js v12.12.0_ + +If the [`--enable-source-maps`](https://nodejs.org/dist/latest-v12.x/docs/api/cli.html#cli_enable_source_maps) flag +is passed to mocha, source maps will be collected and used to provide accurate stack traces for transpiled code: + +```bash +Error: cool + at Object. (/Users/fake-user/bigco/nodejs-tasks/build/src/index.js:27:7) + -> /Users/fake-user/bigco/nodejs-tasks/src/index.ts:24:7 +``` + ### About V8 Flags Prepend `--v8-` to any flag listed in the output of `node --v8-options` (excluding `--v8-options` itself) to use it.