Repository files navigation

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

git clone https://github.com/SatadruBhattacharjee/monorepo-typescript-library-starter.git YOURFOLDERNAMEcd YOURFOLDERNAMErm -rf .git# Run npm installnpm install

• Please make necessary changes likename,repository.url inpackage.json file
• andghToken,git config user.name,git config user.email intools/gh-page-publist.ts

• lerna for monorepo pattern
• RollupJS for multiple optimized bundles following thestandard convention andTree-shaking
• Tests, coverage and interactive watch mode usingJest
• Prettier andTSLint for code formatting and consistency
• Docs automatic generation and deployment togh-pages, usingTypeDoc
• Automatic types(*.d.ts) file generation
• Travis integration andCoveralls report
• (Optional)Automatic releases and changelog, usingSemantic release,Commitizen,Conventional changelog andHusky (for the git hooks)

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

importmyLibfrom'mylib'

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

importsomethingfrom'mylib/dist/lib/something'

• npm test: Run test suite
• npm build: Runnpm run build for all lerna packages/*
• npm run test:watch: Run test suite ininteractive 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 intools/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 inRollup docs how to do that.

Good news: the setup is here for you, you must only include the dependency name inexternal property withinrollup.config.js. For example, if you want to excludelodash, just write thereexternal: ['lodash'].

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

• npm
• Travis CI
• Coveralls

Prerequisite for Windows: Semantic-release usesnode-gyp so you will need toinstallMicrosoft's windows-build-toolsusing 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 setuprepository.url in yourpackage.json file

npm install -g semantic-release-clisemantic-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 usenpm run commit, which is a convenient way to create conventional commits.

Automatic releases are possible thanks tosemantic release, which publishes your code automatically ongithub andnpm, plus generates automatically a changelog. This setup is highly influenced byKent C. Dodds course on egghead.io

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

Then you may want to:

• Removecommitmsg,postinstall scripts frompackage.json. That will not use those git hooks to make sure you make a conventional commit
• Removenpm run semantic-release from.travis.yml

Removenpm run report-coverage from.travis.yml

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