@nx/plugin 0.0.0-pr-31222-862e973 → 0.0.0-pr-31313-387cdca

package/src/generators/preset/generator.js

@@ -1,23 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = default_1;
+exports.presetGenerator = presetGenerator;
+exports.presetGeneratorInternal = presetGeneratorInternal;
 const devkit_1 = require("@nx/devkit");
-const eslint_1 = require("@nx/eslint");
-const plugin_1 = require("../plugin/plugin");
+const ts_solution_setup_1 = require("@nx/js/src/utils/typescript/ts-solution-setup");
 const create_package_1 = require("../create-package/create-package");
-async function default_1(tree, options) {
+const plugin_1 = require("../plugin/plugin");
+async function presetGenerator(tree, rawOptions) {
+    return await presetGeneratorInternal(tree, {
+        addPlugin: false,
+        useProjectJson: true,
+        ...rawOptions,
+    });
+}
+async function presetGeneratorInternal(tree, rawOptions) {
     const tasks = [];
-    const pluginProjectName = (0, devkit_1.names)(options.pluginName.includes('/')
-        ? options.pluginName.split('/')[1]
-        : options.pluginName).fileName;
-    options.createPackageName =
-        options.createPackageName === 'false' // for command line in e2e, it is passed as a string
-            ? undefined
-            : options.createPackageName;
+    const options = normalizeOptions(tree, rawOptions);
     const pluginTask = await (0, plugin_1.pluginGenerator)(tree, {
         compiler: 'tsc',
-        linter: eslint_1.Linter.EsLint,
-        name: pluginProjectName,
+        linter: 'eslint',
         skipFormat: true,
         unitTestRunner: 'jest',
         importPath: options.pluginName,
@@ -25,23 +26,27 @@ async function default_1(tree, options) {
         publishable: true,
         // when creating a CLI package, the plugin will be in the packages folder
         directory: options.createPackageName && options.createPackageName !== 'false'
-            ? 'packages'
-            : undefined,
+            ? `packages/${options.pluginName}`
+            : options.pluginName,
         rootProject: options.createPackageName ? false : true,
+        useProjectJson: options.useProjectJson,
+        addPlugin: options.addPlugin,
     });
     tasks.push(pluginTask);
     moveNxPluginToDevDeps(tree);
     if (options.createPackageName) {
         const e2eProject = `${options.pluginName}-e2e`;
-        const cliTask = await (0, create_package_1.default)(tree, {
-            directory: 'packages',
+        const cliTask = await (0, create_package_1.createPackageGenerator)(tree, {
+            directory: `packages/${options.createPackageName}`,
             name: options.createPackageName,
             e2eProject: e2eProject,
             project: options.pluginName,
             skipFormat: true,
             unitTestRunner: 'jest',
-            linter: eslint_1.Linter.EsLint,
+            linter: 'eslint',
             compiler: 'tsc',
+            useProjectJson: options.useProjectJson,
+            addPlugin: options.addPlugin,
         });
         tasks.push(cliTask);
     }
@@ -50,9 +55,31 @@ async function default_1(tree, options) {
 }
 function moveNxPluginToDevDeps(tree) {
     (0, devkit_1.updateJson)(tree, 'package.json', (json) => {
-        const nxPluginEntry = json.dependencies['@nx/plugin'];
-        delete json.dependencies['@nx/plugin'];
-        json.devDependencies['@nx/plugin'] = nxPluginEntry;
+        if (json.dependencies['@nx/plugin']) {
+            const nxPluginEntry = json.dependencies['@nx/plugin'];
+            delete json.dependencies['@nx/plugin'];
+            json.devDependencies['@nx/plugin'] = nxPluginEntry;
+        }
         return json;
     });
 }
+function normalizeOptions(tree, options) {
+    const isTsSolutionSetup = (0, ts_solution_setup_1.isUsingTsSolutionSetup)(tree);
+    const nxJson = (0, devkit_1.readNxJson)(tree);
+    const addPlugin = options.addPlugin ??
+        (isTsSolutionSetup &&
+            process.env.NX_ADD_PLUGINS !== 'false' &&
+            nxJson.useInferencePlugins !== false);
+    return {
+        ...options,
+        pluginName: (0, devkit_1.names)(options.pluginName.includes('/')
+            ? options.pluginName.split('/')[1]
+            : options.pluginName).fileName,
+        createPackageName: options.createPackageName === 'false' // for command line in e2e, it is passed as a string
+            ? undefined
+            : options.createPackageName,
+        addPlugin,
+        useProjectJson: options.useProjectJson ?? !isTsSolutionSetup,
+    };
+}
+exports.default = presetGenerator;

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

@@ -1,4 +1,13 @@
 export interface PresetGeneratorSchema {
   pluginName: string;
   createPackageName?: string;
+  useProjectJson?: boolean;
+  addPlugin?: boolean;
+}
+
+export interface NormalizedPresetGeneratorOptions
+  extends PresetGeneratorSchema {
+  createPackageName: string;
+  useProjectJson: boolean;
+  addPlugin: boolean;
 }

package/src/generators/preset/schema.json

@@ -24,6 +24,10 @@
     "createPackageName": {
       "type": "string",
       "description": "Name of package which creates a workspace"
+    },
+    "useProjectJson": {
+      "type": "boolean",
+      "description": "Use a `project.json` configuration file instead of inlining the Nx configuration in the `package.json` file."
     }
   },
   "required": ["pluginName"]

package/src/utils/paths.d.ts

@@ -0,0 +1,2 @@
+import { type Tree } from '@nx/devkit';
+export declare function getArtifactMetadataDirectory(tree: Tree, projectName: string, sourceDirectory: string, isTsSolutionSetup: boolean): string;

package/src/utils/paths.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getArtifactMetadataDirectory = getArtifactMetadataDirectory;
+const devkit_1 = require("@nx/devkit");
+const posix_1 = require("node:path/posix");
+function getArtifactMetadataDirectory(tree, projectName, sourceDirectory, isTsSolutionSetup) {
+    const project = (0, devkit_1.readProjectConfiguration)(tree, projectName);
+    if (!isTsSolutionSetup) {
+        return `./${(0, posix_1.relative)(project.root, sourceDirectory)}`;
+    }
+    const target = Object.values(project.targets ?? {}).find((t) => t.executor === '@nx/js:tsc' || t.executor === '@nx/js:swc');
+    // the repo is using the new ts setup where the outputs are contained inside the project
+    if (target?.executor === '@nx/js:tsc') {
+        // the @nx/js:tsc executor defaults rootDir to the project root
+        return `./${(0, posix_1.join)('dist', (0, posix_1.relative)(target.options.rootDir ?? project.root, sourceDirectory))}`;
+    }
+    if (target?.executor === '@nx/js:swc') {
+        return `./${(0, posix_1.join)('dist', target.options.stripLeadingPaths
+            ? (0, posix_1.relative)((0, posix_1.dirname)(target.options.main), sourceDirectory)
+            : (0, posix_1.relative)(project.root, sourceDirectory))}`;
+    }
+    // We generate the plugin with the executors above, so we shouldn't get here
+    // unless the user manually changed the build process. In that case, we can't
+    // reliably determine the output directory because it depends on the build
+    // tool, so we'll just assume some defaults.
+    const baseDir = project.sourceRoot ??
+        (tree.exists((0, posix_1.join)(project.root, 'src'))
+            ? (0, posix_1.join)(project.root, 'src')
+            : project.root);
+    return `./${(0, posix_1.join)('dist', (0, posix_1.relative)(baseDir, sourceDirectory))}`;
+}

package/src/utils/testing-utils/async-commands.js

@@ -19,7 +19,7 @@ function runCommandAsync(command, opts = {
         (0, child_process_1.exec)(command, {
             cwd: opts.cwd ?? (0, paths_1.tmpProjPath)(),
             env: { ...process.env, ...opts.env },
-            windowsHide: true,
+            windowsHide: false,
         }, (err, stdout, stderr) => {
             if (!opts.silenceError && err) {
                 reject(err);

package/src/utils/testing-utils/commands.js

@@ -21,7 +21,7 @@ function runNxCommand(command, opts = {
         const execSyncOptions = {
             cwd,
             env: { ...process.env, ...opts.env },
-            windowsHide: true,
+            windowsHide: false,
         };
         if ((0, utils_1.fileExists)((0, paths_1.tmpProjPath)('package.json'))) {
             const pmc = (0, devkit_1.getPackageManagerCommand)((0, devkit_1.detectPackageManager)(cwd));

package/src/utils/testing-utils/nx-project.js

@@ -17,7 +17,7 @@ function runNxNewCommand(args, silent) {
     return (0, child_process_1.execSync)(`node ${require.resolve('nx')} new proj --nx-workspace-root=${localTmpDir} --no-interactive --skip-install --collection=@nx/workspace --npmScope=proj --preset=apps ${args || ''}`, {
         cwd: localTmpDir,
         ...(silent && false ? { stdio: ['ignore', 'ignore', 'ignore'] } : {}),
-        windowsHide: true,
+        windowsHide: false,
     });
 }
 function patchPackageJsonForPlugin(npmPackageName, distPath) {
@@ -45,7 +45,7 @@ function runPackageManagerInstall(silent = true) {
     const install = (0, child_process_1.execSync)(pmc.install, {
         cwd,
         ...(silent ? { stdio: ['ignore', 'ignore', 'ignore'] } : {}),
-        windowsHide: true,
+        windowsHide: false,
     });
     return install ? install.toString() : '';
 }

package/src/migrations/update-16-0-0/cli-in-schema-json.d.ts

@@ -1,3 +0,0 @@
-import { Tree } from '@nx/devkit';
-export declare function updateCliPropsForPlugins(tree: Tree): void;
-export default updateCliPropsForPlugins;

package/src/migrations/update-16-0-0/cli-in-schema-json.js

@@ -1,134 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateCliPropsForPlugins = updateCliPropsForPlugins;
-const devkit_1 = require("@nx/devkit");
-const package_json_1 = require("nx/src/utils/package-json");
-const path_1 = require("path");
-function updateCliPropsForPlugins(tree) {
-    const projects = (0, devkit_1.getProjects)(tree);
-    for (const project of projects.values()) {
-        if (tree.exists((0, devkit_1.joinPathFragments)(project.root, 'package.json'))) {
-            const packageJson = (0, devkit_1.readJson)(tree, (0, devkit_1.joinPathFragments)(project.root, 'package.json'));
-            const migrateConfig = (0, package_json_1.readNxMigrateConfig)(packageJson);
-            if (migrateConfig.migrations) {
-                const migrationsPath = (0, devkit_1.joinPathFragments)(project.root, migrateConfig.migrations);
-                if (tree.exists(migrationsPath)) {
-                    updateMigrationsJsonForPlugin(tree, migrationsPath);
-                }
-                else {
-                    devkit_1.output.warn({
-                        title: `Migrations file specified for ${packageJson.name} does not exist: ${migrationsPath}`,
-                        bodyLines: [
-                            'Please ensure that migrations that use the Angular Devkit are placed inside the `schematics` property, and migrations that use the Nx Devkit are placed inside the `generators` property.',
-                        ],
-                    });
-                }
-            }
-            if (packageJson.generators) {
-                const generatorsPath = (0, devkit_1.joinPathFragments)(project.root, packageJson.generators);
-                if (tree.exists(generatorsPath)) {
-                    removeCliFromGeneratorSchemaJsonFiles(tree, generatorsPath);
-                }
-                else {
-                    devkit_1.output.warn({
-                        title: `Generators file specified for ${packageJson.name} does not exist: ${generatorsPath}`,
-                        bodyLines: [
-                            "The `cli` property inside generator's `schema.json` files is no longer supported.",
-                        ],
-                    });
-                }
-            }
-            if (packageJson.executors) {
-                const executorsPath = (0, devkit_1.joinPathFragments)(project.root, packageJson.executors);
-                if (tree.exists(executorsPath)) {
-                    removeCliFromExecutorSchemaJsonFiles(tree, executorsPath);
-                }
-                else {
-                    devkit_1.output.warn({
-                        title: `Executors file specified for ${packageJson.name} does not exist: ${executorsPath}`,
-                        bodyLines: [
-                            "The `cli` property inside executor's `schema.json` files is no longer supported.",
-                        ],
-                    });
-                }
-            }
-            if (packageJson.builders) {
-                const buildersPath = (0, devkit_1.joinPathFragments)(project.root, packageJson.builders);
-                if (tree.exists(buildersPath)) {
-                    removeCliFromExecutorSchemaJsonFiles(tree, buildersPath);
-                }
-                else {
-                    devkit_1.output.warn({
-                        title: `Builders file specified for ${packageJson.name} does not exist: ${buildersPath}`,
-                        bodyLines: [
-                            "The `cli` property inside builder's `schema.json` files is no longer supported.",
-                        ],
-                    });
-                }
-            }
-            if (packageJson.schematics) {
-                const schematicsPath = (0, devkit_1.joinPathFragments)(project.root, packageJson.schematics);
-                if (tree.exists(schematicsPath)) {
-                    removeCliFromGeneratorSchemaJsonFiles(tree, schematicsPath);
-                }
-                else {
-                    devkit_1.output.warn({
-                        title: `Schematics file specified for ${packageJson.name} does not exist: ${schematicsPath}`,
-                        bodyLines: [
-                            "The `cli` property inside schematic's `schema.json` files is no longer supported.",
-                        ],
-                    });
-                }
-            }
-        }
-    }
-}
-function removeCliFromExecutorSchemaJsonFiles(tree, collectionPath) {
-    const collection = (0, devkit_1.readJson)(tree, collectionPath);
-    for (const [name, entry] of Object.entries(collection.executors ?? {}).concat(Object.entries(collection.builders ?? {}))) {
-        deleteCliPropFromSchemaFile(collectionPath, entry, tree);
-    }
-}
-function removeCliFromGeneratorSchemaJsonFiles(tree, collectionPath) {
-    const collection = (0, devkit_1.readJson)(tree, collectionPath);
-    for (const [name, entry] of Object.entries(collection.generators ?? {}).concat(Object.entries(collection.schematics ?? {}))) {
-        deleteCliPropFromSchemaFile(collectionPath, entry, tree);
-    }
-}
-function updateMigrationsJsonForPlugin(tree, collectionPath) {
-    (0, devkit_1.updateJson)(tree, collectionPath, (json) => {
-        for (const migration in json.generators ?? {}) {
-            if (!(json.generators[migration].cli === 'nx')) {
-                json.schematics ??= {};
-                json.schematics[migration] = json.generators[migration];
-                delete json.generators[migration];
-            }
-        }
-        for (const migration in json.schematics ?? {}) {
-            if (json.schematics[migration].cli === 'nx') {
-                json.generators ??= {};
-                json.generators[migration] = json.schematics[migration];
-                delete json.schematics[migration];
-            }
-        }
-        return json;
-    });
-}
-exports.default = updateCliPropsForPlugins;
-function deleteCliPropFromSchemaFile(collectionPath, entry, tree) {
-    if (typeof entry === 'string' || !entry.schema) {
-        return;
-    }
-    const schemaPath = (0, devkit_1.joinPathFragments)((0, path_1.dirname)(collectionPath), entry.schema);
-    if (tree.exists(schemaPath)) {
-        (0, devkit_1.updateJson)(tree, schemaPath, (json) => {
-            if (json.cli) {
-                delete json.cli;
-            }
-            return json;
-        });
-    }
-    else {
-        console.warn(`Could not find schema file ${schemaPath}`);
-    }
-}

package/src/migrations/update-16-0-0-add-nx-packages/update-16-0-0-add-nx-packages.d.ts

@@ -1,2 +0,0 @@
-import { Tree } from '@nx/devkit';
-export default function replacePackage(tree: Tree): Promise<void>;

package/src/migrations/update-16-0-0-add-nx-packages/update-16-0-0-add-nx-packages.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = replacePackage;
-const devkit_1 = require("@nx/devkit");
-const replace_package_1 = require("@nx/devkit/src/utils/replace-package");
-async function replacePackage(tree) {
-    await (0, replace_package_1.replaceNrwlPackageWithNxPackage)(tree, '@nrwl/nx-plugin', '@nx/plugin');
-    await (0, devkit_1.formatFiles)(tree);
-}

package/src/migrations/update-16-2-0/replace-e2e-executor.d.ts

@@ -1,7 +0,0 @@
-import { Tree } from '@nx/devkit';
-import { JestExecutorOptions } from '@nx/jest/src/executors/jest/schema';
-export interface NxPluginE2EExecutorOptions extends JestExecutorOptions {
-    target: string;
-    jestConfig: string;
-}
-export default function replaceE2EExecutor(tree: Tree): Promise<void>;

package/src/migrations/update-16-2-0/replace-e2e-executor.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = replaceE2EExecutor;
-const devkit_1 = require("@nx/devkit");
-const executor_options_utils_1 = require("@nx/devkit/src/generators/executor-options-utils");
-async function replaceE2EExecutor(tree) {
-    const projects = (0, devkit_1.getProjects)(tree);
-    for (const executor of ['@nx/plugin:e2e', '@nrwl/nx-plugin:e2e']) {
-        (0, executor_options_utils_1.forEachExecutorOptions)(tree, executor, (options, project, target, configuration) => {
-            const projectConfiguration = projects.get(project);
-            const config = {
-                ...options,
-                target: undefined,
-                runInBand: true,
-            };
-            if (configuration) {
-                projectConfiguration.targets[target].configurations[configuration] =
-                    config;
-            }
-            else {
-                projectConfiguration.targets[target].dependsOn = [
-                    ...(projectConfiguration.targets[target].dependsOn ?? []),
-                    options.target,
-                ];
-                projectConfiguration.targets[target].executor = '@nx/jest:jest';
-                projectConfiguration.targets[target].options = config;
-            }
-            (0, devkit_1.updateProjectConfiguration)(tree, project, projectConfiguration);
-        });
-    }
-    await (0, devkit_1.formatFiles)(tree);
-}