@nx/js 21.2.3 → 21.3.0-beta.0

package/executors.json

@@ -22,6 +22,11 @@
       "schema": "./src/executors/node/schema.json",
       "description": "Execute a Node application."
     },
+    "prune-lockfile": {
+      "implementation": "./src/executors/prune-lockfile/prune-lockfile",
+      "schema": "./src/executors/prune-lockfile/schema.json",
+      "description": "Creates a pruned lockfile based on the project dependencies and places it into the output directory."
+    },
     "release-publish": {
       "implementation": "./src/executors/release-publish/release-publish.impl",
       "schema": "./src/executors/release-publish/schema.json",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/js",
-  "version": "21.2.3",
+  "version": "21.3.0-beta.0",
   "private": false,
   "description": "The JS plugin for Nx contains executors and generators that provide the best experience for developing JavaScript and TypeScript projects. ",
   "repository": {
@@ -39,8 +39,8 @@
     "@babel/preset-env": "^7.23.2",
     "@babel/preset-typescript": "^7.22.5",
     "@babel/runtime": "^7.22.6",
-    "@nx/devkit": "21.2.3",
-    "@nx/workspace": "21.2.3",
+    "@nx/devkit": "21.3.0-beta.0",
+    "@nx/workspace": "21.3.0-beta.0",
     "@zkochan/js-yaml": "0.0.7",
     "babel-plugin-const-enum": "^1.0.1",
     "babel-plugin-macros": "^3.1.0",

package/src/executors/copy-workspace-modules/copy-workspace-modules.js

@@ -6,7 +6,8 @@ const utils_1 = require("nx/src/tasks-runner/utils");
 const node_fs_1 = require("node:fs");
 const path_1 = require("path");
 const fs_1 = require("fs");
-const get_workspace_packages_from_graph_1 = require("../../utils/package-json/get-workspace-packages-from-graph");
+// eslint-disable-next-line @typescript-eslint/no-restricted-imports
+const get_workspace_packages_from_graph_1 = require("nx/src/plugins/js/utils/get-workspace-packages-from-graph");
 async function copyWorkspaceModules(schema, context) {
     devkit_1.logger.log('Copying Workspace Modules to Build Directory...');
     const outputDirectory = getOutputDir(schema, context);

package/src/executors/prune-lockfile/prune-lockfile.d.ts

@@ -0,0 +1,5 @@
+import { type ExecutorContext } from '@nx/devkit';
+import { type PruneLockfileOptions } from './schema';
+export default function pruneLockfileExecutor(schema: PruneLockfileOptions, context: ExecutorContext): Promise<{
+    success: boolean;
+}>;

package/src/executors/prune-lockfile/prune-lockfile.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = pruneLockfileExecutor;
+const devkit_1 = require("@nx/devkit");
+const fs_1 = require("fs");
+const path_1 = require("path");
+const utils_1 = require("nx/src/tasks-runner/utils");
+// eslint-disable-next-line @typescript-eslint/no-restricted-imports
+const lock_file_1 = require("nx/src/plugins/js/lock-file/lock-file");
+async function pruneLockfileExecutor(schema, context) {
+    devkit_1.logger.log('Pruning lockfile...');
+    const outputDirectory = getOutputDir(schema, context);
+    const packageJson = getPackageJson(schema, context);
+    const packageManager = (0, devkit_1.detectPackageManager)(devkit_1.workspaceRoot);
+    if (packageManager === 'bun') {
+        devkit_1.logger.warn('Bun lockfile generation is not supported. Only package.json will be generated. Run "bun install" in the output directory if needed.');
+        (0, fs_1.writeFileSync)((0, path_1.join)(outputDirectory, 'package.json'), JSON.stringify(packageJson, null, 2));
+    }
+    else {
+        const { lockfileName, lockFile } = createPrunedLockfile(packageJson, context.projectGraph);
+        const lockfileOutputPath = (0, path_1.join)(outputDirectory, lockfileName);
+        (0, fs_1.writeFileSync)(lockfileOutputPath, lockFile);
+        (0, fs_1.writeFileSync)((0, path_1.join)(outputDirectory, 'package.json'), JSON.stringify(packageJson, null, 2));
+        devkit_1.logger.log(`Lockfile pruned: ${lockfileOutputPath}`);
+    }
+    return {
+        success: true,
+    };
+}
+function createPrunedLockfile(packageJson, graph) {
+    const packageManager = (0, devkit_1.detectPackageManager)(devkit_1.workspaceRoot);
+    const lockfileName = (0, lock_file_1.getLockFileName)(packageManager);
+    const lockFile = (0, lock_file_1.createLockFile)(packageJson, graph, packageManager);
+    for (const [pkgName, pkgVersion] of Object.entries(packageJson.dependencies ?? {})) {
+        if (pkgVersion.startsWith('workspace:') ||
+            pkgVersion.startsWith('file:') ||
+            pkgVersion.startsWith('link:')) {
+            packageJson.dependencies[pkgName] = `file:./workspace_modules/${pkgName}`;
+        }
+    }
+    return {
+        lockfileName,
+        lockFile,
+    };
+}
+function getPackageJson(schema, context) {
+    const target = (0, devkit_1.parseTargetString)(schema.buildTarget, context);
+    const project = context.projectGraph.nodes[target.project].data;
+    const packageJsonPath = (0, path_1.join)(devkit_1.workspaceRoot, project.root, 'package.json');
+    if (!(0, fs_1.existsSync)(packageJsonPath)) {
+        throw new Error(`${packageJsonPath} does not exist.`);
+    }
+    const packageJson = (0, devkit_1.readJsonFile)(packageJsonPath);
+    return packageJson;
+}
+function getOutputDir(schema, context) {
+    let outputDir = schema.outputPath;
+    if (outputDir) {
+        outputDir = normalizeOutputPath(outputDir);
+        if ((0, fs_1.existsSync)(outputDir)) {
+            return outputDir;
+        }
+    }
+    const target = (0, devkit_1.parseTargetString)(schema.buildTarget, context);
+    const project = context.projectGraph.nodes[target.project].data;
+    const buildTarget = project.targets[target.target];
+    let maybeOutputPath = buildTarget.outputs?.[0] ??
+        buildTarget.options.outputPath ??
+        buildTarget.options.outputDir;
+    if (!maybeOutputPath) {
+        throw new Error(`Could not infer an output directory from the '${schema.buildTarget}' target. Please provide 'outputPath'.`);
+    }
+    maybeOutputPath = (0, utils_1.interpolate)(maybeOutputPath, {
+        workspaceRoot: devkit_1.workspaceRoot,
+        projectRoot: project.root,
+        projectName: project.name,
+        options: {
+            ...(buildTarget.options ?? {}),
+        },
+    });
+    outputDir = normalizeOutputPath(maybeOutputPath);
+    if (!(0, fs_1.existsSync)(outputDir)) {
+        throw new Error(`The output directory '${outputDir}' inferred from the '${schema.buildTarget}' target does not exist.\nPlease ensure a build has run first, and that the path is correct. Otherwise, please provide 'outputPath'.`);
+    }
+    return outputDir;
+}
+function normalizeOutputPath(outputPath) {
+    if (!outputPath.startsWith(devkit_1.workspaceRoot)) {
+        outputPath = (0, path_1.join)(devkit_1.workspaceRoot, outputPath);
+    }
+    if (!(0, fs_1.lstatSync)(outputPath).isDirectory()) {
+        outputPath = (0, path_1.dirname)(outputPath);
+    }
+    return outputPath;
+}

package/src/executors/prune-lockfile/schema.d.ts

@@ -0,0 +1,4 @@
+export interface PruneLockfileOptions {
+  buildTarget: string;
+  outputPath?: string;
+}

package/src/executors/prune-lockfile/schema.json

@@ -0,0 +1,20 @@
+{
+  "version": 2,
+  "outputCapture": "direct-nodejs",
+  "title": "Prune Lockfile",
+  "description": "Creates a pruned lockfile based on the project dependencies and places it into the output directory.",
+  "cli": "nx",
+  "type": "object",
+  "properties": {
+    "buildTarget": {
+      "type": "string",
+      "description": "The build target that produces the output directory to place the pruned lockfile.",
+      "default": "build"
+    },
+    "outputPath": {
+      "type": "string",
+      "description": "The output path to place the pruned lockfile. Usually inferred from the outputs of the buildTarget."
+    }
+  },
+  "required": ["buildTarget"]
+}

package/src/generators/library/library.js

@@ -43,6 +43,10 @@ async function libraryGeneratorInternal(tree, schema) {
         formatter: (0, ts_solution_setup_1.isUsingTsSolutionSetup)(tree) ? 'none' : 'prettier',
     }));
     const options = await normalizeOptions(tree, schema);
+    if (schema.simpleName !== undefined && schema.simpleName !== false) {
+        // TODO(v22): Remove simpleName as user should be using name.
+        devkit_1.logger.warn(`The "--simpleName" option is deprecated and will be removed in Nx 22. Please use the "--name" option to provide the exact name you want for the library.`);
+    }
     createFiles(tree, options);
     await configureProject(tree, options);
     if (!options.skipPackageJson) {

package/src/generators/library/schema.json

@@ -130,7 +130,8 @@
     "simpleName": {
       "description": "Don't include the directory in the generated file name.",
       "type": "boolean",
-      "default": false
+      "default": false,
+      "x-deprecated": "Use the --name option to provide the exact name instead. This option will be removed in Nx 22."
     },
     "useProjectJson": {
       "type": "boolean",

package/src/generators/setup-build/generator.js

@@ -5,12 +5,12 @@ const devkit_1 = require("@nx/devkit");
 const target_defaults_utils_1 = require("@nx/devkit/src/generators/target-defaults-utils");
 const posix_1 = require("node:path/posix");
 const devkit_internals_1 = require("nx/src/devkit-internals");
+const plugin_1 = require("../../utils/typescript/plugin");
 const get_import_path_1 = require("../../utils/get-import-path");
 const update_package_json_1 = require("../../utils/package-json/update-package-json");
 const add_swc_config_1 = require("../../utils/swc/add-swc-config");
 const add_swc_dependencies_1 = require("../../utils/swc/add-swc-dependencies");
 const ensure_typescript_1 = require("../../utils/typescript/ensure-typescript");
-const plugin_1 = require("../../utils/typescript/plugin");
 const ts_config_1 = require("../../utils/typescript/ts-config");
 const ts_solution_setup_1 = require("../../utils/typescript/ts-solution-setup");
 const versions_1 = require("../../utils/versions");
@@ -29,7 +29,7 @@ async function setupBuildGenerator(tree, options) {
         mainFile = options.main;
     }
     else {
-        const root = (0, ts_solution_setup_1.getProjectSourceRoot)(project, tree);
+        const root = project.sourceRoot ?? project.root;
         for (const f of [
             (0, devkit_1.joinPathFragments)(root, 'main.ts'),
             (0, devkit_1.joinPathFragments)(root, 'main.js'),

package/src/utils/inline.js

@@ -7,7 +7,6 @@ exports.getRootTsConfigPath = getRootTsConfigPath;
 const devkit_1 = require("@nx/devkit");
 const node_fs_1 = require("node:fs");
 const path_1 = require("path");
-const ts_solution_setup_1 = require("./typescript/ts-solution-setup");
 function isInlineGraphEmpty(inlineGraph) {
     return Object.keys(inlineGraph.nodes).length === 0;
 }
@@ -73,7 +72,7 @@ function projectNodeToInlineProjectNode(projectNode, pathAlias = '', buildOutput
     return {
         name: projectNode.name,
         root: projectNode.data.root,
-        sourceRoot: (0, ts_solution_setup_1.getProjectSourceRoot)(projectNode.data),
+        sourceRoot: projectNode.data.sourceRoot,
         pathAlias,
         buildOutputPath,
     };

package/src/utils/typescript/ts-solution-setup.d.ts

@@ -1,4 +1,4 @@
-import { type ProjectConfiguration, type Tree } from '@nx/devkit';
+import { type Tree } from '@nx/devkit';
 export declare function isUsingTypeScriptPlugin(tree: Tree): boolean;
 export declare function isUsingTsSolutionSetup(tree?: Tree): boolean;
 export declare function assertNotUsingTsSolutionSetup(tree: Tree, pluginName: string, generatorName: string): void;
@@ -6,4 +6,4 @@ export declare function findRuntimeTsConfigName(projectRoot: string, tree?: Tree
 export declare function updateTsconfigFiles(tree: Tree, projectRoot: string, runtimeTsconfigFileName: string, compilerOptions: Record<string, string | boolean | string[]>, exclude?: string[], rootDir?: string): void;
 export declare function addProjectToTsSolutionWorkspace(tree: Tree, projectDir: string): Promise<void>;
 export declare function getProjectType(tree: Tree, projectRoot: string, projectType?: 'library' | 'application'): 'library' | 'application';
-export declare function getProjectSourceRoot(project: ProjectConfiguration, tree?: Tree): string;
+export declare function getProjectSourceRoot(tree: Tree, projectSourceRoot: string | undefined, projectRoot: string): string | undefined;

package/src/utils/typescript/ts-solution-setup.js

@@ -9,7 +9,6 @@ exports.addProjectToTsSolutionWorkspace = addProjectToTsSolutionWorkspace;
 exports.getProjectType = getProjectType;
 exports.getProjectSourceRoot = getProjectSourceRoot;
 const devkit_1 = require("@nx/devkit");
-const node_fs_1 = require("node:fs");
 const posix_1 = require("node:path/posix");
 const tree_1 = require("nx/src/generators/tree");
 const package_manager_workspaces_1 = require("../package-manager-workspaces");
@@ -207,15 +206,9 @@ function getProjectType(tree, projectRoot, projectType) {
         return 'application';
     return 'library';
 }
-function getProjectSourceRoot(project, tree) {
-    if (tree) {
-        return (project.sourceRoot ??
-            (tree.exists((0, devkit_1.joinPathFragments)(project.root, 'src'))
-                ? (0, devkit_1.joinPathFragments)(project.root, 'src')
-                : project.root));
-    }
-    return (project.sourceRoot ??
-        ((0, node_fs_1.existsSync)((0, posix_1.join)(devkit_1.workspaceRoot, project.root, 'src'))
-            ? (0, devkit_1.joinPathFragments)(project.root, 'src')
-            : project.root));
+function getProjectSourceRoot(tree, projectSourceRoot, projectRoot) {
+    return (projectSourceRoot ??
+        (tree.exists((0, devkit_1.joinPathFragments)(projectRoot, 'src'))
+            ? (0, devkit_1.joinPathFragments)(projectRoot, 'src')
+            : projectRoot));
 }

package/src/utils/package-json/get-workspace-packages-from-graph.d.ts

@@ -1,2 +0,0 @@
-import { type ProjectGraph, ProjectGraphProjectNode } from '@nx/devkit';
-export declare function getWorkspacePackagesFromGraph(graph: ProjectGraph): Map<string, ProjectGraphProjectNode>;

package/src/utils/package-json/get-workspace-packages-from-graph.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getWorkspacePackagesFromGraph = getWorkspacePackagesFromGraph;
-function getWorkspacePackagesFromGraph(graph) {
-    const workspacePackages = new Map();
-    for (const [projectName, project] of Object.entries(graph.nodes)) {
-        const pkgName = project.data?.metadata?.js?.packageName;
-        if (pkgName) {
-            workspacePackages.set(pkgName, project);
-        }
-    }
-    return workspacePackages;
-}