File

libs/nx/src/generators/library/schema.ts

Index

Properties

Properties

category
Type string
CLI Usage --category="FNOL"
Description

The name of the category to which future Building Blocks in this library should belong to.

directory (Optional)
Type string
CLI Usage --directory="fnol/fnol_name/building-blocks"
Description

The directory where the library should be created. The library will be created inside the "libs/" folder located in the root directory unless a specific directory is provided.

name
Type string
CLI Usage --name="@allianz/building-blocks-fnol"
Description

The project name. Must be unique.

prefix
Type string
CLI Usage --prefix="fnol"
Description

The name of the prefix which will be used in Building Block selectors, files and folder names

export interface LibraryGeneratorSchema {
  /**
   * The project name. Must be unique.
   * @examples ["@allianz/building-blocks-new-business"]
   * @x-prompt Please type the project name (e.g., "@allianz/building-blocks-new-business"):
   * @cliUsage --name="@allianz/building-blocks-fnol"
   */
  name: string;
  /**
   * The name of the category to which future Building Blocks in this library should belong to.
   * @x-prompt Please type the name of the category where future Building Blocks should be placed. It will be included in a new npm script that creates Building Blocks for this library:
   * @cliUsage --category="FNOL"
   */
  category: string;
  /**
   * The name of the prefix which will be used in Building Block selectors, files and folder names
   * @x-prompt Please type the prefix what should be used in the selectors of your Building Blocks (e.g. "nb" for "New Business"):
   * @cliUsage --prefix="fnol"
   */
  prefix: string;
  /**
   * The directory where the library should be created. The library will be created inside the "libs/" folder located in the root directory unless a specific directory is provided.
   * @cliUsage --directory="fnol/fnol_name/building-blocks"
   */
  directory?: string;
}

results matching ""

    No results matching ""