schema.d.ts 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111
  1. /**
  2. * Generates a new Angular application within your workspace. This schematic sets up the
  3. * foundational structure of your project, including the root component, module, and
  4. * configuration files. You can customize various aspects of the application, such as
  5. * routing, styling, and testing.
  6. */
  7. export type Schema = {
  8. /**
  9. * Generate an application that does not use `zone.js`.
  10. */
  11. experimentalZoneless?: boolean;
  12. /**
  13. * Include the styles for the root component directly within the `app.component.ts` file.
  14. * Only CSS styles can be included inline. By default, a separate stylesheet file (e.g.,
  15. * `app.component.css`) is created.
  16. */
  17. inlineStyle?: boolean;
  18. /**
  19. * Include the HTML template for the root component directly within the `app.component.ts`
  20. * file. By default, a separate template file (e.g., `app.component.html`) is created.
  21. */
  22. inlineTemplate?: boolean;
  23. /**
  24. * Generate a minimal project without any testing frameworks. This is intended for learning
  25. * purposes and simple experimentation, not for production applications.
  26. */
  27. minimal?: boolean;
  28. /**
  29. * The name for the new application. This name will be used for the project directory and
  30. * various identifiers throughout the application's code.
  31. */
  32. name: string;
  33. /**
  34. * A prefix to be added to the selectors of components generated within this application.
  35. * For example, if the prefix is `my-app` and you generate a component named `my-component`,
  36. * the selector will be `my-app-my-component`.
  37. */
  38. prefix?: string;
  39. /**
  40. * The directory where the new application's files will be created, relative to the
  41. * workspace root. If not specified, the application will be created in a subfolder within
  42. * the `projects` directory, using the application's name.
  43. */
  44. projectRoot?: string;
  45. /**
  46. * Generate an application with routing already configured. This sets up the necessary files
  47. * and modules for managing navigation between different views in your application.
  48. */
  49. routing?: boolean;
  50. /**
  51. * Set up a server application using the Server Routing and App Engine APIs (Developer
  52. * Preview).
  53. */
  54. serverRouting?: boolean;
  55. /**
  56. * Skip the automatic installation of packages. You will need to manually install the
  57. * dependencies later.
  58. */
  59. skipInstall?: boolean;
  60. /**
  61. * Do not add dependencies to the `package.json` file.
  62. */
  63. skipPackageJson?: boolean;
  64. /**
  65. * Skip the generation of a unit test files `spec.ts`.
  66. */
  67. skipTests?: boolean;
  68. /**
  69. * Configure the application for Server-Side Rendering (SSR) and Static Site Generation
  70. * (SSG/Prerendering).
  71. */
  72. ssr?: boolean;
  73. /**
  74. * Create an application that utilizes the standalone API, eliminating the need for
  75. * NgModules. This can simplify the structure of your application.
  76. */
  77. standalone?: boolean;
  78. /**
  79. * Enable stricter bundle budget settings for the application. This helps to keep your
  80. * application's bundle size small and improve performance. For more information, see
  81. * https://angular.dev/tools/cli/template-typecheck#strict-mode
  82. */
  83. strict?: boolean;
  84. /**
  85. * The type of stylesheet files to be created for components in the application.
  86. */
  87. style?: Style;
  88. /**
  89. * Sets the view encapsulation mode for the application's components. This determines how
  90. * component styles are scoped and applied.
  91. */
  92. viewEncapsulation?: ViewEncapsulation;
  93. };
  94. /**
  95. * The type of stylesheet files to be created for components in the application.
  96. */
  97. export declare enum Style {
  98. Css = "css",
  99. Less = "less",
  100. Sass = "sass",
  101. Scss = "scss"
  102. }
  103. /**
  104. * Sets the view encapsulation mode for the application's components. This determines how
  105. * component styles are scoped and applied.
  106. */
  107. export declare enum ViewEncapsulation {
  108. Emulated = "Emulated",
  109. None = "None",
  110. ShadowDom = "ShadowDom"
  111. }