docs: generate cli flags docs from code #21270
Open
+365
−99
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sapphi-red
reviewed
Dec 12, 2025
Member
There was a problem hiding this comment.
I wonder if it's better to generate the json when bundling the vite package. Then, cli.js would always exist.
Member
There was a problem hiding this comment.
I think we should add this file to
Line 3 in 181d870
so that the docs are built when this file changes.
Comment on lines
+23
to
+24
| <!-- render as html --> | ||
| <div v-html="data.viteDevFlags"></div> |
Member
There was a problem hiding this comment.
One downside of using HTML tags is that the md files does not contain the content: https://deploy-preview-21270--vite-docs-main.netlify.app/guide/cli.md
I guess it's ok for now.
Comment on lines
+72
to
+76
| ## Shared Options | ||
|
|
||
| These options are available for all commands. | ||
|
|
||
| <div v-html="data.globalFlags"></div> |
Member
There was a problem hiding this comment.
Maybe we should put this as the first item? I think it's difficult to notice that these options exists.
An alternative would be to link to this section from all "Options" sections or duplicating these into all "Options".
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related: #19436
Preview link: https://deploy-preview-21270--vite-docs-main.netlify.app/guide/cli
The flow:
docs/_data/cli-vite.jsonfromdocs/.vitepress/updateData.config.ts(called on vitepress config load)docs/_data/cli-vite.data.tsloads the JSON and formats as HTML.docs/guide/cli.mdloads the HTML and renders it.I separated step 1 & 2 as two steps so that translators can directly translate on the
docs/_data/cli-core.jsonfile. Maybe there's a better way to organize the source of truth but I went with this for now to prevent editing the CLI code too much.Other changes:
--profileflag to CLI help message, so the generation also picks it up. A caveat however is that it's missing a link to the performance page.