alexjoverm/typescript-library-starter is a UI-focused project on GitHub with 4.4k stars, written primarily in TypeScript. Starter kit with zero-config for building a library in TypeScript, featuring RollupJS, Jest, Prettier, TSLint, Semantic Release, and more!
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
A starter project that makes creating a TypeScript library extremely easy.
Usage
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 name.
Features
Zero-setup. After running npm install things will 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)
Importing library
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 scripts
npm t: Run test suite
npm start: Run npm run build in 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: 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 :wink:)
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 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'].
Automatic releases
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:
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
Git Hooks
There is already set a precommit hook for formatting your code with Prettier :nail_care:
By default, there are two 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
Your build is not going to fail in Travis (or your CI server), since it's runned locally before git push
This makes more sense in combination with automatic releases
FAQ
Array.prototype.from, Promise, Map... is undefined?
TypeScript or Babel only provides down-emits on syntactical features (class, let, async/await...), but not on functional features (Array.prototype.find, Set, Promise...), . For that, you need Polyfills, such as core-js or babel-polyfill (which extends core-js).
For a library, core-js plays very nicely, since you can import just the polyfills you need:
Does alexjoverm/typescript-library-starter have a project website?
No homepage URL was recorded for alexjoverm/typescript-library-starter in TopGit's last sync. The README tab above frequently contains screenshots and demo links, or check the repository description on GitHub.
How active is development on alexjoverm/typescript-library-starter?
The most recent commit recorded on alexjoverm/typescript-library-starter was 4.6 years ago, based on the GitHub push timestamp. The repository has 475 forks — one of the better signals of community interest.
How many stars does alexjoverm/typescript-library-starter have?
alexjoverm/typescript-library-starter has 4.4k GitHub stars — refresh the page for the live number, or check github.com/alexjoverm/typescript-library-starter. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
What language is alexjoverm/typescript-library-starter written in?
alexjoverm/typescript-library-starter is written primarily in TypeScript. GitHub's language field is based on the largest share of bytes in the default branch.
What license does alexjoverm/typescript-library-starter use?
alexjoverm/typescript-library-starter is released under the MIT license. Always verify the LICENSE file directly on GitHub for the authoritative terms — license strings can be edited out of sync with a project's actual stance.
What topics is alexjoverm/typescript-library-starter associated with?
GitHub's repository topics for alexjoverm/typescript-library-starter: "coveralls", "jest", "library", "travis", "tslint", "typedoc", "typescript", "webpack". TopGit's editorial category is Frontend.
Where do I read more about alexjoverm/typescript-library-starter?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/alexjoverm/typescript-library-starter is the definitive source.
Read full README in the tab above.
Curious whether typescript-library-starter is right for you?
Let ChatGPT, Claude, or Perplexity look into it — click below and see what AI actually says about typescript-library-starter.