schema.d.ts 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127
  1. /**
  2. * Creates a new project by combining the workspace and application schematics.
  3. */
  4. export interface Schema {
  5. /**
  6. * Initial git repository commit information.
  7. */
  8. commit?: CommitUnion;
  9. /**
  10. * Create a new initial application project in the 'src' folder of the new workspace. When
  11. * false, creates an empty workspace with no initial application. You can then use the
  12. * generate application command so that all applications are created in the projects folder.
  13. */
  14. createApplication?: boolean;
  15. /**
  16. * The directory name to create the workspace in.
  17. */
  18. directory?: string;
  19. /**
  20. * Include styles inline in the component TS file. By default, an external styles file is
  21. * created and referenced in the component TypeScript file.
  22. */
  23. inlineStyle?: boolean;
  24. /**
  25. * Include template inline in the component TS file. By default, an external template file
  26. * is created and referenced in the component TypeScript file.
  27. */
  28. inlineTemplate?: boolean;
  29. /**
  30. * Link the CLI to the global version (internal development only).
  31. */
  32. linkCli?: boolean;
  33. /**
  34. * Create a workspace without any testing frameworks. (Use for learning purposes only.)
  35. */
  36. minimal?: boolean;
  37. /**
  38. * The name of the new workspace and initial project.
  39. */
  40. name: string;
  41. /**
  42. * The path where new projects will be created, relative to the new workspace root.
  43. */
  44. newProjectRoot?: string;
  45. /**
  46. * The package manager used to install dependencies.
  47. */
  48. packageManager?: PackageManager;
  49. /**
  50. * The prefix to apply to generated selectors for the initial project.
  51. */
  52. prefix?: string;
  53. /**
  54. * Generate a routing module for the initial project.
  55. */
  56. routing?: boolean;
  57. /**
  58. * Do not initialize a git repository.
  59. */
  60. skipGit?: boolean;
  61. /**
  62. * Do not install dependency packages.
  63. */
  64. skipInstall?: boolean;
  65. /**
  66. * Do not generate "spec.ts" test files for the new project.
  67. */
  68. skipTests?: boolean;
  69. /**
  70. * Creates an application based upon the standalone API, without NgModules.
  71. */
  72. standalone?: boolean;
  73. /**
  74. * Creates a workspace with stricter type checking and stricter bundle budgets settings.
  75. * This setting helps improve maintainability and catch bugs ahead of time. For more
  76. * information, see https://angular.io/guide/strict-mode
  77. */
  78. strict?: boolean;
  79. /**
  80. * The file extension or preprocessor to use for style files.
  81. */
  82. style?: Style;
  83. /**
  84. * The version of the Angular CLI to use.
  85. */
  86. version: string;
  87. /**
  88. * The view encapsulation strategy to use in the initial project.
  89. */
  90. viewEncapsulation?: ViewEncapsulation;
  91. }
  92. /**
  93. * Initial git repository commit information.
  94. */
  95. export type CommitUnion = boolean | CommitObject;
  96. export interface CommitObject {
  97. email: string;
  98. message?: string;
  99. name: string;
  100. [property: string]: any;
  101. }
  102. /**
  103. * The package manager used to install dependencies.
  104. */
  105. export declare enum PackageManager {
  106. Cnpm = "cnpm",
  107. Npm = "npm",
  108. Pnpm = "pnpm",
  109. Yarn = "yarn"
  110. }
  111. /**
  112. * The file extension or preprocessor to use for style files.
  113. */
  114. export declare enum Style {
  115. Css = "css",
  116. Less = "less",
  117. Sass = "sass",
  118. Scss = "scss"
  119. }
  120. /**
  121. * The view encapsulation strategy to use in the initial project.
  122. */
  123. export declare enum ViewEncapsulation {
  124. Emulated = "Emulated",
  125. None = "None",
  126. ShadowDom = "ShadowDom"
  127. }