Skip to content
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.

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

fix: add v4 compatibility version handeling for pages tab #758

Merged
merged 2 commits into from
Dec 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions packages/devtools/client/composables/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import { useSessionStorage } from '@vueuse/core'
import { relative } from 'pathe'
import { triggerRef } from 'vue'
import { useClient } from './client'
import { useServerConfig } from './state'

export function isNodeModulePath(path: string) {
return !!path.match(/[/\\]node_modules[/\\]/) || isPackageName(path)
Expand Down Expand Up @@ -183,3 +184,8 @@ export function refreshData() {
export function reloadPage() {
location.reload()
}

export function useNuxtCompatibilityVersion() {
const config = useServerConfig()
return config.value?.future.compatibilityVersion
}
7 changes: 6 additions & 1 deletion packages/devtools/client/pages/modules/pages.vue
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { definePageMeta } from '#imports'
import { computed, onMounted, ref } from 'vue'
import { useClient, useClientRoute, useClientRouter } from '~/composables/client'
import { useLayouts, useMergedRouteList, useServerApp, useServerConfig } from '~/composables/state'
import { useNuxtCompatibilityVersion } from '~/composables/utils'

definePageMeta({
icon: 'carbon-tree-view-alt',
Expand Down Expand Up @@ -59,6 +60,10 @@ function navigateToRoute(path: string) {
router.value.push(path)
routeInput.value = path
}

const compatibilityVersion = useNuxtCompatibilityVersion()

const pagesPath = computed(() => `./${compatibilityVersion === 4 ? 'app/' : ''}pages/index.vue`)
</script>

<template>
Expand Down Expand Up @@ -164,7 +169,7 @@ function navigateToRoute(path: string) {
icon="carbon-tree-view-alt"
name="wizard-pages"
title="Nuxt Routing"
description="Create `./pages/index.vue` to enable routing"
:description="`Create ${pagesPath} to enable routing`"
:actions="[
{
label: 'Learn more',
Expand Down
5 changes: 3 additions & 2 deletions packages/devtools/src/wizard/enable-pages.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,9 @@ const route = useRoute()
`

export async function enablePages(nuxt: Nuxt) {
const pathApp = join(nuxt.options.srcDir, 'app.vue')
const pathPageIndex = join(nuxt.options.srcDir, 'pages/index.vue')
const baseDir = nuxt.options.future.compatibilityVersion === 4 ? nuxt.options.dir.app : nuxt.options.srcDir
const pathApp = join(baseDir, 'app.vue')
const pathPageIndex = join(baseDir, 'pages/index.vue')

if (fs.existsSync(pathPageIndex)) {
logger.warn('pages/index.vue already exists, skipping')
Expand Down
2 changes: 2 additions & 0 deletions playgrounds/v4/.npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
shamefully-hoist=true
strict-peer-dependencies=false
12 changes: 12 additions & 0 deletions playgrounds/v4/nuxt.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
// https://nuxt.com/docs/api/configuration/nuxt-config
export default defineNuxtConfig({
modules: [
'../../local',
],

compatibilityDate: '2024-09-19',

future: {
compatibilityVersion: 4,
},
})
10 changes: 10 additions & 0 deletions playgrounds/v4/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"version": "1.6.1",
"private": true,
"scripts": {
"build": "nuxt build",
"dev": "nuxt dev",
"generate": "nuxt generate",
"preview": "nuxt preview"
}
}
4 changes: 4 additions & 0 deletions playgrounds/v4/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
// https://nuxt.com/docs/guide/concepts/typescript
"extends": "./.nuxt/tsconfig.json"
}
2 changes: 2 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.