@nx/plugin 17.0.0-beta.4 → 17.0.0-beta.6

package/generators.json

@@ -29,7 +29,7 @@
       "description": "Create a generator for an Nx Plugin."
     },
     "executor": {
-      "factory": "./src/generators/executor/executor",
+      "factory": "./src/generators/executor/executor#executorGeneratorInternal",
       "schema": "./src/generators/executor/schema.json",
       "description": "Create an executor for an Nx Plugin."
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/plugin",
-  "version": "17.0.0-beta.4",
+  "version": "17.0.0-beta.6",
   "private": false,
   "description": "This plugin is used to create Nx plugins! It contains generators for generating common plugin features like generators, executors, migrations and more.",
   "repository": {
@@ -31,11 +31,11 @@
     "@phenomnomnominal/tsquery": "~5.0.1",
     "fs-extra": "^11.1.0",
     "tslib": "^2.3.0",
-    "@nx/devkit": "17.0.0-beta.4",
-    "@nx/jest": "17.0.0-beta.4",
-    "@nx/js": "17.0.0-beta.4",
-    "@nx/linter": "17.0.0-beta.4",
-    "@nrwl/nx-plugin": "17.0.0-beta.4"
+    "@nx/devkit": "17.0.0-beta.6",
+    "@nx/jest": "17.0.0-beta.6",
+    "@nx/js": "17.0.0-beta.6",
+    "@nx/linter": "17.0.0-beta.6",
+    "@nrwl/nx-plugin": "17.0.0-beta.6"
   },
   "publishConfig": {
     "access": "public"

package/src/generators/executor/executor.d.ts

@@ -1,5 +1,6 @@
 import type { Tree } from '@nx/devkit';
 import type { Schema } from './schema';
 export declare function createExecutorsJson(host: Tree, projectRoot: string, projectName: string, skipLintChecks?: boolean): Promise<void>;
-export declare function executorGenerator(host: Tree, schema: Schema): Promise<void>;
+export declare function executorGenerator(tree: Tree, rawOptions: Schema): Promise<void>;
+export declare function executorGeneratorInternal(host: Tree, schema: Schema): Promise<void>;
 export default executorGenerator;

package/src/generators/executor/executor.js

@@ -1,26 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.executorGenerator = exports.createExecutorsJson = void 0;
+exports.executorGeneratorInternal = exports.executorGenerator = exports.createExecutorsJson = void 0;
 const devkit_1 = require("@nx/devkit");
 const path = require("path");
 const generator_1 = require("../lint-checks/generator");
 const versions_1 = require("../../utils/versions");
+const get_npm_scope_1 = require("@nx/js/src/utils/package-json/get-npm-scope");
+const artifact_name_and_directory_utils_1 = require("@nx/devkit/src/generators/artifact-name-and-directory-utils");
+const path_1 = require("path");
 function addFiles(host, options) {
-    (0, devkit_1.generateFiles)(host, path.join(__dirname, './files/executor'), `${options.projectSourceRoot}/executors`, {
+    (0, devkit_1.generateFiles)(host, path.join(__dirname, './files/executor'), options.directory, {
         ...options,
-        tmpl: '',
     });
     if (options.unitTestRunner === 'none') {
-        host.delete((0, devkit_1.joinPathFragments)(options.projectSourceRoot, 'executors', options.fileName, `executor.spec.ts`));
+        host.delete((0, devkit_1.joinPathFragments)(options.directory, `executor.spec.ts`));
     }
 }
 function addHasherFiles(host, options) {
-    (0, devkit_1.generateFiles)(host, path.join(__dirname, './files/hasher'), `${options.projectSourceRoot}/executors`, {
+    (0, devkit_1.generateFiles)(host, path.join(__dirname, './files/hasher'), options.directory, {
         ...options,
-        tmpl: '',
     });
     if (options.unitTestRunner === 'none') {
-        host.delete((0, devkit_1.joinPathFragments)(options.projectSourceRoot, 'executors', options.fileName, 'hasher.spec.ts'));
+        host.delete((0, devkit_1.joinPathFragments)(options.directory, 'hasher.spec.ts'));
     }
 }
 async function createExecutorsJson(host, projectRoot, projectName, skipLintChecks) {
@@ -62,21 +63,32 @@ async function updateExecutorJson(host, options) {
         let executors = json.executors ?? json.builders;
         executors ||= {};
         executors[options.name] = {
-            implementation: `./src/executors/${options.fileName}/executor`,
-            schema: `./src/executors/${options.fileName}/schema.json`,
+            implementation: `./${(0, devkit_1.normalizePath)((0, path_1.relative)(options.projectRoot, (0, path_1.join)(options.directory, 'executor')))}`,
+            schema: `./${(0, devkit_1.normalizePath)((0, path_1.relative)(options.projectRoot, (0, path_1.join)(options.directory, 'schema.json')))}`,
             description: options.description,
         };
         if (options.includeHasher) {
-            executors[options.name].hasher = `./src/executors/${options.fileName}/hasher`;
+            executors[options.name].hasher = `./${(0, devkit_1.normalizePath)((0, path_1.relative)(options.projectRoot, (0, path_1.join)(options.directory, 'hasher')))}`;
         }
         json.executors = executors;
         return json;
     });
 }
-function normalizeOptions(host, options) {
-    const { npmScope } = (0, devkit_1.getWorkspaceLayout)(host);
-    const { fileName, className, propertyName } = (0, devkit_1.names)(options.name);
-    const { root: projectRoot, sourceRoot: projectSourceRoot } = (0, devkit_1.readProjectConfiguration)(host, options.project);
+async function normalizeOptions(tree, options) {
+    const npmScope = (0, get_npm_scope_1.getNpmScope)(tree);
+    const res = await (0, artifact_name_and_directory_utils_1.determineArtifactNameAndDirectoryOptions)(tree, {
+        artifactType: 'executor',
+        callingGenerator: '@nx/plugin:executor',
+        name: options.name,
+        nameAndDirectoryFormat: options.nameAndDirectoryFormat,
+        project: options.project,
+        directory: options.directory,
+        fileName: 'executor',
+        derivedDirectory: 'executors',
+    });
+    const { project, fileName, artifactName, filePath, directory } = res;
+    const { className, propertyName } = (0, devkit_1.names)(artifactName);
+    const { root: projectRoot } = (0, devkit_1.readProjectConfiguration)(tree, project);
     let description;
     if (options.description) {
         description = options.description;
@@ -86,17 +98,26 @@ function normalizeOptions(host, options) {
     }
     return {
         ...options,
+        filePath,
+        project,
+        directory,
         fileName,
         className,
         propertyName,
         description,
         projectRoot,
-        projectSourceRoot,
         npmScope,
     };
 }
-async function executorGenerator(host, schema) {
-    const options = normalizeOptions(host, schema);
+async function executorGenerator(tree, rawOptions) {
+    await executorGeneratorInternal(tree, {
+        nameAndDirectoryFormat: 'derived',
+        ...rawOptions,
+    });
+}
+exports.executorGenerator = executorGenerator;
+async function executorGeneratorInternal(host, schema) {
+    const options = await normalizeOptions(host, schema);
     addFiles(host, options);
     if (options.includeHasher) {
         addHasherFiles(host, options);
@@ -106,5 +127,5 @@ async function executorGenerator(host, schema) {
         await (0, devkit_1.formatFiles)(host);
     }
 }
-exports.executorGenerator = executorGenerator;
+exports.executorGeneratorInternal = executorGeneratorInternal;
 exports.default = executorGenerator;

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

@@ -1,9 +1,13 @@
+import type { NameAndDirectoryFormat } from '@nx/devkit/src/generators/artifact-name-and-directory-utils';
+
 export interface Schema {
-  project: string;
+  project?: string;
   name: string;
+  directory?: string;
   description?: string;
   unitTestRunner: 'jest' | 'none';
   includeHasher: boolean;
+  nameAndDirectoryFormat?: NameAndDirectoryFormat;
   skipLintChecks?: boolean;
   skipFormat?: boolean;
 }

package/src/generators/executor/schema.json

@@ -19,9 +19,7 @@
       "alias": "p",
       "$default": {
         "$source": "projectName"
-      },
-      "x-prompt": "What is the name of the project for the executor?",
-      "x-priority": "important"
+      }
     },
     "name": {
       "type": "string",
@@ -33,6 +31,11 @@
       "x-prompt": "What name would you like to use for the executor?",
       "x-priority": "important"
     },
+    "directory": {
+      "type": "string",
+      "description": "The directory at which to create the executor file. When `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. Otherwise, it will be relative to the workspace root.",
+      "aliases": ["dir"]
+    },
     "description": {
       "type": "string",
       "description": "Executor description."
@@ -53,6 +56,11 @@
       "default": false,
       "description": "Do not add an eslint configuration for plugin json files."
     },
+    "nameAndDirectoryFormat": {
+      "description": "Whether to generate the component in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
+      "type": "string",
+      "enum": ["as-provided", "derived"]
+    },
     "skipFormat": {
       "type": "boolean",
       "description": "Skip formatting files.",
@@ -60,6 +68,6 @@
       "x-priority": "internal"
     }
   },
-  "required": ["project", "name"],
+  "required": ["name"],
   "additionalProperties": false
 }