Skip to content

docs: remove wrong short argument -w for --json in cli.mdx#8507

Merged
chenjiahan merged 2 commits intoweb-infra-dev:mainfrom
stefanseeger:patch-1
Nov 22, 2024
Merged

docs: remove wrong short argument -w for --json in cli.mdx#8507
chenjiahan merged 2 commits intoweb-infra-dev:mainfrom
stefanseeger:patch-1

Conversation

@stefanseeger
Copy link
Copy Markdown
Contributor

Summary

The documentation falsely references the argument -w twice.
The --json argument does not have a short hand

output of npx @rspack/cli --help

Options:
  -c, --config       config file                                        [string]
      --entry        entry file                                          [array]
  -o, --output-path  output path dir                                    [string]
  -m, --mode         mode                                               [string]
  -w, --watch        watch                            [boolean] [default: false]
      --env          env passed to config function                       [array]
      --node-env     sets process.env.NODE_ENV to be specified value    [string]
  -d, --devtool      devtool                          [boolean] [default: false]
      --configName   Name of the configuration to use.                   [array]
      --analyze      analyze                          [boolean] [default: false]
      --json         emit stats json
      --profile      capture timing information for each module
                                                      [boolean] [default: false]
  -v, --version      Show version number                               [boolean]
  -h, --help         Show help                                         [boolean]

Checklist

  • Tests updated (or not required).
  • Documentation updated (or not required).

@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Nov 21, 2024

CLA assistant check
All committers have signed the CLA.

@netlify
Copy link
Copy Markdown

netlify bot commented Nov 21, 2024

Deploy Preview for rspack ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 726a2c0
🔍 Latest deploy log https://app.netlify.com/sites/rspack/deploys/673f555ac231ce0008d52568
😎 Deploy Preview https://deploy-preview-8507--rspack.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@stefanseeger stefanseeger changed the title Remove wrong short argument for json cli.mdx Remove wrong short argument -w for --json in cli.mdx Nov 21, 2024
@chenjiahan chenjiahan changed the title Remove wrong short argument -w for --json in cli.mdx docs: remove wrong short argument -w for --json in cli.mdx Nov 22, 2024
@github-actions github-actions bot added the release: document release: document related release(mr only) label Nov 22, 2024
Copy link
Copy Markdown
Member

@chenjiahan chenjiahan left a comment

Choose a reason for hiding this comment

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

Thank you!

@chenjiahan chenjiahan merged commit d9af25f into web-infra-dev:main Nov 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release: document release: document related release(mr only)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants