@nx/js 16.7.0-beta.3 → 16.7.0-beta.4

package/generators.json

@@ -38,7 +38,7 @@
   },
   "generators": {
     "library": {
-      "factory": "./src/generators/library/library#libraryGenerator",
+      "factory": "./src/generators/library/library#libraryGeneratorInternal",
       "schema": "./src/generators/library/schema.json",
       "aliases": ["lib"],
       "x-type": "library",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/js",
-  "version": "16.7.0-beta.3",
+  "version": "16.7.0-beta.4",
   "private": false,
   "description": "The JS plugin for Nx contains executors and generators that provide the best experience for developing JavaScript and TypeScript projects. ",
   "repository": {
@@ -16,7 +16,7 @@
     "Tsc",
     "CLI"
   ],
-  "main": "src/index.js",
+  "main": "./src/index.js",
   "typings": "src/index.d.ts",
   "license": "MIT",
   "bugs": {
@@ -39,9 +39,9 @@
     "@babel/preset-env": "^7.22.9",
     "@babel/preset-typescript": "^7.22.5",
     "@babel/runtime": "^7.22.6",
-    "@nrwl/js": "16.7.0-beta.3",
-    "@nx/devkit": "16.7.0-beta.3",
-    "@nx/workspace": "16.7.0-beta.3",
+    "@nrwl/js": "16.7.0-beta.4",
+    "@nx/devkit": "16.7.0-beta.4",
+    "@nx/workspace": "16.7.0-beta.4",
     "@phenomnomnominal/tsquery": "~5.0.1",
     "babel-plugin-const-enum": "^1.0.1",
     "babel-plugin-macros": "^2.8.0",
@@ -70,6 +70,6 @@
   "publishConfig": {
     "access": "public"
   },
-  "types": "./src/index.d.ts",
-  "gitHead": "118faf4e432667fd041954d96aa6c9c99fea5ebd"
+  "type": "commonjs",
+  "gitHead": "dcbba686b182737b66ebbfb9db372769e77ba005"
 }

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

@@ -1,15 +1,17 @@
 import { GeneratorCallback, Tree } from '@nx/devkit';
+import { type ProjectNameAndRootOptions } from '@nx/devkit/src/generators/project-name-and-root-utils';
 import { LibraryGeneratorSchema } from '../../utils/schema';
 export declare function libraryGenerator(tree: Tree, schema: LibraryGeneratorSchema): Promise<GeneratorCallback>;
-export declare function projectGenerator(tree: Tree, schema: LibraryGeneratorSchema, destinationDir: string, filesDir: string): Promise<GeneratorCallback>;
+export declare function libraryGeneratorInternal(tree: Tree, schema: LibraryGeneratorSchema): Promise<GeneratorCallback>;
 export interface NormalizedSchema extends LibraryGeneratorSchema {
     name: string;
+    projectNames: ProjectNameAndRootOptions['names'];
     fileName: string;
     projectRoot: string;
-    projectDirectory: string;
     parsedTags: string[];
     importPath?: string;
 }
-export declare function addLint(tree: Tree, options: NormalizedSchema): Promise<GeneratorCallback>;
+export type AddLintOptions = Pick<NormalizedSchema, 'name' | 'linter' | 'projectRoot' | 'unitTestRunner' | 'js' | 'setParserOptionsProject' | 'rootProject'>;
+export declare function addLint(tree: Tree, options: AddLintOptions): Promise<GeneratorCallback>;
 export default libraryGenerator;
 export declare const librarySchematic: (generatorOptions: LibraryGeneratorSchema) => (tree: any, context: any) => Promise<any>;

package/src/generators/library/library.js

@@ -1,36 +1,35 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.librarySchematic = exports.addLint = exports.projectGenerator = exports.libraryGenerator = void 0;
+exports.librarySchematic = exports.addLint = exports.libraryGeneratorInternal = exports.libraryGenerator = void 0;
 const tslib_1 = require("tslib");
 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 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 get_import_path_1 = require("../../utils/get-import-path");
 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");
 function libraryGenerator(tree, schema) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
-        const { layoutDirectory, projectDirectory } = (0, devkit_1.extractLayoutDirectory)(schema.directory);
-        schema.directory = projectDirectory;
-        const libsDir = schema.rootProject
-            ? '.'
-            : layoutDirectory !== null && layoutDirectory !== void 0 ? layoutDirectory : (0, devkit_1.getWorkspaceLayout)(tree).libsDir;
-        return projectGenerator(tree, schema, libsDir, (0, path_1.join)(__dirname, './files'));
+        return yield libraryGeneratorInternal(tree, Object.assign({ 
+            // provide a default projectNameAndRootFormat to avoid breaking changes
+            // to external generators invoking this one
+            projectNameAndRootFormat: 'derived' }, schema));
     });
 }
 exports.libraryGenerator = libraryGenerator;
-function projectGenerator(tree, schema, destinationDir, filesDir) {
+function libraryGeneratorInternal(tree, schema) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const filesDir = (0, path_1.join)(__dirname, './files');
         const tasks = [];
         tasks.push(yield (0, init_1.default)(tree, Object.assign(Object.assign({}, schema), { skipFormat: true, tsConfigName: schema.rootProject ? 'tsconfig.json' : 'tsconfig.base.json' })));
-        const options = normalizeOptions(tree, schema, destinationDir);
+        const options = yield normalizeOptions(tree, schema);
         createFiles(tree, options, `${filesDir}/lib`);
-        addProject(tree, options, destinationDir);
+        addProject(tree, options);
         tasks.push(addProjectDependencies(tree, options));
         if (options.publishable) {
             tasks.push(yield (0, generator_1.default)(tree, Object.assign(Object.assign({}, options), { skipFormat: true })));
@@ -86,8 +85,8 @@ function projectGenerator(tree, schema, destinationDir, filesDir) {
         return (0, devkit_1.runTasksInSerial)(...tasks);
     });
 }
-exports.projectGenerator = projectGenerator;
-function addProject(tree, options, destinationDir) {
+exports.libraryGeneratorInternal = libraryGeneratorInternal;
+function addProject(tree, options) {
     var _a;
     var _b;
     const projectConfiguration = {
@@ -100,7 +99,7 @@ function addProject(tree, options, destinationDir) {
     if (options.bundler &&
         options.bundler !== 'none' &&
         options.config !== 'npm-scripts') {
-        const outputPath = getOutputPath(options, destinationDir);
+        const outputPath = getOutputPath(options);
         projectConfiguration.targets.build = {
             executor: getBuildExecutor(options.bundler),
             outputs: ['{options.outputPath}'],
@@ -212,7 +211,7 @@ function addBabelRc(tree, options) {
     (0, devkit_1.writeJson)(tree, (0, path_1.join)(options.projectRoot, filename), babelrc);
 }
 function createFiles(tree, options, filesDir) {
-    const { className, name, propertyName } = (0, devkit_1.names)(options.name);
+    const { className, name, propertyName } = (0, devkit_1.names)(options.projectNames.projectFileName);
     createProjectTsConfigJson(tree, options);
     (0, devkit_1.generateFiles)(tree, filesDir, options.projectRoot, Object.assign(Object.assign({}, options), { dot: '.', className,
         name,
@@ -290,90 +289,88 @@ function replaceJestConfig(tree, options, filesDir) {
         testEnvironment: options.testEnvironment,
     });
 }
-function normalizeOptions(tree, options, destinationDir) {
-    /**
-     * We are deprecating the compiler and the buildable options.
-     * However, we want to keep the existing behavior for now.
-     *
-     * So, if the user has not provided a bundler, we will use the compiler option, if any.
-     *
-     * If the user has not provided a bundler and no compiler, but has set buildable to true,
-     * we will use tsc, since that is the compiler the old generator used to default to, if buildable was true
-     * and no compiler was provided.
-     *
-     * If the user has not provided a bundler and no compiler, and has not set buildable to true, then
-     * set the bundler to tsc, to preserve old default behaviour (buildable: true by default).
-     *
-     * If it's publishable, we need to build the code before publishing it, so again
-     * we default to `tsc`. In the previous version of this, it would set `buildable` to true
-     * and that would default to `tsc`.
-     *
-     * In the past, the only way to get a non-buildable library was to set buildable to false.
-     * Now, the only way to get a non-buildble library is to set bundler to none.
-     * By default, with nothing provided, libraries are buildable with `@nx/js:tsc`.
-     */
-    var _a, _b, _c, _d;
-    options.bundler = (_b = (_a = options.bundler) !== null && _a !== void 0 ? _a : options.compiler) !== null && _b !== void 0 ? _b : 'tsc';
-    // ensure programmatic runs have an expected default
-    if (!options.config) {
-        options.config = 'project';
-    }
-    if (options.publishable) {
-        if (!options.importPath) {
-            throw new Error(`For publishable libs you have to provide a proper "--importPath" which needs to be a valid npm package name (e.g. my-awesome-lib or @myorg/my-lib)`);
+function normalizeOptions(tree, options) {
+    var _a, _b, _c;
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        /**
+         * We are deprecating the compiler and the buildable options.
+         * However, we want to keep the existing behavior for now.
+         *
+         * So, if the user has not provided a bundler, we will use the compiler option, if any.
+         *
+         * If the user has not provided a bundler and no compiler, but has set buildable to true,
+         * we will use tsc, since that is the compiler the old generator used to default to, if buildable was true
+         * and no compiler was provided.
+         *
+         * If the user has not provided a bundler and no compiler, and has not set buildable to true, then
+         * set the bundler to tsc, to preserve old default behaviour (buildable: true by default).
+         *
+         * If it's publishable, we need to build the code before publishing it, so again
+         * we default to `tsc`. In the previous version of this, it would set `buildable` to true
+         * and that would default to `tsc`.
+         *
+         * In the past, the only way to get a non-buildable library was to set buildable to false.
+         * Now, the only way to get a non-buildble library is to set bundler to none.
+         * By default, with nothing provided, libraries are buildable with `@nx/js:tsc`.
+         */
+        options.bundler = (_b = (_a = options.bundler) !== null && _a !== void 0 ? _a : options.compiler) !== null && _b !== void 0 ? _b : 'tsc';
+        // ensure programmatic runs have an expected default
+        if (!options.config) {
+            options.config = 'project';
         }
-        if (options.bundler === 'none') {
-            options.bundler = 'tsc';
+        if (options.publishable) {
+            if (!options.importPath) {
+                throw new Error(`For publishable libs you have to provide a proper "--importPath" which needs to be a valid npm package name (e.g. my-awesome-lib or @myorg/my-lib)`);
+            }
+            if (options.bundler === 'none') {
+                options.bundler = 'tsc';
+            }
         }
-    }
-    // This is to preserve old behaviour, buildable: false
-    if (options.publishable === false && options.buildable === false) {
-        options.bundler = 'none';
-    }
-    const { Linter } = (0, devkit_1.ensurePackage)('@nx/linter', versions_1.nxVersion);
-    if (options.config === 'npm-scripts') {
-        options.unitTestRunner = 'none';
-        options.linter = Linter.None;
-        options.bundler = 'none';
-    }
-    if ((options.bundler === 'swc' || options.bundler === 'rollup') &&
-        options.skipTypeCheck == null) {
-        options.skipTypeCheck = false;
-    }
-    const name = (0, devkit_1.names)(options.name).fileName;
-    const projectDirectory = options.directory
-        ? `${(0, devkit_1.names)(options.directory).fileName}/${name}`
-        : options.rootProject
-            ? '.'
-            : name;
-    if (!options.unitTestRunner && options.bundler === 'vite') {
-        options.unitTestRunner = 'vitest';
-    }
-    else if (!options.unitTestRunner && options.config !== 'npm-scripts') {
-        options.unitTestRunner = 'jest';
-    }
-    if (!options.linter && options.config !== 'npm-scripts') {
-        options.linter = Linter.EsLint;
-    }
-    const projectName = options.rootProject
-        ? name
-        : projectDirectory.replace(new RegExp('/', 'g'), '-');
-    const fileName = getCaseAwareFileName({
-        fileName: options.simpleName ? name : projectName,
-        pascalCaseFiles: options.pascalCaseFiles,
+        // This is to preserve old behaviour, buildable: false
+        if (options.publishable === false && options.buildable === false) {
+            options.bundler = 'none';
+        }
+        const { Linter } = (0, devkit_1.ensurePackage)('@nx/linter', versions_1.nxVersion);
+        if (options.config === 'npm-scripts') {
+            options.unitTestRunner = 'none';
+            options.linter = Linter.None;
+            options.bundler = 'none';
+        }
+        if ((options.bundler === 'swc' || options.bundler === 'rollup') &&
+            options.skipTypeCheck == null) {
+            options.skipTypeCheck = false;
+        }
+        if (!options.unitTestRunner && options.bundler === 'vite') {
+            options.unitTestRunner = 'vitest';
+        }
+        else if (!options.unitTestRunner && options.config !== 'npm-scripts') {
+            options.unitTestRunner = 'jest';
+        }
+        if (!options.linter && options.config !== 'npm-scripts') {
+            options.linter = Linter.EsLint;
+        }
+        const { projectName, names: projectNames, projectDirectory, importPath, } = yield (0, project_name_and_root_utils_1.determineProjectNameAndRootOptions)(tree, {
+            name: options.name,
+            projectType: 'library',
+            directory: options.directory,
+            importPath: options.importPath,
+            projectNameAndRootFormat: options.projectNameAndRootFormat,
+            rootProject: options.rootProject,
+        });
+        options.rootProject = projectDirectory === '.';
+        const fileName = getCaseAwareFileName({
+            fileName: options.simpleName
+                ? projectNames.projectSimpleName
+                : projectNames.projectFileName,
+            pascalCaseFiles: options.pascalCaseFiles,
+        });
+        const parsedTags = options.tags
+            ? options.tags.split(',').map((s) => s.trim())
+            : [];
+        (_c = options.minimal) !== null && _c !== void 0 ? _c : (options.minimal = false);
+        return Object.assign(Object.assign({}, options), { fileName, name: projectName, projectNames, projectRoot: projectDirectory, parsedTags,
+            importPath });
     });
-    const projectRoot = (0, devkit_1.joinPathFragments)(destinationDir, projectDirectory);
-    const parsedTags = options.tags
-        ? options.tags.split(',').map((s) => s.trim())
-        : [];
-    const importPath = options.rootProject
-        ? (_c = (0, devkit_1.readJson)(tree, 'package.json').name) !== null && _c !== void 0 ? _c : (0, get_import_path_1.getImportPath)(tree, 'core')
-        : options.importPath || (0, get_import_path_1.getImportPath)(tree, projectDirectory);
-    (_d = options.minimal) !== null && _d !== void 0 ? _d : (options.minimal = false);
-    return Object.assign(Object.assign({}, options), { fileName, name: projectName, projectRoot,
-        projectDirectory,
-        parsedTags,
-        importPath });
 }
 function getCaseAwareFileName(options) {
     const normalized = (0, devkit_1.names)(options.fileName);
@@ -413,16 +410,13 @@ function getBuildExecutor(bundler) {
             return undefined;
     }
 }
-function getOutputPath(options, destinationDir) {
+function getOutputPath(options) {
     const parts = ['dist'];
-    if (destinationDir) {
-        parts.push(destinationDir);
-    }
-    if (options.projectDirectory === '.') {
+    if (options.projectRoot === '.') {
         parts.push(options.name);
     }
     else {
-        parts.push(options.projectDirectory);
+        parts.push(options.projectRoot);
     }
     return (0, devkit_1.joinPathFragments)(...parts);
 }
@@ -506,4 +500,4 @@ function determineEntryFields(options) {
     }
 }
 exports.default = libraryGenerator;
-exports.librarySchematic = (0, devkit_1.convertNxGenerator)(libraryGenerator);
+exports.librarySchematic = (0, devkit_1.convertNxGenerator)(libraryGeneratorInternal);

package/src/generators/library/schema.json

@@ -14,13 +14,18 @@
         "index": 0
       },
       "x-prompt": "What name would you like to use for the library?",
-      "pattern": "^[a-zA-Z].*$"
+      "pattern": "(?:^@[a-zA-Z0-9-*~][a-zA-Z0-9-*._~]*\\/[a-zA-Z0-9-~][a-zA-Z0-9-._~]*|^[a-zA-Z][^:]*)$"
     },
     "directory": {
       "type": "string",
       "description": "A directory where the lib is placed.",
       "x-priority": "important"
     },
+    "projectNameAndRootFormat": {
+      "description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
+      "type": "string",
+      "enum": ["as-provided", "derived"]
+    },
     "linter": {
       "description": "The tool to use for running lint checks.",
       "type": "string",

package/src/utils/schema.d.ts

@@ -1,3 +1,4 @@
+import type { ProjectNameAndRootFormat } from '@nx/devkit/src/generators/project-name-directory-utils';
 // nx-ignore-next-line
 const { Linter } = require('@nx/linter'); // use require to import to avoid circular dependency
 import type { AssetGlob, FileInputOutput } from './assets/assets';
@@ -9,6 +10,7 @@ export type Bundler = 'swc' | 'tsc' | 'rollup' | 'vite' | 'esbuild' | 'none';
 export interface LibraryGeneratorSchema {
   name: string;
   directory?: string;
+  projectNameAndRootFormat?: ProjectNameAndRootFormat;
   skipFormat?: boolean;
   tags?: string;
   skipTsConfig?: boolean;