refactor: adopt nuxt v4 recommended folder structure

acdh-oeaw · Jun 20, 2024 · fc8b423 · fc8b423
1 parent 6f8f169
commit fc8b423
Show file tree

Hide file tree

Showing 41 changed files with 21 additions and 25 deletions.
diff --git a/app.vue → app/app.vue b/app.vue → app/app.vue
diff --git a/components/app-footer.vue → app/components/app-footer.vue b/components/app-footer.vue → app/components/app-footer.vue
diff --git a/components/app-header.vue → app/components/app-header.vue b/components/app-header.vue → app/components/app-header.vue
diff --git a/components/color-scheme-switcher.vue → app/components/color-scheme-switcher.vue b/components/color-scheme-switcher.vue → app/components/color-scheme-switcher.vue
diff --git a/components/content/prose-a.vue → app/components/content/prose-a.vue b/components/content/prose-a.vue → app/components/content/prose-a.vue
diff --git a/components/content/prose-img.vue → app/components/content/prose-img.vue b/components/content/prose-img.vue → app/components/content/prose-img.vue
diff --git a/components/error-boundary.vue → app/components/error-boundary.vue b/components/error-boundary.vue → app/components/error-boundary.vue
diff --git a/components/imprint.vue → app/components/imprint.vue b/components/imprint.vue → app/components/imprint.vue
diff --git a/components/locale-switcher.vue → app/components/locale-switcher.vue b/components/locale-switcher.vue → app/components/locale-switcher.vue
diff --git a/components/main-content.vue → app/components/main-content.vue b/components/main-content.vue → app/components/main-content.vue
diff --git a/components/skip-link.vue → app/components/skip-link.vue b/components/skip-link.vue → app/components/skip-link.vue
diff --git a/components/ui/centered.vue → app/components/ui/centered.vue b/components/ui/centered.vue → app/components/ui/centered.vue
diff --git a/components/ui/page-title.vue → app/components/ui/page-title.vue b/components/ui/page-title.vue → app/components/ui/page-title.vue
diff --git a/composables/use-locale.ts → app/composables/use-locale.ts b/composables/use-locale.ts → app/composables/use-locale.ts
diff --git a/composables/use-page-metadata.ts → app/composables/use-page-metadata.ts b/composables/use-page-metadata.ts → app/composables/use-page-metadata.ts
diff --git a/composables/use-translations.ts → app/composables/use-translations.ts b/composables/use-translations.ts → app/composables/use-translations.ts
diff --git a/config/i18n.config.ts → app/config/i18n.config.ts b/config/i18n.config.ts → app/config/i18n.config.ts
diff --git a/config/imprint.config.ts → app/config/imprint.config.ts b/config/imprint.config.ts → app/config/imprint.config.ts
diff --git a/error.vue → app/error.vue b/error.vue → app/error.vue
diff --git a/layouts/default.vue → app/layouts/default.vue b/layouts/default.vue → app/layouts/default.vue
diff --git a/messages/de.json → app/messages/de.json b/messages/de.json → app/messages/de.json
diff --git a/messages/en.json → app/messages/en.json b/messages/en.json → app/messages/en.json
diff --git a/pages/imprint.vue → app/pages/imprint.vue b/pages/imprint.vue → app/pages/imprint.vue
diff --git a/pages/index.vue → app/pages/index.vue b/pages/index.vue → app/pages/index.vue
diff --git a/styles/index.css → app/styles/index.css b/styles/index.css → app/styles/index.css
diff --git a/types/i18n.d.ts → app/types/i18n.d.ts b/types/i18n.d.ts → app/types/i18n.d.ts
diff --git a/utils/analytics.ts → app/utils/analytics.ts b/utils/analytics.ts → app/utils/analytics.ts
diff --git a/utils/safe-json-ld-replacer.ts → app/utils/safe-json-ld-replacer.ts b/utils/safe-json-ld-replacer.ts → app/utils/safe-json-ld-replacer.ts
diff --git a/e2e/lib/fixtures/imprint-page.ts b/e2e/lib/fixtures/imprint-page.ts
@@ -1,7 +1,7 @@
 import type { Locator, Page } from "@playwright/test";
 
 import { defaultLocale, type Locale } from "@/config/i18n.config";
-import type { I18n } from "@/e2e/lib/fixtures/i18n";
+import type { I18n } from "~/e2e/lib/fixtures/i18n";
 
 export class ImprintPage {
 	readonly page: Page;

diff --git a/e2e/lib/fixtures/index-page.ts b/e2e/lib/fixtures/index-page.ts
@@ -1,7 +1,7 @@
 import type { Locator, Page } from "@playwright/test";
 
 import { defaultLocale, type Locale } from "@/config/i18n.config";
-import type { I18n } from "@/e2e/lib/fixtures/i18n";
+import type { I18n } from "~/e2e/lib/fixtures/i18n";
 
 export class IndexPage {
 	readonly page: Page;

diff --git a/e2e/lib/test.ts b/e2e/lib/test.ts
@@ -1,10 +1,10 @@
 import { test as base } from "@playwright/test";
 
 import { defaultLocale, type Locale } from "@/config/i18n.config";
-import { type AccessibilityScanner, createAccessibilityScanner } from "@/e2e/lib/fixtures/a11y";
-import { createI18n, type I18n, type WithI18n } from "@/e2e/lib/fixtures/i18n";
-import { ImprintPage } from "@/e2e/lib/fixtures/imprint-page";
-import { IndexPage } from "@/e2e/lib/fixtures/index-page";
+import { type AccessibilityScanner, createAccessibilityScanner } from "~/e2e/lib/fixtures/a11y";
+import { createI18n, type I18n, type WithI18n } from "~/e2e/lib/fixtures/i18n";
+import { ImprintPage } from "~/e2e/lib/fixtures/imprint-page";
+import { IndexPage } from "~/e2e/lib/fixtures/index-page";
 
 interface Fixtures {
 	createAccessibilityScanner: () => Promise<AccessibilityScanner>;

diff --git a/e2e/tests/app/analytics.test.ts b/e2e/tests/app/analytics.test.ts
@@ -1,6 +1,6 @@
 import { createUrl } from "@acdh-oeaw/lib";
 
-import { expect, test } from "@/e2e/lib/test";
+import { expect, test } from "~/e2e/lib/test";
 
 if (process.env.NUXT_PUBLIC_MATOMO_BASE_URL && process.env.NUXT_PUBLIC_MATOMO_ID) {
 	const baseUrl = String(

diff --git a/e2e/tests/app/app.test.ts b/e2e/tests/app/app.test.ts
@@ -1,7 +1,7 @@
 import { createUrl } from "@acdh-oeaw/lib";
 
 import { defaultLocale, locales } from "@/config/i18n.config";
-import { expect, test } from "@/e2e/lib/test";
+import { expect, test } from "~/e2e/lib/test";
 
 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 const baseUrl = process.env.NUXT_PUBLIC_APP_BASE_URL!;

diff --git a/e2e/tests/app/i18n.test.ts b/e2e/tests/app/i18n.test.ts
@@ -1,7 +1,7 @@
 import { createUrl } from "@acdh-oeaw/lib";
 
 import { locales } from "@/config/i18n.config";
-import { expect, test } from "@/e2e/lib/test";
+import { expect, test } from "~/e2e/lib/test";
 
 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 const baseUrl = process.env.NUXT_PUBLIC_APP_BASE_URL!;

diff --git a/e2e/tests/app/metadata.test.ts b/e2e/tests/app/metadata.test.ts
@@ -1,8 +1,8 @@
 import { createUrl } from "@acdh-oeaw/lib";
 
 import { locales } from "@/config/i18n.config";
-import { expect, test } from "@/e2e/lib/test";
 import { escape } from "@/utils/safe-json-ld-replacer";
+import { expect, test } from "~/e2e/lib/test";
 
 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 const baseUrl = process.env.NUXT_PUBLIC_APP_BASE_URL!;

diff --git a/e2e/tests/pages/imprint.test.ts b/e2e/tests/pages/imprint.test.ts
@@ -1,5 +1,5 @@
 import { locales } from "@/config/i18n.config";
-import { expect, test } from "@/e2e/lib/test";
+import { expect, test } from "~/e2e/lib/test";
 
 test.describe("imprint page", () => {
 	test("should have document title", async ({ createImprintPage }) => {

diff --git a/e2e/tests/pages/index.test.ts b/e2e/tests/pages/index.test.ts
@@ -1,5 +1,5 @@
 import { locales } from "@/config/i18n.config";
-import { expect, test } from "@/e2e/lib/test";
+import { expect, test } from "~/e2e/lib/test";
 
 test.describe("index page", () => {
 	test("should have document title", async ({ createIndexPage }) => {

diff --git a/e2e/tsconfig.json b/e2e/tsconfig.json
@@ -4,7 +4,8 @@
 	"compilerOptions": {
 		"baseUrl": "..",
 		"paths": {
-			"@/*": ["./*"]
+			"@/*": ["./app/*"],
+			"~/*": ["./*"]
 		}
 	}
 }
diff --git a/nuxt.config.ts b/nuxt.config.ts
@@ -1,13 +1,14 @@
 import { fileURLToPath } from "node:url";
 
-import { defaultLocale, localesMap } from "./config/i18n.config";
+import { defaultLocale, localesMap } from "./app/config/i18n.config";
 
 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 const baseUrl = process.env.NUXT_PUBLIC_APP_BASE_URL!;
 
 export default defineNuxtConfig({
 	alias: {
-		"@": fileURLToPath(new URL("./", import.meta.url)),
+		"@": fileURLToPath(new URL("./app/", import.meta.url)),
+		"~": fileURLToPath(new URL("./", import.meta.url)),
 	},
 	app: {
 		layoutTransition: false,
@@ -94,7 +95,8 @@ export default defineNuxtConfig({
 			compilerOptions: {
 				baseUrl: ".",
 				paths: {
-					"@/*": ["./*"],
+					"@/*": ["./app/*"],
+					"~/*": ["./*"],
 				},
 			},
 		},

diff --git a/server/routes/sitemap.xml.get.ts b/server/routes/sitemap.xml.get.ts
@@ -9,7 +9,7 @@ import { locales } from "@/config/i18n.config";
 const baseUrl = v.parse(v.pipe(v.string(), v.url()), process.env.NUXT_PUBLIC_APP_BASE_URL);
 
 // eslint-disable-next-line import/no-named-as-default-member
-const paths = fg.globSync("./**/*.vue", { cwd: join(process.cwd(), "pages") });
+const paths = fg.globSync("./**/*.vue", { cwd: join(process.cwd(), "app", "pages") });
 
 const routes: Array<string> = [];
 

diff --git a/tailwind.config.ts b/tailwind.config.ts
@@ -4,14 +4,7 @@ import type { Config } from "tailwindcss";
 const preset = createPreset();
 
 const config = {
-	content: [
-		"./app.vue",
-		"./error.vue",
-		"./components/**/*.@(css|ts|vue)",
-		"./content/**/*.md",
-		"./layouts/**/*.@(css|ts|vue)",
-		"./pages/**/*.@(css|ts|vue)",
-	],
+	content: ["./app/**/*.@(css|ts|vue)", "./content/**/*.md"],
 	presets: [preset],
 } satisfies Config;