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

Add reporter alias names to docs #4127

Merged
merged 5 commits into from
Jan 3, 2020
Merged

Conversation

khg0712
Copy link
Contributor

@khg0712 khg0712 commented Dec 14, 2019

Description

  • Reporter part of Mocha docs was so unkind about enable reporter name.
    • there are two enable names but current docs makes users confused.

Description of the Change

  • Add enable names to docs clearly
  • Unite reporter name to call a reporter type

Summary

before
The "progress" reporter implements a simple progress-bar:

after
Enable Names: Progress, progress
The Progress reporter implements a simple progress-bar:

fix #4054
fix #4134

@jsf-clabot
Copy link

jsf-clabot commented Dec 14, 2019

CLA assistant check
All committers have signed the CLA.

@coveralls
Copy link

coveralls commented Dec 14, 2019

Coverage Status

Coverage increased (+0.07%) to 92.881% when pulling 78b7c85 on khg0712:issue/4054 into 3bd2d28 on mochajs:master.

@outsideris
Copy link
Contributor

@khg0712 Your email for git commit is not connected your GitHub account.

@khg0712
Copy link
Contributor Author

khg0712 commented Dec 14, 2019

@outsideris I changed it!

@outsideris outsideris added the area: documentation anything involving docs or mochajs.org label Dec 14, 2019
Copy link
Contributor

@juergba juergba left a comment

Choose a reason for hiding this comment

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

@khg0712 thank you for this PR. I have some small comments.

docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
Copy link
Contributor

@juergba juergba left a comment

Choose a reason for hiding this comment

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

I guess something went wrong while resolving conflicts.
I propose:

  • delete your last commits git reset ...
  • to keep up with master, don't merge but rebase git rebase ...
  • then apply your changes and be careful when resolving conflicts.

docs/index.md Outdated Show resolved Hide resolved
@khg0712
Copy link
Contributor Author

khg0712 commented Dec 29, 2019

@juergba
I want to add alias to mocha --reporters

스크린샷 2019-12-29 오후 6 03 00

I dig down to solve this problem. I encountered this code. showKeys function prevent showing capitalized word. how about modify reporter's showKeys logic?

@juergba
Copy link
Contributor

juergba commented Dec 29, 2019

I dig down to solve this problem.

I don't see any problem, IMO this list is perfect as it is.

@khg0712
Copy link
Contributor Author

khg0712 commented Dec 29, 2019

I don't see any problem, IMO this list is perfect as it is.

doesn't it needs to specify all alias like HTML, html?

@juergba
Copy link
Contributor

juergba commented Dec 30, 2019

No, HTML is the default reporter for Mocha browser and should not show up in this CLI listing.

@khg0712
Copy link
Contributor Author

khg0712 commented Dec 31, 2019

sry, I cited wrong example.

@juergba
I want to add alias to mocha --reporters

스크린샷 2019-12-29 오후 6 03 00

I meant that it seems to need to be added capitalized alias to cli options.
ex) Nyan, nyan - "nyan cat"

@juergba
Copy link
Contributor

juergba commented Jan 2, 2020

I have understood your concerns, but this listing is good as is, please leave it unchanged.

Copy link
Contributor

@juergba juergba left a comment

Choose a reason for hiding this comment

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

@khg0712 thank you

@juergba juergba merged commit 35cf39b into mochajs:master Jan 3, 2020
@juergba juergba changed the title Add reporter names enable and Unite names into one Add reporter alias names to docs Jan 3, 2020
@juergba juergba added this to the v7.0.0 milestone 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

Successfully merging this pull request may close these issues.

Mocha docs has wrong third-party example link (documentation) Inconsistent formatting of reporter names
5 participants