@nx/js 17.0.2 → 17.1.0-beta.0

package/babel.js

@@ -70,6 +70,7 @@ module.exports = function (api, options = {}) {
                 require.resolve('@babel/plugin-proposal-decorators'),
                 options.decorators ?? { legacy: true },
             ],
+            [require.resolve('@babel/plugin-transform-class-properties'), { loose }],
         ].filter(Boolean),
         overrides: [
             // Convert `const enum` to `enum`. The former cannot be supported by babel

package/migrations.json

@@ -23,6 +23,12 @@
       "version": "16.8.2-beta.0",
       "description": "Remove invalid options (strict, noInterop) for ES6 type modules.",
       "factory": "./src/migrations/update-16-8-2/update-swcrc"
+    },
+    "update-17-0-0-remove-deprecated-build-options": {
+      "cli": "nx",
+      "version": "17.0.2",
+      "description": "Remove deprecated build options",
+      "implementation": "./src/migrations/update-17-0-0/remove-deprecated-build-options"
     }
   },
   "packageJsonUpdates": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/js",
-  "version": "17.0.2",
+  "version": "17.1.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": {
@@ -33,6 +33,7 @@
     "@babel/core": "^7.22.9",
     "@babel/plugin-proposal-decorators": "^7.22.7",
     "@babel/plugin-transform-runtime": "^7.22.9",
+    "@babel/plugin-transform-class-properties": "^7.22.5",
     "@babel/preset-env": "^7.22.9",
     "@babel/preset-typescript": "^7.22.5",
     "@babel/runtime": "^7.22.6",
@@ -56,9 +57,9 @@
     "semver": "7.5.3",
     "source-map-support": "0.5.19",
     "tslib": "^2.3.0",
-    "@nx/devkit": "17.0.2",
-    "@nx/workspace": "17.0.2",
-    "@nrwl/js": "17.0.2"
+    "@nx/devkit": "17.1.0-beta.0",
+    "@nx/workspace": "17.1.0-beta.0",
+    "@nrwl/js": "17.1.0-beta.0"
   },
   "peerDependencies": {
     "verdaccio": "^5.0.4"

package/src/executors/release-publish/release-publish.impl.js

@@ -21,11 +21,11 @@ async function runExecutor(options, context) {
     const packageRoot = (0, devkit_1.joinPathFragments)(context.root, options.packageRoot ?? projectConfig.root);
     const packageJsonPath = (0, devkit_1.joinPathFragments)(packageRoot, 'package.json');
     const projectPackageJson = (0, devkit_1.readJsonFile)(packageJsonPath);
-    const name = projectPackageJson.name;
+    const packageName = projectPackageJson.name;
     // If package and project name match, we can make log messages terser
-    let packageTxt = name === context.projectName
-        ? `package "${name}"`
-        : `package "${name}" from project "${context.projectName}"`;
+    let packageTxt = packageName === context.projectName
+        ? `package "${packageName}"`
+        : `package "${packageName}" from project "${context.projectName}"`;
     if (projectPackageJson.private === true) {
         console.warn(`Skipping ${packageTxt}, because it has \`"private": true\` in ${packageJsonPath}`);
         return {
@@ -54,7 +54,7 @@ async function runExecutor(options, context) {
         });
         const stdoutData = JSON.parse(output.toString());
         // If npm workspaces are in use, the publish output will nest the data under the package name, so we normalize it first
-        const normalizedStdoutData = stdoutData[context.projectName] ?? stdoutData;
+        const normalizedStdoutData = stdoutData[packageName] ?? stdoutData;
         (0, log_tar_1.logTar)(normalizedStdoutData);
         if (options.dryRun) {
             console.log(`Would publish to ${registry} with tag "${tag}", but ${chalk.keyword('orange')('[dry-run]')} was set`);

package/src/generators/library/library.js

@@ -32,7 +32,9 @@ async function libraryGeneratorInternal(tree, schema) {
     const options = await normalizeOptions(tree, schema);
     createFiles(tree, options, `${filesDir}/lib`);
     addProject(tree, options);
-    tasks.push(addProjectDependencies(tree, options));
+    if (!options.skipPackageJson) {
+        tasks.push(addProjectDependencies(tree, options));
+    }
     if (options.publishable) {
         tasks.push(await (0, generator_1.default)(tree, { ...options, skipFormat: true }));
     }
@@ -52,6 +54,7 @@ async function libraryGeneratorInternal(tree, schema) {
             project: options.name,
             includeLib: true,
             includeVitest: options.unitTestRunner === 'vitest',
+            testEnvironment: options.testEnvironment,
         }, false);
     }
     if (options.linter !== 'none') {
@@ -81,6 +84,7 @@ async function libraryGeneratorInternal(tree, schema) {
             project: options.name,
             includeLib: false,
             includeVitest: true,
+            testEnvironment: options.testEnvironment,
         }, true);
     }
     if (!schema.skipTsConfig) {

package/src/generators/library/schema.json

@@ -48,6 +48,12 @@
       "default": false,
       "x-priority": "internal"
     },
+    "skipPackageJson": {
+      "description": "Do not add dependencies to `package.json`.",
+      "type": "boolean",
+      "default": false,
+      "x-priority": "internal"
+    },
     "skipTsConfig": {
       "type": "boolean",
       "description": "Do not update tsconfig.json for development experience.",

package/src/generators/release-version/release-version.js

@@ -4,107 +4,195 @@ exports.releaseVersionGenerator = void 0;
 const devkit_1 = require("@nx/devkit");
 const chalk = require("chalk");
 const child_process_1 = require("child_process");
+const git_1 = require("nx/src/command-line/release/utils/git");
+const resolve_semver_specifier_1 = require("nx/src/command-line/release/utils/resolve-semver-specifier");
+const semver_1 = require("nx/src/command-line/release/utils/semver");
 const version_1 = require("nx/src/command-line/release/version");
 const utils_1 = require("nx/src/tasks-runner/utils");
 const ora = require("ora");
 const path_1 = require("path");
+const semver_2 = require("semver");
 const resolve_local_package_dependencies_1 = require("./utils/resolve-local-package-dependencies");
 async function releaseVersionGenerator(tree, options) {
-    const projects = options.projects;
-    // Resolve any custom package roots for each project upfront as they will need to be reused during dependency resolution
-    const projectNameToPackageRootMap = new Map();
-    for (const project of projects) {
-        projectNameToPackageRootMap.set(project.name, 
-        // Default to the project root if no custom packageRoot
-        !options.packageRoot
-            ? project.data.root
-            : (0, utils_1.interpolate)(options.packageRoot, {
-                workspaceRoot: '',
-                projectRoot: project.data.root,
-                projectName: project.name,
-            }));
-    }
-    let currentVersion;
-    for (const project of projects) {
-        const projectName = project.name;
-        const packageRoot = projectNameToPackageRootMap.get(projectName);
-        const packageJsonPath = (0, devkit_1.joinPathFragments)(packageRoot, 'package.json');
-        const workspaceRelativePackageJsonPath = (0, path_1.relative)(devkit_1.workspaceRoot, packageJsonPath);
-        const color = getColor(projectName);
-        const log = (msg) => {
-            console.log(color.instance.bold(projectName) + ' ' + msg);
-        };
-        if (!tree.exists(packageJsonPath)) {
-            throw new Error(`The project "${projectName}" does not have a package.json available at ${workspaceRelativePackageJsonPath}.
-        
-To fix this you will either need to add a package.json file at that location, or configure "release" within your nx.json to exclude "${projectName}" from the current release group, or amend the packageRoot configuration to point to where the package.json should be.`);
+    try {
+        // If the user provided a specifier, validate that it is valid semver or a relative semver keyword
+        if (options.specifier && !(0, semver_1.isValidSemverSpecifier)(options.specifier)) {
+            throw new Error(`The given version specifier "${options.specifier}" is not valid. You provide an exact version or a valid semver keyword such as "major", "minor", "patch", etc.`);
+        }
+        const projects = options.projects;
+        // Resolve any custom package roots for each project upfront as they will need to be reused during dependency resolution
+        const projectNameToPackageRootMap = new Map();
+        for (const project of projects) {
+            projectNameToPackageRootMap.set(project.name, 
+            // Default to the project root if no custom packageRoot
+            !options.packageRoot
+                ? project.data.root
+                : (0, utils_1.interpolate)(options.packageRoot, {
+                    workspaceRoot: '',
+                    projectRoot: project.data.root,
+                    projectName: project.name,
+                }));
         }
-        devkit_1.output.logSingleLine(`Running release version for project: ${color.instance.bold(project.name)}`);
-        const projectPackageJson = (0, devkit_1.readJson)(tree, packageJsonPath);
-        log(`🔍 Reading data for package "${projectPackageJson.name}" from ${workspaceRelativePackageJsonPath}`);
-        const { name: packageName, version: currentVersionFromDisk } = projectPackageJson;
-        switch (options.currentVersionResolver) {
-            case 'registry': {
-                const metadata = options.currentVersionResolverMetadata;
-                const registry = metadata?.registry ?? 'https://registry.npmjs.org';
-                const tag = metadata?.tag ?? 'latest';
-                // If the currentVersionResolver is set to registry, we only want to make the request once for the whole batch of projects
-                if (!currentVersion) {
-                    const spinner = ora(`${Array.from(new Array(projectName.length + 3)).join(' ')}Resolving the current version for tag "${tag}" on ${registry}`);
-                    spinner.color =
-                        color.spinnerColor;
-                    spinner.start();
-                    // Must be non-blocking async to allow spinner to render
-                    currentVersion = await new Promise((resolve, reject) => {
-                        (0, child_process_1.exec)(`npm view ${packageName} version --registry=${registry} --tag=${tag}`, (error, stdout, stderr) => {
-                            if (error) {
-                                return reject(error);
-                            }
-                            if (stderr) {
-                                return reject(stderr);
-                            }
-                            return resolve(stdout.trim());
+        let currentVersion;
+        // only used for options.currentVersionResolver === 'git-tag', but
+        // must be declared here in order to reuse it for additional projects
+        let latestMatchingGitTag;
+        // if specifier is undefined, then we haven't resolved it yet
+        // if specifier is null, then it has been resolved and no changes are necessary
+        let specifier = options.specifier ? options.specifier : undefined;
+        for (const project of projects) {
+            const projectName = project.name;
+            const packageRoot = projectNameToPackageRootMap.get(projectName);
+            const packageJsonPath = (0, devkit_1.joinPathFragments)(packageRoot, 'package.json');
+            const workspaceRelativePackageJsonPath = (0, path_1.relative)(devkit_1.workspaceRoot, packageJsonPath);
+            const color = getColor(projectName);
+            const log = (msg) => {
+                console.log(color.instance.bold(projectName) + ' ' + msg);
+            };
+            if (!tree.exists(packageJsonPath)) {
+                throw new Error(`The project "${projectName}" does not have a package.json available at ${workspaceRelativePackageJsonPath}.
+
+To fix this you will either need to add a package.json file at that location, or configure "release" within your nx.json to exclude "${projectName}" from the current release group, or amend the packageRoot configuration to point to where the package.json should be.`);
+            }
+            devkit_1.output.logSingleLine(`Running release version for project: ${color.instance.bold(project.name)}`);
+            const projectPackageJson = (0, devkit_1.readJson)(tree, packageJsonPath);
+            log(`🔍 Reading data for package "${projectPackageJson.name}" from ${workspaceRelativePackageJsonPath}`);
+            const { name: packageName, version: currentVersionFromDisk } = projectPackageJson;
+            switch (options.currentVersionResolver) {
+                case 'registry': {
+                    const metadata = options.currentVersionResolverMetadata;
+                    const registry = metadata?.registry ??
+                        (await getNpmRegistry()) ??
+                        'https://registry.npmjs.org';
+                    const tag = metadata?.tag ?? 'latest';
+                    // If the currentVersionResolver is set to registry, we only want to make the request once for the whole batch of projects
+                    if (!currentVersion) {
+                        const spinner = ora(`${Array.from(new Array(projectName.length + 3)).join(' ')}Resolving the current version for tag "${tag}" on ${registry}`);
+                        spinner.color =
+                            color.spinnerColor;
+                        spinner.start();
+                        // Must be non-blocking async to allow spinner to render
+                        currentVersion = await new Promise((resolve, reject) => {
+                            (0, child_process_1.exec)(`npm view ${packageName} version --registry=${registry} --tag=${tag}`, (error, stdout, stderr) => {
+                                if (error) {
+                                    return reject(error);
+                                }
+                                if (stderr) {
+                                    return reject(stderr);
+                                }
+                                return resolve(stdout.trim());
+                            });
                         });
-                    });
-                    spinner.stop();
-                    log(`📄 Resolved the current version as ${currentVersion} for tag "${tag}" from registry ${registry}`);
+                        spinner.stop();
+                        log(`📄 Resolved the current version as ${currentVersion} for tag "${tag}" from registry ${registry}`);
+                    }
+                    else {
+                        log(`📄 Using the current version ${currentVersion} already resolved from the registry ${registry}`);
+                    }
+                    break;
                 }
-                else {
-                    log(`📄 Using the current version ${currentVersion} already resolved from the registry ${registry}`);
+                case 'disk':
+                    currentVersion = currentVersionFromDisk;
+                    log(`📄 Resolved the current version as ${currentVersion} from ${packageJsonPath}`);
+                    break;
+                case 'git-tag': {
+                    if (!currentVersion) {
+                        const releaseTagPattern = options.releaseGroup.releaseTagPattern;
+                        latestMatchingGitTag = await (0, git_1.getLatestGitTagForPattern)(releaseTagPattern, {
+                            projectName: project.name,
+                        });
+                        if (!latestMatchingGitTag) {
+                            throw new Error(`No git tags matching pattern "${releaseTagPattern}" for project "${project.name}" were found.`);
+                        }
+                        currentVersion = latestMatchingGitTag.extractedVersion;
+                        log(`📄 Resolved the current version as ${currentVersion} from git tag "${latestMatchingGitTag.tag}".`);
+                    }
+                    else {
+                        log(`📄 Using the current version ${currentVersion} already resolved from git tag "${latestMatchingGitTag.tag}".`);
+                    }
+                    break;
                 }
-                break;
+                default:
+                    throw new Error(`Invalid value for options.currentVersionResolver: ${options.currentVersionResolver}`);
+            }
+            if (options.specifier) {
+                log(`📄 Using the provided version specifier "${options.specifier}".`);
+            }
+            // if specifier is null, then we determined previously via conventional commits that no changes are necessary
+            if (specifier === undefined) {
+                const specifierSource = options.specifierSource;
+                switch (specifierSource) {
+                    case 'conventional-commits':
+                        if (options.currentVersionResolver !== 'git-tag') {
+                            throw new Error(`Invalid currentVersionResolver "${options.currentVersionResolver}" provided for release group "${options.releaseGroup.name}". Must be "git-tag" when "specifierSource" is "conventional-commits"`);
+                        }
+                        specifier = await (0, resolve_semver_specifier_1.resolveSemverSpecifierFromConventionalCommits)(latestMatchingGitTag.tag, options.projectGraph, projects.map((p) => p.name));
+                        if (!specifier) {
+                            log(`🚫 No changes were detected using git history and the conventional commits standard.`);
+                            break;
+                        }
+                        // Always assume that if the current version is a prerelease, then the next version should be a prerelease.
+                        // Users must manually graduate from a prerelease to a release by providing an explicit specifier.
+                        if ((0, semver_2.prerelease)(currentVersion)) {
+                            specifier = 'prerelease';
+                            log(`📄 Resolved the specifier as "${specifier}" since the current version is a prerelease.`);
+                        }
+                        else {
+                            log(`📄 Resolved the specifier as "${specifier}" using git history and the conventional commits standard.`);
+                        }
+                        break;
+                    case 'prompt':
+                        specifier = await (0, resolve_semver_specifier_1.resolveSemverSpecifierFromPrompt)(`What kind of change is this for the ${projects.length} matched projects(s) within release group "${options.releaseGroup.name}"?`, `What is the exact version for the ${projects.length} matched project(s) within release group "${options.releaseGroup.name}"?`);
+                        break;
+                    default:
+                        throw new Error(`Invalid specifierSource "${specifierSource}" provided. Must be one of "prompt" or "conventional-commits"`);
+                }
+            }
+            if (!specifier) {
+                log(`🚫 Skipping versioning "${projectPackageJson.name}" as no changes were detected.`);
+                continue;
+            }
+            // Resolve any local package dependencies for this project (before applying the new version)
+            const localPackageDependencies = (0, resolve_local_package_dependencies_1.resolveLocalPackageDependencies)(tree, options.projectGraph, projects, projectNameToPackageRootMap);
+            const newVersion = (0, version_1.deriveNewSemverVersion)(currentVersion, specifier, options.preid);
+            (0, devkit_1.writeJson)(tree, packageJsonPath, {
+                ...projectPackageJson,
+                version: newVersion,
+            });
+            log(`✍️  New version ${newVersion} written to ${workspaceRelativePackageJsonPath}`);
+            const dependentProjects = Object.values(localPackageDependencies)
+                .filter((localPackageDependencies) => {
+                return localPackageDependencies.some((localPackageDependency) => localPackageDependency.target === project.name);
+            })
+                .flat();
+            if (dependentProjects.length > 0) {
+                log(`✍️  Applying new version ${newVersion} to ${dependentProjects.length} ${dependentProjects.length > 1
+                    ? 'packages which depend'
+                    : 'package which depends'} on ${project.name}`);
+            }
+            for (const dependentProject of dependentProjects) {
+                (0, devkit_1.updateJson)(tree, (0, devkit_1.joinPathFragments)(projectNameToPackageRootMap.get(dependentProject.source), 'package.json'), (json) => {
+                    json[dependentProject.dependencyCollection][packageName] =
+                        newVersion;
+                    return json;
+                });
             }
-            case 'disk':
-                currentVersion = currentVersionFromDisk;
-                log(`📄 Resolved the current version as ${currentVersion} from ${packageJsonPath}`);
-                break;
-            default:
-                throw new Error(`Invalid value for options.currentVersionResolver: ${options.currentVersionResolver}`);
         }
-        // Resolve any local package dependencies for this project (before applying the new version)
-        const localPackageDependencies = (0, resolve_local_package_dependencies_1.resolveLocalPackageDependencies)(tree, options.projectGraph, projects, projectNameToPackageRootMap);
-        const newVersion = (0, version_1.deriveNewSemverVersion)(currentVersion, options.specifier, options.preid);
-        (0, devkit_1.writeJson)(tree, packageJsonPath, {
-            ...projectPackageJson,
-            version: newVersion,
-        });
-        log(`✍️  New version ${newVersion} written to ${workspaceRelativePackageJsonPath}`);
-        const dependentProjects = Object.values(localPackageDependencies)
-            .filter((localPackageDependencies) => {
-            return localPackageDependencies.some((localPackageDependency) => localPackageDependency.target === project.name);
-        })
-            .flat();
-        if (dependentProjects.length > 0) {
-            log(`✍️  Applying new version ${newVersion} to ${dependentProjects.length} ${dependentProjects.length > 1
-                ? 'packages which depend'
-                : 'package which depends'} on ${project.name}`);
+    }
+    catch (e) {
+        if (process.env.NX_VERBOSE_LOGGING === 'true') {
+            devkit_1.output.error({
+                title: e.message,
+            });
+            // Dump the full stack trace in verbose mode
+            console.error(e);
         }
-        for (const dependentProject of dependentProjects) {
-            (0, devkit_1.updateJson)(tree, (0, devkit_1.joinPathFragments)(projectNameToPackageRootMap.get(dependentProject.source), 'package.json'), (json) => {
-                json[dependentProject.dependencyCollection][packageName] = newVersion;
-                return json;
+        else {
+            devkit_1.output.error({
+                title: e.message,
             });
         }
+        process.exit(1);
     }
 }
 exports.releaseVersionGenerator = releaseVersionGenerator;
@@ -129,3 +217,17 @@ function getColor(projectName) {
     const colorIndex = code % colors.length;
     return colors[colorIndex];
 }
+async function getNpmRegistry() {
+    // Must be non-blocking async to allow spinner to render
+    return await new Promise((resolve, reject) => {
+        (0, child_process_1.exec)('npm config get registry', (error, stdout, stderr) => {
+            if (error) {
+                return reject(error);
+            }
+            if (stderr) {
+                return reject(stderr);
+            }
+            return resolve(stdout.trim());
+        });
+    });
+}

package/src/generators/release-version/schema.json

@@ -19,7 +19,17 @@
     },
     "specifier": {
       "type": "string",
-      "description": "Exact version or semver keyword to apply to the selected release group. NOTE: This should be set on the release group level, not the project level."
+      "description": "Exact version or semver keyword to apply to the selected release group. Overrides specifierSource."
+    },
+    "releaseGroup": {
+      "type": "object",
+      "description": "The resolved release group configuration, including name, relevant to all projects in the current execution."
+    },
+    "specifierSource": {
+      "type": "string",
+      "default": "prompt",
+      "description": "Which approach to use to determine the semver specifier used to bump the version of the project.",
+      "enum": ["prompt", "conventional-commits"]
     },
     "preid": {
       "type": "string",
@@ -33,7 +43,7 @@
       "type": "string",
       "default": "disk",
       "description": "Which approach to use to determine the current version of the project.",
-      "enum": ["registry", "disk"]
+      "enum": ["registry", "disk", "git-tag"]
     },
     "currentVersionResolverMetadata": {
       "type": "object",
@@ -41,5 +51,5 @@
       "default": {}
     }
   },
-  "required": ["projects", "projectGraph", "specifier"]
+  "required": ["projects", "projectGraph", "releaseGroup"]
 }

package/src/utils/schema.d.ts

@@ -14,6 +14,7 @@ export interface LibraryGeneratorSchema {
   skipFormat?: boolean;
   tags?: string;
   skipTsConfig?: boolean;
+  skipPackageJson?: boolean;
   includeBabelRc?: boolean;
   unitTestRunner?: 'jest' | 'vitest' | 'none';
   linter?: Linter;