77 lines
3.3 KiB
JSON

{
"name": "ng-add",
"factory": "./src/generators/ng-add/ng-add",
"schema": {
"$schema": "http://json-schema.org/schema",
"$id": "NxAngularNgAddGenerator",
"title": "Angular plugin initialization",
"cli": "nx",
"description": "Migrates an Angular CLI workspace to Nx or adds the Angular plugin to an Nx workspace. NOTE: Does not work in the `--dry-run` mode.",
"type": "object",
"properties": {
"defaultBase": {
"type": "string",
"description": "Default base branch for affected. NOTE: only used if running the generator in an Angular CLI workspace.",
"x-priority": "important"
},
"skipInstall": {
"type": "boolean",
"description": "Skip installing added packages.",
"default": false,
"x-priority": "internal"
},
"unitTestRunner": {
"type": "string",
"enum": ["karma", "jest", "none"],
"description": "Test runner to use for unit tests. NOTE: only used if running the generator in an Nx workspace.",
"default": "jest"
},
"e2eTestRunner": {
"type": "string",
"enum": ["protractor", "cypress", "none"],
"description": "Test runner to use for end to end (e2e) tests. NOTE: only used if running the generator in an Nx workspace.",
"default": "cypress"
},
"skipFormat": {
"description": "Skip formatting files. NOTE: only used if running the generator in an Nx workspace.",
"type": "boolean",
"default": false,
"x-priority": "internal"
},
"linter": {
"description": "The tool to use for running lint checks. NOTE: only used if running the generator in an Nx workspace.",
"type": "string",
"enum": ["eslint", "none"],
"default": "eslint"
},
"style": {
"description": "The file extension to be used for style files. NOTE: only used if running the generator in an Nx workspace.",
"type": "string",
"default": "css",
"enum": ["css", "scss", "sass", "less"]
},
"skipPackageJson": {
"type": "boolean",
"default": false,
"description": "Do not add dependencies to `package.json`. NOTE: only used if running the generator in an Nx workspace.",
"x-priority": "internal"
},
"skipPostInstall": {
"type": "boolean",
"default": false,
"description": "Do not add or append `ngcc` to the `postinstall` script in `package.json`. NOTE: only used if running the generator in an Nx workspace.",
"x-priority": "internal"
}
},
"additionalProperties": false,
"examplesFile": "## Information\n\nThis generator is usually used as part of the process of migrating from an Angular CLI Workspace to an [Nx Integrated Workspace](/concepts/integrated-vs-package-based#integrated-repos) using `npx nx@latest init --integrated`.\n\nYou can read more about [migrating from Angular CLI to Nx here](/recipes/adopting-nx-angular).\n",
"presets": []
},
"description": "Migrates an Angular CLI workspace to Nx or adds the Angular plugin to an Nx workspace.",
"hidden": true,
"implementation": "/packages/angular/src/generators/ng-add/ng-add.ts",
"aliases": [],
"path": "/packages/angular/src/generators/ng-add/schema.json",
"type": "generator"
}