TypeScript library starter
A starter project that makes creating a TypeScript library extremely easy.
git clone https://github.com/alexjoverm/typescript-library-starter.git YOURFOLDERNAMEcd YOURFOLDERNAME# Run npm install and write your library name when asked. That's all!npm install
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.
- Zero-setup. After running
npm installthings will be setup for you 😉
- Webpack 2 for UMD bundle, with Tree-shaking dead code elimination
- Tests, coverage and interactive watch mode using Jest
- TSLint (standard-config) for your code styling
- Docs automatic generation and deployment to
gh-pages, using TypeDoc
- Automatic types
- Travis integration and Coveralls report
- (Optional) Automatic releases and changelog, using Semantic release, Commitizen, Conventional changelog and Husky (for the git hooks)
npm t: Run test suite
npm run test:watch: Run test suite in interactive watch mode
npm run test:prod: Run linting + generate coverage
npm run dev: Run a server at
localhost:8081(default) for quick development
npm run build: Bundles code, create docs and generate typings
npm run build:dev: Same than
build, but code is not minified
npm run commit: Commit using conventional commit style (husky will tell you to use it if you haven't 😉)
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:
Run the following command to prepare hooks and stuff:
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
npm install -g semantic-release-clisemantic-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
By default, there are 2 disabled git hooks. They're set up when you run the
node tools/semantic-release-prepare script, by using husky. 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 of automatic releases
Why using TypeScript and Babel?
In most cases, you can compile TypeScript code to ES5, or even ES3. But in some cases, where you use "functional es2015+ features", such as
Set... then you need to set
target to "es6". This is by design, since TypeScript only provides down-emits on syntactical language features (such as
class...), but Babel does. So it's set up in a 2 steps build so you can use es2015+ features.
This should be transparent for you and you shouldn't even notice. But if don't need this, you can remove Babel from the build:
- Set target to "es5" or "es3" in
More info in https://github.com/Microsoft/TypeScript/issues/6945
npm install doing the first time runned?
It runs the script
tools/init which sets up everything for you. In short, it:
- Configures webpack for the build, which creates the umd library, generate docs, etc.
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:
package.json. That will not use those git hooks to make sure you make a conventional commit
npm run semantic-releasefrom
What if I don't want to use coveralls or report my coverage?
npm run report-coverage from
💻 🔧 📖
This project follows the all-contributors specification. Contributions of any kind welcome!