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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/plugin",
-  "version": "16.6.0-beta.4",
+  "version": "16.6.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": {
@@ -28,11 +28,11 @@
     "migrations": "./migrations.json"
   },
   "dependencies": {
-    "@nrwl/nx-plugin": "16.6.0-beta.4",
-    "@nx/devkit": "16.6.0-beta.4",
-    "@nx/jest": "16.6.0-beta.4",
-    "@nx/js": "16.6.0-beta.4",
-    "@nx/linter": "16.6.0-beta.4",
+    "@nrwl/nx-plugin": "16.6.0-beta.6",
+    "@nx/devkit": "16.6.0-beta.6",
+    "@nx/jest": "16.6.0-beta.6",
+    "@nx/js": "16.6.0-beta.6",
+    "@nx/linter": "16.6.0-beta.6",
     "@phenomnomnominal/tsquery": "~5.0.1",
     "dotenv": "~10.0.0",
     "fs-extra": "^11.1.0",
@@ -41,5 +41,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "b1a9ae7ce76697019b26ec9a172005840cca8da6"
+  "gitHead": "9aad21dbfb2b659e488b6626f59df58ab23c0032"
 }

package/src/generators/create-package/schema.json

@@ -4,6 +4,7 @@
   "$id": "NxPluginCreatePackage",
   "title": "Create a framework package",
   "description": "Create a framework package that uses Nx CLI.",
+  "examplesFile": "../../../docs/generators/create-package-examples.md",
   "type": "object",
   "properties": {
     "name": {

package/src/generators/e2e-project/schema.json

@@ -4,6 +4,7 @@
   "$id": "NxPluginE2E",
   "title": "Create an E2E app for a Nx Plugin",
   "description": "Create an E2E app for a Nx Plugin.",
+  "examplesFile": "../../../docs/generators/e2e-project-examples.md",
   "type": "object",
   "properties": {
     "pluginName": {
@@ -29,12 +30,6 @@
       "type": "string",
       "description": "Jest config file."
     },
-    "standaloneConfig": {
-      "description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
-      "type": "boolean",
-      "default": true,
-      "x-deprecated": "Nx only supports standaloneConfig"
-    },
     "linter": {
       "description": "The tool to use for running lint checks.",
       "type": "string",

package/src/generators/executor/executor.js

@@ -5,6 +5,7 @@ const tslib_1 = require("tslib");
 const devkit_1 = require("@nx/devkit");
 const path = require("path");
 const generator_1 = require("../lint-checks/generator");
+const versions_1 = require("../../utils/versions");
 function addFiles(host, options) {
     (0, devkit_1.generateFiles)(host, path.join(__dirname, './files/executor'), `${options.projectSourceRoot}/executors`, Object.assign(Object.assign({}, options), { tmpl: '' }));
     if (options.unitTestRunner === 'none') {
@@ -49,6 +50,11 @@ function updateExecutorJson(host, options) {
         if (!host.exists(executorsPath)) {
             yield createExecutorsJson(host, options.projectRoot, options.project, options.skipLintChecks);
         }
+        // add dependencies
+        (0, devkit_1.updateJson)(host, (0, devkit_1.joinPathFragments)(options.projectRoot, 'package.json'), (json) => {
+            json.dependencies = Object.assign({ '@nx/devkit': versions_1.nxVersion }, json.dependencies);
+            return json;
+        });
         return (0, devkit_1.updateJson)(host, executorsPath, (json) => {
             var _a;
             let executors = (_a = json.executors) !== null && _a !== void 0 ? _a : json.builders;

package/src/generators/executor/schema.json

@@ -4,6 +4,7 @@
   "$id": "NxPluginExecutor",
   "title": "Create an Executor for an Nx Plugin",
   "description": "Create an Executor for an Nx Plugin.",
+  "examplesFile": "../../../docs/generators/executor-examples.md",
   "type": "object",
   "examples": [
     {

package/src/generators/generator/generator.js

@@ -6,6 +6,7 @@ const devkit_1 = require("@nx/devkit");
 const path = require("path");
 const has_generator_1 = require("../../utils/has-generator");
 const generator_1 = require("../lint-checks/generator");
+const versions_1 = require("../../utils/versions");
 function normalizeOptions(host, options) {
     const { npmScope } = (0, devkit_1.getWorkspaceLayout)(host);
     const { root: projectRoot, sourceRoot: projectSourceRoot } = (0, devkit_1.readProjectConfiguration)(host, options.project);
@@ -66,6 +67,11 @@ function updateGeneratorJson(host, options) {
         if (!host.exists(generatorsPath)) {
             yield createGeneratorsJson(host, options.projectRoot, options.project, options.skipLintChecks, options.skipFormat);
         }
+        // add dependencies
+        (0, devkit_1.updateJson)(host, (0, devkit_1.joinPathFragments)(options.projectRoot, 'package.json'), (json) => {
+            json.dependencies = Object.assign({ '@nx/devkit': versions_1.nxVersion }, json.dependencies);
+            return json;
+        });
         (0, devkit_1.updateJson)(host, generatorsPath, (json) => {
             var _a;
             let generators = (_a = json.generators) !== null && _a !== void 0 ? _a : json.schematics;

package/src/generators/lint-checks/schema.json

@@ -5,6 +5,12 @@
   "title": "",
   "type": "object",
   "description": "Adds linting configuration to validate common json files for nx plugins.",
+  "examples": [
+    {
+      "command": "nx g @nx/plugin:lint-checks",
+      "description": "Sets up linting configuration to validate common json files for an nx plugin project."
+    }
+  ],
   "properties": {
     "projectName": {
       "type": "string",

package/src/generators/migration/migration.js

@@ -6,6 +6,7 @@ const devkit_1 = require("@nx/devkit");
 const path = require("path");
 const generator_1 = require("../lint-checks/generator");
 const package_json_1 = require("nx/src/utils/package-json");
+const versions_1 = require("../../utils/versions");
 function normalizeOptions(host, options) {
     var _a;
     let name;
@@ -37,7 +38,6 @@ function updateMigrationsJson(host, options) {
     generators[options.name] = {
         version: options.packageVersion,
         description: options.description,
-        cli: 'nx',
         implementation: `./src/migrations/${options.name}/${options.name}`,
     };
     migrations.generators = generators;
@@ -68,6 +68,8 @@ function updatePackageJson(host, options) {
         else if (preexistingValue.migrations) {
             preexistingValue.migrations = './migrations.json';
         }
+        // add dependencies
+        json.dependencies = Object.assign({ '@nx/devkit': versions_1.nxVersion }, json.dependencies);
         return json;
     });
 }

package/src/generators/migration/schema.json

@@ -8,7 +8,7 @@
   "examples": [
     {
       "command": "nx g migration my-migration --project=my-plugin --version=1.0.0",
-      "description": "Generate `libs/my-plugin/src/migrations/my-migration`"
+      "description": "Adds a new migration to the project `my-plugin`, which will be triggered when migrating to version 1.0.0 or above from a previous version."
     }
   ],
   "properties": {

package/src/generators/plugin/schema.json

@@ -8,7 +8,7 @@
   "examples": [
     {
       "command": "nx g plugin my-plugin --directory=plugins --importPath=@myorg/my-plugin",
-      "description": "Generate `libs/plugins/my-plugin`"
+      "description": "Generates an Nx plugin project called `plugins-my-plugin` at `libs/plugins/my-plugin`. The project will have an npm package name and import path of `@myorg/my-plugin`."
     }
   ],
   "properties": {

package/src/generators/preset/generator.js

@@ -8,26 +8,37 @@ const create_package_1 = require("../create-package/create-package");
 function default_1(tree, options) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
         const tasks = [];
+        const pluginProjectName = (0, devkit_1.names)(options.pluginName.includes('/')
+            ? options.pluginName.split('/')[1]
+            : options.pluginName).fileName;
+        options.createPackageName =
+            options.createPackageName === 'false' // for command line in e2e, it is passed as a string
+                ? undefined
+                : options.createPackageName;
         const pluginTask = yield (0, plugin_1.pluginGenerator)(tree, {
             compiler: 'tsc',
             linter: linter_1.Linter.EsLint,
-            name: options.pluginName.includes('/')
-                ? options.pluginName.split('/')[1]
-                : options.pluginName,
+            name: pluginProjectName,
             skipFormat: true,
             unitTestRunner: 'jest',
             importPath: options.pluginName,
-            rootProject: true,
             e2eTestRunner: 'jest',
             publishable: true,
+            // when creating a CLI package, the plugin will be in the packages folder
+            directory: options.createPackageName && options.createPackageName !== 'false'
+                ? 'packages'
+                : undefined,
+            rootProject: options.createPackageName ? false : true,
         });
         tasks.push(pluginTask);
         removeNpmScope(tree);
         moveNxPluginToDevDeps(tree);
         if (options.createPackageName) {
+            const e2eProject = `${options.pluginName}-e2e`;
             const cliTask = yield (0, create_package_1.default)(tree, {
+                directory: 'packages',
                 name: options.createPackageName,
-                e2eProject: 'e2e',
+                e2eProject: e2eProject,
                 project: options.pluginName,
                 skipFormat: true,
                 unitTestRunner: 'jest',

package/src/generators/preset/schema.json

@@ -4,6 +4,16 @@
   "$id": "NxPluginPreset",
   "title": "Generator ran by create-nx-plugin",
   "description": "Initializes a workspace with an nx-plugin inside of it. Use as: `create-nx-plugin` or `create-nx-workspace --preset @nx/nx-plugin`.",
+  "examples": [
+    {
+      "command": "npx create-nx-plugin",
+      "description": "Creates a new Nx workspace containing an Nx plugin."
+    },
+    {
+      "command": "npx create-nx-workspace --preset @nx/plugin",
+      "description": "Creates a new Nx workspace containing an Nx plugin."
+    }
+  ],
   "type": "object",
   "properties": {
     "pluginName": {

package/src/utils/versions.d.ts

@@ -1 +1,2 @@
+export declare const nxVersion: any;
 export declare const jsoncEslintParserVersion = "^2.1.0";

package/src/utils/versions.js

@@ -1,4 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.jsoncEslintParserVersion = void 0;
+exports.jsoncEslintParserVersion = exports.nxVersion = void 0;
+exports.nxVersion = require('../../package.json').version;
 exports.jsoncEslintParserVersion = '^2.1.0';