ng-matero/ng-generate/module/schema.ts

Angular Material admin template

/**
 * Creates a new generic NgModule definition in the given or default project.
 */
export interface Schema {
  /**
   * Whether the generated module is standalone.
   */
  standalone?: boolean;
  /**
   * When true, creates the new files at the top level of the current project root.
   */
  flat?: boolean;
  /**
   * When true, applies lint fixes after generating the module.
   */
  lintFix?: boolean;
  /**
   * The root of feature modules. Defaults to `routes` folder.
   */
  moduleRoot?: string;
  /**
   * The declaring NgModule. Defaults to `routes.module`.
   */
  module?: string;
  /**
   * The name of the NgModule.
   */
  name: string;
  /**
   * The path at which to create the NgModule, relative to the workspace root.
   */
  path?: string;
  /**
   * The name of the project.
   */
  project?: string;
  /**
   * Creates lazy loaded routing module. Requires --module option.
   * Defaults to `routes-routing.module`.
   */
  route?: string;
  /**
   * When true, creates a routing module. Invalid to config.
   */
  routing?: boolean;
  /**
   * The scope for the new routing module. Invalid to config.
   */
  routingScope?: RoutingScope;
}

/**
 * The scope for the new routing module.
 */
export enum RoutingScope {
  Child = 'Child',
  Root = 'Root',
}