Generators

This project contains following generators:

model

Info Creates a file with a given type in a folder named after the type in a defined project. The folder named after the type will not be created if a specific path is defined.

Properties

• name

  • the name for the file and created export (adds I before interfaces for example ISchema)

• project

  • the name of the project in which the file should be created

• type

  • is a prompt which lets you choose between three different types -> Interface, Enum, Type (Can also be defined while initialisation, but can lead to errors if defined otherwise)

• path (optional)

  • define a specified path inside the projects directory, where the file should be generated

• extname (optional)

  • define your own file extname (default: the selected type)

• public (optional)

  • exports the file inside public_api.ts, recursively till the project root and adds it in an index.ts

recursive-export

Info Uses the generators public-api and index to export a file from a given path to the project/library root directory app/lib. Recursively uses public_api.ts files, which export another till the project/library root where the main index.ts will be located. Properties

• path

  • the path of the directory where the file to export is located

• project

  • the name of the project/library where the generator shall be used

• file

  • the name of the file to export

index

Info Adds an export of a given file to a file called index.ts next to the project/library dirname app/lib ( creates the index.ts if not present) Properties

• path

  • the path of the file to export

• project

  • the name of the project/library where the generator shall be used

public-api

Info Adds an export of a given file to a file called public_api.ts next to the given file ( creates the public_api.ts if not present) Properties

• path

  • the path of the file to export

• export (optional)

  • custom export if the basename of the given path should not be used