fix(nuxt,schema)!: remove support for compatibilityVersion: 3
#32255
Conversation
|
|
There was a problem hiding this comment.
Pull Request Overview
Removes legacy compatibilityVersion: 3 handling and simplifies v4-only logic across schema resolvers, Nuxt modules, and tests.
- Deletes conditional branches based on
compatibilityVersionand assumes v4 behavior by default. - Cleans up async resolvers and simplifies path resolution in schema and Nuxt core.
- Updates tests to drop explicit version flags and expect v4 defaults.
Reviewed Changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| packages/schema/test/folder-structure.spec.ts | Remove explicit v4 opt-in flags and update test titles |
| packages/schema/src/config/experimental.ts | Strip out compatibilityVersion checks in experimental resolvers |
| packages/schema/src/config/common.ts | Simplify directory resolvers by removing version branches |
| packages/schema/src/config/app.ts | Streamline renderSSRHeadOptions and drop async version logic |
| packages/nuxt/test/shared-dir-config.test.ts | Assume v4 default in Nitro import dirs test |
| packages/nuxt/src/pages/module.ts | Always include all extraction keys, drop version guard |
| packages/nuxt/src/imports/module.ts | Merge composablesDirs logic, remove version-based filtering |
| packages/nuxt/src/head/runtime/composables/v3.ts | Remove entire v3 head runtime file |
| packages/nuxt/src/head/module.ts | Always alias to new composables path, drop version detection |
| packages/nuxt/src/core/nitro.ts | Remove legacy Nitro config hook and v3 guard |
| packages/nuxt/src/core/app.ts | Always include index middleware files, eliminate version checks |
| packages/nuxt/package.json | Update #unhead/composables import paths to non-v4 suffixes |
| packages/kit/src/template.ts | Drop version flag checks in type generation settings |
Comments suppressed due to low confidence (4)
packages/schema/src/config/common.ts:157
- The
serverDirresolver referencesrootDirwithout declaring it in the function scope. You should addconst rootDir = await get('rootDir')before using it.
return resolve(rootDir, val && typeof val === 'string' ? val : 'server')
packages/schema/src/config/common.ts:348
- [nitpick] The
isV4constant is alwaystrueand only used once. Consider inlining this branch or removing the unused variable to simplify the code.
const isV4 = true
packages/schema/src/config/common.ts:376
- [nitpick] This
isV4flag is hardcoded totrueand not needed—either remove it or inline the conditional to reduce clutter.
const isV4 = true
packages/schema/src/config/common.ts:409
- [nitpick] Since v3 support is removed, this always-true
isV4declaration can be removed and its branch inlined.
const isV4 = true
@nuxt/kit
nuxt
@nuxt/rspack-builder
@nuxt/schema
@nuxt/vite-builder
@nuxt/webpack-builder
commit: |
WalkthroughThis change set removes all conditional logic and code branches related to the 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
✨ Finishing Touches
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
packages/schema/src/config/common.ts (1)
4-4:⚠️ Potential issueRemove unused import.
The
joinimport is unused and should be removed to fix the pipeline failure.-import { basename, join, relative, resolve } from 'pathe' +import { basename, relative, resolve } from 'pathe'🧰 Tools
🪛 GitHub Check: code
[failure] 4-4:
'join' is defined but never used🪛 GitHub Actions: autofix.ci
[error] 4-4: ESLint: 'join' is defined but never used. (@typescript-eslint/no-unused-vars)
🧹 Nitpick comments (3)
packages/schema/src/config/common.ts (3)
348-354: Consider further simplification by removing hardcoded isV4.Whilst the hardcoded
isV4 = truecorrectly assumes v4 behaviour, the conditional branch could be removed entirely for cleaner code.- $resolve: async (val, get) => { - const isV4 = true - if (isV4) { - const [srcDir, rootDir] = await Promise.all([get('srcDir'), get('rootDir')]) - return resolve(await get('srcDir'), val && typeof val === 'string' ? val : (srcDir === rootDir ? 'app' : '.')) - } - return val && typeof val === 'string' ? val : 'app' - }, + $resolve: async (val, get) => { + const [srcDir, rootDir] = await Promise.all([get('srcDir'), get('rootDir')]) + return resolve(await get('srcDir'), val && typeof val === 'string' ? val : (srcDir === rootDir ? 'app' : '.')) + },
375-381: Consider further simplification by removing hardcoded isV4.Similar to the
appdirectory resolver, the hardcodedisV4branch could be removed for cleaner code.- $resolve: async (val, get) => { - const isV4 = true - if (isV4) { - return resolve(await get('rootDir'), val && typeof val === 'string' ? val : 'modules') - } - return val && typeof val === 'string' ? val : 'modules' - }, + $resolve: async (val, get) => { + return resolve(await get('rootDir'), val && typeof val === 'string' ? val : 'modules') + },
408-415: Consider further simplification by removing hardcoded isV4.The conditional branch with hardcoded
isV4could be removed for consistency and cleaner code.- $resolve: async (val, get) => { - const isV4 = true - if (isV4) { - return resolve(await get('rootDir'), val && typeof val === 'string' ? val : (await get('dir.static') || 'public')) - } - return val && typeof val === 'string' ? val : (await get('dir.static') || 'public') - }, + $resolve: async (val, get) => { + return resolve(await get('rootDir'), val && typeof val === 'string' ? val : (await get('dir.static') || 'public')) + },
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
packages/nuxt/package.jsonis excluded by!**/package.json
📒 Files selected for processing (13)
packages/kit/src/template.ts(2 hunks)packages/nuxt/src/core/app.ts(1 hunks)packages/nuxt/src/core/nitro.ts(1 hunks)packages/nuxt/src/head/module.ts(2 hunks)packages/nuxt/src/head/runtime/composables/v3.ts(0 hunks)packages/nuxt/src/imports/module.ts(1 hunks)packages/nuxt/src/pages/module.ts(1 hunks)packages/nuxt/test/shared-dir-config.test.ts(1 hunks)packages/schema/src/config/app.ts(1 hunks)packages/schema/src/config/common.ts(5 hunks)packages/schema/src/config/experimental.ts(8 hunks)packages/schema/test/folder-structure.spec.ts(3 hunks)tsconfig.json(1 hunks)
💤 Files with no reviewable changes (1)
- packages/nuxt/src/head/runtime/composables/v3.ts
🧰 Additional context used
🧬 Code Graph Analysis (1)
packages/nuxt/src/pages/module.ts (1)
packages/nuxt/src/pages/utils.ts (1)
defaultExtractionKeys(211-211)
🪛 GitHub Actions: autofix.ci
packages/schema/src/config/common.ts
[error] 4-4: ESLint: 'join' is defined but never used. (@typescript-eslint/no-unused-vars)
⏰ Context from checks skipped due to timeout of 90000ms (20)
- GitHub Check: test-fixtures (windows-latest, built, vite, default, manifest-on, json, 20)
- GitHub Check: test-fixtures (windows-latest, built, rspack, async, manifest-on, json, 20)
- GitHub Check: test-fixtures (windows-latest, built, vite, async, manifest-off, json, 20)
- GitHub Check: test-fixtures (ubuntu-latest, built, webpack, async, manifest-on, json, 20)
- GitHub Check: test-fixtures (windows-latest, dev, vite, async, manifest-on, json, 20)
- GitHub Check: test-fixtures (windows-latest, dev, vite, async, manifest-off, json, 20)
- GitHub Check: test-fixtures (ubuntu-latest, built, vite, default, manifest-off, json, 20)
- GitHub Check: test-fixtures (ubuntu-latest, dev, vite, default, manifest-on, json, 20)
- GitHub Check: test-fixtures (ubuntu-latest, built, rspack, default, manifest-on, json, 20)
- GitHub Check: test-fixtures (ubuntu-latest, built, vite, default, manifest-on, json, 20)
- GitHub Check: test-fixtures (ubuntu-latest, built, vite, async, manifest-on, js, 20)
- GitHub Check: test-fixtures (ubuntu-latest, built, vite, async, manifest-on, json, 20)
- GitHub Check: test-fixtures (ubuntu-latest, dev, vite, default, manifest-off, json, 20)
- GitHub Check: test-fixtures (ubuntu-latest, dev, vite, async, manifest-off, json, 20)
- GitHub Check: test-fixtures (ubuntu-latest, dev, vite, async, manifest-on, js, 20)
- GitHub Check: test-fixtures (ubuntu-latest, dev, vite, async, manifest-on, json, 20)
- GitHub Check: release-pr
- GitHub Check: typecheck (ubuntu-latest, bundler)
- GitHub Check: test-benchmark
- GitHub Check: typecheck (windows-latest, bundler)
🔇 Additional comments (25)
packages/schema/src/config/experimental.ts (9)
69-69: LGTM! Simplified inlineStyles resolver.The removal of async logic and compatibility version checks correctly simplifies the resolver to return a default function for Vue components when no explicit value is provided.
332-334: LGTM! Synchronous scanPageMeta resolver.The resolver has been simplified from async to synchronous, removing compatibility version dependencies whilst maintaining the same default behaviour of returning
'after-resolve'.
370-372: LGTM! Simplified sharedPrerenderData resolver.The resolver now directly returns
trueas the default value when not explicitly set to a boolean, removing the async complexity and compatibility version checks.
438-440: LGTM! Synchronous normalizeComponentNames resolver.The simplification correctly defaults to
truewhen not explicitly set to a boolean value, removing the previous async and compatibility version dependencies.
448-452: LGTM! Simplified spaLoadingTemplateLocation resolver.The resolver now directly validates and defaults to
'body'without async operations, maintaining type safety whilst removing compatibility version complexity.
588-590: LGTM! Synchronous granularCachedData resolver.The resolver has been appropriately simplified to default to
truewhen not explicitly set to a boolean, removing async complexity.
599-601: LGTM! Simplified alwaysRunFetchOnKeyChange resolver.The resolver now directly defaults to
falsewhen not explicitly set to a boolean value, correctly removing async operations and compatibility version checks.
608-610: LGTM! Synchronous parseErrorData resolver.The simplification appropriately defaults to
truewhen not explicitly set to a boolean, removing the previous async complexity.
622-624: LGTM! Simplified pendingWhenIdle resolver.The resolver has been correctly simplified to default to
falsewhen not explicitly set to a boolean value, maintaining consistency with the overall simplification effort.tsconfig.json (1)
37-37: LGTM! Simplified path mapping for unhead composables.The removal of the version-specific
/v4suffix correctly unifies the composables path, aligning with the broader removal of compatibility version logic throughout the codebase.packages/nuxt/test/shared-dir-config.test.ts (1)
11-11: LGTM! Simplified test to use default compatibility version.The removal of explicit compatibility version overrides correctly simplifies the test whilst maintaining validation of shared directory import functionality. The test now relies on the default behaviour rather than testing version-specific logic.
packages/nuxt/src/core/app.ts (1)
181-181: LGTM! Unconditional middleware index pattern resolution.The removal of the compatibility version check correctly ensures that nested middleware files with index patterns (e.g.,
middleware/auth/index.ts) are always resolved, simplifying the middleware discovery logic whilst maintaining full functionality.packages/kit/src/template.ts (2)
219-219: LGTM: Correct unconditional v4 behaviorThe change to always default
hasTypescriptVersionWithModulePreservetotruecorrectly implements the v4 behavior without version-specific branching.
237-237: LGTM: Stricter TypeScript checking now always enabledSetting
noUncheckedIndexedAccessto alwaystruecorrectly enforces the stricter TypeScript checking that was conditional in v4 compatibility mode. This improves type safety across the codebase.packages/nuxt/src/imports/module.ts (1)
77-82: LGTM: Shared directories now unconditionally includedThe removal of the
isNuxtV4conditional logic correctly implements the v4-only behavior. Shared directories (shared/utilsandshared/types) are now always included alongsidecomposablesandutils, which simplifies the code and ensures consistent import scanning behavior.packages/schema/test/folder-structure.spec.ts (3)
47-48: LGTM: Test updated to reflect v4 default behaviorRemoving the explicit
future.compatibilityVersion: 4configuration is correct since v4 is now the default and only supported behavior. The test expectations remain unchanged, confirming that the default configuration now provides the same behavior.
65-65: LGTM: Consistent test simplificationThe removal of the explicit compatibility version configuration is consistent with the broader changes and correctly relies on the new v4 default behavior.
82-82: LGTM: Test streamlined for v4-only behaviorThe test correctly removes the explicit compatibility version setting, demonstrating that the default behavior now matches the previously conditional v4 configuration.
packages/nuxt/src/pages/module.ts (1)
492-492: LGTM: Page metadata extraction keys now unconditionally comprehensiveThe change correctly removes the compatibility version check and always includes the full set of extraction keys (
defaultExtractionKeys,'middleware', andextraPageMetaExtractionKeys). This ensures consistent and comprehensive page metadata extraction, which aligns with the v4-only behavior this PR implements.From the relevant code snippet,
defaultExtractionKeysincludes essential page metadata like'name','path','props','alias','redirect', and'middleware', so including these unconditionally improves the page metadata extraction capabilities.packages/schema/src/config/app.ts (1)
472-475: LGTM! Simplified resolver correctly assumes v4 behaviour.The simplification from an async resolver with compatibility version checks to a synchronous resolver that unconditionally sets
omitLineBreaks: trueis correct and aligns with the removal ofcompatibilityVersion: 3support.packages/nuxt/src/head/module.ts (2)
42-42: LGTM! Simplified alias resolution.The alias now correctly points to the generic
composablesdirectory without version-specific branching, consistent with the removal of compatibility version checks.
56-56: LGTM! Simplified template generation logic.Removing the
isNuxtV4check and only evaluatingoptions.legacycorrectly simplifies the conditional logic whilst maintaining the intended behaviour.packages/nuxt/src/core/nitro.ts (1)
54-64: LGTM! Simplified shared directories inclusion.The removal of compatibility version checks and unconditional inclusion of shared directories when imports are enabled correctly assumes v4 behaviour and aligns with the broader simplification effort.
packages/schema/src/config/common.ts (2)
115-116: LGTM! Simplified srcDir resolver.The removal of compatibility version checks correctly simplifies the resolver logic whilst maintaining the intended functionality.
156-157: LGTM! Simplified serverDir resolver.The resolver is now appropriately synchronous and assumes v4 behaviour consistently.
CodSpeed Performance ReportMerging #32255 will not alter performanceComparing Summary
|
1 participant
🔗 Linked issue
📚 Description
we've had some bits of code that have respected
compatibilityVersion: 3but this is removed in v4 and we can remove the duplicate handling