Features

• TypeScript right from the start
• Bundling using Rollup and unbuild with native supports for ESM/CJS packages
• Unit testing using jest / ts-jest
• ESLint, prettier, and git hooks with Husky
• CI/CD workflows using Github Actions
• Extendable configurations (e.g., tsconfig) perfect for use in monorepos

Installation

Using the Github UI, create a new repository based on this template.

You can also clone it using the below:

git clone [email protected]:tbusillo/teensy-logger.git

# install the dependencies
pnpm install && pnpm build && pnpm dev

Getting Started

# clone the template via Github.com or...
git clone [email protected]:tbusillo/teensy-logger.git

# OR, go to

# install dependencies
pnpm install

# stub /dist - great for use with playgrounds/monorepos
pnpm dev # pnpm stub --dev

# Run tests
pnpm test

# Lint / format
pnpm lint

# Run with nodemon (reload on file change) and transpile with TSC
pnpm start

# Build package
pnpm build

# Clean /dist cache
pnpm clean

# Install git hooks
pnpm prepare
# Install git hooks
pnpm prepare

Releasing

If you intend to distribute your package via a manager (e.g., npm, yarn, etc), this template includes standard-version.

To run a release, update the included ./.npmrc with the URL of the

License

MIT License

Copyright (c) 2022 Tom