schema.json 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. {
  2. "$schema": "http://json-schema.org/draft-07/schema",
  3. "$id": "SchematicsAngularModule",
  4. "title": "Angular Module Options Schema",
  5. "type": "object",
  6. "additionalProperties": false,
  7. "description": "Creates a new, generic NgModule definition in the given project.",
  8. "properties": {
  9. "name": {
  10. "type": "string",
  11. "description": "The name of the NgModule.",
  12. "$default": {
  13. "$source": "argv",
  14. "index": 0
  15. },
  16. "x-prompt": "What name would you like to use for the NgModule?"
  17. },
  18. "path": {
  19. "type": "string",
  20. "format": "path",
  21. "$default": {
  22. "$source": "workingDirectory"
  23. },
  24. "description": "The path at which to create the NgModule, relative to the workspace root.",
  25. "visible": false
  26. },
  27. "project": {
  28. "type": "string",
  29. "description": "The name of the project.",
  30. "$default": {
  31. "$source": "projectName"
  32. }
  33. },
  34. "routing": {
  35. "type": "boolean",
  36. "description": "Create a routing module.",
  37. "default": false,
  38. "x-user-analytics": "ep.ng_routing"
  39. },
  40. "routingScope": {
  41. "enum": ["Child", "Root"],
  42. "type": "string",
  43. "description": "The scope for the new routing module.",
  44. "default": "Child"
  45. },
  46. "route": {
  47. "type": "string",
  48. "description": "The route path for a lazy-loaded module. When supplied, creates a component in the new module, and adds the route to that component in the `Routes` array declared in the module provided in the `--module` option."
  49. },
  50. "flat": {
  51. "type": "boolean",
  52. "description": "Create the new files at the top level of the current project root. ",
  53. "default": false
  54. },
  55. "commonModule": {
  56. "type": "boolean",
  57. "description": "The new NgModule imports \"CommonModule\". ",
  58. "default": true,
  59. "visible": false
  60. },
  61. "module": {
  62. "type": "string",
  63. "description": "The declaring NgModule.",
  64. "alias": "m"
  65. }
  66. },
  67. "required": ["name", "project"]
  68. }