docs: reformat tables #33813
docs: reformat tables #33813
Conversation
|
|
WalkthroughThis pull request reformats Markdown tables across 27 documentation files, adjusting column alignment, header formatting, spacing, and padding throughout the Nuxt documentation. Changes span getting-started guides, API documentation for composables, utilities, commands, and kit modules, as well as advanced and community sections. All modifications are presentational, with minor wording adjustments in isolated instances. No functional, behavioural, or logical changes to documented APIs or features are introduced. Possibly related PRs
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Tip ✨ Issue Enrichment is now available for GitHub issues!CodeRabbit can now help you manage issues more effectively:
Disable automatic issue enrichmentTo disable automatic issue enrichment, add the following to your issue_enrichment:
auto_enrich:
enabled: falseThanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/4.api/2.composables/use-cookie.md (1)
62-62: Minor: Improve compound adjective hyphenation.Line 62 contains "top level properties" which should be "top-level properties" when used as a compound adjective modifying the noun.
Apply this diff to fix the compound adjective:
- Whether to watch for changes and update the cookie. `true` for deep watch, `'shallow'` for shallow watch, i.e. data changes for only top level properties, `false` to disable. <br/> **Note:** Refresh `useCookie` values manually when a cookie has changed with [`refreshCookie`](/docs/4.x/api/utils/refresh-cookie). + Whether to watch for changes and update the cookie. `true` for deep watch, `'shallow'` for shallow watch, i.e. data changes for only top-level properties, `false` to disable. <br/> **Note:** Refresh `useCookie` values manually when a cookie has changed with [`refreshCookie`](/docs/4.x/api/utils/refresh-cookie).docs/4.api/4.commands/module.md (1)
75-75: Minor: Improve compound adjective hyphenation.Line 75 contains "auto detected" which should be "auto-detected" when used as a compound adjective.
Apply this diff to fix the compound adjective:
- | `--nuxtVersion=<2\|3>` | | Filter by Nuxt version and list compatible modules only (auto detected by default) | + | `--nuxtVersion=<2\|3>` | | Filter by Nuxt version and list compatible modules only (auto-detected by default) |docs/4.api/5.kit/1.modules.md (1)
59-68: Minor grammar improvements for future consideration.Static analysis flagged two pre-existing minor grammar issues in the surrounding prose:
- Line 65: "Can be an object or a function that receive..." → should be "receives"
- Line 364: Similar grammatical structure could be improved
These are not blocking issues and fall outside the scope of this formatting-focused PR, but could be addressed in a future content improvement pass.
Also applies to: 362-366
docs/1.getting-started/03.configuration.md (1)
144-144: Minor: Correct "Non primitive" to "Non-primitive".The feature name in the comparison table should use a hyphen for grammatical correctness.
Apply this diff to correct the hyphenation:
-| Non primitive JS types | ❌ No | ✅ Yes | +| Non-primitive JS types | ❌ No | ✅ Yes |This aligns with standard English grammar conventions for compound adjectives.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (32)
docs/1.getting-started/03.configuration.md(1 hunks)docs/1.getting-started/18.upgrade.md(1 hunks)docs/4.api/2.composables/use-cookie.md(1 hunks)docs/4.api/2.composables/use-fetch.md(2 hunks)docs/4.api/2.composables/use-lazy-fetch.md(1 hunks)docs/4.api/3.utils/define-nuxt-plugin.md(1 hunks)docs/4.api/3.utils/navigate-to.md(1 hunks)docs/4.api/4.commands/add.md(1 hunks)docs/4.api/4.commands/analyze.md(1 hunks)docs/4.api/4.commands/build-module.md(1 hunks)docs/4.api/4.commands/build.md(1 hunks)docs/4.api/4.commands/cleanup.md(1 hunks)docs/4.api/4.commands/dev.md(1 hunks)docs/4.api/4.commands/devtools.md(1 hunks)docs/4.api/4.commands/generate.md(1 hunks)docs/4.api/4.commands/info.md(1 hunks)docs/4.api/4.commands/init.md(1 hunks)docs/4.api/4.commands/module.md(2 hunks)docs/4.api/4.commands/prepare.md(1 hunks)docs/4.api/4.commands/preview.md(1 hunks)docs/4.api/4.commands/test.md(1 hunks)docs/4.api/4.commands/typecheck.md(1 hunks)docs/4.api/4.commands/upgrade.md(1 hunks)docs/4.api/5.kit/1.modules.md(2 hunks)docs/4.api/5.kit/10.templates.md(4 hunks)docs/4.api/5.kit/11.nitro.md(7 hunks)docs/4.api/5.kit/14.builder.md(5 hunks)docs/4.api/5.kit/16.layers.md(1 hunks)docs/4.api/5.kit/4.autoimports.md(3 hunks)docs/4.api/5.kit/5.components.md(2 hunks)docs/4.api/6.advanced/1.hooks.md(1 hunks)docs/5.community/6.roadmap.md(2 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: Tofandel
Repo: nuxt/nuxt PR: 0
File: :0-0
Timestamp: 2024-11-11T12:34:22.648Z
Learning: Ensure that AI-generated summaries accurately reflect the key changes in the PR, focusing on notable changes such as the removal of unused imports and variables starting with underscores.
📚 Learning: 2024-11-11T12:34:22.648Z
Learnt from: Tofandel
Repo: nuxt/nuxt PR: 0
File: :0-0
Timestamp: 2024-11-11T12:34:22.648Z
Learning: Ensure that AI-generated summaries accurately reflect the key changes in the PR, focusing on notable changes such as the removal of unused imports and variables starting with underscores.
Applied to files:
docs/4.api/4.commands/build-module.mddocs/4.api/4.commands/devtools.mddocs/5.community/6.roadmap.mddocs/4.api/4.commands/analyze.mddocs/4.api/4.commands/preview.mddocs/4.api/4.commands/generate.mddocs/4.api/5.kit/14.builder.mddocs/4.api/4.commands/prepare.mddocs/4.api/6.advanced/1.hooks.mddocs/4.api/5.kit/10.templates.mddocs/4.api/5.kit/4.autoimports.mddocs/4.api/5.kit/11.nitro.mddocs/4.api/3.utils/define-nuxt-plugin.mddocs/4.api/4.commands/typecheck.mddocs/1.getting-started/03.configuration.mddocs/4.api/4.commands/build.mddocs/1.getting-started/18.upgrade.mddocs/4.api/5.kit/1.modules.md
📚 Learning: 2025-11-25T11:42:16.132Z
Learnt from: CR
Repo: nuxt/nuxt PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-25T11:42:16.132Z
Learning: Applies to **/*.{ts,tsx,vue} : Follow standard TypeScript conventions and best practices
Applied to files:
docs/1.getting-started/03.configuration.md
🪛 LanguageTool
docs/4.api/4.commands/init.md
[style] ~44-~44: This adverb was used twice in the sentence. Consider removing one of them or replacing them with a synonym.
Context: ... | | Use Nuxt nightly release channel (3x or latest) ...
(ADVERB_REPETITION_PREMIUM)
docs/4.api/5.kit/5.components.md
[misspelling] ~51-~51: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...ectories inside project or directly use an npm package path similar to require. ...
(EN_A_VS_AN)
docs/4.api/4.commands/module.md
[misspelling] ~75-~75: This expression is normally spelled as one or with a hyphen.
Context: ...rsion and list compatible modules only (auto detected by default) | <!--/module-search-opts--...
(EN_COMPOUNDS_AUTO_DETECTED)
docs/4.api/2.composables/use-cookie.md
[uncategorized] ~62-~62: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...allow watch, i.e. data changes for only top level properties, false to disable.
*...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/4.api/6.advanced/1.hooks.md
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ... | | app:error:cleared | { redirect? } | Server & Client | Called when a ...
(UNLIKELY_OPENING_PUNCTUATION)
[style] ~27-~27: This phrase is redundant. Consider using “inside”.
Context: ....org/guide/built-ins/suspense#suspense) inside of NuxtPage pending event. ...
(OUTSIDE_OF)
[style] ~28-~28: This phrase is redundant. Consider using “inside”.
Context: ....org/guide/built-ins/suspense#suspense) inside of NuxtPage resolved event. ...
(OUTSIDE_OF)
[typographical] ~42-~42: Usually, there’s no comma before “when”.
Context: ... | Called after Nuxt initialization, when the Nuxt instance is ready to work. ...
(IF_NO_COMMA)
[grammar] ~87-~87: It seems that a pronoun is missing.
Context: ... | Called on done if has errors on WebpackBar. ...
(IF_VB)
[uncategorized] ~102-~102: Loose punctuation mark.
Context: ... | | error | error, { event? } | Called when a...
(UNLIKELY_OPENING_PUNCTUATION)
docs/4.api/4.commands/dev.md
[formatting] ~40-~40: Did you mean “?”
Context: ...| | Host to listen on (default: NUXT_HOST \|\| NITRO_HOST \|\| HOST \|\| nuxtOptions.devServer?.host) ...
(MULTIPLE_PUNCTATION_MARKS_1)
docs/1.getting-started/03.configuration.md
[grammar] ~144-~144: This expression is usually spelled with a hyphen.
Context: ... | ❌ No | ✅ Yes | | Non primitive JS types | ❌ No | ✅ Yes ...
(NON_ANTI_JJ)
[style] ~148-~148: ‘During the course of’ might be wordy. Consider a shorter alternative.
Context: ...s reading external configuration files. During the course of building your project, you may have a n...
(EN_WORDINESS_PREMIUM_DURING_THE_COURSE_OF)
docs/4.api/5.kit/1.modules.md
[style] ~65-~65: To form a complete sentence, be sure to include a subject or ‘there’.
Context: ... version constraints and configuration. Can be an object or a function that receive...
(MISSING_IT_THERE)
[style] ~364-~364: To form a complete sentence, be sure to include a subject.
Context: ...s"} | true | The module to install. Can be either a string with the module name...
(MISSING_IT_THERE)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: check-provenance
- GitHub Check: link-checker
🔇 Additional comments (54)
docs/4.api/4.commands/cleanup.md (2)
27-29: Well-formatted ARGUMENTS table.The ARGUMENTS section has been correctly reformatted to standard Markdown table syntax with proper alignment and separation. Content is unchanged and remains clear.
35-37: Well-formatted OPTIONS table.The OPTIONS section has been correctly reformatted to standard Markdown table syntax with proper column alignment and spacing. Content and structure are preserved accurately.
docs/5.community/6.roadmap.md (1)
31-35: LGTM!The Markdown table reformatting across all four tables (Roadmap, Core Modules Roadmap, Current Packages/Release Cycle, and Support Status) is consistent and correct. Column alignment, padding, and pipe placement are properly adjusted. All semantic content remains intact, including links, badge HTML, and text. The changes align with the PR objective of applying WebStorm auto-fixes to resolve
lint:docsfailures.Also applies to: 41-46, 68-74, 78-83
docs/4.api/5.kit/5.components.md (2)
49-70: Table reformatting preserves content accurately.The parameter tables for
addComponentsDirand itsoptsobject have been successfully reflowed into a standardised four-column layout (Property, Type, Required, Description). All property definitions, type signatures, and descriptions remain semantically identical.
112-127: Unable to verify trailing whitespace claim due to repository access limitation.The review comment cannot be verified at this time as shell access to the repository failed. While the comment requests verification of trailing whitespace on lines 113 and 122 in
docs/4.api/5.kit/5.components.md, the actual file content cannot be inspected to confirm whether trailing spaces exist after the final pipe character. A manual inspection of the raw file or reproduction of the suggested verification command is necessary to determine if this concern is valid.docs/4.api/2.composables/use-lazy-fetch.md (1)
72-79: Table reformatting approved.The Return Values table has been properly reformatted with improved column alignment and spacing while preserving all content and semantics.
docs/4.api/4.commands/preview.md (2)
22-24: Arguments table reformatting approved.The Arguments table has been properly reformatted with aligned columns and header row.
30-37: Options table reformatting approved.The Options table has been properly reformatted with aligned columns and header row, preserving all command options and descriptions.
docs/4.api/3.utils/navigate-to.md (1)
220-228: windowFeatures properties table reformatting approved.The table has been reformatted with improved column alignment and spacing while maintaining all property definitions and type information.
docs/4.api/2.composables/use-cookie.md (1)
57-71: Properties table reformatting approved.The table has been reformatted with aligned columns and improved header formatting while preserving all property definitions and descriptions.
docs/4.api/4.commands/module.md (4)
22-24: Arguments table (module add) reformatting approved.The table has been reformatted with aligned columns and header row.
28-34: Options table (module add) reformatting approved.The table has been reformatted with aligned columns, header row, and improved spacing.
64-66: Arguments table (module search) reformatting approved.The table has been reformatted with aligned columns and header row.
72-75: Options table (module search) reformatting approved.The table has been reformatted with aligned columns and header row while preserving all option descriptions.
docs/4.api/6.advanced/1.hooks.md (3)
12-33: App Hooks table reformatting approved.The table has been reformatted with aligned columns and improved header formatting while preserving all 22 hook definitions and descriptions.
39-89: Nuxt Hooks table reformatting approved.The comprehensive Nuxt Hooks table has been reformatted with aligned columns and improved spacing while preserving all 51 hook definitions, arguments, and descriptions.
95-105: Nitro App Hooks table reformatting approved.The Nitro App Hooks table has been reformatted with aligned columns and header row while preserving all hook definitions and type information.
docs/4.api/4.commands/test.md (2)
22-24: Arguments table reformatting approved.The table has been reformatted with aligned columns and header row.
30-35: Options table reformatting approved.The Options table has been reformatted with aligned columns and header row while preserving all test command options.
docs/4.api/4.commands/init.md (2)
22-24: Arguments table reformatting approved.The table has been reformatted with aligned columns and header row.
30-44: Options table reformatting approved.The Options table has been comprehensively reformatted with aligned columns, header row, and improved spacing while preserving all 13 init command options and their descriptions.
docs/4.api/4.commands/upgrade.md (1)
22-36: Table formatting improvements approved.The
upgradecommand documentation tables (Arguments and Options) have been correctly reformatted with explicit headers and aligned columns. Content is fully preserved, and the changes align with thelint:docsfix objective.docs/4.api/4.commands/prepare.md (1)
22-36: Table formatting improvements approved.The
preparecommand documentation tables (Arguments and Options) have been correctly reformatted with explicit headers and aligned columns. All content is fully preserved.docs/4.api/5.kit/16.layers.md (1)
88-99: Table formatting improvements approved.The
LayerDirectoriesinterface documentation table has been correctly reformatted with explicit headers and aligned columns. All property definitions, types, and descriptions are fully preserved.docs/4.api/4.commands/devtools.md (1)
22-33: Table formatting improvements approved.The
devtoolscommand documentation tables (Arguments and Options) have been correctly reformatted with explicit headers and aligned columns. All content is fully preserved.docs/4.api/5.kit/1.modules.md (2)
59-68: Table formatting improvements approved.The
defineNuxtModuleparameters table has been correctly reformatted with explicit headers and aligned columns. All parameter definitions are fully preserved.
362-366: Table formatting improvements approved.The
installModuleparameters table has been correctly reformatted with explicit headers and aligned columns. All parameter definitions are fully preserved.docs/4.api/4.commands/generate.md (1)
22-37: Table formatting improvements approved.The
generatecommand documentation tables (Arguments and Options) have been correctly reformatted with explicit headers and aligned columns. All content is fully preserved.docs/1.getting-started/18.upgrade.md (1)
1315-1331: Table formatting improvements approved.The Nuxt version comparison table (Nuxt 2 vs. Bridge vs. 3+) has been correctly reformatted with explicit headers and aligned columns. All feature comparisons and content are fully preserved.
docs/4.api/4.commands/analyze.md (1)
22-37: Table formatting improvements approved.The
analysecommand documentation tables (Arguments and Options) have been correctly reformatted with explicit headers and aligned columns. All content is fully preserved.docs/4.api/3.utils/define-nuxt-plugin.md (1)
48-57: Approved: table formatting improvement.The ObjectPlugin properties table has been reformatted with improved column alignment and consistent padding. All property definitions, types, and descriptions remain intact with no semantic changes.
docs/4.api/5.kit/11.nitro.md (1)
44-50: Approved: comprehensive table formatting across API documentation.Seven parameter tables have been reformatted with improved column alignment and consistent header styling. All API properties, types, defaults, and descriptions remain unchanged. Documentation semantics are fully preserved.
Also applies to: 129-132, 225-227, 296-298, 336-345, 376-379, 456-459
docs/4.api/2.composables/use-fetch.md (1)
186-208: Approved: Options and Return Values tables reformatted.Both tables have been restructured with improved column alignment and consistent padding. All option names, types, defaults, descriptions, and return value semantics remain unchanged.
Also applies to: 225-232
docs/4.api/4.commands/info.md (1)
22-24: Approved: command documentation tables reformatted.The Arguments and Options tables have been restructured with improved alignment and consistent header formatting. All command arguments, options, defaults, and descriptions remain unchanged.
Also applies to: 30-32
docs/4.api/4.commands/dev.md (2)
22-24: Approved: command documentation tables reformatted.The Arguments and Options tables have been restructured with improved alignment and consistent header formatting. All command arguments, options, defaults, and descriptions remain unchanged.
Also applies to: 30-49
40-40: Static analysis false positive: JavaScript optional chaining syntax.The LanguageTool hint flagging line 40 is incorrect. The
?.syntax is valid JavaScript optional chaining within a code snippet (inline code context), not a punctuation error. This can be safely ignored.docs/4.api/5.kit/10.templates.md (1)
51-58: Approved: template API tables reformatted.Five parameter tables (addTemplate, addTypeTemplate context, addServerTemplate, updateTemplates) have been restructured with improved column alignment and consistent header styling. All property definitions, types, requirements, and descriptions remain unchanged.
Also applies to: 136-149, 146-149, 229-232, 307-309
docs/4.api/4.commands/build.md (1)
22-24: Approved: command documentation tables reformatted.The Arguments and Options tables have been restructured with improved alignment and consistent header formatting. All command arguments, options, defaults, and descriptions remain unchanged.
Also applies to: 30-38
docs/4.api/4.commands/typecheck.md (1)
22-24: Approved: command documentation tables reformatted.The Arguments and Options tables have been restructured with improved alignment and consistent header formatting. All command arguments, options, defaults, and descriptions remain unchanged.
Also applies to: 30-35
docs/4.api/5.kit/4.autoimports.md (3)
61-70: Table reformatting foraddImportsparameters is correctly applied.The table has been reformatted with consistent column alignment and spacing whilst preserving all parameter documentation. The structure now follows standardised Markdown table formatting.
101-104: Table reformatting foraddImportsDirparameters is correctly applied.Column alignment and spacing have been updated consistently, with all parameter information preserved intact.
141-143: Table reformatting foraddImportsSourcesparameters is correctly applied.The reformatted table maintains all documentation content whilst improving presentation through standardised column alignment.
docs/4.api/4.commands/build-module.md (2)
22-24: Arguments table reformatted correctly.The table structure is properly maintained with ROOTDIR argument and its description intact. Formatting aligns with standardised documentation tables.
30-37: Options table reformatted correctly.All command-line options (cwd, logLevel, build, stub, sourcemap, prepare) are properly formatted with defaults and descriptions preserved. Table structure follows documentation standards.
docs/4.api/5.kit/14.builder.md (5)
96-102: extendViteConfig options table reformatted correctly.Table header and rows properly aligned with standardised four-column format. All option documentation (dev, build, server, client, prepend) and deprecation notices preserved.
145-151: extendWebpackConfig options table reformatted correctly.Column alignment standardised consistently. All option descriptions and formatting requirements (boolean types, deprecation status) preserved intact.
214-220: addVitePlugin options table reformatted correctly.Table structure properly maintained with consistent column alignment. All options (dev, build, server, client, prepend) and their descriptions with deprecation notices are preserved.
273-279: addWebpackPlugin options table reformatted correctly.Formatting standardised with proper column alignment. All parameter documentation preserved accurately.
309-315: addBuildPlugin options table reformatted correctly.Options table properly reformatted with consistent column alignment and spacing. All documentation content (dev, build, server, client, prepend options) preserved.
docs/4.api/4.commands/add.md (2)
17-24: Arguments section properly formatted as table.TEMPLATE and NAME arguments are clearly documented with full option list for TEMPLATE preserved and maintained. Table structure follows documentation standards.
29-34: Options section properly formatted as table.All command options (cwd, logLevel, force) are clearly presented with defaults and descriptions intact. Table formatting aligns with standardised documentation structure.
docs/1.getting-started/03.configuration.md (3)
136-144: Feature comparison table reformatted correctly.The runtimeConfig vs. app.config table is properly structured with all seven features clearly presented. Column alignment and content are preserved. Table follows documentation standards.
150-155: External Configuration Files table reformatted correctly.Table structure properly maintained with tool names (Nitro, PostCSS, Vite, webpack), config file references, and how-to-configure links all preserved. Formatting is clear and consistent.
159-166: Common configuration files table reformatted correctly.All tools (TypeScript, ESLint, Prettier, Stylelint, TailwindCSS, Vitest) and their associated information (config files and reference links) are properly preserved. Table formatting is consistent with documentation standards.
|
thank you again ❤️ |
📚 Description
This applies WebStorm's auto-fix to all the tables that were causing
lint:docsto fail.Now targeting
main.