feat(kit): add `ignore` option to `resolveFiles` #32858

cernymatej · 2025-08-04T23:57:41Z

📚 Description

This PR adds an ignore option to resolveFiles, allowing it to ignore certain files based on a glob pattern.

bolt-new-by-stackblitz · 2025-08-04T23:57:43Z

Run & review this pull request in StackBlitz Codeflow.

coderabbitai · 2025-08-04T23:59:46Z

Walkthrough

The resolveFiles function in packages/kit/src/resolve.ts was modified to accept an additional optional ignore parameter within its options object. This parameter is typed as GlobOptions['ignore'] from the tinyglobby package and is passed directly to the underlying glob function, enabling the specification of ignore patterns during file globbing. The function's JSDoc comment was also added or updated to describe its purpose and parameters. The core logic of the function, including filtering and sorting of file paths, remains unchanged.

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 84816d8 and a3849e2.

📒 Files selected for processing (1)

packages/kit/src/resolve.ts (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

**/*.{ts,tsx}

📄 CodeRabbit Inference Engine (.github/copilot-instructions.md)

Follow standard TypeScript conventions and best practices

Files:

packages/kit/src/resolve.ts

🧠 Learnings (4)

📓 Common learnings

Learnt from: GalacticHypernova
PR: nuxt/nuxt#29661
File: packages/kit/src/template.ts:227-229
Timestamp: 2024-11-28T21:22:40.496Z
Learning: In `packages/kit/src/template.ts`, when updating the `EXTENSION_RE` regular expression for TypeScript configuration, avoid using patterns like `(\.\w+)+$` as they can result in catastrophic backtracking.

Learnt from: GalacticHypernova
PR: nuxt/nuxt#26468
File: packages/nuxt/src/components/plugins/loader.ts:24-24
Timestamp: 2024-11-05T15:22:54.759Z
Learning: In `packages/nuxt/src/components/plugins/loader.ts`, the references to `resolve` and `distDir` are legacy code from before Nuxt used the new unplugin VFS and will be removed.

Learnt from: Tofandel
PR: nuxt/nuxt#29876
File: eslint.config.mjs:76-76
Timestamp: 2024-11-11T10:45:48.403Z
Learning: In ESLint, changing `varsIgnorePattern` to flag unused variables is safe because unused variables are locally declared and their removal doesn't affect the code. However, changing `argsIgnorePattern` might have unintended side effects since unused function arguments could be necessary for correct function signatures or implicit typing.

📚 Learning: in `packages/kit/src/template.ts`, when updating the `extension_re` regular expression for typescrip...

Learnt from: GalacticHypernova
PR: nuxt/nuxt#29661
File: packages/kit/src/template.ts:227-229
Timestamp: 2024-11-28T21:22:40.496Z
Learning: In `packages/kit/src/template.ts`, when updating the `EXTENSION_RE` regular expression for TypeScript configuration, avoid using patterns like `(\.\w+)+$` as they can result in catastrophic backtracking.

Applied to files:

packages/kit/src/resolve.ts

📚 Learning: in `packages/nuxt/src/components/plugins/loader.ts`, the references to `resolve` and `distdir` are l...

Learnt from: GalacticHypernova
PR: nuxt/nuxt#26468
File: packages/nuxt/src/components/plugins/loader.ts:24-24
Timestamp: 2024-11-05T15:22:54.759Z
Learning: In `packages/nuxt/src/components/plugins/loader.ts`, the references to `resolve` and `distDir` are legacy code from before Nuxt used the new unplugin VFS and will be removed.

Applied to files:

packages/kit/src/resolve.ts

📚 Learning: in eslint, changing `varsignorepattern` to flag unused variables is safe because unused variables ar...

Learnt from: Tofandel
PR: nuxt/nuxt#29876
File: eslint.config.mjs:76-76
Timestamp: 2024-11-11T10:45:48.403Z
Learning: In ESLint, changing `varsIgnorePattern` to flag unused variables is safe because unused variables are locally declared and their removal doesn't affect the code. However, changing `argsIgnorePattern` might have unintended side effects since unused function arguments could be necessary for correct function signatures or implicit typing.

Applied to files:

packages/kit/src/resolve.ts

⏰ 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: codeql (actions)
GitHub Check: code

🔇 Additional comments (3)

packages/kit/src/resolve.ts (3)

4-4: LGTM: Appropriate type import for the new feature.

The import of GlobOptions type from tinyglobby is correctly added to support the new ignore parameter typing.

245-250: LGTM: Comprehensive JSDoc documentation.

The JSDoc comment provides clear documentation for the function's purpose, parameters, and options. This improves the developer experience and maintainability.

251-253: LGTM: Clean implementation with proper typing.

The function signature correctly adds the optional ignore parameter with appropriate typing, and the implementation properly passes it to the underlying glob function whilst maintaining backward compatibility.

Note that files are now filtered at two levels: first by the ignore glob patterns, then by the isIgnored function. This provides flexibility whilst preserving existing .nuxtignore behaviour.

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment

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.
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.

Support

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

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.

pkg-pr-new · 2025-08-05T00:05:36Z

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: a3849e2

codspeed-hq · 2025-08-05T00:16:04Z

CodSpeed Performance Report

Merging #32858 will not alter performance

_{Comparing cernymatej:feat/kit-resolve-files-ignore (a3849e2) with main (84816d8)}

Summary

✅ 10 untouched benchmarks

feat(kit): add ignore option to resolveFiles

a3849e2

cernymatej requested a review from danielroe as a code owner August 4, 2025 23:57

github-actions bot added 4.x enhancement labels Aug 4, 2025

danielroe approved these changes Aug 11, 2025

View reviewed changes

danielroe merged commit b79a599 into nuxt:main Aug 11, 2025
47 checks passed

github-actions bot mentioned this pull request Aug 11, 2025

v4.1.0 #32938

Merged

cernymatej deleted the feat/kit-resolve-files-ignore branch August 11, 2025 20:56

danielroe pushed a commit that referenced this pull request Sep 2, 2025

feat(kit): add ignore option to resolveFiles (#32858)

3e6a7df

github-actions bot mentioned this pull request Sep 2, 2025

v3.19.0 #33114

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat(kit): add `ignore` option to `resolveFiles` #32858

feat(kit): add `ignore` option to `resolveFiles` #32858

Uh oh!

cernymatej commented Aug 4, 2025

Uh oh!

bolt-new-by-stackblitz bot commented Aug 4, 2025

Uh oh!

coderabbitai bot commented Aug 4, 2025

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

pkg-pr-new bot commented Aug 5, 2025

Uh oh!

codspeed-hq bot commented Aug 5, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

feat(kit): add ignore option to resolveFiles #32858

feat(kit): add ignore option to resolveFiles #32858

Uh oh!

Conversation

cernymatej commented Aug 4, 2025

📚 Description

Uh oh!

bolt-new-by-stackblitz bot commented Aug 4, 2025

Uh oh!

coderabbitai bot commented Aug 4, 2025

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!

pkg-pr-new bot commented Aug 5, 2025

Uh oh!

codspeed-hq bot commented Aug 5, 2025

CodSpeed Performance Report

Merging #32858 will not alter performance

Summary

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

feat(kit): add `ignore` option to `resolveFiles` #32858

feat(kit): add `ignore` option to `resolveFiles` #32858

CodeRabbit Configuration File (`.coderabbit.yaml`)