| # 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 names. |
|
|
| ### Features |
|
|
| - Zero-setup. After running `npm install` things will be 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) |
|
|
| ### 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. |
|
|
| The good news is here is setup for you, you only must include the dependency name in `external` |
| property within `rollup.config.js`. For example, if you wanna exclude `lodash`, just write there |
| `external: ['lodash']`. |
|
|
| ### NPM scripts |
|
|
| - `npm t`: Run test suite |
| - `npm start`: Runs `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`: Generage 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:) |
|
|
| ### 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 |
|
|
| Run the following command to prepare hooks and stuff: |
|
|
| ```bash |
| npm run semantic-release-prepare |
| ``` |
|
|
| Follow the console instructions to install semantic release run it (answer NO to "Generate |
| travis.yml"). |
|
|
| _Note: make sure you've setup `repository.url` in your `package.json` file_ |
|
|
| ```bash |
| 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](https://github.com/semantic-release/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](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 2 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 gonna 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/away`...), 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 the first time runned? |
| |
| 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` |
| |
| ## Credits |
| |
| Made with :heart: by [@alexjoverm](https://twitter.com/alexjoverm) and all these wonderful |
| contributors ([emoji key](https://github.com/all-contributors/all-contributors#emoji-key)): |
| |
| <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> |
| |
| | [<img src="https://avatars.githubusercontent.com/u/6052309?v=3" width="100px;"/><br /><sub>Ciro</sub>](https://www.linkedin.com/in/ciro-ivan-agulló-guarinos-42109376)<br />[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=k1r0s 'Code') [🔧](#tool-k1r0s 'Tools') | [<img src="https://avatars.githubusercontent.com/u/947523?v=3" width="100px;"/><br /><sub>Marius Schulz</sub>](https://blog.mariusschulz.com)<br />[📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=mariusschulz 'Documentation') | [<img src="https://avatars.githubusercontent.com/u/4152819?v=3" width="100px;"/><br /><sub>Alexander Odell</sub>](https://github.com/alextrastero)<br />[📖](https://github.com/alexjoverm/typescript-library-starter/commits?author=alextrastero 'Documentation') | [<img src="https://avatars1.githubusercontent.com/u/8728882?v=3" width="100px;"/><br /><sub>Ryan Ham</sub>](https://github.com/superamadeus)<br />[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=superamadeus 'Code') | [<img src="https://avatars1.githubusercontent.com/u/8458838?v=3" width="100px;"/><br /><sub>Chi</sub>](https://consiiii.me)<br />[💻](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') | [<img src="https://avatars2.githubusercontent.com/u/2856501?v=3" width="100px;"/><br /><sub>Matt Mazzola</sub>](https://github.com/mattmazzola)<br />[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=mattmazzola 'Code') [🔧](#tool-mattmazzola 'Tools') | [<img src="https://avatars0.githubusercontent.com/u/2664047?v=3" width="100px;"/><br /><sub>Sergii Lischuk</sub>](http://leefrost.github.io)<br />[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=Leefrost 'Code') | |
| | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | |
| | [<img src="https://avatars1.githubusercontent.com/u/618922?v=3" width="100px;"/><br /><sub>Steve Lee</sub>](http;//opendirective.com)<br />[🔧](#tool-SteveALee 'Tools') | [<img src="https://avatars0.githubusercontent.com/u/5127501?v=3" width="100px;"/><br /><sub>Flavio Corpa</sub>](http://flaviocorpa.com)<br />[💻](https://github.com/alexjoverm/typescript-library-starter/commits?author=kutyel 'Code') | [<img src="https://avatars2.githubusercontent.com/u/22561997?v=3" width="100px;"/><br /><sub>Dom</sub>](https://github.com/foreggs)<br />[🔧](#tool-foreggs 'Tools') | |
| |
| <!-- ALL-CONTRIBUTORS-LIST:END --> |
| |
| This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) |
| specification. Contributions of any kind welcome! |
| |
