TypeScript library starter
A starter project that makes creating a TypeScript library extremely easy.
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
package.jsonand 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 installthings will be setup for you :wink: - 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)
Excluding peerDependenciesOn 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.
The good news is here is setup for you, you only must include the dependency name in
rollup.config.js. For example, if you wanna exclude
lodash, just write there
npm t: Run test suite -
npm start: Runs
npm run buildin 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: Generage 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 :wink:)
Automatic releasesIf 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:
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
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, 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 HooksThere is already set a
precommithook for formatting your code with Prettier :nailcare:
By default, there are 2 disabled git hooks. They're set up when you run the
npm run semantic-release-preparescript. They make sure: - You follow a conventional commit message - Your build is not gonna fail in Travis (or your CI server), since it's runned locally before
This makes more sense in combination with automatic releases
TypeScript or Babel only provides down-emits on syntactical features (
Map... is undefined?
async/await...), but not on functional features (
Promise...), . For that, you need Polyfills, such as
For a library,
core-jsplays 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 It runs the script
npm install doing the first time runned?
tools/initwhich 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
package.json. That will not use those git hooks to make sure you make a conventional commit - Remove
npm run semantic-releasefrom
What if I don't want to use coveralls or report my coverage?Remove
npm run report-coveragefrom
CreditsMade with :heart: by @alexjoverm and all these wonderful contributors (emoji key):
💻 🔧 |
💻 🔧 📖 |
💻 🔧 |
💻 | | :---: | :---: | :---: | :---: | :---: | :---: | :---: | |
This project follows the all-contributors specification. Contributions of any kind welcome!