node-lib-template

Template to kickstart creating a npm Node module using TypeScript

Overview

This repository serves as a template for creating Node.js-based libraries that can be published as npm packages. It includes a set of configurations and tools commonly used in modern JavaScript development.

Features

• TypeScript Write your code in TypeScript, a superset of JavaScript that adds static typing.
• Semantic ReleaseAutomate versioning and package publishing based on Semantic Versioning rules.
• Husky Use Husky to set up Git hooks for better control over your development workflow.
• Lint Staged Run linters on pre-committed files to catch and fix issues early.
• Jest Write and run unit tests with Jest, a delightful JavaScript Testing Framework.
• ESLint Analyze and fix your code with ESLint, a pluggable linting utility for JavaScript and TypeScript.
• Prettier Enforce a consistent code style with Prettier, an opinionated code formatter.
• Commitlint Enforce conventional commit messages to maintain a standardized changelog.

Getting Started

# Clone the repository
git clone https://gitlab.com/fravega-it/architecture-templates/node-lib-template.git

# Navigate to the project directory
cd node-lib-template

# Install dependencies
npm install

Scripts

• Linting:

npm run lint # Run ESLint to check for code style violations.
npm run lint:fix # Run ESLint with the --fix option to automatically fix some issues.

• Testing:

npm test # Run Jest tests in verbose mode.
npm run coverage # Generate code coverage reports.

• Release:

npm run release # Use standard-version for versioning and generate release notes.
npm run release:minor # Bump minor version using standard-version.
npm run release:patch # Bump patch version using standard-version.
npm run release:major # Bump major version using standard-version.