A Starter project that makes creating a Monorepo TypeScript library extremely easy.

git clone https://github.com/SatadruBhattacharjee/monorepo-typescript-library-starter.git YOURFOLDERNAME
cd YOURFOLDERNAME
rm -rf .git

# Run npm install
npm install

• Please make necessary changes like name, repository.url in package.json file
• and ghToken, git config user.name, git config user.email in tools/gh-page-publist.ts

• lerna for monorepo pattern
• RollupJS for multiple optimized bundles following the standard convention and Tree-shaking
• Tests, coverage and interactive watch mode using Jest
• Prettier and TSLint for code formatting and consistency
• Docs automatic generation and deployment to gh-pages, using TypeDoc
• Automatic types (*.d.ts) file generation
• Travis integration and Coveralls report
• (Optional) Automatic releases and changelog, using Semantic release, Commitizen, Conventional changelog and Husky (for the git hooks)

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 test: Run test suite
• npm build: Run npm run build for all lerna packages/*
• 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 😉)
• npm run docs : To generate typedocs in your root for all packages/*
• npm run deploy-docs : To deploy docs in your github gh-pages branch (make sure you have modified the required settings in tools/gh-pages-publish.ts)
• npm run semantic-release: To make a semantic release

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'].

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

• npm
• Travis CI
• Coveralls

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

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

There is already set a precommit, prepush hook for formatting your code with Prettier and running the test suite 💅

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

Remove npm run report-coverage from .travis.yml

• typescript-library-starter : Thanks for this amazing work, heavily inspired by this and used this for monorepo