collection-schema.d.ts 1.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. export interface Schema {
  2. extends?: Extends;
  3. /**
  4. * A map of schematic names to schematic details
  5. */
  6. schematics: {
  7. [key: string]: Schematic;
  8. };
  9. version?: string;
  10. }
  11. export declare type Extends = string[] | string;
  12. export interface Schematic {
  13. aliases?: string[];
  14. /**
  15. * A description for the schematic
  16. */
  17. description: string;
  18. /**
  19. * An schematic override. It can be a local schematic or from another collection (in the
  20. * format 'collection:schematic')
  21. */
  22. extends?: string;
  23. /**
  24. * A folder or file path to the schematic factory
  25. */
  26. factory: string;
  27. /**
  28. * Whether or not this schematic should be listed by the tooling. This does not prevent the
  29. * tooling to run this schematic, just removes its name from listSchematicNames().
  30. */
  31. hidden?: boolean;
  32. /**
  33. * Whether or not this schematic can be called from an external schematic, or a tool. This
  34. * implies hidden: true.
  35. */
  36. private?: boolean;
  37. /**
  38. * Location of the schema.json file of the schematic
  39. */
  40. schema?: string;
  41. }