@nx/js 20.4.3 → 20.5.0-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/js",
-  "version": "20.4.3",
+  "version": "20.5.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": "20.4.3",
-    "@nx/workspace": "20.4.3",
+    "@nx/devkit": "20.5.0-beta.0",
+    "@nx/workspace": "20.5.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/node/node.impl.js

@@ -88,7 +88,7 @@ async function* nodeExecutor(options, context) {
                 start: async () => {
                     // Wait for build to finish.
                     const result = await buildResult;
-                    if (result && !result.success) {
+                    if (!result.success) {
                         // If in watch-mode, don't throw or else the process exits.
                         if (options.watch) {
                             if (!task.killed) {

package/src/generators/library/library.js

@@ -8,6 +8,7 @@ const project_name_and_root_utils_1 = require("@nx/devkit/src/generators/project
 const prompt_1 = require("@nx/devkit/src/generators/prompt");
 const target_defaults_utils_1 = require("@nx/devkit/src/generators/target-defaults-utils");
 const log_show_project_command_1 = require("@nx/devkit/src/utils/log-show-project-command");
+const find_matching_projects_1 = require("nx/src/utils/find-matching-projects");
 const path_1 = require("path");
 const generator_prompts_1 = require("../../utils/generator-prompts");
 const update_package_json_1 = require("../../utils/package-json/update-package-json");
@@ -21,9 +22,9 @@ 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");
 const init_1 = require("../init/init");
+const generator_1 = require("../setup-verdaccio/generator");
 const sort_fields_1 = require("../../utils/package-json/sort-fields");
 const get_import_path_1 = require("../../utils/get-import-path");
-const add_release_config_1 = require("./utils/add-release-config");
 const defaultOutputDirectory = 'dist';
 async function libraryGenerator(tree, schema) {
     return await libraryGeneratorInternal(tree, {
@@ -53,13 +54,15 @@ async function libraryGeneratorInternal(tree, schema) {
     if (!options.skipPackageJson) {
         tasks.push(addProjectDependencies(tree, options));
     }
+    if (options.publishable) {
+        tasks.push(await (0, generator_1.default)(tree, { ...options, skipFormat: true }));
+    }
     if (options.bundler === 'rollup') {
         const { configurationGenerator } = (0, devkit_1.ensurePackage)('@nx/rollup', versions_1.nxVersion);
         await configurationGenerator(tree, {
             project: options.name,
             compiler: 'swc',
             format: options.isUsingTsSolutionConfig ? ['esm'] : ['cjs', 'esm'],
-            skipFormat: true,
         });
     }
     if (options.bundler === 'vite') {
@@ -147,7 +150,9 @@ async function libraryGeneratorInternal(tree, schema) {
         await (0, devkit_1.formatFiles)(tree);
     }
     if (options.publishable) {
-        tasks.push(await (0, add_release_config_1.releaseTasks)(tree));
+        tasks.push(() => {
+            logNxReleaseDocsInfo();
+        });
     }
     // Always run install to link packages.
     if (options.isUsingTsSolutionConfig) {
@@ -214,12 +219,26 @@ async function configureProject(tree, options) {
         }
     }
     if (options.publishable) {
-        if (options.isUsingTsSolutionConfig) {
-            await (0, add_release_config_1.addReleaseConfigForTsSolution)(tree, options.name, projectConfiguration);
-        }
-        else {
-            await (0, add_release_config_1.addReleaseConfigForNonTsSolution)(tree, options.name, projectConfiguration, defaultOutputDirectory);
+        if (!options.isUsingTsSolutionConfig) {
+            const packageRoot = (0, devkit_1.joinPathFragments)(defaultOutputDirectory, '{projectRoot}');
+            projectConfiguration.targets ??= {};
+            projectConfiguration.targets['nx-release-publish'] = {
+                options: {
+                    packageRoot,
+                },
+            };
+            projectConfiguration.release = {
+                version: {
+                    generatorOptions: {
+                        packageRoot,
+                        // using git tags to determine the current version is required here because
+                        // the version in the package root is overridden with every build
+                        currentVersionResolver: 'git-tag',
+                    },
+                },
+            };
         }
+        await addProjectToNxReleaseConfig(tree, options, projectConfiguration);
     }
     if (!options.useProjectJson) {
         // we want the package.json as clean as possible, with the bare minimum
@@ -910,6 +929,96 @@ function determineEntryFields(options) {
         }
     }
 }
+function projectsConfigMatchesProject(projectsConfig, project) {
+    if (!projectsConfig) {
+        return false;
+    }
+    if (typeof projectsConfig === 'string') {
+        projectsConfig = [projectsConfig];
+    }
+    const graph = {
+        [project.name]: project,
+    };
+    const matchingProjects = (0, find_matching_projects_1.findMatchingProjects)(projectsConfig, graph);
+    return matchingProjects.includes(project.name);
+}
+async function addProjectToNxReleaseConfig(tree, options, projectConfiguration) {
+    const nxJson = (0, devkit_1.readNxJson)(tree);
+    const addPreVersionCommand = () => {
+        const pmc = (0, devkit_1.getPackageManagerCommand)();
+        nxJson.release = {
+            ...nxJson.release,
+            version: {
+                preVersionCommand: `${pmc.dlx} nx run-many -t build`,
+                ...nxJson.release?.version,
+            },
+        };
+    };
+    if (!nxJson.release || (!nxJson.release.projects && !nxJson.release.groups)) {
+        // skip adding any projects configuration since the new project should be
+        // automatically included by nx release's default project detection logic
+        addPreVersionCommand();
+        (0, devkit_1.writeJson)(tree, 'nx.json', nxJson);
+        return;
+    }
+    const project = {
+        name: options.name,
+        type: 'lib',
+        data: {
+            root: projectConfiguration.root,
+            tags: projectConfiguration.tags,
+        },
+    };
+    if (projectsConfigMatchesProject(nxJson.release.projects, project)) {
+        devkit_1.output.log({
+            title: `Project already included in existing release configuration`,
+        });
+        addPreVersionCommand();
+        (0, devkit_1.writeJson)(tree, 'nx.json', nxJson);
+        return;
+    }
+    if (Array.isArray(nxJson.release.projects)) {
+        nxJson.release.projects.push(options.name);
+        addPreVersionCommand();
+        (0, devkit_1.writeJson)(tree, 'nx.json', nxJson);
+        devkit_1.output.log({
+            title: `Added project to existing release configuration`,
+        });
+    }
+    if (nxJson.release.groups) {
+        const allGroups = Object.entries(nxJson.release.groups);
+        for (const [name, group] of allGroups) {
+            if (projectsConfigMatchesProject(group.projects, project)) {
+                addPreVersionCommand();
+                (0, devkit_1.writeJson)(tree, 'nx.json', nxJson);
+                return `Project already included in existing release configuration for group ${name}`;
+            }
+        }
+        devkit_1.output.warn({
+            title: `Could not find a release group that includes ${options.name}`,
+            bodyLines: [
+                `Ensure that ${options.name} is included in a release group's "projects" list in nx.json so it can be published with "nx release"`,
+            ],
+        });
+        addPreVersionCommand();
+        (0, devkit_1.writeJson)(tree, 'nx.json', nxJson);
+        return;
+    }
+    if (typeof nxJson.release.projects === 'string') {
+        nxJson.release.projects = [nxJson.release.projects, options.name];
+        addPreVersionCommand();
+        (0, devkit_1.writeJson)(tree, 'nx.json', nxJson);
+        devkit_1.output.log({
+            title: `Added project to existing release configuration`,
+        });
+        return;
+    }
+}
+function logNxReleaseDocsInfo() {
+    devkit_1.output.log({
+        title: `📦 To learn how to publish this library, see https://nx.dev/core-features/manage-releases.`,
+    });
+}
 function findRootJestPreset(tree) {
     const ext = ['js', 'cjs', 'mjs'].find((ext) => tree.exists(`jest.preset.${ext}`));
     return ext ? `jest.preset.${ext}` : null;

package/src/plugins/jest/start-local-registry.js

@@ -31,7 +31,7 @@ function startLocalRegistry({ localRegistryTarget, storage, verbose, clearStorag
                 const registry = `http://${listenAddress}:${port}`;
                 console.log(`Local registry started on ${registry}`);
                 process.env.npm_config_registry = registry;
-                (0, child_process_1.execSync)(`npm config set //${listenAddress}:${port}/:_authToken "secretVerdaccioToken" --ws=false`, {
+                (0, child_process_1.execSync)(`npm config set //${listenAddress}:${port}/:_authToken "secretVerdaccioToken"`, {
                     windowsHide: false,
                 });
                 // yarnv1
@@ -42,7 +42,7 @@ function startLocalRegistry({ localRegistryTarget, storage, verbose, clearStorag
                 console.log('Set npm and yarn config registry to ' + registry);
                 resolve(() => {
                     childProcess.kill();
-                    (0, child_process_1.execSync)(`npm config delete //${listenAddress}:${port}/:_authToken --ws=false`, {
+                    (0, child_process_1.execSync)(`npm config delete //${listenAddress}:${port}/:_authToken`, {
                         windowsHide: false,
                     });
                 });

package/src/plugins/typescript/plugin.d.ts

@@ -9,7 +9,6 @@ export interface TscPluginOptions {
         buildDepsName?: string;
         watchDepsName?: string;
     };
-    verboseOutput?: boolean;
 }
 /**
  * @deprecated The 'createDependencies' function is now a no-op. This functionality is included in 'createNodesV2'.

package/src/plugins/typescript/plugin.js

@@ -126,6 +126,11 @@ function buildTscTargets(configFilePath, projectRoot, options, context) {
     const targets = {};
     const namedInputs = (0, get_named_inputs_1.getNamedInputs)(projectRoot, context);
     const tsConfig = readCachedTsConfig(configFilePath);
+    // TODO: check whether we want to always run with --pretty --verbose, it makes replacing scripts harder
+    // `--verbose` conflicts with `tsc -b --clean`, might be another reason for not using it, it would
+    // prevent users from running the task with `--clean` flag.
+    // Should we consider creating a different optional target for `--clean`?
+    // Should we consider having a plugin option to disable `--pretty` and `--verbose`?
     let internalProjectReferences;
     // Typecheck target
     if ((0, node_path_1.basename)(configFilePath) === 'tsconfig.json' && options.typecheck) {
@@ -133,7 +138,7 @@ function buildTscTargets(configFilePath, projectRoot, options, context) {
         const externalProjectReferences = resolveShallowExternalProjectReferences(tsConfig, context.workspaceRoot, projectRoot);
         const targetName = options.typecheck.targetName;
         if (!targets[targetName]) {
-            let command = `tsc --build --emitDeclarationOnly${options.verboseOutput ? ' --verbose' : ''}`;
+            let command = `tsc --build --emitDeclarationOnly --pretty --verbose`;
             if (tsConfig.options.noEmit ||
                 Object.values(internalProjectReferences).some((ref) => ref.options.noEmit) ||
                 Object.values(externalProjectReferences).some((ref) => ref.options.noEmit)) {
@@ -169,7 +174,7 @@ function buildTscTargets(configFilePath, projectRoot, options, context) {
         const targetName = options.build.targetName;
         targets[targetName] = {
             dependsOn: [`^${targetName}`],
-            command: `tsc --build ${options.build.configName}${options.verboseOutput ? ' --verbose' : ''}`,
+            command: `tsc --build ${options.build.configName} --pretty --verbose`,
             options: { cwd: projectRoot },
             cache: true,
             inputs: getInputs(namedInputs, configFilePath, tsConfig, internalProjectReferences, context.workspaceRoot, projectRoot),
@@ -579,7 +584,6 @@ function normalizePluginOptions(pluginOptions = {}) {
     return {
         typecheck,
         build,
-        verboseOutput: pluginOptions.verboseOutput ?? false,
     };
 }
 function resolveExtendedTsConfigPath(tsConfigPath, directory) {

package/src/utils/npm-config.js

@@ -78,7 +78,10 @@ async function execAsync(command, cwd) {
     return new Promise((resolve, reject) => {
         (0, child_process_1.exec)(command, { cwd, windowsHide: false }, (error, stdout, stderr) => {
             if (error) {
-                return reject((stderr ? `${stderr}\n` : '') + error);
+                return reject(error);
+            }
+            if (stderr) {
+                return reject(stderr);
             }
             return resolve(stdout.trim());
         });

package/src/utils/swc/add-swc-config.d.ts

@@ -1,4 +1,4 @@
 import { type Tree } from '@nx/devkit';
 export declare const defaultExclude: string[];
-export declare function addSwcConfig(tree: Tree, projectDir: string, type?: 'commonjs' | 'es6', supportTsx?: boolean, swcName?: string, additionalExcludes?: string[]): void;
+export declare function addSwcConfig(tree: Tree, projectDir: string, type?: 'commonjs' | 'es6', supportTsx?: boolean): void;
 export declare function addSwcTestConfig(tree: Tree, projectDir: string, type?: 'commonjs' | 'es6', supportTsx?: boolean): void;

package/src/utils/swc/add-swc-config.js

@@ -43,11 +43,11 @@ const swcOptionsString = (type = 'commonjs', exclude, supportTsx) => `{
   "exclude": ${JSON.stringify(exclude)}
 }
 `;
-function addSwcConfig(tree, projectDir, type = 'commonjs', supportTsx = false, swcName = '.swcrc', additionalExcludes = []) {
-    const swcrcPath = (0, path_1.join)(projectDir, swcName);
+function addSwcConfig(tree, projectDir, type = 'commonjs', supportTsx = false) {
+    const swcrcPath = (0, path_1.join)(projectDir, '.swcrc');
     if (tree.exists(swcrcPath))
         return;
-    tree.write(swcrcPath, swcOptionsString(type, [...exports.defaultExclude, ...additionalExcludes], supportTsx));
+    tree.write(swcrcPath, swcOptionsString(type, exports.defaultExclude, supportTsx));
 }
 function addSwcTestConfig(tree, projectDir, type = 'commonjs', supportTsx = false) {
     const swcrcPath = (0, path_1.join)(projectDir, '.spec.swcrc');

package/src/generators/library/utils/add-release-config.d.ts

@@ -1,11 +0,0 @@
-import { GeneratorCallback, ProjectConfiguration, Tree } from '@nx/devkit';
-/**
- * Adds release option in nx.json to build the project before versioning
- */
-export declare function addReleaseConfigForTsSolution(tree: Tree, projectName: string, projectConfiguration: ProjectConfiguration): Promise<void>;
-/**
- * Add release configuration for non-ts solution projects
- * Add release option in project.json and add packageRoot to nx-release-publish target
- */
-export declare function addReleaseConfigForNonTsSolution(tree: Tree, projectName: string, projectConfiguration: ProjectConfiguration, defaultOutputDirectory?: string): Promise<ProjectConfiguration>;
-export declare function releaseTasks(tree: Tree): Promise<GeneratorCallback>;

package/src/generators/library/utils/add-release-config.js

@@ -1,136 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.addReleaseConfigForTsSolution = addReleaseConfigForTsSolution;
-exports.addReleaseConfigForNonTsSolution = addReleaseConfigForNonTsSolution;
-exports.releaseTasks = releaseTasks;
-const devkit_1 = require("@nx/devkit");
-const find_matching_projects_1 = require("nx/src/utils/find-matching-projects");
-const generator_1 = require("../../setup-verdaccio/generator");
-/**
- * Adds release option in nx.json to build the project before versioning
- */
-async function addReleaseConfigForTsSolution(tree, projectName, projectConfiguration) {
-    const nxJson = (0, devkit_1.readNxJson)(tree);
-    const addPreVersionCommand = () => {
-        const pmc = (0, devkit_1.getPackageManagerCommand)();
-        nxJson.release = {
-            ...nxJson.release,
-            version: {
-                preVersionCommand: `${pmc.dlx} nx run-many -t build`,
-                ...nxJson.release?.version,
-            },
-        };
-    };
-    // if the release configuration does not exist, it will be created
-    if (!nxJson.release || (!nxJson.release.projects && !nxJson.release.groups)) {
-        // skip adding any projects configuration since the new project should be
-        // automatically included by nx release's default project detection logic
-        addPreVersionCommand();
-        (0, devkit_1.writeJson)(tree, 'nx.json', nxJson);
-        return;
-    }
-    const project = {
-        name: projectName,
-        type: 'lib',
-        data: {
-            root: projectConfiguration.root,
-            tags: projectConfiguration.tags,
-        },
-    };
-    // if the project is already included in the release configuration, it will not be added again
-    if (projectsConfigMatchesProject(nxJson.release.projects, project)) {
-        devkit_1.output.log({
-            title: `Project already included in existing release configuration`,
-        });
-        addPreVersionCommand();
-        (0, devkit_1.writeJson)(tree, 'nx.json', nxJson);
-        return;
-    }
-    // if the release configuration is a string, it will be converted to an array and added to it
-    if (Array.isArray(nxJson.release.projects)) {
-        nxJson.release.projects.push(projectName);
-        addPreVersionCommand();
-        (0, devkit_1.writeJson)(tree, 'nx.json', nxJson);
-        devkit_1.output.log({
-            title: `Added project to existing release configuration`,
-        });
-    }
-    if (nxJson.release.groups) {
-        const allGroups = Object.entries(nxJson.release.groups);
-        for (const [name, group] of allGroups) {
-            if (projectsConfigMatchesProject(group.projects, project)) {
-                addPreVersionCommand();
-                (0, devkit_1.writeJson)(tree, 'nx.json', nxJson);
-                devkit_1.output.log({
-                    title: `Project already included in existing release configuration for group ${name}`,
-                });
-                return;
-            }
-        }
-        devkit_1.output.warn({
-            title: `Could not find a release group that includes ${projectName}`,
-            bodyLines: [
-                `Ensure that ${projectName} is included in a release group's "projects" list in nx.json so it can be published with "nx release"`,
-            ],
-        });
-        addPreVersionCommand();
-        (0, devkit_1.writeJson)(tree, 'nx.json', nxJson);
-        return;
-    }
-    if (typeof nxJson.release.projects === 'string') {
-        nxJson.release.projects = [nxJson.release.projects, projectName];
-        addPreVersionCommand();
-        (0, devkit_1.writeJson)(tree, 'nx.json', nxJson);
-        devkit_1.output.log({
-            title: `Added project to existing release configuration`,
-        });
-        return;
-    }
-}
-/**
- * Add release configuration for non-ts solution projects
- * Add release option in project.json and add packageRoot to nx-release-publish target
- */
-async function addReleaseConfigForNonTsSolution(tree, projectName, projectConfiguration, defaultOutputDirectory = 'dist') {
-    const packageRoot = (0, devkit_1.joinPathFragments)(defaultOutputDirectory, '{projectRoot}');
-    projectConfiguration.targets ??= {};
-    projectConfiguration.targets['nx-release-publish'] = {
-        options: {
-            packageRoot,
-        },
-    };
-    projectConfiguration.release = {
-        version: {
-            generatorOptions: {
-                packageRoot,
-                // using git tags to determine the current version is required here because
-                // the version in the package root is overridden with every build
-                currentVersionResolver: 'git-tag',
-                fallbackCurrentVersionResolver: 'disk',
-            },
-        },
-    };
-    await addReleaseConfigForTsSolution(tree, projectName, projectConfiguration);
-    return projectConfiguration;
-}
-function projectsConfigMatchesProject(projectsConfig, project) {
-    if (!projectsConfig) {
-        return false;
-    }
-    if (typeof projectsConfig === 'string') {
-        projectsConfig = [projectsConfig];
-    }
-    const graph = {
-        [project.name]: project,
-    };
-    const matchingProjects = (0, find_matching_projects_1.findMatchingProjects)(projectsConfig, graph);
-    return matchingProjects.includes(project.name);
-}
-async function releaseTasks(tree) {
-    return (0, devkit_1.runTasksInSerial)(await (0, generator_1.default)(tree, { skipFormat: true }), () => logNxReleaseDocsInfo());
-}
-function logNxReleaseDocsInfo() {
-    devkit_1.output.log({
-        title: `📦 To learn how to publish this library, see https://nx.dev/core-features/manage-releases.`,
-    });
-}