Skip to content

Documented some cli options - #3447

Closed
aikin wants to merge 5 commits into
mochajs:masterfrom
aikin:patch-1
Closed

Documented some cli options#3447
aikin wants to merge 5 commits into
mochajs:masterfrom
aikin:patch-1

Conversation

@aikin

@aikin aikin commented Aug 3, 2018

Copy link
Copy Markdown

Requirements

  • Filling out the template is required. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
  • All new code requires tests to ensure against regressions.

Description of the Change

Some options didn't show description after execution mocha --help, like --max-old-space-size, --experimental-modules, --gc-global, --allow-natives-syntax .

so these commits documented --max-old-space-size, --experimental-modules, --gc-global, --allow-natives-syntax cli options to _mocha file and doc index.md file.

Alternate Designs

Do Noting.

Why should this be in core?

Maybe not.

Benefits

Show command options help.

Possible Drawbacks

I'm not sure.

Applicable issues

Can't not find.

@jsf-clabot

jsf-clabot commented Aug 3, 2018 •
edited
Loading

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@coveralls

coveralls commented Aug 3, 2018 •
edited
Loading

Copy link
Copy Markdown

Coverage Status

Coverage increased (+0.1%) to 90.388% when pulling d4beb9d on aikin:patch-1 into f745651 on mochajs:master.

outsideris
outsideris approved these changes Aug 4, 2018
View reviewed changes

@outsideris outsideris left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@outsideris outsideris added the area: documentation anything involving docs or mochajs.org label Aug 4, 2018
plroebuck
plroebuck reviewed Aug 30, 2018
View reviewed changes
Comment thread bin/_mocha Outdated
@plroebuck

plroebuck commented Aug 30, 2018 •
edited
Loading

Copy link
Copy Markdown
Contributor

Curious since we're documenting them. When I run node --help (v10.3.0), I see
--experimental-modules. Are the other three you added only present in some newer/older version of Node?

plroebuck
plroebuck suggested changes Aug 30, 2018
View reviewed changes

@plroebuck plroebuck left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Notice all the other options were in alphabetical order? Think these should be as well. Pedantic, I know...

@plroebuck

plroebuck commented Sep 3, 2018 •
edited
Loading

Copy link
Copy Markdown
Contributor

Separate discussion on Node cmdline options from another PR.

@aikin

aikin commented Sep 3, 2018

Copy link
Copy Markdown
Author

@plroebuck

The other three options are v8 config. you can run node --v8-options to get result.

plroebuck
plroebuck reviewed Sep 5, 2018
View reviewed changes
Comment thread docs/index.md Outdated
@plroebuck

plroebuck commented Sep 5, 2018

Copy link
Copy Markdown
Contributor

Perusing PR #3423, @boneskull mentions "Mocha never had an exhaustive list of hardcoded flags." here. Unsure of his go-forward plans (now that nodejs/node#19335 has been merged), but predict some related cleanup on Mocha's Node cmd-line option processing.

@plroebuck
plroebuck requested a review from boneskull November 2, 2018 23:48
@plroebuck plroebuck added the status: needs review a maintainer should (re-)review this pull request label Nov 2, 2018
@boneskull

boneskull commented Nov 5, 2018

Copy link
Copy Markdown
Member

Mocha doesn't support --experimental-modules if the user is running Node.js v6.
😄

Thanks, but I think I'd rather go in the direction of documenting Mocha-specific CLI options, then displaying something like "all flags for node are also supported".

@boneskull boneskull closed this Nov 5, 2018
@aikin

aikin commented Nov 6, 2018

Copy link
Copy Markdown
Author

That was cool.

@plroebuck plroebuck added status: wontfix typically a feature which won't be added, or a "bug" which is actually intended behavior and removed status: needs review a maintainer should (re-)review this pull request labels Nov 9, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@boneskull boneskull Awaiting requested review from boneskull
2 more reviewers
@plroebuck plroebuck plroebuck requested changes
@outsideris outsideris outsideris approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

area: documentation anything involving docs or mochajs.org status: wontfix typically a feature which won't be added, or a "bug" which is actually intended behavior

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@aikin @jsf-clabot @coveralls @plroebuck @boneskull @outsideris