@nx/js 20.1.0 → 20.2.0-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/js",
-  "version": "20.1.0",
+  "version": "20.2.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.1.0",
-    "@nx/workspace": "20.1.0",
+    "@nx/devkit": "20.2.0-beta.0",
+    "@nx/workspace": "20.2.0-beta.0",
     "@zkochan/js-yaml": "0.0.7",
     "babel-plugin-const-enum": "^1.0.1",
     "babel-plugin-macros": "^2.8.0",

package/src/executors/tsc/lib/normalize-options.js

@@ -35,5 +35,6 @@ function normalizeOptions(options, contextRoot, sourceRoot, projectRoot) {
         tsConfig: (0, path_1.join)(contextRoot, options.tsConfig),
         rootDir,
         mainOutputPath: (0, path_1.resolve)(outputPath, options.main.replace(`${projectRoot}/`, '').replace('.ts', '.js')),
+        generatePackageJson: options.generatePackageJson ?? true,
     };
 }

package/src/executors/tsc/schema.json

@@ -16,13 +16,13 @@
     "generateExportsField": {
       "type": "boolean",
       "alias": "exports",
-      "description": "Update the output package.json file's 'exports' field. This field is used by Node and bundles.",
+      "description": "Update the output package.json file's 'exports' field. This field is used by Node and bundlers. Ignored when `generatePackageJson` is set to `false`.",
       "default": false,
       "x-priority": "important"
     },
     "additionalEntryPoints": {
       "type": "array",
-      "description": "Additional entry-points to add to exports field in the package.json file.",
+      "description": "Additional entry-points to add to exports field in the package.json file. Ignored when `generatePackageJson` is set to `false`.",
       "items": {
         "type": "string"
       },
@@ -103,9 +103,14 @@
     },
     "generateLockfile": {
       "type": "boolean",
-      "description": "Generate a lockfile (e.g. package-lock.json) that matches the workspace lockfile to ensure package versions match.",
+      "description": "Generate a lockfile (e.g. package-lock.json) that matches the workspace lockfile to ensure package versions match. Ignored when `generatePackageJson` is set to `false`.",
       "default": false,
       "x-priority": "internal"
+    },
+    "generatePackageJson": {
+      "type": "boolean",
+      "description": "Generate package.json file in the output folder.",
+      "default": true
     }
   },
   "required": ["main", "outputPath", "tsConfig"],

package/src/executors/tsc/tsc.impl.js

@@ -63,11 +63,13 @@ async function* tscExecutor(_options, context) {
     }
     const typescriptCompilation = (0, compile_typescript_files_1.compileTypeScriptFiles)(options, tsCompilationOptions, async () => {
         await assetHandler.processAllAssetsOnce();
-        (0, update_package_json_1.updatePackageJson)({
-            ...options,
-            additionalEntryPoints: (0, create_entry_points_1.createEntryPoints)(options.additionalEntryPoints, context.root),
-            format: [determineModuleFormatFromTsConfig(options.tsConfig)],
-        }, context, target, dependencies);
+        if (options.generatePackageJson) {
+            (0, update_package_json_1.updatePackageJson)({
+                ...options,
+                additionalEntryPoints: (0, create_entry_points_1.createEntryPoints)(options.additionalEntryPoints, context.root),
+                format: [determineModuleFormatFromTsConfig(options.tsConfig)],
+            }, context, target, dependencies);
+        }
         (0, inline_1.postProcessInlinedDependencies)(tsCompilationOptions.outputPath, tsCompilationOptions.projectRoot, inlineProjectGraph);
     });
     if (!(0, devkit_1.isDaemonEnabled)() && options.watch) {
@@ -77,15 +79,18 @@ async function* tscExecutor(_options, context) {
     }
     if ((0, devkit_1.isDaemonEnabled)() && options.watch) {
         const disposeWatchAssetChanges = await assetHandler.watchAndProcessOnAssetChange();
-        const disposePackageJsonChanges = await (0, watch_for_single_file_changes_1.watchForSingleFileChanges)(context.projectName, options.projectRoot, 'package.json', () => (0, update_package_json_1.updatePackageJson)({
-            ...options,
-            additionalEntryPoints: (0, create_entry_points_1.createEntryPoints)(options.additionalEntryPoints, context.root),
-            format: [determineModuleFormatFromTsConfig(options.tsConfig)],
-        }, context, target, dependencies));
+        let disposePackageJsonChanges;
+        if (options.generatePackageJson) {
+            disposePackageJsonChanges = await (0, watch_for_single_file_changes_1.watchForSingleFileChanges)(context.projectName, options.projectRoot, 'package.json', () => (0, update_package_json_1.updatePackageJson)({
+                ...options,
+                additionalEntryPoints: (0, create_entry_points_1.createEntryPoints)(options.additionalEntryPoints, context.root),
+                format: [determineModuleFormatFromTsConfig(options.tsConfig)],
+            }, context, target, dependencies));
+        }
         const handleTermination = async (exitCode) => {
             await typescriptCompilation.close();
             disposeWatchAssetChanges();
-            disposePackageJsonChanges();
+            disposePackageJsonChanges?.();
             process.exit(exitCode);
         };
         process.on('SIGINT', () => handleTermination(128 + 2));

package/src/generators/library/library.js

@@ -10,17 +10,18 @@ const target_defaults_utils_1 = require("@nx/devkit/src/generators/target-defaul
 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 package_manager_workspaces_1 = require("../../utils/package-manager-workspaces");
 const add_swc_config_1 = require("../../utils/swc/add-swc-config");
 const add_swc_dependencies_1 = require("../../utils/swc/add-swc-dependencies");
 const configuration_1 = require("../../utils/typescript/configuration");
 const create_ts_config_1 = require("../../utils/typescript/create-ts-config");
+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");
 const init_1 = require("../init/init");
 const generator_1 = require("../setup-verdaccio/generator");
-const plugin_1 = require("../../utils/typescript/plugin");
 const defaultOutputDirectory = 'dist';
 async function libraryGenerator(tree, schema) {
     return await libraryGeneratorInternal(tree, {
@@ -115,12 +116,6 @@ async function libraryGeneratorInternal(tree, schema) {
     }
     if (options.isUsingTsSolutionConfig && options.unitTestRunner !== 'none') {
         (0, devkit_1.updateJson)(tree, (0, devkit_1.joinPathFragments)(options.projectRoot, 'tsconfig.spec.json'), (json) => {
-            const rootOffset = (0, devkit_1.offsetFromRoot)(options.projectRoot);
-            // ensure it extends from the root tsconfig.base.json
-            json.extends = (0, devkit_1.joinPathFragments)(rootOffset, 'tsconfig.base.json');
-            // ensure outDir is set to the correct value
-            json.compilerOptions ??= {};
-            json.compilerOptions.outDir = (0, devkit_1.joinPathFragments)(rootOffset, 'dist/out-tsc', options.projectRoot);
             // add project reference to the runtime tsconfig.lib.json file
             json.references ??= [];
             json.references.push({ path: './tsconfig.lib.json' });
@@ -130,7 +125,8 @@ async function libraryGeneratorInternal(tree, schema) {
     if (!options.skipFormat) {
         await (0, devkit_1.formatFiles)(tree);
     }
-    if (options.isUsingTsSolutionConfig &&
+    if (!options.skipWorkspacesWarning &&
+        options.isUsingTsSolutionConfig &&
         options.projectPackageManagerWorkspaceState !== 'included') {
         tasks.push((0, package_manager_workspaces_1.getProjectPackageManagerWorkspaceStateWarningTask)(options.projectPackageManagerWorkspaceState, tree.root));
     }
@@ -165,7 +161,8 @@ async function configureProject(tree, options) {
     if (options.config !== 'npm-scripts' &&
         (options.bundler === 'swc' ||
             options.bundler === 'esbuild' ||
-            (!options.isUsingTsSolutionConfig && options.bundler === 'tsc'))) {
+            ((!options.isUsingTsSolutionConfig || options.useTscExecutor) &&
+                options.bundler === 'tsc'))) {
         const outputPath = getOutputPath(options);
         const executor = getBuildExecutor(options.bundler);
         (0, target_defaults_utils_1.addBuildTargetDefaults)(tree, executor);
@@ -188,6 +185,9 @@ async function configureProject(tree, options) {
             if (options.bundler === 'esbuild') {
                 projectConfiguration.targets.build.options.declarationRootDir = `${options.projectRoot}/src`;
             }
+            else if (options.bundler === 'swc') {
+                projectConfiguration.targets.build.options.stripLeadingPaths = true;
+            }
         }
         else {
             projectConfiguration.targets.build.options.assets = [];
@@ -227,8 +227,6 @@ async function configureProject(tree, options) {
         if (!projectConfiguration.tags?.length) {
             delete projectConfiguration.tags;
         }
-        // automatically inferred as `library`
-        delete projectConfiguration.projectType;
         // empty targets are cleaned up automatically by `updateProjectConfiguration`
         (0, devkit_1.updateProjectConfiguration)(tree, options.name, projectConfiguration);
     }
@@ -475,16 +473,10 @@ async function normalizeOptions(tree, options) {
     options.addPlugin ??=
         process.env.NX_ADD_PLUGINS !== 'false' &&
             nxJson.useInferencePlugins !== false;
+    options.linter = await (0, generator_prompts_1.normalizeLinterOption)(tree, options.linter);
     const hasPlugin = (0, ts_solution_setup_1.isUsingTypeScriptPlugin)(tree);
     const isUsingTsSolutionConfig = (0, ts_solution_setup_1.isUsingTsSolutionSetup)(tree);
     if (isUsingTsSolutionConfig) {
-        options.linter ??= await (0, prompt_1.promptWhenInteractive)({
-            type: 'autocomplete',
-            name: 'linter',
-            message: `Which linter would you like to use?`,
-            choices: [{ name: 'none' }, { name: 'eslint' }],
-            initial: 0,
-        }, { linter: 'none' }).then(({ linter }) => linter);
         options.unitTestRunner ??= await (0, prompt_1.promptWhenInteractive)({
             type: 'autocomplete',
             name: 'unitTestRunner',
@@ -494,13 +486,6 @@ async function normalizeOptions(tree, options) {
         }, { unitTestRunner: 'none' }).then(({ unitTestRunner }) => unitTestRunner);
     }
     else {
-        options.linter ??= await (0, prompt_1.promptWhenInteractive)({
-            type: 'autocomplete',
-            name: 'linter',
-            message: `Which linter would you like to use?`,
-            choices: [{ name: 'eslint' }, { name: 'none' }],
-            initial: 0,
-        }, { linter: 'eslint' }).then(({ linter }) => linter);
         options.unitTestRunner ??= await (0, prompt_1.promptWhenInteractive)({
             type: 'autocomplete',
             name: 'unitTestRunner',
@@ -784,10 +769,10 @@ function determineEntryFields(options) {
             return {
                 type: 'commonjs',
                 main: options.isUsingTsSolutionConfig
-                    ? './dist/src/index.js'
+                    ? './dist/index.js'
                     : './src/index.js',
                 typings: options.isUsingTsSolutionConfig
-                    ? './dist/src/index.d.ts'
+                    ? './dist/index.d.ts'
                     : './src/index.d.ts',
             };
         case 'rollup':

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

@@ -37,6 +37,8 @@ export interface LibraryGeneratorSchema {
   simpleName?: boolean;
   addPlugin?: boolean;
   useProjectJson?: boolean;
+  skipWorkspacesWarning?: boolean;
+  useTscExecutor?: boolean;
 }
 
 export interface NormalizedLibraryGeneratorOptions

package/src/utils/add-local-registry-scripts.js

@@ -2,13 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.addLocalRegistryScripts = addLocalRegistryScripts;
 const devkit_1 = require("@nx/devkit");
-const startLocalRegistryScript = (localRegistryTarget) => `
-/**
+const startLocalRegistryScript = (localRegistryTarget) => `/**
  * This script starts a local registry for e2e testing purposes.
  * It is meant to be called in jest's globalSetup.
  */
+
+/// <reference path="registry.d.ts" />
+
 import { startLocalRegistry } from '@nx/js/plugins/jest/local-registry';
-import { execFileSync } from 'child_process';
 import { releasePublish, releaseVersion } from 'nx/release';
 
 export default async () => {
@@ -39,23 +40,35 @@ export default async () => {
   });
 };
 `;
-const stopLocalRegistryScript = `
-/**
+const stopLocalRegistryScript = `/**
  * This script stops the local registry for e2e testing purposes.
  * It is meant to be called in jest's globalTeardown.
  */
 
+/// <reference path="registry.d.ts" />
+
 export default () => {
   if (global.stopLocalRegistry) {
     global.stopLocalRegistry();
   }
 };
 `;
+const registryDeclarationText = `declare function stopLocalRegistry(): void;
+`;
 function addLocalRegistryScripts(tree) {
     const startLocalRegistryPath = 'tools/scripts/start-local-registry.ts';
     const stopLocalRegistryPath = 'tools/scripts/stop-local-registry.ts';
-    const projectConfiguration = (0, devkit_1.readJson)(tree, 'project.json');
-    const localRegistryTarget = `${projectConfiguration.name}:local-registry`;
+    const registryDeclarationPath = 'tools/scripts/registry.d.ts';
+    let projectName;
+    try {
+        ({ name: projectName } = (0, devkit_1.readJson)(tree, 'project.json'));
+    }
+    catch {
+        // if project.json doesn't exist, try package.json
+        const { name, nx } = (0, devkit_1.readJson)(tree, 'package.json');
+        projectName = nx?.name ?? name;
+    }
+    const localRegistryTarget = `${projectName}:local-registry`;
     if (!tree.exists(startLocalRegistryPath)) {
         tree.write(startLocalRegistryPath, startLocalRegistryScript(localRegistryTarget));
     }
@@ -72,5 +85,8 @@ function addLocalRegistryScripts(tree) {
     if (!tree.exists(stopLocalRegistryPath)) {
         tree.write(stopLocalRegistryPath, stopLocalRegistryScript);
     }
+    if (!tree.exists(registryDeclarationPath)) {
+        tree.write(registryDeclarationPath, registryDeclarationText);
+    }
     return { startLocalRegistryPath, stopLocalRegistryPath };
 }

package/src/utils/generator-prompts.d.ts

@@ -0,0 +1,3 @@
+import type { Tree } from '@nx/devkit';
+export declare function normalizeLinterOption(tree: Tree, linter: undefined | 'none' | 'eslint'): Promise<'none' | 'eslint'>;
+export declare function normalizeUnitTestRunnerOption<T extends 'none' | 'jest' | 'vitest'>(tree: Tree, unitTestRunner: undefined | T, testRunners?: Array<'jest' | 'vitest'>): Promise<T>;

package/src/utils/generator-prompts.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeLinterOption = normalizeLinterOption;
+exports.normalizeUnitTestRunnerOption = normalizeUnitTestRunnerOption;
+const prompt_1 = require("@nx/devkit/src/generators/prompt");
+const ts_solution_setup_1 = require("./typescript/ts-solution-setup");
+async function normalizeLinterOption(tree, linter) {
+    if (linter) {
+        return linter;
+    }
+    const isTsSolutionSetup = (0, ts_solution_setup_1.isUsingTsSolutionSetup)(tree);
+    const choices = isTsSolutionSetup
+        ? [{ name: 'none' }, { name: 'eslint' }]
+        : [{ name: 'eslint' }, { name: 'none' }];
+    const defaultValue = isTsSolutionSetup ? 'none' : 'eslint';
+    return await (0, prompt_1.promptWhenInteractive)({
+        type: 'autocomplete',
+        name: 'linter',
+        message: `Which linter would you like to use?`,
+        choices,
+        initial: 0,
+    }, { linter: defaultValue }).then(({ linter }) => linter);
+}
+async function normalizeUnitTestRunnerOption(tree, unitTestRunner, testRunners = ['jest', 'vitest']) {
+    if (unitTestRunner) {
+        return unitTestRunner;
+    }
+    const isTsSolutionSetup = (0, ts_solution_setup_1.isUsingTsSolutionSetup)(tree);
+    const choices = isTsSolutionSetup
+        ? [{ name: 'none' }, ...testRunners.map((runner) => ({ name: runner }))]
+        : [...testRunners.map((runner) => ({ name: runner })), { name: 'none' }];
+    const defaultValue = (isTsSolutionSetup ? 'none' : testRunners[0]);
+    return await (0, prompt_1.promptWhenInteractive)({
+        type: 'autocomplete',
+        name: 'unitTestRunner',
+        message: `Which unit test runner would you like to use?`,
+        choices,
+        initial: 0,
+    }, { unitTestRunner: defaultValue }).then(({ unitTestRunner }) => unitTestRunner);
+}

package/src/utils/package-json/update-package-json.js

@@ -114,7 +114,7 @@ function addMissingDependencies(packageJson, { projectName, targetName, configur
 function getExports(options) {
     const outputDir = getOutputDir(options);
     const mainFile = options.outputFileName
-        ? options.outputFileName.replace(/\.[tj]s$/, '')
+        ? (0, path_1.basename)(options.outputFileName).replace(/\.[tj]s$/, '')
         : (0, path_1.basename)(options.main).replace(/\.[tj]s$/, '');
     const exports = {
         '.': outputDir + mainFile + options.fileExt,
@@ -218,8 +218,8 @@ function getOutputDir(options) {
         : options.outputPath;
     const relativeOutputPath = (0, path_1.relative)(packageJsonDir, options.outputPath);
     const relativeMainDir = options.outputFileName
-        ? ''
+        ? (0, path_1.dirname)(options.outputFileName)
         : (0, path_1.relative)(options.rootDir ?? options.projectRoot, (0, path_1.dirname)(options.main));
-    const outputDir = (0, path_1.join)(relativeOutputPath, relativeMainDir);
+    const outputDir = (0, devkit_1.joinPathFragments)(relativeOutputPath, relativeMainDir);
     return outputDir === '.' ? `./` : `./${outputDir}/`;
 }

package/src/utils/schema.d.ts

@@ -19,12 +19,14 @@ export interface ExecutorOptions {
   externalBuildTargets?: string[];
   generateLockfile?: boolean;
   stripLeadingPaths?: boolean;
+  generatePackageJson?: boolean;
 }
 
 export interface NormalizedExecutorOptions extends ExecutorOptions {
   rootDir: string;
   projectRoot: string;
   mainOutputPath: string;
+  generatePackageJson: boolean;
   files: Array<FileInputOutput>;
   root?: string;
   sourceRoot?: string;