8000 fix(nuxt): do not warn about `[[` optional dynamic params by danielroe · Pull Request #30619 · nuxt/nuxt · GitHub
[go: up one dir, main page]
Skip to content

fix(nuxt): do not warn about [[ optional dynamic params #30619

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Jan 16, 2025
Merged

fix(nuxt): do not warn about [[ optional dynamic params #30619

merged 1 commit into from
Jan 16, 2025

Conversation

danielroe
Copy link
Member

🔗 Linked issue

resolves #30616

📚 Description

this exempts [ and ] from the warning about invalid characters

@bolt-new-by-stackblitz Bolt.new (by StackBlitz)
Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@coderabbitai coderabbitai
Copy link
coderabbitai bot commented Jan 15, 2025

Walkthrough

The pull request introduces a subtle modification to the error handling mechanism within the parseSegment function located in the packages/nuxt/src/pages/utils.ts file. The change specifically refines the warning logging logic for dynamic route parameters. The updated implementation now restricts warning messages to cases involving characters that are not square brackets, potentially reducing the frequency of logged warnings. The core parsing functionality remains unchanged, maintaining the existing logic for segment and token generation. This adjustment appears to be a targeted refinement of the error reporting approach without altering the fundamental behaviour of the route parsing mechanism.

📜 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 16d213b and 698e826.

📒 Files selected for processing (1)
  • packages/nuxt/src/pages/utils.ts (1 hunks)
🔇 Additional comments (1)
packages/nuxt/src/pages/utils.ts (1)

428-430: LGTM! Consider adding test coverage.

The modification correctly implements the requirement to suppress warnings for square brackets in dynamic route parameters whilst maintaining warnings for other invalid characters. This change aligns well with the PR objective.

Would you like me to help create a test case to verify this behaviour? We should ensure that:

  1. Square brackets ([ and ]) in dynamic parameters do not trigger warnings
  2. Other invalid characters still trigger appropriate warnings

Finishing Touches

  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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. (Beta)
  • @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.

@pkg-pr-new pkg.pr.new
Copy link
pkg-pr-new bot commented Jan 15, 2025

Open in Stackblitz

@nuxt/kit

npm i https://pkg.pr.new/@nuxt/kit@30619

@nuxt/rspack-builder

npm i https://pkg.pr.new/@nuxt/rspack-builder@30619

nuxt

npm i https://pkg.pr.new/nuxt@30619

@nuxt/schema

npm i https://pkg.pr.new/@nuxt/schema@30619

@nuxt/vite-builder

npm i https://pkg.pr.new/@nuxt/vite-builder@30619

@nuxt/webpack-builder

npm i https://pkg.pr.new/@nuxt/webpack-builder@30619

commit: 698e826

@danielroe danielroe merged commit f277030 into main Jan 16, 2025
46 checks passed
@danielroe danielroe deleted the fix/optional-slug branch January 16, 2025 10:36
@github-actions github-actions bot mentioned this pull request Jan 16, 2025
Merged
This was referenced Jan 22, 2025
Merged
Closed
danielroe added a commit that referenced this pull request Jan 22, 2025
@danielroe
fix(nuxt): do not warn about [[ optional dynamic params (#30619)
2669184
@github-actions github-actions bot mentioned this pull request Jan 21, 2025
Merged
Kamsou pushed a commit to Kamsou/nuxt that referenced this pull request Feb 5, 2025
@danielroe @Kamsou
fix(nuxt): do not warn about [[ optional dynamic params (nuxt#30619)
0cf080d
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
3.x bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Invalid warning for optional param page names
1 participant
@danielroe
0