create-typescript-lib-template v1.0.0

create-typescript-lib-template

A tool based on plop.js that makes creating a TypeScript library extremely easy.

Installation

Install create-typescript-lib-template globally

$ npm install -g create-typescript-lib-template

CLI Usage

Once create-typescript-lib-template is installed, you are ready to run tslib from the terminal.

Usage:

$ tslib          // Create a typescript library template

This command will ask you some questions to generate your TypeScript library

• library name: enter the library name
• Where would you like to create this library ? choose where you want to create the library
• version: (1.0.0) enter the version (default = 1.0.0)
• description: enter the description
• entry point: (index.ts) enter entry point file (default = index.ts)
• git repository: enter the git repository
• keywords: enter the keywords (use , for separating keywords)

• author: enter the author

Congratulations :).

Start coding! package.json and entry files are already set up for you, so don't worry about linking to your main file, typings, etc. Just keep those files with the same name.

Features

• Zero-setup. After running npm install things will setup for you :wink:
• RollupJS for multiple optimized bundles following the standard convention and Tree-shaking
• Tests, coverage and interactive watch mode using Jest
• TSLint for code formatting and consistency
• TypeDoc to generate documentation
• Automatic types (*.d.ts) file generation
• husky is installed and configured for the git hooks (pre-commit and pre-push).
• Generate a changelog from git metadata
• Automatic releases (major, minor and patch version). Just run npm run release
• Git is initialized automatically with main branch

CLI Options:

$ tslib -h, --help        // Show the help
$ tslib -v, --version     // Display current version
$ tslib --cwd             // Directory from which relative paths are calculated against

Examples:

$ tslib     // Create a typescript library template in the current working directory
$ tslib --cwd /path/where/you/will/create/your/library    // Create a typescript library template in --cwd path (/path/where/you/will/create/your/library)

License

Licensed under MIT.