docs: add example for module `.with()` #32757

danielroe · 2025-07-25T10:42:01Z

🔗 Linked issue

📚 Description

This adds some basic docs for .with option introduced in #27520

bolt-new-by-stackblitz · 2025-07-25T10:42:05Z

Run & review this pull request in StackBlitz Codeflow.

coderabbitai · 2025-07-25T10:44:36Z

Walkthrough

The documentation for the defineNuxtModule function has been updated to include a new overload signature that introduces a .with() method. This method accepts a module definition with explicit default option values, enabling TypeScript to infer the resolved module options more precisely. The update provides a detailed example illustrating how to define module options with optional and required properties and how .with() ensures defaulted properties are treated as non-optional in the setup function’s resolved options. The change is purely additive to the type definitions and documentation, with no modifications to existing functionality or control flow.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6278e20 and cece885.

📒 Files selected for processing (1)

docs/3.api/5.kit/1.modules.md (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

docs/3.api/5.kit/1.modules.md

⏰ 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: lint-docs
GitHub Check: lint-docs

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch docs/with-module

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (2)

docs/3.api/5.kit/1.modules.md (2)

48-52: Add a short prose intro before the overload snippet for discoverability

The new overload appears abruptly after the first declaration without any narrative to explain why it exists or when to prefer it. One-sentence context (e.g. “For cases where you need defaults to influence the resolved options type, use the following overload…”) will help readers who skim rather than read top-to-bottom.

131-173: Clarify “optional” vs “always defined” in the .with() example

In the inline comment you state that timeout and retries are “Optional, has default value” yet also show their types as plain number, implying they are always defined after resolution. This can confuse readers about the actual compile-time guarantee provided by .with().

Replace the wording with something like “Always defined (default supplied)” to make the contract unambiguous, or explicitly show the post-merge type (number) contrasted with the pre-merge optional (number | undefined).

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d8d2f3e and 6278e20.

📒 Files selected for processing (1)

docs/3.api/5.kit/1.modules.md (2 hunks)

⏰ 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). (1)

GitHub Check: lint-docs

docs/3.api/5.kit/1.modules.md

Co-authored-by: Damian Głowala <damian.glowala.rebkow@gmail.com>

docs: add example for module .with()

6278e20

danielroe requested a review from DamianGlowala July 25, 2025 10:42

github-actions bot added 4.x documentation labels Jul 25, 2025

coderabbitai bot reviewed Jul 25, 2025

View reviewed changes

DamianGlowala reviewed Jul 25, 2025

View reviewed changes

docs/3.api/5.kit/1.modules.md Outdated Show resolved Hide resolved

Apply suggestion from @DamianGlowala

cece885

Co-authored-by: Damian Głowala <damian.glowala.rebkow@gmail.com>

DamianGlowala approved these changes Jul 25, 2025

View reviewed changes

danielroe merged commit 2f7d45b into main Jul 25, 2025
8 of 9 checks passed

danielroe deleted the docs/with-module branch July 25, 2025 22:13

github-actions bot mentioned this pull request Jul 25, 2025

v4.0.2 #32710

Merged

danielroe added a commit that referenced this pull request Jul 25, 2025

docs: add example for module .with() (#32757)

e727f4f

github-actions bot mentioned this pull request Jul 25, 2025

v3.18.0 #32713

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

docs: add example for module `.with()` #32757

docs: add example for module `.with()` #32757

Uh oh!

danielroe commented Jul 25, 2025

Uh oh!

bolt-new-by-stackblitz bot commented Jul 25, 2025

Uh oh!

coderabbitai bot commented Jul 25, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

docs: add example for module .with() #32757

docs: add example for module .with() #32757

Uh oh!

Conversation

danielroe commented Jul 25, 2025

🔗 Linked issue

📚 Description

Uh oh!

bolt-new-by-stackblitz bot commented Jul 25, 2025

Uh oh!

coderabbitai bot commented Jul 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Estimated code review effort

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

docs: add example for module `.with()` #32757

docs: add example for module `.with()` #32757

coderabbitai bot commented Jul 25, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)