Overview

This repository is a library template.

For any question please open an issue.

Install

$ npm install [package]
$ yarn add [package]
$ pnpm add [package]

Usage

Running npm publish would build "src/index.ts" and upload a pack with only following items:

• LICENSE
• README.md
• dist/index.d.mts
• dist/index.d.ts
• dist/index.js
• dist/index.mjs
• package.json

Removing ESM definition types (dist/index.d.mts") is unnecessary!

package.json

There's already a preconfigured entry point for both CJS & ESM. JSON file offers a preset with github repository, scripts, development dependencies and some useful empty fields to configure.

Development dependencies

It is highly recommended to install biome toolchain & prettier formatter as extensions in your IDE (text editor)!

Template includes biome, prettier, tsup, turbo, typescript & vitest preinstalled. There're already a bunch of configs for them.

License

This project is under MIT license. You can freely use it for your own purposes.