@nx/plugin 16.4.0-beta.1 → 16.4.0-beta.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/plugin",
-  "version": "16.4.0-beta.1",
+  "version": "16.4.0-beta.10",
   "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.4.0-beta.1",
-    "@nx/devkit": "16.4.0-beta.1",
-    "@nx/jest": "16.4.0-beta.1",
-    "@nx/js": "16.4.0-beta.1",
-    "@nx/linter": "16.4.0-beta.1",
+    "@nrwl/nx-plugin": "16.4.0-beta.10",
+    "@nx/devkit": "16.4.0-beta.10",
+    "@nx/jest": "16.4.0-beta.10",
+    "@nx/js": "16.4.0-beta.10",
+    "@nx/linter": "16.4.0-beta.10",
     "@phenomnomnominal/tsquery": "~5.0.1",
     "dotenv": "~10.0.0",
     "fs-extra": "^11.1.0",
@@ -41,5 +41,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "1c4fb934b607f0d93bb23bff2cf0f39b31a8fa43"
+  "gitHead": "d2bde0605c692a023bc9c28686f3a3037bbd56d3"
 }

package/src/generators/create-package/create-package.js

@@ -7,7 +7,6 @@ const js_1 = require("@nx/js");
 const versions_1 = require("nx/src/utils/versions");
 const generator_1 = require("../generator/generator");
 const normalize_schema_1 = require("./utils/normalize-schema");
-const e2e_1 = require("../e2e-project/e2e");
 const has_generator_1 = require("../../utils/has-generator");
 function createPackageGenerator(host, schema) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
@@ -19,6 +18,9 @@ function createPackageGenerator(host, schema) {
         }, {});
         tasks.push(installTask);
         yield createCliPackage(host, options, pluginPackageName);
+        if (options.e2eProject) {
+            addE2eProject(host, options);
+        }
         if (!options.skipFormat) {
             yield (0, devkit_1.formatFiles)(host);
         }
@@ -84,27 +86,11 @@ function createCliPackage(host, options, pluginPackageName) {
  * @returns
  */
 function addE2eProject(host, options) {
-    return tslib_1.__awaiter(this, void 0, void 0, function* () {
-        const pluginProjectConfiguration = (0, devkit_1.readProjectConfiguration)(host, options.project);
-        const pluginOutputPath = pluginProjectConfiguration.targets.build.options.outputPath;
-        const cliProjectConfiguration = (0, devkit_1.readProjectConfiguration)(host, options.projectName);
-        const cliOutputPath = cliProjectConfiguration.targets.build.options.outputPath;
-        const e2eTask = yield (0, e2e_1.default)(host, {
-            pluginName: options.projectName,
-            projectDirectory: options.projectDirectory,
-            pluginOutputPath,
-            npmPackageName: options.name,
-            skipFormat: true,
-            rootProject: false,
-        });
-        const e2eProjectConfiguration = (0, devkit_1.readProjectConfiguration)(host, `${options.projectName}-e2e`);
-        e2eProjectConfiguration.targets.e2e.dependsOn = ['^build'];
-        (0, devkit_1.updateProjectConfiguration)(host, e2eProjectConfiguration.name, e2eProjectConfiguration);
-        // delete the default e2e test file
-        host.delete(e2eProjectConfiguration.sourceRoot);
-        (0, devkit_1.generateFiles)(host, (0, devkit_1.joinPathFragments)(__dirname, './files/e2e'), e2eProjectConfiguration.sourceRoot, Object.assign(Object.assign({}, options), { pluginOutputPath,
-            cliOutputPath, tmpl: '' }));
-        return e2eTask;
+    const e2eProjectConfiguration = (0, devkit_1.readProjectConfiguration)(host, options.e2eProject);
+    (0, devkit_1.generateFiles)(host, (0, devkit_1.joinPathFragments)(__dirname, './files/e2e'), e2eProjectConfiguration.sourceRoot, {
+        pluginName: options.project,
+        cliName: options.name,
+        tmpl: '',
     });
 }
 exports.default = createPackageGenerator;

package/src/generators/create-package/files/e2e/__cliName__.spec.ts__tmpl__

@@ -0,0 +1,31 @@
+import {
+  checkFilesExist,
+  removeTmpProject,
+  tmpFolder,
+  uniq,
+} from '@nx/plugin/testing';
+import { execSync } from 'child_process';
+import { join } from 'path';
+
+describe('<%= cliName %> e2e', () => {
+  let project: string;
+  beforeAll(async () => {
+    // create a workspace with cli
+    project = uniq('<%= cliName %>');
+    execSync(`npx <%= cliName %>@1.0.0 ${project}`, {
+      cwd: tmpFolder(),
+      env: process.env,
+    });
+  }, 240_000);
+
+  afterAll(() => {
+    // Remove the generated project from the file system
+    removeTmpProject(project);
+  });
+
+  it('should create project using <%= cliName %>', () => {
+    expect(() =>
+      checkFilesExist(join(tmpFolder(), project, 'package.json'))
+    ).not.toThrow();
+  });
+});

package/src/generators/create-package/schema.d.ts

@@ -13,5 +13,5 @@ export interface CreatePackageSchema {
   compiler: 'swc' | 'tsc';
 
   // options to create e2e project, passed to e2e project generator
-  e2eTestRunner?: 'jest' | 'none';
+  e2eProject?: string;
 }

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

@@ -59,11 +59,14 @@
       "default": "tsc",
       "description": "The compiler used by the build and test targets."
     },
-    "e2eTestRunner": {
+    "e2eProject": {
       "type": "string",
-      "enum": ["jest", "none"],
-      "description": "Test runner to use for end to end (E2E) tests.",
-      "default": "jest"
+      "description": "The name of the e2e project.",
+      "alias": "p",
+      "$default": {
+        "$source": "projectName"
+      },
+      "x-prompt": "What is the name of the e2e project?"
     }
   },
   "required": ["name", "project"]

package/src/generators/e2e-project/e2e.js

@@ -5,7 +5,9 @@ const tslib_1 = require("tslib");
 const devkit_1 = require("@nx/devkit");
 const jest_1 = require("@nx/jest");
 const js_1 = require("@nx/js");
-const path = require("path");
+const generator_1 = require("@nx/js/src/generators/setup-verdaccio/generator");
+const add_local_registry_scripts_1 = require("@nx/js/src/utils/add-local-registry-scripts");
+const path_1 = require("path");
 const linter_1 = require("@nx/linter");
 function normalizeOptions(host, options) {
     var _a;
@@ -32,7 +34,7 @@ function validatePlugin(host, pluginName) {
     }
 }
 function addFiles(host, options) {
-    (0, devkit_1.generateFiles)(host, path.join(__dirname, './files'), options.projectRoot, Object.assign(Object.assign({}, options), { tmpl: '', rootTsConfigPath: (0, js_1.getRelativePathToRootTsConfig)(host, options.projectRoot) }));
+    (0, devkit_1.generateFiles)(host, (0, path_1.join)(__dirname, './files'), options.projectRoot, Object.assign(Object.assign({}, options), { tmpl: '', rootTsConfigPath: (0, js_1.getRelativePathToRootTsConfig)(host, options.projectRoot) }));
 }
 function addJest(host, options) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
@@ -50,6 +52,9 @@ function addJest(host, options) {
             skipSerializers: true,
             skipFormat: true,
         });
+        const { startLocalRegistryPath, stopLocalRegistryPath } = (0, add_local_registry_scripts_1.addLocalRegistryScripts)(host);
+        (0, jest_1.addPropertyToJestConfig)(host, (0, path_1.join)(options.projectRoot, 'jest.config.ts'), 'globalSetup', (0, path_1.join)((0, devkit_1.offsetFromRoot)(options.projectRoot), startLocalRegistryPath));
+        (0, jest_1.addPropertyToJestConfig)(host, (0, path_1.join)(options.projectRoot, 'jest.config.ts'), 'globalTeardown', (0, path_1.join)((0, devkit_1.offsetFromRoot)(options.projectRoot), stopLocalRegistryPath));
         const project = (0, devkit_1.readProjectConfiguration)(host, options.projectName);
         const testTarget = project.targets.test;
         project.targets.e2e = Object.assign(Object.assign({}, testTarget), { dependsOn: [`^build`], options: Object.assign(Object.assign({}, testTarget.options), { runInBand: true }), configurations: testTarget.configurations });
@@ -81,6 +86,9 @@ function e2eProjectGenerator(host, schema) {
         validatePlugin(host, schema.pluginName);
         const options = normalizeOptions(host, schema);
         addFiles(host, options);
+        tasks.push(yield (0, generator_1.setupVerdaccio)(host, {
+            skipFormat: true,
+        }));
         tasks.push(yield addJest(host, options));
         if (options.linter !== linter_1.Linter.None) {
             tasks.push(yield addLintingToApplication(host, Object.assign({}, options)));

package/src/generators/e2e-project/files/tests/__pluginName__.spec.ts__tmpl__

@@ -1,7 +1,6 @@
 import {
   checkFilesExist,
   ensureNxProject,
-  readJson,
   runNxCommandAsync,
   runNxCommand,
 } from '@nx/plugin/testing';

package/src/generators/lint-checks/generator.js

@@ -174,7 +174,7 @@ function setupVsCodeLintingForJsonFiles(host) {
         existing = (0, devkit_1.readJson)(host, '.vscode/settings.json');
     }
     else {
-        devkit_1.logger.info(`${logger_1.NX_PREFIX} We've updated the vscode settings for this repository to ensure that plugin lint checks show up inside your IDE. This created .vscode/settings.json. To read more about this file, check vscode's documentation. It is frequently not commited, so other developers may need to add similar settings if they'd like to see the lint checks in the IDE rather than only during linting.`);
+        devkit_1.logger.info(`${logger_1.NX_PREFIX} We've updated the vscode settings for this repository to ensure that plugin lint checks show up inside your IDE. This created .vscode/settings.json. To read more about this file, check vscode's documentation. It is frequently not committed, so other developers may need to add similar settings if they'd like to see the lint checks in the IDE rather than only during linting.`);
     }
     // setup eslint validation for json files
     const eslintValidate = (_a = existing['eslint.validate']) !== null && _a !== void 0 ? _a : [];

package/src/utils/testing-utils/index.d.ts

@@ -1,6 +1,5 @@
 export * from './async-commands';
 export * from './commands';
-export * from './create-package-cli';
 export * from './paths';
 export * from './nx-project';
 export * from './utils';

package/src/utils/testing-utils/index.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./async-commands"), exports);
 tslib_1.__exportStar(require("./commands"), exports);
-tslib_1.__exportStar(require("./create-package-cli"), exports);
 tslib_1.__exportStar(require("./paths"), exports);
 tslib_1.__exportStar(require("./nx-project"), exports);
 tslib_1.__exportStar(require("./utils"), exports);

package/src/generators/create-package/files/e2e/__name__.spec.ts__tmpl__

@@ -1,29 +0,0 @@
-import {
-  runCreatePackageCli,
-  removeTmpProject,
-} from '@nx/plugin/testing';
-
-describe('<%= name %> e2e', () => {
-  const project = '<%= name %>';
-  let createPackageResult;
-
-  beforeAll(async () => {
-    // Create project using CLI command
-    createPackageResult = await runCreatePackageCli(
-      project,
-      {
-        pluginLibraryBuildPath: '<%= pluginOutputPath %>',
-        createPackageLibraryBuildPath: '<%= cliOutputPath %>',
-      }
-    );
-  }, 240_000);
-
-  afterAll(() => {
-    // Remove the generated project from the file system
-    removeTmpProject(project);
-  });
-
-  it('should create project using <%= name %>', () => {
-    expect(createPackageResult).toContain('Successfully created');
-  });
-});

package/src/utils/testing-utils/create-package-cli.d.ts

@@ -1,18 +0,0 @@
-/**
- * This function is used to run the create package CLI command.
- * It builds the plugin library and the create package library and run the create package command with for the plugin library.
- * It needs to be ran inside an Nx project. It would assume that an Nx project already exists.
- * @param projectToBeCreated project name to be created using the cli
- * @param pluginLibraryBuildPath e.g. dist/packages/my-plugin
- * @param createPackageLibraryBuildPath e.g. dist/packages/create-my-plugin-package
- * @param extraArguments extra arguments to be passed to the create package command
- * @param verbose if true, NX_VERBOSE_LOGGING will be set to true
- * @returns results for the create package command
- */
-export declare function runCreatePackageCli(projectToBeCreated: string, { pluginLibraryBuildPath, createPackageLibraryBuildPath, extraArguments, verbose, }: {
-    pluginLibraryBuildPath: string;
-    createPackageLibraryBuildPath: string;
-    extraArguments?: string[];
-    verbose?: boolean;
-}): Promise<string>;
-export declare function generatedPackagePath(projectToBeCreated: string): string;

package/src/utils/testing-utils/create-package-cli.js

@@ -1,52 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generatedPackagePath = exports.runCreatePackageCli = void 0;
-const devkit_1 = require("@nx/devkit");
-const paths_1 = require("./paths");
-const child_process_1 = require("child_process");
-/**
- * This function is used to run the create package CLI command.
- * It builds the plugin library and the create package library and run the create package command with for the plugin library.
- * It needs to be ran inside an Nx project. It would assume that an Nx project already exists.
- * @param projectToBeCreated project name to be created using the cli
- * @param pluginLibraryBuildPath e.g. dist/packages/my-plugin
- * @param createPackageLibraryBuildPath e.g. dist/packages/create-my-plugin-package
- * @param extraArguments extra arguments to be passed to the create package command
- * @param verbose if true, NX_VERBOSE_LOGGING will be set to true
- * @returns results for the create package command
- */
-function runCreatePackageCli(projectToBeCreated, { pluginLibraryBuildPath, createPackageLibraryBuildPath, extraArguments, verbose, }) {
-    return new Promise((resolve, reject) => {
-        const childProcess = (0, child_process_1.fork)(`${devkit_1.workspaceRoot}/${createPackageLibraryBuildPath}/bin/index.js`, [projectToBeCreated, ...(extraArguments || [])], {
-            stdio: ['pipe', 'pipe', 'pipe', 'ipc'],
-            env: Object.assign(Object.assign(Object.assign({}, process.env), { [`NX_E2E_PRESET_VERSION`]: `file:${devkit_1.workspaceRoot}/${pluginLibraryBuildPath}` }), (verbose && { NX_VERBOSE_LOGGING: 'true' })),
-            cwd: (0, paths_1.tmpFolder)(),
-        });
-        // Ensure the child process is killed when the parent exits
-        process.on('exit', () => childProcess.kill());
-        process.on('SIGTERM', () => childProcess.kill());
-        let allMessages = '';
-        childProcess.on('message', (message) => {
-            allMessages += message;
-        });
-        childProcess.stdout.on('data', (data) => {
-            allMessages += data;
-        });
-        childProcess.on('error', (error) => {
-            reject(error);
-        });
-        childProcess.on('exit', (code) => {
-            if (code === 0) {
-                resolve(allMessages);
-            }
-            else {
-                reject(allMessages);
-            }
-        });
-    });
-}
-exports.runCreatePackageCli = runCreatePackageCli;
-function generatedPackagePath(projectToBeCreated) {
-    return `${(0, paths_1.tmpFolder)()}/${projectToBeCreated}`;
-}
-exports.generatedPackagePath = generatedPackagePath;