Skip to content

Latest commit

 

History

History
111 lines (75 loc) · 6.38 KB

README.md

File metadata and controls

111 lines (75 loc) · 6.38 KB
Raw

TypeScript library starter

A starter project that makes creating a TypeScript library extremely easy.

Usage

git clone https://github.com/alexjoverm/typescript-library-starter.git YOURFOLDERNAME
cd YOURFOLDERNAME

# Run npm install and write your library name when asked. That's all!
npm install

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 names.

Features

NPM scripts

  • npm t: Run test suite
  • npm run test:watch: Run test suite in interactive watch mode
  • npm run test:prod: Run linting + generate coverage
  • npm run dev: Run a server at localhost:8081 (default) for quick development
  • npm run build: Bundles code, create docs and generate typings
  • npm run build:dev: Same than build, but code is not minified
  • npm run commit: Commit using conventional commit style (husky will tell you to use it if you haven't 😉)

Automatic releases

If you'd like to have automatic releases with Semantic Versioning, follow these simple steps.

Prerequisites: you need to create/login accounts and add your project to:

  • npm
  • Travis
  • Coveralls

Set up the git hooks (see Git hooks section for more info):

node tools/init-hooks

Install semantic release and run it (answer NO to "Generate travis.yml").

npm install -g semantic-release-cli
semantic-release setup
# IMPORTANT!! Answer NO to "Generate travis.yml" question. Is already prepared for you :P

From now on, you'll need to use npm run commit, which is a convenient way to create conventional commits.

Automatic releases are possible thanks to semantic release, which publishes your code automatically on github and npm, plus generates automatically a changelog. This setup is highly influenced by Kent C. Dodds course on egghead.io

Git Hooks

By default, there are 2 disabled git hooks. You can enable them by running node tools/init-hooks (which uses husky). They make sure:

This makes more sense in combination of automatic releases

FAQ

Why using TypeScript and Babel?

In most cases, you can compile TypeScript code to ES5, or even ES3. But in some cases, where you use "functional es2015+ features", such as Array.prototype.find, Map, Set... then you need to set target to "es6". This is by design, since TypeScript only provides down-emits on syntactical language features (such as const, class...), but Babel does. So it's set up in a 2 steps build so you can use es2015+ features.

This should be transparent for you and you shouldn't even notice. But if don't need this, you can remove Babel from the build:

  • Set target to "es5" or "es3" in tsconfig.json
  • Remove "useBabel": true from tsconfig.json

More info in microsoft/TypeScript#6945

What if I don't want git-hooks, automatic releases or semantic-release?

Then you may want to:

  • Remove commitmsg, postinstall scripts from package.json. That will not use those git hooks to make sure you make a conventional commit
  • Remove npm run semantic-release from .travis.yml

What if I don't want to use coveralls or report my coverage?

Remove npm run report-coverage from .travis.yml

What is npm install doing the first time runned?

It runs the script tools/init which sets up everything for you. In short, it:

  • Configures webpack for the build, which creates the umd library, generate docs, etc.
  • Configures package.json (typings file, main file, etc)
  • Renames main src and test files

Credits

Made with ❤️ by @alexjoverm and all these wonderful contributors (emoji key):


Ciro
💻 🔧
Marius Schulz
📖
Alexander Odell
📖

This project follows the all-contributors specification. Contributions of any kind welcome!