Skip to content

feat(cli): making the CLI help interface more documented #1463

@aman29271

Description

@aman29271

Is your feature request related to a problem? Please describe.
Using CLI help commands gives a list of available commands, flags and their short description. But, when you wanna explore more lets say you want to know about stats flag, like how can i use stats flag or which arguments are valid. It should also provide a more descriptive information about stats flag. But right now, It just provide a short desc about that flag.

~/Desktop/test$ npx webpack-cli help --stats
Usage: webpack --stats verbose
Description: It instructs webpack on how to treat the stats
Documentation: https://webpack.js.org/configuration/stats/#stats

                  Made with ♥️  by the webpack team

Describe the solution you'd like
So, I propose to provide a long and short description for each flag and commands available through CLI.

Benefits

  • more descriptive
  • for starters, they don't have to go through documentation.
  • offline support 😄

Describe alternatives you've considered

~/Desktop/test$ npx webpack-cli help --stats
Usage: webpack --stats verbose

Description: 

Example: npx webpack-cli --stats verbose

Accepted Value:  none | errors-only | minimal | normal | detailed | verbose | errors-warnings

It instructs webpack on how to treat the stats

Documentation: https://webpack.js.org/configuration/stats/#stats

                  Made with ♥️  by the webpack team

Additional context
Hit me up for any suggestions

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions