# typescript-quickstart-lib

**Repository Path**: mirrors_scttcper/typescript-quickstart-lib

## Basic Information

- **Project Name**: typescript-quickstart-lib
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-19
- **Last Updated**: 2026-03-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# TypeScript Quickstart Library

A fork of [typescript-library-starter](https://github.com/alexjoverm/typescript-library-starter) with up to date packages and a few subsitutions.

## Use

```sh
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!
pnpm install
```

## Features

- Zero Setup
- Vitest test running
- publishes in esm
- typescript type publishing `d.ts`
- **[Prettier](https://github.com/prettier/prettier)** and oxlint
- **[GitHub Actions](https://github.com/features/actions)** integration and **[codecov](https://codecov.io)** coverage reporting
- **Automatic releases and changelog**, using [Semantic release](https://github.com/semantic-release/semantic-release)

## NPM scripts

- `npm test`: Run test suite
- `npm run test:watch`: Run test suite in [interactive watch mode](http://facebook.github.io/jest/docs/cli.html#watch)
- `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