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

package/package.json

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

package/src/executors/e2e/e2e.impl.js

@@ -19,21 +19,16 @@ function nxPluginE2EExecutor(options, context) {
         });
         let success;
         try {
-            for (var _d = true, _e = tslib_1.__asyncValues(runBuildTarget(target, context)), _f; _f = yield tslib_1.__await(_e.next()), _a = _f.done, !_a;) {
+            for (var _d = true, _e = tslib_1.__asyncValues(runBuildTarget(target, context)), _f; _f = yield tslib_1.__await(_e.next()), _a = _f.done, !_a; _d = true) {
                 _c = _f.value;
                 _d = false;
+                const _ = _c;
                 try {
-                    const _ = _c;
-                    try {
-                        success = yield tslib_1.__await(runTests(jestOptions, context));
-                    }
-                    catch (e) {
-                        devkit_1.logger.error(e.message);
-                        success = false;
-                    }
+                    success = yield tslib_1.__await(runTests(jestOptions, context));
                 }
-                finally {
-                    _d = true;
+                catch (e) {
+                    devkit_1.logger.error(e.message);
+                    success = false;
                 }
             }
         }
@@ -56,18 +51,13 @@ function runBuildTarget(buildTarget, context) {
         const buildTargetOptions = (0, devkit_1.readTargetOptions)({ project, target, configuration }, context);
         const targetSupportsWatch = Object.keys(buildTargetOptions).includes('watch');
         try {
-            for (var _d = true, _e = tslib_1.__asyncValues(yield tslib_1.__await((0, devkit_1.runExecutor)({ project, target, configuration }, targetSupportsWatch ? { watch: false } : {}, context))), _f; _f = yield tslib_1.__await(_e.next()), _a = _f.done, !_a;) {
+            for (var _d = true, _e = tslib_1.__asyncValues(yield tslib_1.__await((0, devkit_1.runExecutor)({ project, target, configuration }, targetSupportsWatch ? { watch: false } : {}, context))), _f; _f = yield tslib_1.__await(_e.next()), _a = _f.done, !_a; _d = true) {
                 _c = _f.value;
                 _d = false;
-                try {
-                    const output = _c;
-                    if (!output.success)
-                        throw new Error('Could not compile application files.');
-                    yield yield tslib_1.__await(output.success);
-                }
-                finally {
-                    _d = true;
-                }
+                const output = _c;
+                if (!output.success)
+                    throw new Error('Could not compile application files.');
+                yield yield tslib_1.__await(output.success);
             }
         }
         catch (e_2_1) { e_2 = { error: e_2_1 }; }

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

@@ -8,6 +8,7 @@ const versions_1 = require("nx/src/utils/versions");
 const generator_1 = require("../generator/generator");
 const normalize_schema_1 = require("./utils/normalize-schema");
 const has_generator_1 = require("../../utils/has-generator");
+const path_1 = require("path");
 function createPackageGenerator(host, schema) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
         const tasks = [];
@@ -87,9 +88,13 @@ function createCliPackage(host, options, pluginPackageName) {
  */
 function addE2eProject(host, options) {
     const e2eProjectConfiguration = (0, devkit_1.readProjectConfiguration)(host, options.e2eProject);
+    const projectConfiguration = (0, devkit_1.readProjectConfiguration)(host, options.project);
+    const { name: pluginPackageName } = (0, devkit_1.readJson)(host, (0, path_1.join)(projectConfiguration.root, 'package.json'));
     (0, devkit_1.generateFiles)(host, (0, devkit_1.joinPathFragments)(__dirname, './files/e2e'), e2eProjectConfiguration.sourceRoot, {
         pluginName: options.project,
         cliName: options.name,
+        packageManagerCommands: (0, devkit_1.getPackageManagerCommand)('npm'),
+        pluginPackageName,
         tmpl: '',
     });
 }

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

@@ -1,31 +1,56 @@
-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);
+import { join, dirname } from 'path';
+import { mkdirSync, rmSync } from 'fs';
+
+describe('<%= cliName %>', () => {
+  let projectDirectory: string;
 
   afterAll(() => {
-    // Remove the generated project from the file system
-    removeTmpProject(project);
+    // Cleanup the test project
+    rmSync(projectDirectory, {
+      recursive: true,
+      force: true,
+    });
   });
 
-  it('should create project using <%= cliName %>', () => {
-    expect(() =>
-      checkFilesExist(join(tmpFolder(), project, 'package.json'))
-    ).not.toThrow();
+
+  it('should be installed', () => {
+    projectDirectory = createTestProject();
+
+    // npm ls will fail if the package is not installed properly
+    execSync('<%= packageManagerCommands.list %> <%= pluginPackageName %>', {
+      cwd: projectDirectory,
+      stdio: 'inherit',
+    });
   });
 });
+
+/**
+ * Creates a test project with create-nx-workspace and installs the plugin
+ * @returns The directory where the test project was created
+ */
+function createTestProject(extraArgs: string = '') {
+  const projectName = 'test-project';
+  const projectDirectory = join(process.cwd(), 'tmp', projectName);
+
+  // Ensure projectDirectory is empty
+  rmSync(projectDirectory, {
+    recursive: true,
+    force: true,
+  });
+  mkdirSync(dirname(projectDirectory), {
+    recursive: true,
+  });
+
+  execSync(
+    `<%= packageManagerCommands.exec %> --yes <%= cliName %>@e2e ${projectName} ${extraArgs}`,
+    {
+      cwd: dirname(projectDirectory),
+      stdio: 'inherit',
+      env: process.env,
+    }
+  );
+  console.log(`Created test project in "${projectDirectory}"`);
+
+  return projectDirectory;
+}

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

@@ -12,7 +12,7 @@ const linter_1 = require("@nx/linter");
 function normalizeOptions(host, options) {
     var _a;
     const { layoutDirectory, projectDirectory } = (0, devkit_1.extractLayoutDirectory)(options.projectDirectory);
-    const { npmScope, appsDir: defaultAppsDir } = (0, devkit_1.getWorkspaceLayout)(host);
+    const { appsDir: defaultAppsDir } = (0, devkit_1.getWorkspaceLayout)(host);
     const appsDir = layoutDirectory !== null && layoutDirectory !== void 0 ? layoutDirectory : defaultAppsDir;
     const projectName = options.rootProject ? 'e2e' : `${options.pluginName}-e2e`;
     const projectRoot = projectDirectory && !options.rootProject
@@ -22,8 +22,7 @@ function normalizeOptions(host, options) {
             : (0, devkit_1.joinPathFragments)(appsDir, projectName);
     const pluginPropertyName = (0, devkit_1.names)(options.pluginName).propertyName;
     return Object.assign(Object.assign({}, options), { projectName, linter: (_a = options.linter) !== null && _a !== void 0 ? _a : linter_1.Linter.EsLint, pluginPropertyName,
-        projectRoot,
-        npmScope });
+        projectRoot });
 }
 function validatePlugin(host, pluginName) {
     try {
@@ -34,7 +33,9 @@ function validatePlugin(host, pluginName) {
     }
 }
 function addFiles(host, options) {
-    (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) }));
+    const projectConfiguration = (0, devkit_1.readProjectConfiguration)(host, options.pluginName);
+    const { name: pluginPackageName } = (0, devkit_1.readJson)(host, (0, path_1.join)(projectConfiguration.root, 'package.json'));
+    (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), packageManagerCommands: (0, devkit_1.getPackageManagerCommand)('npm'), pluginPackageName }));
 }
 function addJest(host, options) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {

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

@@ -1,35 +1,66 @@
-import {
-  checkFilesExist,
-  ensureNxProject,
-  runNxCommandAsync,
-  runNxCommand,
-} from '@nx/plugin/testing';
-
-describe('<%= pluginName %> e2e', () => {
-  // Setting up individual workspaces per
-  // test can cause e2e runs to take a long time.
-  // For this reason, we recommend each suite only
-  // consumes 1 workspace. The tests should each operate
-  // on a unique project in the workspace, such that they
-  // are not dependant on one another.
+import { execSync } from 'child_process';
+import { join, dirname } from 'path';
+import { mkdirSync, rmSync } from 'fs';
+
+describe('<%= pluginName %>', () => {
+  let projectDirectory: string;
+
   beforeAll(() => {
-    ensureNxProject('<%= npmPackageName %>', '<%= pluginOutputPath %>');
+    projectDirectory = createTestProject();
+
+    // The plugin has been built and published to a local registry in the jest globalSetup
+    // Install the plugin built with the latest source code into the test repo
+    execSync(`<%= packageManagerCommands.install %> <%= pluginPackageName %>@e2e`, {
+      cwd: projectDirectory,
+      stdio: 'inherit',
+      env: process.env,
+    });
   });
 
-  afterAll(async () => {
-    // `nx reset` kills the daemon, and performs
-    // some work which can help clean up e2e leftovers
-    await runNxCommandAsync('reset');
+  afterAll(() => {
+    // Cleanup the test project
+    rmSync(projectDirectory, {
+      recursive: true,
+      force: true,
+    });
   });
 
 
-  // Add some tests here to check that your plugin functionality works as expected.
-  // A sample test is included below to give you some ideas.
-  xit('should be able to build generated projects', async () => {
-    const name = 'proj';
-    const generator = 'PLACEHOLDER';
-    await runNxCommandAsync(`generate <%= npmPackageName %>:${generator} --name ${name}`);
-    expect(() => runNxCommand('build ${proj}')).not.toThrow();
-    expect(() => checkFilesExist(`dist/${name}/index.js`)).not.toThrow();
+  it('should be installed', () => {
+    // npm ls will fail if the package is not installed properly
+    execSync('<%= packageManagerCommands.list %> <%= pluginPackageName %>', {
+      cwd: projectDirectory,
+      stdio: 'inherit',
+    });
   });
 });
+
+/**
+ * Creates a test project with create-nx-workspace and installs the plugin
+ * @returns The directory where the test project was created
+ */
+function createTestProject() {
+  const projectName = 'test-project';
+  const projectDirectory = join(process.cwd(), 'tmp', projectName);
+
+  // Ensure projectDirectory is empty
+  rmSync(projectDirectory, {
+    recursive: true,
+    force: true,
+  });
+  mkdirSync(dirname(projectDirectory), {
+    recursive: true,
+  });
+
+  execSync(
+    `<%= packageManagerCommands.exec %> --yes create-nx-workspace@latest ${projectName} --preset empty --no-nxCloud --no-interactive`,
+    {
+      cwd: dirname(projectDirectory),
+      stdio: 'inherit',
+      env: process.env,
+    }
+  );
+  console.log(`Created test project in "${projectDirectory}"`);
+
+  return projectDirectory;
+}