@nx/nuxt 0.0.0-pr-22179-271588f → 0.0.0-pr-26482-ebe2dba

package/LICENSE

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2017-2023 Narwhal Technologies Inc.
+Copyright (c) 2017-2024 Narwhal Technologies Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

package/migrations.json

@@ -1,4 +1,23 @@
 {
   "generators": {},
-  "packageJsonUpdates": {}
+  "packageJsonUpdates": {
+    "18.2.0": {
+      "version": "18.2.0-beta.0",
+      "packages": {
+        "@nuxt/eslint-config": {
+          "version": "~0.3.0-alpha.1",
+          "alwaysAddToPackageJson": false
+        }
+      }
+    },
+    "18.3.0": {
+      "version": "18.3.0-beta.2",
+      "packages": {
+        "@nuxt/eslint-config": {
+          "version": "~0.3.6",
+          "alwaysAddToPackageJson": false
+        }
+      }
+    }
+  }
 }

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@nx/nuxt",
-  "version": "0.0.0-pr-22179-271588f",
+  "version": "0.0.0-pr-26482-ebe2dba",
   "private": false,
-  "description": "The Nuxt plugin for Nx contains executors and generators for managing Nuxt applications and libraries within an Nx workspace. It provides:\n\n\n- Integration with libraries such as Vitest, Cypress, and Storybook.\n\n- Generators for applications, libraries, and more.\n\n- Library build support for publishing packages to npm or other registries.\n\n- Utilities for automatic workspace refactoring.",
+  "description": "The Nuxt plugin for Nx contains executors and generators for managing Nuxt applications and libraries within an Nx workspace. It provides:\n\n\n- Integration with libraries such as Vitest, Playwright, Cypress, and Storybook.\n\n- Generators for applications, libraries, and more.\n\n- Library build support for publishing packages to npm or other registries.\n\n- Utilities for automatic workspace refactoring.",
   "repository": {
     "type": "git",
     "url": "https://github.com/nrwl/nx.git",
@@ -12,9 +12,10 @@
     "Monorepo",
     "Nuxt",
     "Web",
-    "CLI"
+    "CLI",
+    "Front-end"
   ],
-  "main": "./index.js",
+  "main": "./index",
   "typings": "./index.d.ts",
   "author": "Victor Savkin",
   "license": "MIT",
@@ -30,11 +31,11 @@
   "dependencies": {
     "tslib": "^2.3.0",
     "@nuxt/kit": "^3.10.0",
-    "@nx/devkit": "0.0.0-pr-22179-271588f",
-    "@nx/js": "0.0.0-pr-22179-271588f",
-    "@nx/eslint": "0.0.0-pr-22179-271588f",
-    "@nx/vue": "0.0.0-pr-22179-271588f",
-    "@nx/vite": "0.0.0-pr-22179-271588f"
+    "@nx/devkit": "0.0.0-pr-26482-ebe2dba",
+    "@nx/js": "0.0.0-pr-26482-ebe2dba",
+    "@nx/eslint": "0.0.0-pr-26482-ebe2dba",
+    "@nx/vue": "0.0.0-pr-26482-ebe2dba",
+    "@nx/vite": "0.0.0-pr-26482-ebe2dba"
   },
   "peerDependencies": {},
   "publishConfig": {

package/src/generators/application/application.js

@@ -14,6 +14,7 @@ const add_vitest_1 = require("./lib/add-vitest");
 const vue_1 = require("@nx/vue");
 const ensure_dependencies_1 = require("./lib/ensure-dependencies");
 const log_show_project_command_1 = require("@nx/devkit/src/utils/log-show-project-command");
+const node_child_process_1 = require("node:child_process");
 async function applicationGenerator(tree, schema) {
     const tasks = [];
     const options = await (0, normalize_options_1.normalizeOptions)(tree, schema);
@@ -24,13 +25,8 @@ async function applicationGenerator(tree, schema) {
         skipFormat: true,
     });
     tasks.push(jsInitTask);
-    const nuxtInitTask = await (0, init_1.default)(tree, {
-        ...options,
-        skipFormat: true,
-    });
-    tasks.push(nuxtInitTask);
     tasks.push((0, ensure_dependencies_1.ensureDependencies)(tree, options));
-    (0, devkit_1.addProjectConfiguration)(tree, options.name, {
+    (0, devkit_1.addProjectConfiguration)(tree, options.projectName, {
         root: options.appProjectRoot,
         projectType: 'application',
         sourceRoot: `${options.appProjectRoot}/src`,
@@ -69,11 +65,24 @@ async function applicationGenerator(tree, schema) {
         }));
         tasks.push(await (0, add_vitest_1.addVitest)(tree, options));
     }
+    const nuxtInitTask = await (0, init_1.default)(tree, {
+        ...options,
+        skipFormat: true,
+    });
+    tasks.push(nuxtInitTask);
     tasks.push(await (0, add_e2e_1.addE2e)(tree, options));
     if (options.js)
         (0, devkit_1.toJS)(tree);
     if (!options.skipFormat)
         await (0, devkit_1.formatFiles)(tree);
+    tasks.push(() => {
+        try {
+            (0, node_child_process_1.execSync)(`npx -y nuxi prepare`, { cwd: options.appProjectRoot });
+        }
+        catch (e) {
+            console.error(`Failed to run \`nuxi prepare\` in "${options.appProjectRoot}". Please run the command manually.`);
+        }
+    });
     tasks.push(() => {
         (0, log_show_project_command_1.logShowProjectCommand)(options.projectName);
     });

package/src/generators/application/files/nuxt.config.ts__tmpl__

@@ -13,7 +13,7 @@ export default defineNuxtConfig({
   typescript: {
     typeCheck: true,
     tsConfig: {
-      extends: './tsconfig.app.json',
+      extends: '../tsconfig.app.json', // Nuxt copies this string as-is to the `./.nuxt/tsconfig.json`, therefore it needs to be relative to that directory
     },
   },
   imports: {

package/src/generators/application/files/src/server/api/greet.ts__tmpl__

@@ -5,6 +5,6 @@ export default defineEventHandler((event) => {
   const name = q.name || 'World';
 
   return {
-    message: `Hello ${name}`,
+    message: `Hello ${projectName}`,
   };
 });

package/src/generators/application/lib/add-e2e.js

@@ -20,12 +20,12 @@ async function addE2e(host, options) {
             directory: 'src',
             bundler: 'vite',
             skipFormat: true,
-            devServerTarget: `${options.projectName}:serve`,
+            devServerTarget: `${options.projectName}:${options.e2eWebServerTarget}`,
             webServerCommands: {
-                default: `${(0, devkit_1.getPackageManagerCommand)().exec} nx serve ${options.projectName}`,
+                default: `${(0, devkit_1.getPackageManagerCommand)().exec} nx ${options.e2eWebServerTarget} ${options.projectName}`,
             },
             ciWebServerCommand: `nx run ${options.projectName}:serve-static`,
-            baseUrl: 'http://localhost:4200',
+            baseUrl: options.e2eWebServerAddress,
             jsx: true,
             addPlugin: true,
         });
@@ -46,8 +46,8 @@ async function addE2e(host, options) {
             js: false,
             linter: options.linter,
             setParserOptionsProject: options.setParserOptionsProject,
-            webServerAddress: 'http://localhost:4200',
-            webServerCommand: `${(0, devkit_1.getPackageManagerCommand)().exec} nx serve ${options.projectName}`,
+            webServerAddress: options.e2eWebServerAddress,
+            webServerCommand: `${(0, devkit_1.getPackageManagerCommand)().exec} nx ${options.e2eWebServerTarget} ${options.projectName}`,
             addPlugin: true,
         });
     }

package/src/generators/application/lib/add-vitest.js

@@ -12,7 +12,7 @@ async function addVitest(tree, options) {
         : p.plugin === '@nx/nuxt/plugin');
     const { createOrEditViteConfig, vitestGenerator } = (0, devkit_1.ensurePackage)('@nx/vite', versions_1.nxVersion);
     const vitestTask = await vitestGenerator(tree, {
-        project: options.name,
+        project: options.projectName,
         uiFramework: 'none',
         coverageProvider: 'v8',
         skipFormat: true,
@@ -21,7 +21,7 @@ async function addVitest(tree, options) {
         addPlugin: true,
     }, hasPlugin);
     createOrEditViteConfig(tree, {
-        project: options.name,
+        project: options.projectName,
         includeLib: false,
         includeVitest: true,
         testEnvironment: 'jsdom',
@@ -31,6 +31,7 @@ async function addVitest(tree, options) {
     (0, devkit_1.updateJson)(tree, `${options.appProjectRoot}/tsconfig.spec.json`, (json) => {
         json.compilerOptions ??= {};
         json.compilerOptions.composite = true;
+        json.include = ['.nuxt/nuxt.d.ts', ...(json.include ?? [])];
         return json;
     });
     return vitestTask;

package/src/generators/application/lib/normalize-options.js

@@ -22,8 +22,26 @@ async function normalizeOptions(host, options, callingGenerator = '@nx/nuxt:appl
     });
     options.rootProject = appProjectRoot === '.';
     options.projectNameAndRootFormat = projectNameAndRootFormat;
+    const nxJson = (0, devkit_1.readNxJson)(host);
+    let e2eWebServerTarget = 'serve';
+    if (nxJson.plugins) {
+        for (const plugin of nxJson.plugins) {
+            if (typeof plugin === 'object' &&
+                plugin.plugin === '@nx/nuxt/plugin' &&
+                plugin.options.serveTargetName) {
+                e2eWebServerTarget = plugin.options
+                    .serveTargetName;
+            }
+        }
+    }
+    let e2ePort = 4200;
+    if (nxJson.targetDefaults?.[e2eWebServerTarget] &&
+        nxJson.targetDefaults?.[e2eWebServerTarget].options?.port) {
+        e2ePort = nxJson.targetDefaults?.[e2eWebServerTarget].options?.port;
+    }
     const e2eProjectName = options.rootProject ? 'e2e' : `${appProjectName}-e2e`;
     const e2eProjectRoot = options.rootProject ? 'e2e' : `${appProjectRoot}-e2e`;
+    const e2eWebServerAddress = `http://localhost:${e2ePort}`;
     const parsedTags = options.tags
         ? options.tags.split(',').map((s) => s.trim())
         : [];
@@ -34,11 +52,14 @@ async function normalizeOptions(host, options, callingGenerator = '@nx/nuxt:appl
         appProjectRoot,
         e2eProjectName,
         e2eProjectRoot,
+        e2eWebServerAddress,
+        e2eWebServerTarget,
+        e2ePort,
         parsedTags,
         style: options.style ?? 'none',
     };
     normalized.unitTestRunner ??= 'vitest';
-    normalized.e2eTestRunner = normalized.e2eTestRunner ?? 'cypress';
+    normalized.e2eTestRunner = normalized.e2eTestRunner ?? 'playwright';
     return normalized;
 }
 exports.normalizeOptions = normalizeOptions;

package/src/generators/application/schema.d.ts

@@ -22,5 +22,8 @@ export interface NormalizedSchema extends Schema {
   appProjectRoot: string;
   e2eProjectName: string;
   e2eProjectRoot: string;
+  e2eWebServerAddress: string;
+  e2eWebServerTarget: string;
+  e2ePort: number;
   parsedTags: string[];
 }

package/src/generators/application/schema.json

@@ -49,10 +49,10 @@
     },
     "e2eTestRunner": {
       "type": "string",
-      "enum": ["cypress", "playwright", "none"],
+      "enum": ["playwright", "cypress", "none"],
       "description": "Test runner to use for end to end (E2E) tests.",
       "x-prompt": "Which E2E test runner would you like to use?",
-      "default": "cypress"
+      "default": "playwright"
     },
     "tags": {
       "type": "string",

package/src/generators/init/init.js

@@ -1,18 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.nuxtInitGenerator = void 0;
-const update_package_scripts_1 = require("@nx/devkit/src/utils/update-package-scripts");
+const devkit_1 = require("@nx/devkit");
+const add_plugin_1 = require("@nx/devkit/src/utils/add-plugin");
 const plugin_1 = require("../../plugins/plugin");
 const utils_1 = require("./lib/utils");
 async function nuxtInitGenerator(host, schema) {
-    (0, utils_1.addPlugin)(host);
+    await (0, add_plugin_1.addPluginV1)(host, await (0, devkit_1.createProjectGraphAsync)(), '@nx/nuxt/plugin', plugin_1.createNodes, {
+        buildTargetName: ['build', 'nuxt:build', 'nuxt-build'],
+        serveTargetName: ['serve', 'nuxt:serve', 'nuxt-serve'],
+    }, schema.updatePackageScripts);
     let installTask = () => { };
     if (!schema.skipPackageJson) {
         installTask = (0, utils_1.updateDependencies)(host, schema);
     }
-    if (schema.updatePackageScripts) {
-        await (0, update_package_scripts_1.updatePackageScripts)(host, plugin_1.createNodes);
-    }
     return installTask;
 }
 exports.nuxtInitGenerator = nuxtInitGenerator;

package/src/plugins/plugin.js

@@ -6,20 +6,23 @@ const path_1 = require("path");
 const cache_directory_1 = require("nx/src/utils/cache-directory");
 const get_named_inputs_1 = require("@nx/devkit/src/utils/get-named-inputs");
 const fs_1 = require("fs");
-const executor_utils_1 = require("../utils/executor-utils");
 const calculate_hash_for_create_nodes_1 = require("@nx/devkit/src/utils/calculate-hash-for-create-nodes");
 const js_1 = require("@nx/js");
-const cachePath = (0, path_1.join)(cache_directory_1.projectGraphCacheDirectory, 'nuxt.hash');
-const targetsCache = (0, fs_1.existsSync)(cachePath) ? readTargetsCache() : {};
-const calculatedTargets = {};
+const config_utils_1 = require("@nx/devkit/src/utils/config-utils");
+const cachePath = (0, path_1.join)(cache_directory_1.workspaceDataDirectory, 'nuxt.hash');
+const targetsCache = readTargetsCache();
 function readTargetsCache() {
-    return (0, devkit_1.readJsonFile)(cachePath);
+    return (0, fs_1.existsSync)(cachePath) ? (0, devkit_1.readJsonFile)(cachePath) : {};
 }
-function writeTargetsToCache(targets) {
-    (0, devkit_1.writeJsonFile)(cachePath, targets);
+function writeTargetsToCache() {
+    const oldCache = readTargetsCache();
+    (0, devkit_1.writeJsonFile)(cachePath, {
+        ...oldCache,
+        ...targetsCache,
+    });
 }
 const createDependencies = () => {
-    writeTargetsToCache(calculatedTargets);
+    writeTargetsToCache();
     return [];
 };
 exports.createDependencies = createDependencies;
@@ -34,18 +37,13 @@ exports.createNodes = [
             return {};
         }
         options = normalizeOptions(options);
-        const hash = (0, calculate_hash_for_create_nodes_1.calculateHashForCreateNodes)(projectRoot, options, context, [
-            (0, js_1.getLockFileName)((0, devkit_1.detectPackageManager)(context.workspaceRoot)),
-        ]);
-        const targets = targetsCache[hash]
-            ? targetsCache[hash]
-            : await buildNuxtTargets(configFilePath, projectRoot, options, context);
-        calculatedTargets[hash] = targets;
+        const hash = await (0, calculate_hash_for_create_nodes_1.calculateHashForCreateNodes)(projectRoot, options, context, [(0, js_1.getLockFileName)((0, devkit_1.detectPackageManager)(context.workspaceRoot))]);
+        targetsCache[hash] ??= await buildNuxtTargets(configFilePath, projectRoot, options, context);
         return {
             projects: {
                 [projectRoot]: {
                     root: projectRoot,
-                    targets,
+                    targets: targetsCache[hash],
                 },
             },
         };
@@ -95,6 +93,8 @@ function serveStaticTarget(options) {
             buildTarget: `${options.buildStaticTargetName}`,
             staticFilePath: '{projectRoot}/dist',
             port: 4200,
+            // Routes are found correctly with serve-static
+            spa: false,
         },
     };
     return targetConfig;
@@ -118,25 +118,19 @@ function buildStaticTarget(buildStaticTargetName, namedInputs, buildOutputs, pro
     return targetConfig;
 }
 async function getInfoFromNuxtConfig(configFilePath, context, projectRoot) {
-    const { loadNuxtConfig } = await (0, executor_utils_1.loadNuxtKitDynamicImport)();
-    const config = await loadNuxtConfig({
-        cwd: (0, devkit_1.joinPathFragments)(context.workspaceRoot, projectRoot),
-        configFile: (0, path_1.basename)(configFilePath),
-    });
+    // TODO(Colum): Once plugins are isolated we can go back to @nuxt/kit since each plugin will be run in its own worker.
+    const config = await (0, config_utils_1.loadConfigFile)((0, path_1.join)(context.workspaceRoot, configFilePath));
     return {
-        buildDir: config?.buildDir,
+        buildDir: config?.buildDir ??
+            // Match .nuxt default build dir from '@nuxt/schema'
+            // See: https://github.com/nuxt/nuxt/blob/871404ae5673425aeedde82f123ea58aa7c6facf/packages/schema/src/config/common.ts#L117-L119
+            '.nuxt',
     };
 }
 function getOutputs(nuxtConfig, projectRoot) {
-    let nuxtBuildDir = nuxtConfig?.buildDir;
-    if (nuxtConfig?.buildDir && (0, path_1.basename)(nuxtConfig?.buildDir) === '.nuxt') {
-        // if buildDir exists, it will be `something/something/.nuxt`
-        // we want the "general" outputPath to be `something/something`
-        nuxtBuildDir = nuxtConfig.buildDir.replace((0, path_1.basename)(nuxtConfig.buildDir), '');
-    }
-    const buildOutputPath = normalizeOutputPath(nuxtBuildDir, projectRoot);
+    const buildOutputPath = normalizeOutputPath(nuxtConfig?.buildDir, projectRoot);
     return {
-        buildOutputs: [buildOutputPath],
+        buildOutputs: [buildOutputPath, '{projectRoot}/.output'],
     };
 }
 function normalizeOutputPath(outputPath, projectRoot) {

package/src/utils/add-linting.js

@@ -19,7 +19,7 @@ async function addLinting(host, options) {
             addPlugin: true,
         });
         tasks.push(lintTask);
-        (0, vue_1.editEslintConfigFiles)(host, options.projectRoot, options.rootProject);
+        (0, vue_1.editEslintConfigFiles)(host, options.projectRoot);
         (0, devkit_1.updateJson)(host, (0, path_1.joinPathFragments)(options.projectRoot, '.eslintrc.json'), (json) => {
             const { extends: pluginExtends, ignorePatterns: pluginIgnorePatters, ...config } = json;
             return {

package/src/utils/create-ts-config.js

@@ -41,6 +41,7 @@ function createAppTsConfig(host, options) {
         compilerOptions: {
             composite: true,
         },
+        include: ['.nuxt/nuxt.d.ts', 'src/**/*'],
         exclude: [],
     };
     (0, devkit_1.writeJson)(host, `${options.projectRoot}/tsconfig.app.json`, json);

package/src/utils/versions.d.ts

@@ -3,4 +3,4 @@ export declare const h3Version = "^1.8.2";
 export declare const nuxtVersion = "^3.10.0";
 export declare const nuxtDevtoolsVersion = "1.0.0";
 export declare const nuxtUiTemplatesVersion = "^1.3.1";
-export declare const nuxtEslintConfigVersion = "0.2.0";
+export declare const nuxtEslintConfigVersion = "~0.3.6";

package/src/utils/versions.js

@@ -8,4 +8,4 @@ exports.nuxtVersion = '^3.10.0';
 exports.nuxtDevtoolsVersion = '1.0.0';
 exports.nuxtUiTemplatesVersion = '^1.3.1';
 // linting deps
-exports.nuxtEslintConfigVersion = '0.2.0';
+exports.nuxtEslintConfigVersion = '~0.3.6';