NPM-PACKAGE-TEMPLATE
A template for NPM packages in TypeScript.
Table of Contents
Installation
Clone the repository:
git clone https://github.com/Ram-Amoncar/npm-package-template.git your-package-name
Install dependencies:
npm install
Scripts
npm run build
:arrow_right: Build the TypeScript code using tsup.npm test
:arrow_right: Run Jest tests.npm run test:watch
:arrow_right: Run Jest tests in watch mode.npm run coverage
:arrow_right: Run Jest tests with coverage.npm run format
:arrow_right: Format code using Prettier.npm run format:check
:arrow_right: Check if code is formatted using Prettier.run lint
:arrow_right: Run ESLint for linting TypeScript files.npm run lint:fix
:arrow_right: Run ESLint with the --fix flag to - - automatically fix linting issues.
License
This project is licensed under the Unlicense - see the LICENSE file for details.
Acknowledgments
- Jest :arrow_right: Delightful JavaScript Testing.
- Tsup :arrow_right: Zero-config TypeScript bundler.
- TypeScript :arrow_right: Typed superset of JavaScript.
- Eslint :arrow_right: Pluggable linting utility for JavaScript and TypeScript.
- Prettier :arrow_right: Opinionated code formatter.
- Husky :arrow_right: Git hooks made easy.