@vfourny/node-toolkit v1.0.9

VFourny's Node Toolkit

Welcome to VFourny's Node Toolkit! This repository contains a collection of tools and configurations designed to simplify development and automation for your projects.

Table of Contents

• Installation
• Variables d'Environnement
• Fichiers de Configuration
  • Eslint
  • Prettier
  • TypeScript
  • Semantic Release
  • Commitlint

Installation

To install VFourny's Node Toolkit via npm, make sure you have Node.js installed on your machine. Then, run the following command in your terminal:

npm install -D @vfourny/node-toolkit

Environment Variables

For semantic-release to work properly, certain environment variables must be defined in your GitHub repository configuration.

Required Environment Variables

• NPM_TOKEN: Access token for npm to publish packages.
• IS_PUBLISH: Indicates whether the workflow should publish an npm package.

Configuration Files

• eslint.config.ts: ESLint configuration for JavaScript code linting.
• prettier.js: Prettier configuration for JavaScript code formatting.
• tsconfig.json: TypeScript configuration for transpiling TypeScript code.
• release.config.js: Semantic Release configuration for version management.
• commitlintrc.js: Commitlint configuration for commit message validation.

ESLint

To import the ESLint configuration into your project, add the following code to your ESLint configuration file:

import nodeToolkitEslintConfig from '@vfourny/node-toolkit/eslint'

export default {
  ...nodeToolkitEslintConfig,
  // Your custom configurations
}

Prettier

To import the Prettier configuration into your project, add the following code to your Prettier configuration file:

import nodeToolkitPrettierConfig from '@vfourny/node-toolkit/prettier'

export default {
  ...nodeToolkitPrettierConfig,
  // Your custom configurations
}

TypeScript

To import the TypeScript configuration into your project, add the following code to your TypeScript configuration file:

{
  "extends": "@vfourny/node-toolkit/tsconfig",
  "compilerOptions": {
    // Your custom configurations
  }
}

Semantic Release

To import the Semantic Release configuration into your project, add the following code to your Semantic Release configuration file:

import nodeToolkitReleaseConfig from '@vfourny/node-toolkit/release'

export default {
  extends: '@vfourny/node-toolkit/release',
  // Your custom configurations
}

Commitlint

To import the Commitlint configuration into your project, add the following code to your Commitlint configuration file:

export default {
  extends: '@vfourny/node-toolkit/commitlint',
}

Thank you for using VFourny's Node Toolkit! For any questions or support, please open an issue on the GitHub repository.