27edf71cef
<!-- Please make sure you have read the submission guidelines before posting an PR --> <!-- https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr --> <!-- Please make sure that your commit message follows our format --> <!-- Example: `fix(nx): must begin with lowercase` --> <!-- If this is a particularly complex change or feature addition, you can request a dedicated Nx release for this pull request branch. Mention someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they will confirm if the PR warrants its own release for testing purposes, and generate it for you if appropriate. --> ## Current Behavior <!-- This is the behavior we have today --> ## Expected Behavior <!-- This is the behavior we should expect with the changes in this PR --> ## Related Issue(s) <!-- Please link the issue being fixed so it gets closed when this is merged. --> Fixes # --------- Co-authored-by: Colum Ferry <cferry09@gmail.com> Co-authored-by: Nicholas Cunningham <ndcunningham@gmail.com>
107 lines
3.6 KiB
JSON
107 lines
3.6 KiB
JSON
{
|
|
"name": "plugin",
|
|
"factory": "./src/generators/plugin/plugin",
|
|
"schema": {
|
|
"$schema": "https://json-schema.org/schema",
|
|
"cli": "nx",
|
|
"$id": "NxPluginPlugin",
|
|
"title": "Create a Plugin for Nx",
|
|
"description": "Create a Plugin for Nx.",
|
|
"type": "object",
|
|
"examples": [
|
|
{
|
|
"command": "nx g plugin my-plugin --directory=plugins --importPath=@myorg/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": {
|
|
"directory": {
|
|
"type": "string",
|
|
"description": "A directory where the plugin is placed.",
|
|
"$default": { "$source": "argv", "index": 0 },
|
|
"x-prompt": "Which directory do you want to create the plugin in?"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Plugin name",
|
|
"x-priority": "important"
|
|
},
|
|
"importPath": {
|
|
"type": "string",
|
|
"description": "How the plugin will be published, like `@myorg/my-awesome-plugin`. Note this must be a valid NPM name.",
|
|
"x-priority": "important"
|
|
},
|
|
"linter": {
|
|
"description": "The tool to use for running lint checks.",
|
|
"type": "string",
|
|
"enum": ["eslint"],
|
|
"default": "eslint"
|
|
},
|
|
"unitTestRunner": {
|
|
"type": "string",
|
|
"enum": ["jest", "none"],
|
|
"description": "Test runner to use for unit tests.",
|
|
"default": "jest"
|
|
},
|
|
"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"
|
|
},
|
|
"skipTsConfig": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"description": "Do not update tsconfig.json for development experience.",
|
|
"x-priority": "internal"
|
|
},
|
|
"skipLintChecks": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"description": "Do not eslint configuration for plugin json files."
|
|
},
|
|
"e2eTestRunner": {
|
|
"type": "string",
|
|
"enum": ["jest", "none"],
|
|
"description": "Test runner to use for end to end (E2E) tests.",
|
|
"default": "none"
|
|
},
|
|
"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"
|
|
},
|
|
"setParserOptionsProject": {
|
|
"type": "boolean",
|
|
"description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
|
|
"default": false
|
|
},
|
|
"compiler": {
|
|
"type": "string",
|
|
"enum": ["tsc", "swc"],
|
|
"default": "tsc",
|
|
"description": "The compiler used by the build and test targets."
|
|
},
|
|
"publishable": {
|
|
"type": "boolean",
|
|
"description": "Generates a boilerplate for publishing the plugin to npm.",
|
|
"default": false
|
|
}
|
|
},
|
|
"required": ["directory"],
|
|
"presets": []
|
|
},
|
|
"description": "Create a Nx Plugin.",
|
|
"implementation": "/packages/plugin/src/generators/plugin/plugin.ts",
|
|
"aliases": [],
|
|
"hidden": false,
|
|
"path": "/packages/plugin/src/generators/plugin/schema.json",
|
|
"type": "generator"
|
|
}
|