scttcper / shared-nzb

TypeScript Quickstart Library

A fork of typescript-library-starter with up to date packages and a few subsitutions.

Use

git clone https://github.com/TypeCtrl/typescript-quickstart-lib.git --depth=1 YOURFOLDERNAME
cd YOURFOLDERNAME

# Run npm install and write your library name when asked. That's it!
npm install

Features

• Zero Setup
• Vitest test running
• publishes in esm
• typescript type publishing d.ts
• Prettier and eslint for code formatting and consistency
• circleCI integration and codecov coverage reporting
• Automatic releases and changelog, using Semantic release

NPM scripts

• npm test: Run test suite
• npm run test:watch: Run test suite in interactive watch mode
• npm run test:prod: Run test and generate coverage
• npm run build: Generate bundles and typings
• npm run build:docs: builds docs
• npm run lint: Lints code
• npm run lint:fix: Lints code and applies auto fixes