Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

JSON Stream documentation #4027

Closed
4 tasks done
Lindsay-Needs-Sleep opened this issue Sep 24, 2019 · 2 comments
Closed
4 tasks done

JSON Stream documentation #4027

Lindsay-Needs-Sleep opened this issue Sep 24, 2019 · 2 comments
Labels
area: documentation anything involving docs or mochajs.org

Comments

@Lindsay-Needs-Sleep
Copy link
Contributor

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?)

@outsideris outsideris added type: bug a defect, confirmed by a maintainer area: documentation anything involving docs or mochajs.org good first issue new contributors should look here! and removed unconfirmed-bug labels Sep 30, 2019
@outsideris
Copy link
Contributor

You are right. It is typo.
mocha only accept json-stream or JSONStream.

@juergba
Copy link
Contributor

juergba commented Jan 3, 2020

fixed by #4127

@juergba juergba closed this as completed Jan 3, 2020
@juergba juergba removed type: bug a defect, confirmed by a maintainer good first issue new contributors should look here! labels Jan 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation anything involving docs or mochajs.org
Projects
None yet
Development

No branches or pull requests

3 participants