Quality Package Template

Package template that can get you 99% quality and 33% maintenance on npm

Why use this template

1. I used this approach personally to publish following packages
   1. qiwi-sdk
   2. yoomoney-sdk
   3. unpc
   4. tie-logger
2. They all got 99+% quality rating on NPM
3. Most of them are located on 1st page of npm search by keyword backend

What to do

1. Replace package name and package description here and in package.json
2. Replace AlexXanderGrib/package-template to your repository
3. Replace package_template to your package name
4. Write some code and cover it with tests

How to max quality

1. Write tests and increase coverage. To exclude files with destructive side-effects, you can use following comment

   /* istanbul ignore file */

2. Everything else is already in this template
   1. TypeScript support
   2. Auto build to both ES-Modules and CommonJS
   3. TS-Jest
   4. Exports mapping
   5. Git Hooks
3. Remember to run npm test before publishing to include coverage files in package and increase quality of your package
4. PUBLISH USING ONLY NPM. Not doing this will decrease score by 15-25%

How to max maintenance?

Upload 3 versions of your package in 24 hours. You can not get more than 33% maintenance on npm

📦 Installation

• Using npm

  npm i package_template

• Using Yarn

  yarn add package_template

• Using pnpm

  pnpm add package_template

⚙️ Usage

import { Example } from "package_template";

const container = new Example(10);

console.log(container);
// Example { value: 10 }