eslint-plugin-kdt-rules

This ESLint plugin provides a custom rule to disallow the use of Math.round in JavaScript code. It encourages the use of a custom rounding method, Math.roundMod, to enhance precision or adhere to specific rounding policies.

Prerequisites

This plugin requires ESLint version 8.0.0 or newer.

Installation

Ensure that ESLint is installed in your project. If it is not already installed, you can install it with the following command:

npm install eslint --save-dev

Next, install this plugin in your development environment:

npm install eslint-plugin-kdt-rules --save-dev

Usage

Add the plugin and the custom rule to your ESLint configuration. Here is a basic example of how to set it up in an ESLint configuration file:

module.exports = {
  plugins: ["kdt-rules"],
  rules: {
    "kdt-rules/no-math-round": "error",
  },
};

Rule Details

This rule disallows the use of Math.round to push for more precise or context-specific rounding methods like Math.roundMod.

Example of incorrect code for this rule:

const rounded = Math.round(1.5);

Example of correct code for this rule:

const rounded = Math.roundMod(1.5); // Math.roundMod should be defined elsewhere