Skip to content

JSON Stream documentation #4027

@Lindsay-Needs-Sleep

Description

@Lindsay-Needs-Sleep

Prerequisites

  • Checked that your issue hasn't already been filed by cross-referencing issues with the faq label
  • Checked next-gen ES issues and syntax problems by using the same environment and/or transpiler configuration without Mocha to ensure it isn't just a feature that actually isn't supported in the environment in question or a bug in your code.
  • 'Smoke tested' the code to be tested by running it outside the real test suite to get a better sense of whether the problem is in the code under test, your usage of Mocha, or Mocha itself
  • Ensured that there is no discrepancy between the locally and globally installed versions of Mocha. You can find them with: node node_modules/.bin/mocha --version(Local) and mocha --version(Global). We recommend that you not install Mocha globally.

Description

While working on pull request #4026 I noticed that the JSON Stream documentation hints that you should use
"JSON stream"
as the name for the JSON Stream reporter.

But, browser mocha will only accept
"json-stream"
or
"JSONStream".
See lib/reporters/index.js:19

Is this a typo in the documentation, or is this an inconsistency between browser mocha and node mocha? (eg. node mocha actually accepts "JSON stream"?)

Steps to Reproduce

Expected behavior: documentation reflects usage correctly

Actual behavior: documentation indicates incorrect name for browser mocha (node mocha as well?)

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: documentationanything involving docs or mochajs.org

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions