@nx/plugin 16.0.0-beta.5

package/src/executors/e2e/schema.json

@@ -0,0 +1,220 @@
+{
+  "version": 2,
+  "outputCapture": "direct-nodejs",
+  "title": "Nx Plugin Playground Target",
+  "description": "Creates a playground for a Nx Plugin.",
+  "cli": "nx",
+  "type": "object",
+  "properties": {
+    "target": {
+      "description": "The build target for the Nx Plugin project.",
+      "type": "string",
+      "x-priority": "important"
+    },
+    "jestConfig": {
+      "type": "string",
+      "description": "Jest config file.",
+      "x-completion-type": "file",
+      "x-completion-glob": "jest.config@(.js|.ts)",
+      "x-priority": "important"
+    },
+    "tsSpecConfig": {
+      "type": "string",
+      "description": "The tsconfig file for specs.",
+      "x-deprecated": "Use the `tsconfig` property for `ts-jest` in the e2e project `jest.config.js` file. It will be removed in the next major release.",
+      "x-completion-type": "file",
+      "x-completion-glob": "tsconfig.*.json",
+      "x-priority": "important"
+    },
+    "codeCoverage": {
+      "description": "Indicates that test coverage information should be collected and reported in the output. (https://jestjs.io/docs/cli#--coverageboolean)",
+      "type": "boolean",
+      "aliases": ["coverage"]
+    },
+    "config": {
+      "description": "The path to a Jest config file specifying how to find and execute tests. If no `rootDir` is set in the config, the directory containing the config file is assumed to be the `rootDir` for the project. This can also be a JSON-encoded value which Jest will use as configuration.",
+      "type": "string"
+    },
+    "clearCache": {
+      "description": "Deletes the Jest cache directory and then exits without running tests. Will delete Jest's default cache directory. _Note: clearing the cache will reduce performance_.",
+      "type": "boolean"
+    },
+    "detectOpenHandles": {
+      "description": "Attempt to collect and print open handles preventing Jest from exiting cleanly (https://jestjs.io/docs/cli#--detectopenhandles)",
+      "type": "boolean"
+    },
+    "logHeapUsage": {
+      "description": "Logs the heap usage after every test. Useful to debug memory leaks. Use together with --runInBand and --expose-gc in node.",
+      "type": "boolean"
+    },
+    "detectLeaks": {
+      "description": "**EXPERIMENTAL**: Detect memory leaks in tests. After executing a test, it will try to garbage collect the global object used, and fail if it was leaked",
+      "type": "boolean"
+    },
+    "testFile": {
+      "description": "The name of the file to test.",
+      "type": "string",
+      "x-completion-type": "file",
+      "x-completion-glob": "**/*.+(spec|test).+(ts|js)"
+    },
+    "tsConfig": {
+      "description": "The name of the Typescript configuration file. Set the tsconfig option in the jest config file. ",
+      "type": "string",
+      "x-deprecated": "Use the ts-jest configuration options in the jest config file instead."
+    },
+    "setupFile": {
+      "description": "The name of a setup file used by Jest. (use Jest config file https://jestjs.io/docs/en/configuration#setupfilesafterenv-array)",
+      "type": "string",
+      "x-deprecated": "Use the setupFilesAfterEnv option in the jest config file. https://jestjs.io/docs/en/configuration#setupfilesafterenv-array"
+    },
+    "bail": {
+      "alias": "b",
+      "description": "Exit the test suite immediately after `n` number of failing tests. (https://jestjs.io/docs/cli#--bail)",
+      "oneOf": [
+        {
+          "type": "number"
+        },
+        {
+          "type": "boolean"
+        }
+      ]
+    },
+    "ci": {
+      "description": "Whether to run Jest in continuous integration (CI) mode. This option is on by default in most popular CI environments. It will prevent snapshots from being written unless explicitly requested. (https://jestjs.io/docs/cli#--ci)",
+      "type": "boolean"
+    },
+    "color": {
+      "alias": "colors",
+      "description": "Forces test results output color highlighting (even if `stdout` is not a TTY). Set to false if you would like to have no colors. (https://jestjs.io/docs/cli#--colors)",
+      "type": "boolean"
+    },
+    "findRelatedTests": {
+      "description": "Find and run the tests that cover a comma separated list of source files that were passed in as arguments. (https://jestjs.io/docs/cli#--findrelatedtests-spaceseparatedlistofsourcefiles)",
+      "type": "string"
+    },
+    "json": {
+      "description": "Prints the test results in `JSON`. This mode will send all other test output and user messages to `stderr`. (https://jestjs.io/docs/cli#--json)",
+      "type": "boolean"
+    },
+    "maxWorkers": {
+      "alias": "w",
+      "description": "Specifies the maximum number of workers the worker-pool will spawn for running tests. This defaults to the number of the cores available on your machine. Useful for CI. (its usually best not to override this default) (https://jestjs.io/docs/cli#--maxworkersnumstring)",
+      "oneOf": [
+        {
+          "type": "number"
+        },
+        {
+          "type": "string"
+        }
+      ]
+    },
+    "onlyChanged": {
+      "alias": "o",
+      "description": "Attempts to identify which tests to run based on which files have changed in the current repository. Only works if you're running tests in a `git` or `hg` repository at the moment. (https://jestjs.io/docs/cli#--onlychanged)",
+      "type": "boolean"
+    },
+    "changedSince": {
+      "description": "Runs tests related to the changes since the provided branch or commit hash. If the current branch has diverged from the given branch, then only changes made locally will be tested. (https://jestjs.io/docs/cli#--changedsince)",
+      "type": "string"
+    },
+    "outputFile": {
+      "description": "Write test results to a file when the `--json` option is also specified. (https://jestjs.io/docs/cli#--outputfilefilename)",
+      "type": "string"
+    },
+    "passWithNoTests": {
+      "description": "Will not fail if no tests are found (for example while using `--testPathPattern`.) (https://jestjs.io/docs/cli#--passwithnotests)",
+      "type": "boolean"
+    },
+    "runInBand": {
+      "alias": "i",
+      "description": "Run all tests serially in the current process (rather than creating a worker pool of child processes that run tests). This is sometimes useful for debugging, but such use cases are pretty rare. Useful for CI. (https://jestjs.io/docs/cli#--runinband)",
+      "type": "boolean",
+      "default": true
+    },
+    "showConfig": {
+      "description": "Print your Jest config and then exits. (https://jestjs.io/docs/en/cli#--showconfig)",
+      "type": "boolean"
+    },
+    "silent": {
+      "description": "Prevent tests from printing messages through the console. (https://jestjs.io/docs/cli#--silent)",
+      "type": "boolean"
+    },
+    "testNamePattern": {
+      "alias": "t",
+      "description": "Run only tests with a name that matches the regex pattern. (https://jestjs.io/docs/cli#--testnamepatternregex)",
+      "type": "string"
+    },
+    "testPathIgnorePatterns": {
+      "description": "An array of regexp pattern strings that is matched against all tests paths before executing the test. Only run those tests with a path that does not match with the provided regexp expressions. (https://jestjs.io/docs/cli#--testpathignorepatternsregexarray)",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "testPathPattern": {
+      "description": "An array of regexp pattern strings that is matched against all tests paths before executing the test. (https://jestjs.io/docs/cli#--testpathpatternregex)",
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "default": []
+    },
+    "colors": {
+      "description": "Forces test results output highlighting even if stdout is not a TTY. (https://jestjs.io/docs/cli#--colors)",
+      "type": "boolean"
+    },
+    "reporters": {
+      "description": "Run tests with specified reporters. Reporter options are not available via CLI. Example with multiple reporters: `jest --reporters=\"default\" --reporters=\"jest-junit\"`. (https://jestjs.io/docs/cli#--reporters)",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "verbose": {
+      "description": "Display individual test results with the test suite hierarchy. (https://jestjs.io/docs/cli#--verbose)",
+      "type": "boolean"
+    },
+    "coverageReporters": {
+      "description": "A list of reporter names that Jest uses when writing coverage reports. Any istanbul reporter.",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "coverageDirectory": {
+      "description": "The directory where Jest should output its coverage files.",
+      "type": "string"
+    },
+    "testResultsProcessor": {
+      "description": "Node module that implements a custom results processor. (https://jestjs.io/docs/en/configuration#testresultsprocessor-string)",
+      "type": "string"
+    },
+    "updateSnapshot": {
+      "alias": "u",
+      "description": "Use this flag to re-record snapshots. Can be used together with a test suite pattern or with `--testNamePattern` to re-record snapshot for test matching the pattern. (https://jestjs.io/docs/cli#--updatesnapshot)",
+      "type": "boolean"
+    },
+    "useStderr": {
+      "description": "Divert all output to stderr.",
+      "type": "boolean"
+    },
+    "watch": {
+      "description": "Watch files for changes and rerun tests related to changed files. If you want to re-run all tests when a file has changed, use the `--watchAll` option. (https://jestjs.io/docs/cli#--watch)",
+      "type": "boolean"
+    },
+    "watchAll": {
+      "description": "Watch files for changes and rerun all tests when something changes. If you want to re-run only the tests that depend on the changed files, use the `--watch` option. (https://jestjs.io/docs/cli#--watchall)",
+      "type": "boolean"
+    },
+    "testLocationInResults": {
+      "description": "Adds a location field to test results.  Used to report location of a test in a reporter. { \"column\": 4, \"line\": 5 } (https://jestjs.io/docs/cli#--testlocationinresults)",
+      "type": "boolean"
+    },
+    "testTimeout": {
+      "description": "Default timeout of a test in milliseconds. Default value: `5000`. (https://jestjs.io/docs/cli#--testtimeoutnumber)",
+      "type": "number"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["target", "jestConfig"]
+}

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

@@ -0,0 +1,5 @@
+import { Tree, GeneratorCallback } from '@nx/devkit';
+import { CreatePackageSchema } from './schema';
+export declare function createPackageGenerator(host: Tree, schema: CreatePackageSchema): Promise<GeneratorCallback>;
+export default createPackageGenerator;
+export declare const createPackageSchematic: (generatorOptions: CreatePackageSchema) => (tree: any, context: any) => Promise<any>;

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

@@ -0,0 +1,115 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPackageSchematic = exports.createPackageGenerator = void 0;
+const tslib_1 = require("tslib");
+const devkit_1 = require("@nx/devkit");
+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* () {
+        const tasks = [];
+        const options = (0, normalize_schema_1.normalizeSchema)(host, schema);
+        const pluginPackageName = yield addPresetGenerator(host, options);
+        const installTask = (0, devkit_1.addDependenciesToPackageJson)(host, {
+            'create-nx-workspace': versions_1.nxVersion,
+        }, {});
+        tasks.push(installTask);
+        yield createCliPackage(host, options, pluginPackageName);
+        if (options.e2eTestRunner !== 'none') {
+            tasks.push(yield addE2eProject(host, options));
+        }
+        if (!options.skipFormat) {
+            yield (0, devkit_1.formatFiles)(host);
+        }
+        return (0, devkit_1.runTasksInSerial)(...tasks);
+    });
+}
+exports.createPackageGenerator = createPackageGenerator;
+/**
+ * Add a preset generator to the plugin if it doesn't exist
+ * @param host
+ * @param schema
+ * @returns package name of the plugin
+ */
+function addPresetGenerator(host, schema) {
+    var _a;
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const { root: projectRoot } = (0, devkit_1.readProjectConfiguration)(host, schema.project);
+        if (!(0, has_generator_1.hasGenerator)(host, schema.project, 'preset')) {
+            yield (0, generator_1.default)(host, {
+                name: 'preset',
+                project: schema.project,
+                unitTestRunner: schema.unitTestRunner,
+                skipFormat: true,
+            });
+        }
+        return (_a = (0, devkit_1.readJson)(host, (0, devkit_1.joinPathFragments)(projectRoot, 'package.json'))) === null || _a === void 0 ? void 0 : _a.name;
+    });
+}
+function createCliPackage(host, options, pluginPackageName) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        yield (0, js_1.libraryGenerator)(host, Object.assign(Object.assign({}, options), { rootProject: false, config: 'project', publishable: true, bundler: options.bundler, importPath: options.name, skipFormat: true, skipTsConfig: true }));
+        host.delete((0, devkit_1.joinPathFragments)(options.projectRoot, 'src'));
+        // Add the bin entry to the package.json
+        (0, devkit_1.updateJson)(host, (0, devkit_1.joinPathFragments)(options.projectRoot, 'package.json'), (packageJson) => {
+            packageJson.bin = {
+                [options.name]: './bin/index.js',
+            };
+            packageJson.dependencies = {
+                'create-nx-workspace': versions_1.nxVersion,
+            };
+            return packageJson;
+        });
+        // update project build target to use the bin entry
+        const projectConfiguration = (0, devkit_1.readProjectConfiguration)(host, options.projectName);
+        projectConfiguration.sourceRoot = (0, devkit_1.joinPathFragments)(options.projectRoot, 'bin');
+        projectConfiguration.targets.build.options.main = (0, devkit_1.joinPathFragments)(options.projectRoot, 'bin/index.ts');
+        projectConfiguration.targets.build.options.updateBuildableProjectDepsInPackageJson =
+            false;
+        projectConfiguration.implicitDependencies = [options.project];
+        (0, devkit_1.updateProjectConfiguration)(host, options.projectName, projectConfiguration);
+        // Add bin files to tsconfg.lib.json
+        (0, devkit_1.updateJson)(host, (0, devkit_1.joinPathFragments)(options.projectRoot, 'tsconfig.lib.json'), (tsConfig) => {
+            tsConfig.include.push('bin/**/*.ts');
+            return tsConfig;
+        });
+        (0, devkit_1.generateFiles)(host, (0, devkit_1.joinPathFragments)(__dirname, './files/create-framework-package'), options.projectRoot, Object.assign(Object.assign({}, options), { preset: pluginPackageName, tmpl: '' }));
+    });
+}
+/**
+ * Add a test file to plugin e2e project
+ * @param host
+ * @param options
+ * @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;
+    });
+}
+exports.default = createPackageGenerator;
+exports.createPackageSchematic = (0, devkit_1.convertNxGenerator)(createPackageGenerator);
+//# sourceMappingURL=create-package.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"create-package.js","sourceRoot":"","sources":["../../../../../../packages/plugin/src/generators/create-package/create-package.ts"],"names":[],"mappings":";;;;AAAA,uCAaoB;AACpB,+BAAgE;AAChE,oDAAkD;AAClD,sDAAwD;AAExD,+DAA6E;AAC7E,4CAAqD;AACrD,6DAAyD;AAEzD,SAAsB,sBAAsB,CAC1C,IAAU,EACV,MAA2B;;QAE3B,MAAM,KAAK,GAAwB,EAAE,CAAC;QAEtC,MAAM,OAAO,GAAG,IAAA,kCAAe,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC9C,MAAM,iBAAiB,GAAG,MAAM,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAElE,MAAM,WAAW,GAAG,IAAA,qCAA4B,EAC9C,IAAI,EACJ;YACE,qBAAqB,EAAE,oBAAS;SACjC,EACD,EAAE,CACH,CAAC;QACF,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAExB,MAAM,gBAAgB,CAAC,IAAI,EAAE,OAAO,EAAE,iBAAiB,CAAC,CAAC;QACzD,IAAI,OAAO,CAAC,aAAa,KAAK,MAAM,EAAE;YACpC,KAAK,CAAC,IAAI,CAAC,MAAM,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;SAChD;QAED,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE;YACvB,MAAM,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;SACzB;QAED,OAAO,IAAA,yBAAgB,EAAC,GAAG,KAAK,CAAC,CAAC;IACpC,CAAC;CAAA;AA5BD,wDA4BC;AAED;;;;;GAKG;AACH,SAAe,kBAAkB,CAC/B,IAAU,EACV,MAAwB;;;QAExB,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,IAAA,iCAAwB,EAAC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;QAC7E,IAAI,CAAC,IAAA,4BAAY,EAAC,IAAI,EAAE,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE;YACjD,MAAM,IAAA,mBAAkB,EAAC,IAAI,EAAE;gBAC7B,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,cAAc,EAAE,MAAM,CAAC,cAAc;gBACrC,UAAU,EAAE,IAAI;aACjB,CAAC,CAAC;SACJ;QAED,OAAO,MAAA,IAAA,iBAAQ,EAAC,IAAI,EAAE,IAAA,0BAAiB,EAAC,WAAW,EAAE,cAAc,CAAC,CAAC,0CAAE,IAAI,CAAC;;CAC7E;AAED,SAAe,gBAAgB,CAC7B,IAAU,EACV,OAAyB,EACzB,iBAAyB;;QAEzB,MAAM,IAAA,qBAAkB,EAAC,IAAI,kCACxB,OAAO,KACV,WAAW,EAAE,KAAK,EAClB,MAAM,EAAE,SAAS,EACjB,WAAW,EAAE,IAAI,EACjB,OAAO,EAAE,OAAO,CAAC,OAAO,EACxB,UAAU,EAAE,OAAO,CAAC,IAAI,EACxB,UAAU,EAAE,IAAI,EAChB,YAAY,EAAE,IAAI,IAClB,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,IAAA,0BAAiB,EAAC,OAAO,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC;QAE3D,wCAAwC;QACxC,IAAA,mBAAU,EACR,IAAI,EACJ,IAAA,0BAAiB,EAAC,OAAO,CAAC,WAAW,EAAE,cAAc,CAAC,EACtD,CAAC,WAAW,EAAE,EAAE;YACd,WAAW,CAAC,GAAG,GAAG;gBAChB,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,gBAAgB;aACjC,CAAC;YACF,WAAW,CAAC,YAAY,GAAG;gBACzB,qBAAqB,EAAE,oBAAS;aACjC,CAAC;YACF,OAAO,WAAW,CAAC;QACrB,CAAC,CACF,CAAC;QAEF,mDAAmD;QACnD,MAAM,oBAAoB,GAAG,IAAA,iCAAwB,EACnD,IAAI,EACJ,OAAO,CAAC,WAAW,CACpB,CAAC;QACF,oBAAoB,CAAC,UAAU,GAAG,IAAA,0BAAiB,EACjD,OAAO,CAAC,WAAW,EACnB,KAAK,CACN,CAAC;QACF,oBAAoB,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,GAAG,IAAA,0BAAiB,EACjE,OAAO,CAAC,WAAW,EACnB,cAAc,CACf,CAAC;QACF,oBAAoB,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,uCAAuC;YAChF,KAAK,CAAC;QACR,oBAAoB,CAAC,oBAAoB,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC9D,IAAA,mCAA0B,EAAC,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE,oBAAoB,CAAC,CAAC;QAE5E,oCAAoC;QACpC,IAAA,mBAAU,EACR,IAAI,EACJ,IAAA,0BAAiB,EAAC,OAAO,CAAC,WAAW,EAAE,mBAAmB,CAAC,EAC3D,CAAC,QAAQ,EAAE,EAAE;YACX,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YACrC,OAAO,QAAQ,CAAC;QAClB,CAAC,CACF,CAAC;QAEF,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EAAC,SAAS,EAAE,kCAAkC,CAAC,EAChE,OAAO,CAAC,WAAW,kCAEd,OAAO,KACV,MAAM,EAAE,iBAAiB,EACzB,IAAI,EAAE,EAAE,IAEX,CAAC;IACJ,CAAC;CAAA;AAED;;;;;GAKG;AACH,SAAe,aAAa,CAAC,IAAU,EAAE,OAAyB;;QAChE,MAAM,0BAA0B,GAAG,IAAA,iCAAwB,EACzD,IAAI,EACJ,OAAO,CAAC,OAAO,CAChB,CAAC;QACF,MAAM,gBAAgB,GACpB,0BAA0B,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC;QAE9D,MAAM,uBAAuB,GAAG,IAAA,iCAAwB,EACtD,IAAI,EACJ,OAAO,CAAC,WAAW,CACpB,CAAC;QACF,MAAM,aAAa,GACjB,uBAAuB,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC;QAE3D,MAAM,OAAO,GAAG,MAAM,IAAA,aAAmB,EAAC,IAAI,EAAE;YAC9C,UAAU,EAAE,OAAO,CAAC,WAAW;YAC/B,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;YAC1C,gBAAgB;YAChB,cAAc,EAAE,OAAO,CAAC,IAAI;YAC5B,UAAU,EAAE,IAAI;YAChB,WAAW,EAAE,KAAK;SACnB,CAAC,CAAC;QAEH,MAAM,uBAAuB,GAAG,IAAA,iCAAwB,EACtD,IAAI,EACJ,GAAG,OAAO,CAAC,WAAW,MAAM,CAC7B,CAAC;QACF,uBAAuB,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC3D,IAAA,mCAA0B,EACxB,IAAI,EACJ,uBAAuB,CAAC,IAAI,EAC5B,uBAAuB,CACxB,CAAC;QAEF,mCAAmC;QACnC,IAAI,CAAC,MAAM,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC;QAEhD,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EAAC,SAAS,EAAE,aAAa,CAAC,EAC3C,uBAAuB,CAAC,UAAU,kCAE7B,OAAO,KACV,gBAAgB;YAChB,aAAa,EACb,IAAI,EAAE,EAAE,IAEX,CAAC;QAEF,OAAO,OAAO,CAAC;IACjB,CAAC;CAAA;AAED,kBAAe,sBAAsB,CAAC;AACzB,QAAA,sBAAsB,GAAG,IAAA,2BAAkB,EACtD,sBAAsB,CACvB,CAAC"}

package/src/generators/create-package/files/create-framework-package/bin/index.ts__tmpl__

@@ -0,0 +1,26 @@
+#!/usr/bin/env node
+
+import { createWorkspace } from 'create-nx-workspace';
+
+async function main() {
+  const name = process.argv[2]; // TODO: use libraries like yargs or enquirer to set your workspace name
+  if (!name) {
+    throw new Error('Please provide a name for the workspace');
+  }
+
+  console.log(`Creating the workspace: ${name}`);
+
+  // TODO: update below to customize the workspace
+  const { directory } = await createWorkspace('<%= preset %>', {
+    name, 
+    nxCloud: false,
+    packageManager: 'npm',
+    // This assumes "<%= preset %>" and "<%= projectName %>" are at the same version
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    presetVersion: require('../package.json').version,
+  });
+
+  console.log(`Successfully created the workspace: ${directory}.`);
+}
+
+main();

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

@@ -0,0 +1,30 @@
+import {
+  uniq,
+  runCreatePackageCli,
+  removeTmpProject,
+} from '@nx/plugin/testing';
+
+describe('<%= name %> e2e', () => {
+  const project = uniq('<%= 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/generators/create-package/schema.d.ts

@@ -0,0 +1,17 @@
+import type { Linter } from '@nx/linter';
+
+export interface CreatePackageSchema {
+  name: string;
+  project: string;
+
+  // options to create cli package, passed to js library generator
+  directory?: string;
+  skipFormat: boolean;
+  tags?: string;
+  unitTestRunner: 'jest' | 'none';
+  linter: Linter;
+  compiler: 'swc' | 'tsc';
+
+  // options to create e2e project, passed to e2e project generator
+  e2eTestRunner?: 'jest' | 'none';
+}

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

@@ -0,0 +1,69 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "cli": "nx",
+  "$id": "NxPluginCreatePackage",
+  "title": "Create a framework package",
+  "description": "Create a framework package that uses Nx CLI.",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "The package name of cli, e.g. `create-framework-package`. Note this must be a valid NPM name to be published.",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "x-priority": "important"
+    },
+    "project": {
+      "type": "string",
+      "description": "The name of the generator project.",
+      "alias": "p",
+      "$default": {
+        "$source": "projectName"
+      },
+      "x-prompt": "What is the name of the project for the generator?",
+      "x-priority": "important"
+    },
+    "unitTestRunner": {
+      "type": "string",
+      "enum": ["jest", "none"],
+      "description": "Test runner to use for unit tests.",
+      "default": "jest"
+    },
+    "directory": {
+      "type": "string",
+      "description": "A directory where the app is placed."
+    },
+    "linter": {
+      "description": "The tool to use for running lint checks.",
+      "type": "string",
+      "enum": ["eslint"],
+      "default": "eslint"
+    },
+    "tags": {
+      "type": "string",
+      "description": "Add tags to the library (used for linting).",
+      "alias": "t"
+    },
+    "skipFormat": {
+      "description": "Skip formatting files.",
+      "type": "boolean",
+      "default": false,
+      "x-priority": "internal"
+    },
+    "compiler": {
+      "type": "string",
+      "enum": ["tsc", "swc"],
+      "default": "tsc",
+      "description": "The compiler used by the build and test targets."
+    },
+    "e2eTestRunner": {
+      "type": "string",
+      "enum": ["jest", "none"],
+      "description": "Test runner to use for end to end (E2E) tests.",
+      "default": "jest"
+    }
+  },
+  "required": ["name", "project"]
+}

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

@@ -0,0 +1,10 @@
+import { Tree } from '@nx/devkit';
+import { CreatePackageSchema } from '../schema';
+export interface NormalizedSchema extends CreatePackageSchema {
+    bundler: 'swc' | 'tsc';
+    libsDir: string;
+    projectName: string;
+    projectRoot: string;
+    projectDirectory: string;
+}
+export declare function normalizeSchema(host: Tree, schema: CreatePackageSchema): NormalizedSchema;

package/src/generators/create-package/utils/normalize-schema.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeSchema = void 0;
+const devkit_1 = require("@nx/devkit");
+function normalizeSchema(host, schema) {
+    var _a;
+    const { layoutDirectory, projectDirectory } = (0, devkit_1.extractLayoutDirectory)(schema.directory);
+    const { libsDir: defaultLibsDir } = (0, devkit_1.getWorkspaceLayout)(host);
+    const libsDir = layoutDirectory !== null && layoutDirectory !== void 0 ? layoutDirectory : defaultLibsDir;
+    const name = (0, devkit_1.names)(schema.name).fileName;
+    const fullProjectDirectory = projectDirectory
+        ? `${(0, devkit_1.names)(projectDirectory).fileName}/${name}`
+        : name;
+    const projectName = fullProjectDirectory.replace(new RegExp('/', 'g'), '-');
+    const projectRoot = (0, devkit_1.joinPathFragments)(libsDir, fullProjectDirectory);
+    return Object.assign(Object.assign({}, schema), { bundler: (_a = schema.compiler) !== null && _a !== void 0 ? _a : 'tsc', libsDir,
+        projectName,
+        projectRoot,
+        name, projectDirectory: fullProjectDirectory });
+}
+exports.normalizeSchema = normalizeSchema;
+//# sourceMappingURL=normalize-schema.js.map

package/src/generators/create-package/utils/normalize-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"normalize-schema.js","sourceRoot":"","sources":["../../../../../../../packages/plugin/src/generators/create-package/utils/normalize-schema.ts"],"names":[],"mappings":";;;AAAA,uCAMoB;AAWpB,SAAgB,eAAe,CAC7B,IAAU,EACV,MAA2B;;IAE3B,MAAM,EAAE,eAAe,EAAE,gBAAgB,EAAE,GAAG,IAAA,+BAAsB,EAClE,MAAM,CAAC,SAAS,CACjB,CAAC;IACF,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,GAAG,IAAA,2BAAkB,EAAC,IAAI,CAAC,CAAC;IAC7D,MAAM,OAAO,GAAG,eAAe,aAAf,eAAe,cAAf,eAAe,GAAI,cAAc,CAAC;IAClD,MAAM,IAAI,GAAG,IAAA,cAAK,EAAC,MAAM,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC;IACzC,MAAM,oBAAoB,GAAG,gBAAgB;QAC3C,CAAC,CAAC,GAAG,IAAA,cAAK,EAAC,gBAAgB,CAAC,CAAC,QAAQ,IAAI,IAAI,EAAE;QAC/C,CAAC,CAAC,IAAI,CAAC;IACT,MAAM,WAAW,GAAG,oBAAoB,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;IAC5E,MAAM,WAAW,GAAG,IAAA,0BAAiB,EAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC;IACrE,uCACK,MAAM,KACT,OAAO,EAAE,MAAA,MAAM,CAAC,QAAQ,mCAAI,KAAK,EACjC,OAAO;QACP,WAAW;QACX,WAAW;QACX,IAAI,EACJ,gBAAgB,EAAE,oBAAoB,IACtC;AACJ,CAAC;AAxBD,0CAwBC"}

package/src/generators/e2e-project/e2e.d.ts

@@ -0,0 +1,6 @@
+import type { Tree } from '@nx/devkit';
+import { GeneratorCallback } from '@nx/devkit';
+import type { Schema } from './schema';
+export declare function e2eProjectGenerator(host: Tree, schema: Schema): Promise<GeneratorCallback>;
+export default e2eProjectGenerator;
+export declare const e2eProjectSchematic: (generatorOptions: Schema) => (tree: any, context: any) => Promise<any>;

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

@@ -0,0 +1,107 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.e2eProjectSchematic = exports.e2eProjectGenerator = void 0;
+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 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 = layoutDirectory !== null && layoutDirectory !== void 0 ? layoutDirectory : defaultAppsDir;
+    const projectName = options.rootProject ? 'e2e' : `${options.pluginName}-e2e`;
+    const projectRoot = projectDirectory && !options.rootProject
+        ? (0, devkit_1.joinPathFragments)(appsDir, `${projectDirectory}-e2e`)
+        : options.rootProject
+            ? projectName
+            : (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 });
+}
+function validatePlugin(host, pluginName) {
+    try {
+        (0, devkit_1.readProjectConfiguration)(host, pluginName);
+    }
+    catch (_a) {
+        throw new Error(`Project name "${pluginName}" doesn't not exist.`);
+    }
+}
+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) }));
+}
+function updateWorkspaceConfiguration(host, options) {
+    (0, devkit_1.addProjectConfiguration)(host, options.projectName, {
+        root: options.projectRoot,
+        projectType: 'application',
+        sourceRoot: `${options.projectRoot}/tests`,
+        targets: {
+            e2e: {
+                executor: '@nx/plugin:e2e',
+                options: { target: `${options.pluginName}:build` },
+            },
+        },
+        tags: [],
+        implicitDependencies: [options.pluginName],
+    });
+}
+function addJest(host, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        yield (0, jest_1.jestProjectGenerator)(host, {
+            project: options.projectName,
+            setupFile: 'none',
+            supportTsx: false,
+            skipSerializers: true,
+            skipFormat: true,
+        });
+        const project = (0, devkit_1.readProjectConfiguration)(host, options.projectName);
+        const testOptions = project.targets.test.options;
+        const e2eOptions = project.targets.e2e.options;
+        project.targets.e2e.options = Object.assign(Object.assign({}, e2eOptions), { jestConfig: testOptions.jestConfig });
+        // remove the jest build target
+        delete project.targets.test;
+        (0, devkit_1.updateProjectConfiguration)(host, options.projectName, project);
+    });
+}
+function addLintingToApplication(tree, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const lintTask = yield (0, linter_1.lintProjectGenerator)(tree, {
+            linter: options.linter,
+            project: options.projectName,
+            tsConfigPaths: [
+                (0, devkit_1.joinPathFragments)(options.projectRoot, 'tsconfig.app.json'),
+            ],
+            eslintFilePatterns: [`${options.projectRoot}/**/*.ts`],
+            unitTestRunner: 'jest',
+            skipFormat: true,
+            setParserOptionsProject: false,
+        });
+        return lintTask;
+    });
+}
+function e2eProjectGenerator(host, schema) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const tasks = [];
+        validatePlugin(host, schema.pluginName);
+        const options = normalizeOptions(host, schema);
+        addFiles(host, options);
+        updateWorkspaceConfiguration(host, options);
+        yield addJest(host, options);
+        if (options.linter !== linter_1.Linter.None) {
+            const lintTask = yield addLintingToApplication(host, Object.assign({}, options));
+            tasks.push(lintTask);
+        }
+        if (!options.skipFormat) {
+            yield (0, devkit_1.formatFiles)(host);
+        }
+        return (0, devkit_1.runTasksInSerial)(...tasks);
+    });
+}
+exports.e2eProjectGenerator = e2eProjectGenerator;
+exports.default = e2eProjectGenerator;
+exports.e2eProjectSchematic = (0, devkit_1.convertNxGenerator)(e2eProjectGenerator);
+//# sourceMappingURL=e2e.js.map