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

[feature] improve readability of argument value #546

Closed
HerringtonDarkholme opened this issue Jul 24, 2023 · 0 comments · Fixed by #560
Closed

[feature] improve readability of argument value #546

HerringtonDarkholme opened this issue Jul 24, 2023 · 0 comments · Fixed by #560
Assignees
Labels
enhancement New feature or request

Comments

@HerringtonDarkholme
Copy link
Member

⭐ Suggestion

This is how ripgrep prints

        --color <WHEN>
            This flag controls when to use colors. The default setting is 'auto', which
            means ripgrep will try to guess when to use colors. For example, if ripgrep is
            printing to a terminal, then it will use colors, but if it is redirected to a
            file or a pipe, then it will suppress color output. ripgrep will suppress color
            output in some other circumstances as well. For example, if the TERM
            environment variable is not set or set to 'dumb', then ripgrep will not use
            colors.

This is how ast-grep outputs


      --color <COLOR>
          Controls output color

          [default: auto]

          Possible values:
          - auto:   Try to use colors, but don't force the issue. If the output is piped to another program, or the console isn't available on Windows, or if TERM=dumb, or if `NO_COLOR` is defined, for example, then don't use colors
          - always: Try very hard to emit colors. This includes emitting ANSI colors on Windows if the console API is unavailable (not implemented yet)
          - ansi:   Ansi is like Always, except it never tries to use anything other than emitting ANSI color codes
          - never:  Never emit colors

💻 Use Cases

  • Change the description
  • Make the value placeholder more descriptive
@HerringtonDarkholme HerringtonDarkholme added the enhancement New feature or request label Jul 24, 2023
@HerringtonDarkholme HerringtonDarkholme self-assigned this Jul 24, 2023
HerringtonDarkholme added a commit that referenced this issue Jul 29, 2023
fix #546

This pull request adds more detailed explanation and
makes value placeholder more descriptive.
github-merge-queue bot pushed a commit that referenced this issue Jul 29, 2023
fix #546

This pull request adds more detailed explanation and
makes value placeholder more descriptive.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant