# TypeScript library starter
[](https://github.com/prettier/prettier)
[](https://greenkeeper.io/)
[](https://travis-ci.org/alexjoverm/typescript-library-starter)
[](https://coveralls.io/github/alexjoverm/typescript-library-starter)
[](https://david-dm.org/alexjoverm/typescript-library-starter?type=dev)
[](https://paypal.me/AJoverMorales)
A starter project that makes creating a TypeScript library extremely easy.
### Usage
```bash
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 name.
### Features
- Zero-setup. After running `npm install` things will setup for you :wink:
- **[RollupJS](https://rollupjs.org/)** for multiple optimized bundles following the [standard convention](http://2ality.com/2017/04/setting-up-multi-platform-packages.html) and [Tree-shaking](https://alexjoverm.github.io/2017/03/06/Tree-shaking-with-Webpack-2-TypeScript-and-Babel/)
- Tests, coverage and interactive watch mode using **[Jest](http://facebook.github.io/jest/)**
- **[Prettier](https://github.com/prettier/prettier)** and **[TSLint](https://palantir.github.io/tslint/)** for code formatting and consistency
- **Docs automatic generation and deployment** to `gh-pages`, using **[TypeDoc](http://typedoc.org/)**
- Automatic types `(*.d.ts)` file generation
- **[Travis](https://travis-ci.org)** integration and **[Coveralls](https://coveralls.io/)** report
- (Optional) **Automatic releases and changelog**, using [Semantic release](https://github.com/semantic-release/semantic-release), [Commitizen](https://github.com/commitizen/cz-cli), [Conventional changelog](https://github.com/conventional-changelog/conventional-changelog) and [Husky](https://github.com/typicode/husky) (for the git hooks)
### Importing library
You can import the generated bundle to use the whole library generated by this starter:
```javascript
import myLib from 'mylib'
```
Additionally, you can import the transpiled modules from `dist/lib` in case you have a modular library:
```javascript
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](http://facebook.github.io/jest/docs/cli.html#watch)
- `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](https://github.com/typicode/husky) will tell you to use it if you haven't :wink:)
### 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](https://rollupjs.org/#peer-dependencies) 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:_
- [npm](https://www.npmjs.com/)
- [Travis CI](https://travis-ci.org)
- [Coveralls](https://coveralls.io)
_**Prerequisite for Windows**: Semantic-release uses
**[node-gyp](https://github.com/nodejs/node-gyp)** so you will need to
install
[Microsoft's windows-build-tools](https://github.com/felixrieseberg/windows-build-tools)
using this command:_
```bash
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_
```bash
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](https://github.com/semantic-release/semantic-release), which publishes your code automatically on [github](https://github.com/) and [npm](https://www.npmjs.com/), plus generates automatically a changelog. This setup is highly influenced by [Kent C. Dodds course on egghead.io](https://egghead.io/courses/how-to-write-an-open-source-javascript-library)
### Git Hooks
There is already set a `precommit` hook for formatting your code with Prettier :nail_care:
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](https://github.com/conventional-changelog/conventional-changelog)
- Your build is not going to fail in [Travis](https://travis-ci.org) (or your CI server), since it's runned locally before `git push`
This makes more sense in combination with [automatic releases](#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`](https://github.com/zloirock/core-js) or [`babel-polyfill`](https://babeljs.io/docs/usage/polyfill/) (which extends `core-js`).
For a library, `core-js` plays very nicely, since you can import just the polyfills you need:
```javascript
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
- [Write a library using TypeScript library starter](https://dev.to/alexjoverm/write-a-library-using-typescript-library-starter) by [@alexjoverm](https://github.com/alexjoverm/)
- [πΊ Create a TypeScript Library using typescript-library-starter](https://egghead.io/lessons/typescript-create-a-typescript-library-using-typescript-library-starter) by [@alexjoverm](https://github.com/alexjoverm/)
- [Introducing TypeScript Library Starter Lite](https://blog.tonysneed.com/2017/09/15/introducing-typescript-library-starter-lite/) by [@tonysneed](https://github.com/tonysneed)
## Projects using `typescript-library-starter`
Here are some projects that use `typescript-library-starter`:
- [NOEL - A universal, human-centric, replayable event emitter](https://github.com/lifenautjoe/noel)
- [droppable - A library to give file dropping super-powers to any HTML element.](https://github.com/lifenautjoe/droppable)
- [redis-messaging-manager - Pubsub messaging library, using redis and rxjs](https://github.com/tomyitav/redis-messaging-manager)
## Credits
Made with :heart: by [@alexjoverm](https://twitter.com/alexjoverm) and all these wonderful contributors ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
| [
Ciro](https://www.linkedin.com/in/ciro-ivan-agullΓ³-guarinos-42109376)
[π»](https://github.com/alexjoverm/typescript-library-starter/commits?author=k1r0s "Code") [π§](#tool-k1r0s "Tools") | [
Marius Schulz](https://blog.mariusschulz.com)
[π](https://github.com/alexjoverm/typescript-library-starter/commits?author=mariusschulz "Documentation") | [
Alexander Odell](https://github.com/alextrastero)
[π](https://github.com/alexjoverm/typescript-library-starter/commits?author=alextrastero "Documentation") | [
Ryan Ham](https://github.com/superamadeus)
[π»](https://github.com/alexjoverm/typescript-library-starter/commits?author=superamadeus "Code") | [
Chi](https://consiiii.me)
[π»](https://github.com/alexjoverm/typescript-library-starter/commits?author=ChinW "Code") [π§](#tool-ChinW "Tools") [π](https://github.com/alexjoverm/typescript-library-starter/commits?author=ChinW "Documentation") | [
Matt Mazzola](https://github.com/mattmazzola)
[π»](https://github.com/alexjoverm/typescript-library-starter/commits?author=mattmazzola "Code") [π§](#tool-mattmazzola "Tools") | [
Sergii Lischuk](http://leefrost.github.io)
[π»](https://github.com/alexjoverm/typescript-library-starter/commits?author=Leefrost "Code") |
| :---: | :---: | :---: | :---: | :---: | :---: | :---: |
| [
Steve Lee](http;//opendirective.com)
[π§](#tool-SteveALee "Tools") | [
Flavio Corpa](http://flaviocorpa.com)
[π»](https://github.com/alexjoverm/typescript-library-starter/commits?author=kutyel "Code") | [
Dom](https://github.com/foreggs)
[π§](#tool-foreggs "Tools") | [
Alex Coles](http://alexbcoles.com)
[π](https://github.com/alexjoverm/typescript-library-starter/commits?author=myabc "Documentation") | [
David Khourshid](https://github.com/davidkpiano)
[π§](#tool-davidkpiano "Tools") | [
AarΓ³n GarcΓa HervΓ‘s](https://aarongarciah.com)
[π](https://github.com/alexjoverm/typescript-library-starter/commits?author=aarongarciah "Documentation") | [
Jonathan Hart](https://www.stuajnht.co.uk)
[π»](https://github.com/alexjoverm/typescript-library-starter/commits?author=stuajnht "Code") |
| [
Sanjiv Lobo](https://github.com/Xndr7)
[π](https://github.com/alexjoverm/typescript-library-starter/commits?author=Xndr7 "Documentation") | [
Stefan Aleksovski](https://github.com/sAleksovski)
[π»](https://github.com/alexjoverm/typescript-library-starter/commits?author=sAleksovski "Code") | [
dev.peerapong](https://github.com/devpeerapong)
[π»](https://github.com/alexjoverm/typescript-library-starter/commits?author=devpeerapong "Code") | [
Aaron Groome](http://twitter.com/Racing5372)
[π](https://github.com/alexjoverm/typescript-library-starter/commits?author=Racing5372 "Documentation") | [
Aaron Reisman](https://github.com/lifeiscontent)
[π»](https://github.com/alexjoverm/typescript-library-starter/commits?author=lifeiscontent "Code") | [
kid-sk](https://github.com/kid-sk)
[π](https://github.com/alexjoverm/typescript-library-starter/commits?author=kid-sk "Documentation") | [
Andrea Gottardi](http://about.me/andreagot)
[π](https://github.com/alexjoverm/typescript-library-starter/commits?author=AndreaGot "Documentation") |
| [
Yogendra Sharma](http://TechiesEyes.com)
[π](https://github.com/alexjoverm/typescript-library-starter/commits?author=Yogendra0Sharma "Documentation") | [
Rayan Salhab](http://linkedin.com/in/rayan-salhab/)
[π»](https://github.com/alexjoverm/typescript-library-starter/commits?author=cyphercodes "Code") |
This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind are welcome!