@nx/plugin
Version:
73 lines (72 loc) • 2.25 kB
JSON
{
"$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": "../../../docs/generators/create-package-examples.md",
"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": ["none", "jest", "vitest"],
"description": "Test runner to use for unit tests."
},
"linter": {
"description": "The tool to use for running lint checks.",
"type": "string",
"enum": ["none", "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"
},
"useProjectJson": {
"type": "boolean",
"description": "Use a `project.json` configuration file instead of inlining the Nx configuration in the `package.json` file."
}
},
"required": ["directory", "name", "project"]
}