@nx/plugin 0.0.0-pr-22179-271588f

package/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2017-2023 Narwhal Technologies Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,72 @@
+<p style="text-align: center;">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-dark.svg">
+    <img alt="Nx - Smart Monorepos · Fast CI" src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-light.svg" width="100%">
+  </picture>
+</p>
+
+<div style="text-align: center;">
+
+[![CircleCI](https://circleci.com/gh/nrwl/nx.svg?style=svg)](https://circleci.com/gh/nrwl/nx)
+[![License](https://img.shields.io/npm/l/@nx/workspace.svg?style=flat-square)]()
+[![NPM Version](https://badge.fury.io/js/%40nrwl%2Fworkspace.svg)](https://www.npmjs.com/@nx/workspace)
+[![Semantic Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)]()
+[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
+[![Join the chat at https://gitter.im/nrwl-nx/community](https://badges.gitter.im/nrwl-nx/community.svg)](https://gitter.im/nrwl-nx/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![Join us on the Official Nx Discord Server](https://img.shields.io/discord/1143497901675401286?label=discord)](https://go.nx.dev/community)
+
+</div>
+
+
+<hr>
+
+# Nx: Smart Monorepos · Fast CI
+
+Nx is a build system with built-in tooling and advanced CI capabilities. It helps you maintain and scale monorepos, both locally and on CI.
+
+## What is It?
+
+It's an Nx plugin used to build other Nx plugins.
+
+Check out the list of community plugins and the documentation on how to create one using `create-nx-plugin` here: [https://nx.dev/community](https://nx.dev/community)
+
+## Getting Started
+
+### Creating an Nx Workspace
+
+**Using `npx`**
+
+```bash
+npx create-nx-workspace
+```
+
+**Using `npm init`**
+
+```bash
+npm init nx-workspace
+```
+
+**Using `yarn create`**
+
+```bash
+yarn create nx-workspace
+```
+
+### Adding Nx to an Existing Repository
+
+Run:
+
+```bash
+npx nx@latest init
+```
+
+## Documentation & Resources
+
+- [Nx.Dev: Documentation, Guides, Tutorials](https://nx.dev)
+- [Intro to Nx](https://nx.dev/getting-started/intro)
+- [Official Nx YouTube Channel](https://www.youtube.com/@NxDevtools)
+- [Blog Posts About Nx](https://blog.nrwl.io/nx/home)
+
+<p style="text-align: center;"><a href="https://nx.dev/#learning-materials" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-courses-and-videos.svg" 
+width="100%" alt="Nx - Smart Monorepos · Fast CI"></a></p>
+

package/executors.json

@@ -0,0 +1,10 @@
+{
+  "executors": {
+    "e2e": {
+      "implementation": "./src/executors/e2e/e2e.impl",
+      "schema": "./src/executors/e2e/schema.json",
+      "description": "Creates and runs the E2E tests for an Nx Plugin.",
+      "x-deprecated": "@nx/plugin:e2e is deprecated and will be removed in Nx v19. Use @nx/jest:jest instead."
+    }
+  }
+}

package/generators.d.ts

@@ -0,0 +1,6 @@
+export * from './src/generators/create-package/create-package';
+export * from './src/generators/e2e-project/e2e';
+export * from './src/generators/executor/executor';
+export * from './src/generators/generator/generator';
+export * from './src/generators/plugin/plugin';
+export * from './src/generators/migration/migration';

package/generators.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./src/generators/create-package/create-package"), exports);
+tslib_1.__exportStar(require("./src/generators/e2e-project/e2e"), exports);
+tslib_1.__exportStar(require("./src/generators/executor/executor"), exports);
+tslib_1.__exportStar(require("./src/generators/generator/generator"), exports);
+tslib_1.__exportStar(require("./src/generators/plugin/plugin"), exports);
+tslib_1.__exportStar(require("./src/generators/migration/migration"), exports);

package/generators.json

@@ -0,0 +1,49 @@
+{
+  "name": "nx/plugin",
+  "version": "0.1",
+  "extends": ["@nx/workspace"],
+  "generators": {
+    "plugin": {
+      "factory": "./src/generators/plugin/plugin#pluginGeneratorInternal",
+      "schema": "./src/generators/plugin/schema.json",
+      "description": "Create a Nx Plugin."
+    },
+    "create-package": {
+      "factory": "./src/generators/create-package/create-package#createPackageGeneratorInternal",
+      "schema": "./src/generators/create-package/schema.json",
+      "description": "Create a package which can be used by npx to create a new workspace"
+    },
+    "e2e-project": {
+      "factory": "./src/generators/e2e-project/e2e#e2eProjectGeneratorInternal",
+      "schema": "./src/generators/e2e-project/schema.json",
+      "description": "Create a E2E application for a Nx Plugin."
+    },
+    "migration": {
+      "factory": "./src/generators/migration/migration#migrationGeneratorInternal",
+      "schema": "./src/generators/migration/schema.json",
+      "description": "Create a migration for an Nx Plugin."
+    },
+    "generator": {
+      "factory": "./src/generators/generator/generator#generatorGeneratorInternal",
+      "schema": "./src/generators/generator/schema.json",
+      "description": "Create a generator for an Nx Plugin."
+    },
+    "executor": {
+      "factory": "./src/generators/executor/executor#executorGeneratorInternal",
+      "schema": "./src/generators/executor/schema.json",
+      "description": "Create an executor for an Nx Plugin."
+    },
+    "plugin-lint-checks": {
+      "factory": "./src/generators/lint-checks/generator",
+      "schema": "./src/generators/lint-checks/schema.json",
+      "description": "Adds linting configuration to validate common json files for nx plugins."
+    },
+    "preset": {
+      "factory": "./src/generators/preset/generator",
+      "schema": "./src/generators/preset/schema.json",
+      "description": "Initializes a workspace with an nx-plugin inside of it. Use as: `create-nx-workspace --preset @nx/plugin`.",
+      "hidden": true,
+      "x-use-standalone-layout": true
+    }
+  }
+}

package/migrations.json

@@ -0,0 +1,40 @@
+{
+  "generators": {
+    "update-15-0-0": {
+      "cli": "nx",
+      "version": "15.0.0-beta.0",
+      "description": "Migrates executor schema files to v2",
+      "factory": "./src/migrations/update-15-0-0/specify-output-capture"
+    },
+    "update-configs-jest-29": {
+      "version": "15.9.0-beta.0",
+      "cli": "nx",
+      "description": "Update nx plugin jest configs to support jest 29 changes (https://jestjs.io/docs/upgrading-to-jest29)",
+      "factory": "./src/migrations/update-15-9-0/jest-29-configs"
+    },
+    "update-tests-jest-29": {
+      "version": "15.9.0-beta.0",
+      "cli": "nx",
+      "description": "Update nx plugin jest test files to support jest 29 changes (https://jestjs.io/docs/upgrading-to-jest29)",
+      "factory": "./src/migrations/update-15-9-0/jest-29-tests"
+    },
+    "update-remove-cli-prop": {
+      "version": "16.0.0-beta.1",
+      "cli": "nx",
+      "description": "Removes CLI property within schema.json files and moves generators and schematics to the proper root node in migrations.json",
+      "factory": "./src/migrations/update-16-0-0/cli-in-schema-json"
+    },
+    "update-16-0-0-add-nx-packages": {
+      "cli": "nx",
+      "version": "16.0.0-beta.1",
+      "description": "Replace @nrwl/nx-plugin with @nx/plugin",
+      "implementation": "./src/migrations/update-16-0-0-add-nx-packages/update-16-0-0-add-nx-packages"
+    },
+    "update-16-2-0-replace-e2e-executor": {
+      "cli": "nx",
+      "version": "16.2.0-beta.0",
+      "description": "Replace @nx/plugin:e2e with @nx/jest",
+      "implementation": "./src/migrations/update-16-2-0/replace-e2e-executor"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@nx/plugin",
+  "version": "0.0.0-pr-22179-271588f",
+  "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": {
+    "type": "git",
+    "url": "https://github.com/nrwl/nx.git",
+    "directory": "packages/plugin"
+  },
+  "keywords": [
+    "Monorepo",
+    "Nx",
+    "CLI"
+  ],
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "author": "Nrwl",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/nrwl/nx/issues"
+  },
+  "homepage": "https://nx.dev",
+  "generators": "./generators.json",
+  "executors": "./executors.json",
+  "ng-update": {
+    "requirements": {},
+    "migrations": "./migrations.json"
+  },
+  "dependencies": {
+    "@phenomnomnominal/tsquery": "~5.0.1",
+    "fs-extra": "^11.1.0",
+    "tslib": "^2.3.0",
+    "@nx/devkit": "0.0.0-pr-22179-271588f",
+    "@nx/jest": "0.0.0-pr-22179-271588f",
+    "@nx/js": "0.0.0-pr-22179-271588f",
+    "@nx/eslint": "0.0.0-pr-22179-271588f",
+    "@nrwl/nx-plugin": "0.0.0-pr-22179-271588f"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "commonjs"
+}

package/src/executors/e2e/e2e.impl.d.ts

@@ -0,0 +1,6 @@
+import type { ExecutorContext } from '@nx/devkit';
+import type { NxPluginE2EExecutorOptions } from './schema';
+export declare function nxPluginE2EExecutor(options: NxPluginE2EExecutorOptions, context: ExecutorContext): AsyncGenerator<{
+    success: boolean;
+}>;
+export default nxPluginE2EExecutor;

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

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.nxPluginE2EExecutor = void 0;
+const devkit_1 = require("@nx/devkit");
+const jest_impl_1 = require("@nx/jest/src/executors/jest/jest.impl");
+// TODO(v19): remove this
+async function* nxPluginE2EExecutor(options, context) {
+    const { target, ...jestOptions } = options;
+    devkit_1.output.warn({
+        title: `"@nx/plugin:e2e" is deprecated and will be removed in Nx 19`,
+        bodyLines: [
+            'Use the "@nx/jest:jest" executor instead and set the following:',
+            `"dependsOn": ["${target}"]`,
+        ],
+    });
+    let success;
+    for await (const _ of runBuildTarget(target, context)) {
+        try {
+            success = await runTests(jestOptions, context);
+        }
+        catch (e) {
+            devkit_1.logger.error(e.message);
+            success = false;
+        }
+    }
+    return { success };
+}
+exports.nxPluginE2EExecutor = nxPluginE2EExecutor;
+async function* runBuildTarget(buildTarget, context) {
+    const { project, target, configuration } = (0, devkit_1.parseTargetString)(buildTarget, context);
+    const buildTargetOptions = (0, devkit_1.readTargetOptions)({ project, target, configuration }, context);
+    const targetSupportsWatch = Object.keys(buildTargetOptions).includes('watch');
+    for await (const output of await (0, devkit_1.runExecutor)({ project, target, configuration }, targetSupportsWatch ? { watch: false } : {}, context)) {
+        if (!output.success)
+            throw new Error('Could not compile application files.');
+        yield output.success;
+    }
+}
+async function runTests(jestOptions, context) {
+    const { success } = await (0, jest_impl_1.jestExecutor)({ ...jestOptions, watch: false }, context);
+    return success;
+}
+exports.default = nxPluginE2EExecutor;

package/src/executors/e2e/schema.d.ts

@@ -0,0 +1,6 @@
+import { JestExecutorOptions } from '@nx/jest/src/executors/jest/schema';
+
+export interface NxPluginE2EExecutorOptions extends JestExecutorOptions {
+  target: string;
+  jestConfig: string;
+}

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 { GeneratorCallback, Tree } from '@nx/devkit';
+import { CreatePackageSchema } from './schema';
+export declare function createPackageGenerator(host: Tree, schema: CreatePackageSchema): Promise<GeneratorCallback>;
+export declare function createPackageGeneratorInternal(host: Tree, schema: CreatePackageSchema): Promise<GeneratorCallback>;
+export default createPackageGenerator;