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

Improve CLI help #6783

Merged
merged 2 commits into from Apr 15, 2023
Merged

Improve CLI help #6783

merged 2 commits into from Apr 15, 2023

Conversation

ybiquitous
Copy link
Member

@ybiquitous ybiquitous commented Apr 13, 2023

Which issue, if any, is this issue related to?

None.

Is there anything in the PR that needs further explanation?

Changes summary:

  • Unify wording and format in the help.
  • Simplify flag descriptions.
  • Add missing flags.
  • Refactor type annotations.

For the help format, I referred to the git log manual.

Screenshot

Note: using bat for coloring.

bin/stylelint.js --help | bat --no-pager -l cmd-help --style=plain
image

- Unify wording and format in the help.
- Simplify flag descriptions.
- Add missing flags.
- Refactor type annotations.
@changeset-bot
Copy link

changeset-bot bot commented Apr 13, 2023

🦋 Changeset detected

Latest commit: d27ea14

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
stylelint Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@ybiquitous ybiquitous marked this pull request as ready for review April 13, 2023 19:04
Copy link
Member

@mattxwang mattxwang left a comment

Choose a reason for hiding this comment

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

Overall this is great -- especially the clarity on the argument provided to each option, which should help with usability!

I only have one minor question, but that can be deferred until later and/or could be bikeshedding.

Copy link
Member

@mattxwang mattxwang left a comment

Choose a reason for hiding this comment

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

I think this is great, nice work! LGTM.

@ybiquitous ybiquitous merged commit 9552c84 into main Apr 15, 2023
14 checks passed
@ybiquitous ybiquitous deleted the improve-cli-help branch April 15, 2023 22:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants