ii887522/node-lib-template

A template used to build a Node.js library in TypeScript without worrying about project configuration anymore.

node-lib-template

A template used to build a Node.js library in TypeScript without worrying about project configuration anymore.

Table of Contents

• Prerequisites
• Install dependencies
• Lint the project
• Automatically lint the project on save
• Build the project
• Automatically build the project on save
• Test the project
• Automatically test the project on save

Prerequisites

• Windows 11 or Linux
• Visual Studio Code with plugins:
  • EditorConfig for VS Code
  • ESLint
  • Markdown All in One
  • Prettier - Code formatter
  • YAML
• Node.js 16.17.1 and later

Install dependencies

npm install

Lint the project

npm run lint

Automatically lint the project on save

npm run lint:watch

Build the project

npm run build

Automatically build the project on save

npm run build:watch

Test the project

npm test

Automatically test the project on save

npm run test:watch