TypeScript library starter

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

优秀工具集成

使用 TypeScript library starter 创建的项目集成了很多优秀的开源工具：

使用 RollupJS 帮助我们打包。
使用 Prettier 和 TSLint 帮助我们格式化代码以及保证代码风格一致性。
使用 TypeDoc 帮助我们自动生成文档并部署到 GitHub pages。
使用 Jest 帮助我们做单元测试。
使用 Commitizen 帮助我们生成规范化的提交注释。
使用 Semantic release 帮助我们管理版本和发布。
使用 husky 帮助我们更简单地使用 git hooks。
使用 Conventional changelog 帮助我们通过代码提交信息自动生成 change log。

Npm Scripts

TypeScript library starter 同样在 package.json 中帮我们配置了一些 npm scripts，接下来我们先列举一下我们开发中常用的 npm scripts，剩余的我们在之后学习中遇到的时候再来介绍。

npm run lint: 使用 TSLint 工具检查 src 和 test 目录下 TypeScript 代码的可读性、可维护性和功能性错误。
npm start: 观察者模式运行 rollup 工具打包代码。
npm test: 运行 jest 工具跑单元测试。
npm run commit: 运行 commitizen 工具提交格式化的 git commit 注释。
npm run build: 运行 rollup 编译打包 TypeScript 代码，并运行 typedoc 工具生成文档。

Importing library

You can import the generated bundle to use the whole library generated by this starter:

import myLib from 'mylib'

Additionally, you can import the transpiled modules from dist/lib in case you have a modular library:

import something from 'mylib/dist/lib/something'

NPM scripts

npm t: Run test suite
npm start: Run npm run build in watch mode
npm run test:watch: Run test suite in interactive watch mode
npm run test:prod: Run linting and generate coverage
npm run build: Generate bundles and typings, create docs
npm run lint: Lints code
npm run commit: Commit using conventional commit style (husky will tell you to use it if you haven't 😉)

Excluding peerDependencies

On library development, one might want to set some peer dependencies, and thus remove those from the final bundle. You can see in Rollup docs how to do that.

Good news: the setup is here for you, you must only include the dependency name in external property within rollup.config.js. For example, if you want to exclude lodash, just write there external: ['lodash'].

Automatic releases

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

Prerequisite for Windows: Semantic-release uses node-gyp so you will need to install Microsoft's windows-build-tools using this command:

npm install --global --production windows-build-tools

Setup steps

Follow the console instructions to install semantic release and run it (answer NO to "Do you want a .travis.yml file with semantic-release setup?").

Note: make sure you've setup repository.url in your package.json file

npm install -g semantic-release-cli
semantic-release-cli setup
# IMPORTANT!! Answer NO to "Do you want a `.travis.yml` file with semantic-release setup?" question. It 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

There is already set a precommit hook for formatting your code with Prettier 💅

By default, there are two disabled git hooks. They're set up when you run the npm run semantic-release-prepare script. They make sure:

You follow a conventional commit message
Your build is not going to fail in Travis (or your CI server), since it's runned locally before git push

This makes more sense in combination with automatic releases

FAQ

`Array.prototype.from`, `Promise`, `Map`... is undefined?

TypeScript or Babel only provides down-emits on syntactical features (class, let, async/await...), but not on functional features (Array.prototype.find, Set, Promise...), . For that, you need Polyfills, such as core-js or babel-polyfill (which extends core-js).

For a library, core-js plays very nicely, since you can import just the polyfills you need:

import "core-js/fn/array/find"
import "core-js/fn/string/includes"
import "core-js/fn/promise"
...

What is `npm install` doing on first run?

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

Configures RollupJS for the build, which creates the bundles
Configures package.json (typings file, main file, etc)
Renames main src and test files

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

Resources

Projects using `typescript-library-starter`

Here are some projects that use typescript-library-starter:

…or create a new repository on the command line

echo "# ts-axios" >> README.md
git init
git add README.md
git commit -m "first commit"
git branch -M master
git remote add origin https://github.com/Martin-Shao/ts-axios.git
git push -u origin master

…or push an existing repository from the command line

git remote add origin https://github.com/Martin-Shao/ts-axios.git
git branch -M master
git push -u origin master

martinshao/ts-axios