@nestjsplus/lib-starter/schematics-utils/schemas/nest-add-options.schema.ts

Boilerplate for building installable NestJS libraries

import { Path } from '@angular-devkit/core';
/**
 * `nest-add` schematics options objects should have these.
 *
 * Right now, we assume `nest add` will be updated to pass `sourceRoot`
 * in the same way that `nest g` does
 *
 * Schematics also accept the following.  Right now, these are not passed through
 * automatically from `nest add`.  They can be specified on the command line and
 * are passed through unchanged.
 *
 * --skipImport (has no standard nest option, must be passed through as --skipImport)
 *
 */

export interface NestAddOptionsSchema {
  /**
   * does not attempt to import the module into the root module (AppModule)
   */
  skipImport?: boolean;

  /**
   * Name to be used during installation of the libarary
   */
  name?: string;

  /**
   * root folder for project source
   */
  sourceRoot?: string;

  /**
   * path for a generated component
   */
  path?: string;

  /**
   *
   */
  metadata?: string;

  type?: string;

  module?: Path;
}