@nx/js 17.0.2 → 17.0.4

package/src/generators/library/files/{lib → readme}/README.md

@@ -14,6 +14,6 @@ Run `<%= cliCommand %> build <%= name %>` to build the library.
 
 ## Running unit tests
 
-Run `<%= cliCommand %> test <%= name %>` to execute the unit tests via [Jest](https://jestjs.io).
+Run `<%= cliCommand %> test <%= name %>` to execute the unit tests via <% if(unitTestRunner === 'jest') { %>[Jest](https://jestjs.io)<% } else { %>[Vitest](https://vitest.dev/)<% } %>.
 
 <% } %>

package/src/generators/library/library.d.ts

@@ -11,6 +11,6 @@ export interface NormalizedSchema extends LibraryGeneratorSchema {
     parsedTags: string[];
     importPath?: string;
 }
-export type AddLintOptions = Pick<NormalizedSchema, 'name' | 'linter' | 'projectRoot' | 'unitTestRunner' | 'js' | 'setParserOptionsProject' | 'rootProject' | 'bundler'>;
+export type AddLintOptions = Pick<NormalizedSchema, 'name' | 'linter' | 'projectRoot' | 'unitTestRunner' | 'js' | 'setParserOptionsProject' | 'rootProject' | 'bundler' | 'addPlugin'>;
 export declare function addLint(tree: Tree, options: AddLintOptions): Promise<GeneratorCallback>;
 export default libraryGenerator;

package/src/generators/library/library.js

@@ -3,17 +3,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.addLint = exports.libraryGeneratorInternal = exports.libraryGenerator = void 0;
 const devkit_1 = require("@nx/devkit");
 const project_name_and_root_utils_1 = require("@nx/devkit/src/generators/project-name-and-root-utils");
-const ts_config_1 = require("../../utils/typescript/ts-config");
+const add_build_target_defaults_1 = require("@nx/devkit/src/generators/add-build-target-defaults");
+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 minimal_publish_script_1 = require("../../utils/minimal-publish-script");
 const add_swc_config_1 = require("../../utils/swc/add-swc-config");
 const add_swc_dependencies_1 = require("../../utils/swc/add-swc-dependencies");
+const create_ts_config_1 = require("../../utils/typescript/create-ts-config");
+const ts_config_1 = require("../../utils/typescript/ts-config");
 const versions_1 = require("../../utils/versions");
 const init_1 = require("../init/init");
 const generator_1 = require("../setup-verdaccio/generator");
-const create_ts_config_1 = require("../../utils/typescript/create-ts-config");
+const defaultOutputDirectory = 'dist';
 async function libraryGenerator(tree, schema) {
     return await libraryGeneratorInternal(tree, {
+        addPlugin: false,
         // provide a default projectNameAndRootFormat to avoid breaking changes
         // to external generators invoking this one
         projectNameAndRootFormat: 'derived',
@@ -22,7 +26,6 @@ async function libraryGenerator(tree, schema) {
 }
 exports.libraryGenerator = libraryGenerator;
 async function libraryGeneratorInternal(tree, schema) {
-    const filesDir = (0, path_1.join)(__dirname, './files');
     const tasks = [];
     tasks.push(await (0, init_1.default)(tree, {
         ...schema,
@@ -30,9 +33,11 @@ async function libraryGeneratorInternal(tree, schema) {
         tsConfigName: schema.rootProject ? 'tsconfig.json' : 'tsconfig.base.json',
     }));
     const options = await normalizeOptions(tree, schema);
-    createFiles(tree, options, `${filesDir}/lib`);
-    addProject(tree, options);
-    tasks.push(addProjectDependencies(tree, options));
+    createFiles(tree, options);
+    await addProject(tree, options);
+    if (!options.skipPackageJson) {
+        tasks.push(addProjectDependencies(tree, options));
+    }
     if (options.publishable) {
         tasks.push(await (0, generator_1.default)(tree, { ...options, skipFormat: true }));
     }
@@ -46,12 +51,14 @@ async function libraryGeneratorInternal(tree, schema) {
             includeLib: true,
             skipFormat: true,
             testEnvironment: options.testEnvironment,
+            addPlugin: options.addPlugin,
         });
         tasks.push(viteTask);
         createOrEditViteConfig(tree, {
             project: options.name,
             includeLib: true,
             includeVitest: options.unitTestRunner === 'vitest',
+            testEnvironment: options.testEnvironment,
         }, false);
     }
     if (options.linter !== 'none') {
@@ -62,7 +69,7 @@ async function libraryGeneratorInternal(tree, schema) {
         const jestCallback = await addJest(tree, options);
         tasks.push(jestCallback);
         if (options.bundler === 'swc' || options.bundler === 'rollup') {
-            replaceJestConfig(tree, options, `${filesDir}/jest-config`);
+            replaceJestConfig(tree, options);
         }
     }
     else if (options.unitTestRunner === 'vitest' &&
@@ -72,7 +79,7 @@ async function libraryGeneratorInternal(tree, schema) {
         const vitestTask = await vitestGenerator(tree, {
             project: options.name,
             uiFramework: 'none',
-            coverageProvider: 'c8',
+            coverageProvider: 'v8',
             skipFormat: true,
             testEnvironment: options.testEnvironment,
         });
@@ -81,6 +88,7 @@ async function libraryGeneratorInternal(tree, schema) {
             project: options.name,
             includeLib: false,
             includeVitest: true,
+            testEnvironment: options.testEnvironment,
         }, true);
     }
     if (!schema.skipTsConfig) {
@@ -94,10 +102,18 @@ async function libraryGeneratorInternal(tree, schema) {
     if (!options.skipFormat) {
         await (0, devkit_1.formatFiles)(tree);
     }
+    if (options.publishable) {
+        tasks.push(() => {
+            logNxReleaseDocsInfo();
+        });
+    }
+    tasks.push(() => {
+        (0, log_show_project_command_1.logShowProjectCommand)(options.name);
+    });
     return (0, devkit_1.runTasksInSerial)(...tasks);
 }
 exports.libraryGeneratorInternal = libraryGeneratorInternal;
-function addProject(tree, options) {
+async function addProject(tree, options) {
     const projectConfiguration = {
         root: options.projectRoot,
         sourceRoot: (0, devkit_1.joinPathFragments)(options.projectRoot, 'src'),
@@ -109,8 +125,10 @@ function addProject(tree, options) {
         options.bundler !== 'none' &&
         options.config !== 'npm-scripts') {
         const outputPath = getOutputPath(options);
+        const executor = getBuildExecutor(options.bundler);
+        (0, add_build_target_defaults_1.addBuildTargetDefaults)(tree, executor);
         projectConfiguration.targets.build = {
-            executor: getBuildExecutor(options.bundler),
+            executor,
             outputs: ['{options.outputPath}'],
             options: {
                 outputPath,
@@ -138,11 +156,24 @@ function addProject(tree, options) {
             projectConfiguration.targets.build.options.assets.push((0, devkit_1.joinPathFragments)(options.projectRoot, '*.md'));
         }
         if (options.publishable) {
-            const publishScriptPath = (0, minimal_publish_script_1.addMinimalPublishScript)(tree);
-            projectConfiguration.targets.publish = {
-                command: `node ${publishScriptPath} ${options.name} {args.ver} {args.tag}`,
-                dependsOn: ['build'],
+            const packageRoot = (0, path_1.join)(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.config === 'workspace' || options.config === 'project') {
@@ -158,11 +189,8 @@ function addProject(tree, options) {
 }
 async function addLint(tree, options) {
     const { lintProjectGenerator } = (0, devkit_1.ensurePackage)('@nx/eslint', versions_1.nxVersion);
-    const { mapLintPattern } = 
-    // nx-ignore-next-line
-    require('@nx/eslint/src/generators/lint-project/lint-project');
     const projectConfiguration = (0, devkit_1.readProjectConfiguration)(tree, options.name);
-    const task = lintProjectGenerator(tree, {
+    const task = await lintProjectGenerator(tree, {
         project: options.name,
         linter: options.linter,
         skipFormat: true,
@@ -170,11 +198,9 @@ async function addLint(tree, options) {
             (0, devkit_1.joinPathFragments)(options.projectRoot, 'tsconfig.lib.json'),
         ],
         unitTestRunner: options.unitTestRunner,
-        eslintFilePatterns: [
-            mapLintPattern(options.projectRoot, options.js ? 'js' : 'ts', options.rootProject),
-        ],
         setParserOptionsProject: options.setParserOptionsProject,
         rootProject: options.rootProject,
+        addPlugin: options.addPlugin,
     });
     const { addOverrideToLintConfig, lintConfigHasOverride, isEslintConfigSupported, updateOverrideInLintConfig,
     // nx-ignore-next-line
@@ -276,10 +302,10 @@ function addBabelRc(tree, options) {
     };
     (0, devkit_1.writeJson)(tree, (0, path_1.join)(options.projectRoot, filename), babelrc);
 }
-function createFiles(tree, options, filesDir) {
+function createFiles(tree, options) {
     const { className, name, propertyName } = (0, devkit_1.names)(options.projectNames.projectFileName);
     createProjectTsConfigJson(tree, options);
-    (0, devkit_1.generateFiles)(tree, filesDir, options.projectRoot, {
+    (0, devkit_1.generateFiles)(tree, (0, path_1.join)(__dirname, './files/lib'), options.projectRoot, {
         ...options,
         dot: '.',
         className,
@@ -293,6 +319,22 @@ function createFiles(tree, options, filesDir) {
         buildable: options.bundler && options.bundler !== 'none',
         hasUnitTestRunner: options.unitTestRunner !== 'none',
     });
+    if (!options.rootProject) {
+        (0, devkit_1.generateFiles)(tree, (0, path_1.join)(__dirname, './files/readme'), options.projectRoot, {
+            ...options,
+            dot: '.',
+            className,
+            name,
+            propertyName,
+            js: !!options.js,
+            cliCommand: 'nx',
+            strict: undefined,
+            tmpl: '',
+            offsetFromRoot: (0, devkit_1.offsetFromRoot)(options.projectRoot),
+            buildable: options.bundler && options.bundler !== 'none',
+            hasUnitTestRunner: options.unitTestRunner !== 'none',
+        });
+    }
     if (options.bundler === 'swc' || options.bundler === 'rollup') {
         (0, add_swc_dependencies_1.addSwcDependencies)(tree);
         (0, add_swc_config_1.addSwcConfig)(tree, options.projectRoot, options.bundler === 'swc' ? 'commonjs' : 'es6');
@@ -316,6 +358,9 @@ function createFiles(tree, options, filesDir) {
             if (json.private && (options.publishable || options.rootProject)) {
                 delete json.private;
             }
+            if (!options.publishable && !options.rootProject) {
+                json.private = true;
+            }
             return {
                 ...json,
                 dependencies: {
@@ -327,12 +372,16 @@ function createFiles(tree, options, filesDir) {
         });
     }
     else {
-        (0, devkit_1.writeJson)(tree, packageJsonPath, {
+        const packageJson = {
             name: options.importPath,
             version: '0.0.1',
             dependencies: determineDependencies(options),
             ...determineEntryFields(options),
-        });
+        };
+        if (!options.publishable && !options.rootProject) {
+            packageJson.private = true;
+        }
+        (0, devkit_1.writeJson)(tree, packageJsonPath, packageJson);
     }
     if (options.config === 'npm-scripts') {
         (0, devkit_1.updateJson)(tree, packageJsonPath, (json) => {
@@ -369,7 +418,8 @@ async function addJest(tree, options) {
                 : undefined,
     });
 }
-function replaceJestConfig(tree, options, filesDir) {
+function replaceJestConfig(tree, options) {
+    const filesDir = (0, path_1.join)(__dirname, './files/jest-config');
     // the existing config has to be deleted otherwise the new config won't overwrite it
     const existingJestConfig = (0, devkit_1.joinPathFragments)(filesDir, `jest.config.${options.js ? 'js' : 'ts'}`);
     if (tree.exists(existingJestConfig)) {
@@ -386,6 +436,10 @@ function replaceJestConfig(tree, options, filesDir) {
     });
 }
 async function normalizeOptions(tree, options) {
+    const nxJson = (0, devkit_1.readNxJson)(tree);
+    const addPlugin = process.env.NX_ADD_PLUGINS !== 'false' &&
+        nxJson.useInferencePlugins !== false;
+    options.addPlugin ??= addPlugin;
     /**
      * We are deprecating the compiler and the buildable options.
      * However, we want to keep the existing behavior for now.
@@ -420,7 +474,7 @@ async function normalizeOptions(tree, options) {
             options.bundler = 'tsc';
         }
     }
-    // This is to preserve old behaviour, buildable: false
+    // This is to preserve old behavior, buildable: false
     if (options.publishable === false && options.buildable === false) {
         options.bundler = 'none';
     }
@@ -512,7 +566,7 @@ function getBuildExecutor(bundler) {
     }
 }
 function getOutputPath(options) {
-    const parts = ['dist'];
+    const parts = [defaultOutputDirectory];
     if (options.projectRoot === '.') {
         parts.push(options.name);
     }
@@ -604,4 +658,94 @@ 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.`,
+    });
+}
 exports.default = libraryGenerator;

package/src/generators/library/schema.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "http://json-schema.org/schema",
+  "$schema": "https://json-schema.org/schema",
   "$id": "NxTypescriptLibrary",
   "cli": "nx",
   "title": "Create a TypeScript Library",
@@ -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.",
@@ -83,7 +89,7 @@
     "publishable": {
       "type": "boolean",
       "default": false,
-      "description": "Generate a publishable library.",
+      "description": "Configure the library ready for use with `nx release` (https://nx.dev/core-features/manage-releases).",
       "x-priority": "important"
     },
     "importPath": {

package/src/generators/release-version/release-version.d.ts

@@ -1,4 +1,5 @@
 import { Tree } from '@nx/devkit';
+import { ReleaseVersionGeneratorResult } from 'nx/src/command-line/release/version';
 import { ReleaseVersionGeneratorSchema } from './schema';
-export declare function releaseVersionGenerator(tree: Tree, options: ReleaseVersionGeneratorSchema): Promise<void>;
+export declare function releaseVersionGenerator(tree: Tree, options: ReleaseVersionGeneratorSchema): Promise<ReleaseVersionGeneratorResult>;
 export default releaseVersionGenerator;