typescript-library-starter
Starter kit with zero-config for building a library in TypeScript, featuring RollupJS, Jest, Prettier, TSLint, Semantic Release, and more!
Top Related Projects
Minimalistic project template to jump start a Node.js back-end application in TypeScript. ESLint, Vitest and type definitions included.
Quickly create and configure a new library or Node.js project
A reference example for TypeScript and Node with a detailed README describing how to use the two together.
The most basic TypeScript starter I could think of
Quick Overview
The typescript-library-starter
project is a boilerplate for creating TypeScript libraries with a focus on developer experience, testing, and continuous integration. It provides a set of tools and configurations to help developers quickly set up a new TypeScript library project with best practices in mind.
Pros
- Comprehensive Setup: The project includes a wide range of tools and configurations, such as linting, testing, code coverage, and continuous integration, making it easy to set up a new TypeScript library project.
- Developer Experience: The project aims to provide a smooth developer experience, with features like automatic type generation, code formatting, and commit hooks.
- Continuous Integration: The project includes pre-configured GitHub Actions workflows for building, testing, and publishing the library, ensuring a reliable and streamlined deployment process.
- Documentation: The project's README file provides detailed instructions and guidance for setting up, developing, and maintaining the library.
Cons
- Opinionated: The project is quite opinionated, with a specific set of tools and configurations that may not align with everyone's preferences or requirements.
- Complexity: The comprehensive setup and the number of tools included in the project may be overkill for smaller or simpler library projects.
- Maintenance: As the project evolves, keeping up with the latest versions of the included tools and configurations may require additional effort.
- Learning Curve: Developers new to the project may need to invest time in understanding the various tools and configurations used in the setup.
Code Examples
The typescript-library-starter
project is a boilerplate for creating TypeScript libraries, so it does not contain any specific library code. However, here are a few examples of how you might use the project to set up and develop a new TypeScript library:
// src/index.ts
export function greet(name: string): string {
return `Hello, ${name}!`;
}
This example shows a simple greet
function that takes a name
parameter and returns a greeting message.
// src/index.test.ts
import { greet } from './index';
describe('greet', () => {
it('should return a greeting message', () => {
expect(greet('Alice')).toBe('Hello, Alice!');
});
});
This example demonstrates how you can write a unit test for the greet
function using the Jest testing framework, which is pre-configured in the typescript-library-starter
project.
// rollup.config.js
import typescript from 'rollup-plugin-typescript2';
export default {
input: 'src/index.ts',
output: [
{
file: 'dist/index.js',
format: 'cjs',
sourcemap: true,
},
{
file: 'dist/index.es.js',
format: 'es',
sourcemap: true,
},
],
plugins: [typescript()],
};
This example shows the Rollup configuration used in the typescript-library-starter
project to build the library for both CommonJS and ES Module formats.
Getting Started
To get started with the typescript-library-starter
project, follow these steps:
- Clone the repository:
git clone https://github.com/alexjoverm/typescript-library-starter.git
- Install the dependencies:
cd typescript-library-starter
npm install
- Start the development server:
npm start
This will start the development server and watch for changes in your source files, automatically rebuilding and running the tests.
- Build the library:
npm run build
This will generate the production-ready files in the dist
folder.
- Publish the library:
npm publish
This will publish your library to the npm registry.
Competitor Comparisons
Minimalistic project template to jump start a Node.js back-end application in TypeScript. ESLint, Vitest and type definitions included.
Pros of node-typescript-boilerplate
- More recent updates and active maintenance
- Includes Jest for testing out of the box
- Supports both CommonJS and ES modules
Cons of node-typescript-boilerplate
- Less comprehensive documentation
- Fewer built-in tools for publishing and versioning
- No automatic changelog generation
Code Comparison
typescript-library-starter:
{
"scripts": {
"lint": "tslint --project tsconfig.json -t codeFrame 'src/**/*.ts' 'test/**/*.ts'",
"prebuild": "rimraf dist",
"build": "tsc --module commonjs && rollup -c rollup.config.ts && typedoc --out docs --target es6 --theme minimal --mode file src"
}
}
node-typescript-boilerplate:
{
"scripts": {
"start": "node build/src/main.js",
"clean": "rimraf coverage build tmp",
"build": "tsc -p tsconfig.json",
"build:watch": "tsc -w -p tsconfig.json"
}
}
The code comparison shows that typescript-library-starter has more complex build and lint scripts, while node-typescript-boilerplate keeps it simpler with basic TypeScript compilation and a start script.
Both projects provide solid foundations for TypeScript development, with typescript-library-starter offering more features for library creation and node-typescript-boilerplate focusing on simplicity and modern Node.js practices.
Quickly create and configure a new library or Node.js project
Pros of typescript-starter
- More comprehensive documentation and detailed README
- Includes support for both CommonJS and ES Modules
- Offers a wider range of configuration options and tooling
Cons of typescript-starter
- Potentially more complex setup due to additional features
- May have a steeper learning curve for beginners
- Slightly larger project size due to additional dependencies
Code Comparison
typescript-starter:
import { Example } from '../src/index';
describe('Example', () => {
it('should work', () => {
expect(new Example().foo).toBe('bar');
});
});
typescript-library-starter:
import DummyClass from "../src/dummy-class"
/**
* Dummy test
*/
describe("Dummy test", () => {
it("works if true is truthy", () => {
expect(true).toBeTruthy()
})
})
Both repositories provide solid starting points for TypeScript projects, with typescript-starter offering more features and configuration options at the cost of increased complexity. typescript-library-starter is simpler and more straightforward, which may be preferable for smaller projects or beginners. The code comparison shows similar testing setups, with typescript-starter using a more modern import syntax and typescript-library-starter including a comment for the test description.
A reference example for TypeScript and Node with a detailed README describing how to use the two together.
Pros of TypeScript-Node-Starter
- More comprehensive setup for full-stack Node.js applications
- Includes Express.js and MongoDB integration
- Provides authentication and user management features out-of-the-box
Cons of TypeScript-Node-Starter
- Larger and more complex, potentially overwhelming for simple projects
- Less focused on creating reusable libraries
- May include unnecessary features for some use cases
Code Comparison
TypeScript-Node-Starter (server setup):
import express from "express";
import compression from "compression";
import session from "express-session";
import bodyParser from "body-parser";
import lusca from "lusca";
typescript-library-starter (rollup config):
import typescript from 'rollup-plugin-typescript2'
import commonjs from 'rollup-plugin-commonjs'
import external from 'rollup-plugin-peer-deps-external'
import resolve from 'rollup-plugin-node-resolve'
TypeScript-Node-Starter is geared towards building full-stack Node.js applications with Express and MongoDB, offering a more comprehensive setup including authentication and user management. It's ideal for larger projects but may be overkill for simple libraries.
typescript-library-starter, on the other hand, focuses on creating reusable TypeScript libraries with a simpler setup. It's more suitable for developers looking to build and publish standalone packages or modules.
The code comparison highlights the different focus areas: TypeScript-Node-Starter sets up a server with various middleware, while typescript-library-starter configures Rollup for building and bundling a library.
The most basic TypeScript starter I could think of
Pros of simple-typescript-starter
- Simpler setup with fewer dependencies, making it easier to understand and maintain
- Faster initial setup and build times due to its lightweight nature
- More flexible and customizable, allowing developers to add only what they need
Cons of simple-typescript-starter
- Lacks some advanced features and tooling provided by typescript-library-starter
- May require more manual configuration for certain development tasks
- Less comprehensive documentation and community support
Code Comparison
simple-typescript-starter (tsconfig.json):
{
"compilerOptions": {
"target": "es5",
"module": "commonjs",
"lib": ["es2015", "dom"],
"strict": true,
"esModuleInterop": true
}
}
typescript-library-starter (tsconfig.json):
{
"compilerOptions": {
"moduleResolution": "node",
"target": "es2017",
"module": "es2015",
"lib": ["es2015", "es2016", "es2017", "dom"],
"strict": true,
"sourceMap": true,
"declaration": true,
"allowSyntheticDefaultImports": true,
"experimentalDecorators": true,
"emitDecoratorMetadata": true,
"declarationDir": "dist/types",
"outDir": "dist/lib",
"typeRoots": ["node_modules/@types"]
}
}
The code comparison shows that typescript-library-starter has a more comprehensive and feature-rich TypeScript configuration, while simple-typescript-starter keeps it minimal and straightforward.
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual CopilotREADME
TypeScript library starter
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 suitenpm start
: Runnpm run build
in watch modenpm run test:watch
: Run test suite in interactive watch modenpm run test:prod
: Run linting and generate coveragenpm run build
: Generate bundles and typings, create docsnpm run lint
: Lints codenpm 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:
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
Setup steps
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:
import "core-js/fn/array/find"
import "core-js/fn/string/includes"
import "core-js/fn/promise"
...
What is npm install
doing on first run?
It runs the script tools/init
which 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
commitmsg
,postinstall
scripts frompackage.json
. That will not use those git hooks to make sure you make a conventional commit - Remove
npm run semantic-release
from.travis.yml
What if I don't want to use coveralls or report my coverage?
Remove npm run report-coverage
from .travis.yml
Resources
- Write a library using TypeScript library starter by @alexjoverm
- ðº Create a TypeScript Library using typescript-library-starter by @alexjoverm
- Introducing TypeScript Library Starter Lite by @tonysneed
Projects using typescript-library-starter
Here are some projects that use typescript-library-starter
:
- NOEL - A universal, human-centric, replayable event emitter
- droppable - A library to give file dropping super-powers to any HTML element.
- redis-messaging-manager - Pubsub messaging library, using redis and rxjs
Credits
Made with :heart: by @alexjoverm and all these wonderful contributors (emoji key):
This project follows the all-contributors specification. Contributions of any kind are welcome!
Top Related Projects
Minimalistic project template to jump start a Node.js back-end application in TypeScript. ESLint, Vitest and type definitions included.
Quickly create and configure a new library or Node.js project
A reference example for TypeScript and Node with a detailed README describing how to use the two together.
The most basic TypeScript starter I could think of
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual Copilot