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>
77 lines
2.8 KiB
JSON
77 lines
2.8 KiB
JSON
{
|
|
"name": "create-package",
|
|
"factory": "./src/generators/create-package/create-package",
|
|
"schema": {
|
|
"$schema": "https://json-schema.org/schema",
|
|
"cli": "nx",
|
|
"$id": "NxPluginCreatePackage",
|
|
"title": "Create a framework package",
|
|
"description": "Create a framework package that uses Nx CLI.",
|
|
"examplesFile": "## Examples\n\n{% tabs %}\n{% tab label=\"Basic executable\" %}\n\nCreate an executable that initializes an Nx workspace with {my-plugin}'s preset:\n\n```bash\nnx g @nx/plugin:create-package create-my-plugin --project my-plugin\n```\n\n{% /tab %}\n{% /tabs %}\n",
|
|
"type": "object",
|
|
"properties": {
|
|
"directory": {
|
|
"type": "string",
|
|
"description": "A directory where the app is placed.",
|
|
"$default": { "$source": "argv", "index": 0 }
|
|
},
|
|
"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.",
|
|
"pattern": "create-.+|^@.+/create(?:-.+)?",
|
|
"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"
|
|
},
|
|
"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."
|
|
},
|
|
"e2eProject": {
|
|
"type": "string",
|
|
"description": "The name of the e2e project.",
|
|
"x-prompt": "What is the name of the e2e project? Leave blank to skip e2e tests"
|
|
}
|
|
},
|
|
"required": ["directory", "name", "project"],
|
|
"presets": []
|
|
},
|
|
"description": "Create a package which can be used by npx to create a new workspace",
|
|
"implementation": "/packages/plugin/src/generators/create-package/create-package.ts",
|
|
"aliases": [],
|
|
"hidden": false,
|
|
"path": "/packages/plugin/src/generators/create-package/schema.json",
|
|
"type": "generator"
|
|
}
|