Skip to content
This repository has been archived by the owner on Apr 20, 2023. It is now read-only.

Latest commit

 

History

History

generator-ts-project

TSProjectGenerator

A Set of Generators for Creating Projects Written in TypeScript

Usage

Install TSProjectGenerator

You can install TSProjectGenerator using the following command:

npm install -g yo @manuth/generator-ts-project

Generate a Generator Written in TypeScript

You can create a generator written in TypeScript using this command:

yo @manuth/ts-project

It is recommended to use a code-editor which provides TypeScript-support (like, for example VSCode or Atom).

Generator Output

  • A basic folder-structure for keeping TypeScript-code and JavaScript-builds separate
  • Linting-rules (optional)
    • Either weak rules…
    • …or strong rules
  • A node-package with required dependencies
  • Mocha test-environment
  • NPM-Scripts for…
    • Compiling the TypeScript-code
    • Cleaning compiled TypeScript-code
    • Linting the package
    • Testing the package
  • Visual Studio Code workspace (optional)
    • Settings
    • Task for building the generator (by pressing CTRL, SHIFT + B)
    • Task for linting the generator
    • Debug-settings

When generating a module you'll additionally get:

  • An empty index script

When generating a generator you'll get following in addition:

  • An EJS-extension for VSCode
  • An example-generator including template-files
  • As many sub-generators as you bother to create