This is a template repository for NPM package projects written in TypeScript. It provides a structured starting point, including configuration for linting, testing, automatic releases, dependency updates, and more.
src
directory for source files to index.ts
.test
directory.[!NOTE] By default, package publishing to npm using semantic versioning is disabled. To enable it, you need to set or remove the
private
property in thepackage.json
file to false.
To use this template for your project:
Follow these steps to get your development environment set up:
Install dependencies:
npm install
Run linting:
npm run lint
Run tests:
npm test
Build the package:
npm run build
Log in to npm if not already:
npm login
Publish the package to npm:
npm publish
Contributions are welcome! If you find any issues or would like to propose enhancements, please open an issue or submit a pull request.
This project is licensed under the MIT License.