@nx/plugin 20.2.0-beta.3 → 20.2.0-beta.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/plugin",
-  "version": "20.2.0-beta.3",
+  "version": "20.2.0-beta.5",
   "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": {
@@ -28,10 +28,10 @@
   },
   "dependencies": {
     "tslib": "^2.3.0",
-    "@nx/devkit": "20.2.0-beta.3",
-    "@nx/jest": "20.2.0-beta.3",
-    "@nx/js": "20.2.0-beta.3",
-    "@nx/eslint": "20.2.0-beta.3"
+    "@nx/devkit": "20.2.0-beta.5",
+    "@nx/jest": "20.2.0-beta.5",
+    "@nx/js": "20.2.0-beta.5",
+    "@nx/eslint": "20.2.0-beta.5"
   },
   "publishConfig": {
     "access": "public"

package/src/generators/executor/schema.json

@@ -6,17 +6,11 @@
   "description": "Create an Executor for an Nx Plugin.",
   "examplesFile": "../../../docs/generators/executor-examples.md",
   "type": "object",
-  "examples": [
-    {
-      "command": "nx g executor my-executor --project=my-plugin",
-      "description": "Generate `libs/my-plugin/src/executors/my-executor`"
-    }
-  ],
   "properties": {
     "path": {
       "type": "string",
-      "description": "Path at which to generate the executor file.",
-      "x-prompt": "What path would you like to use for the executor?",
+      "description": "The file path to the executor without the file extension. Relative to the current working directory.",
+      "x-prompt": "What is the executor file path?",
       "$default": {
         "$source": "argv",
         "index": 0
@@ -25,9 +19,7 @@
     },
     "name": {
       "type": "string",
-      "description": "Executor name.",
-      "x-prompt": "What name would you like to use for the executor?",
-      "x-priority": "important"
+      "description": "The executor name to export in the plugin executors collection."
     },
     "description": {
       "type": "string",

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

@@ -1,5 +1,3 @@
-import { NameAndDirectoryFormat } from '@nx/devkit/src/generators/artifact-name-and-directory-utils';
-
 export interface Schema {
   path: string;
   name?: string;

package/src/generators/generator/schema.json

@@ -7,26 +7,28 @@
   "type": "object",
   "examples": [
     {
-      "command": "nx g generator libs/my-plugin/src/generators//my-generator",
-      "description": "Generate `libs/my-plugin/src/generators/my-generator`"
+      "description": "Generate a generator exported with the name matching the file name. It results in the generator `foo` at `mylib/src/generators/foo.ts`",
+      "command": "nx g @nx/plugin:generator mylib/src/generators/foo"
+    },
+    {
+      "description": "Generate a generator exported with a different name from the file name. It results in the generator `custom` at `mylib/src/generators/foo.ts`",
+      "command": "nx g @nx/plugin:generator mylib/src/generators/foo --name=custom"
     }
   ],
   "properties": {
     "path": {
       "type": "string",
-      "description": "Path where the generator will be generated.",
+      "description": "The file path to the generator without the file extension. Relative to the current working directory.",
       "$default": {
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "Where should the generator be generated?",
+      "x-prompt": "What is the generator file path?",
       "x-priority": "important"
     },
     "name": {
       "type": "string",
-      "description": "Generator name.",
-      "x-prompt": "What name would you like to use for the generator?",
-      "x-priority": "important"
+      "description": "The generator name to export in the plugin generators collection."
     },
     "description": {
       "type": "string",

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

@@ -1,5 +1,3 @@
-import { NameAndDirectoryFormat } from '@nx/devkit/src/generators/artifact-name-and-directory-utils';
-
 export interface Schema {
   path: string;
   name?: string;

package/src/generators/migration/schema.json

@@ -7,25 +7,28 @@
   "type": "object",
   "examples": [
     {
-      "command": "nx g migration my-plugin/my-migration --version=1.0.0",
-      "description": "Adds a new migration inside `my-plugin`, which will be triggered when migrating to version 1.0.0 or above from a previous version."
+      "description": "Generate a migration exported with the name matching the file name, which will be triggered when migrating to version 1.0.0 or above from a previous version. It results in the migration `foo` at `mylib/src/migrations/foo.ts`",
+      "command": "nx g @nx/plugin:migration mylib/src/migrations/foo -v=1.0.0"
+    },
+    {
+      "description": "Generate a migration exported with a different name from the file name, which will be triggered when migrating to version 1.0.0 or above from a previous version. It results in the migration `custom` at `mylib/src/migrations/foo.ts`",
+      "command": "nx g @nx/plugin:migration mylib/src/migrations/foo --name=custom -v=1.0.0"
     }
   ],
   "properties": {
     "path": {
       "type": "string",
-      "description": "Path where the migration will be generated.",
+      "description": "The file path to the migration without the file extension. Relative to the current working directory.",
       "$default": {
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "Where should the migration be generated?",
+      "x-prompt": "What is the migration file path?",
       "x-priority": "important"
     },
     "name": {
       "type": "string",
-      "description": "Migration name.",
-      "x-priority": "important"
+      "description": "The migration name to export in the plugin migrations collection."
     },
     "description": {
       "type": "string",