eslint-rules-th

This repository contains custom ESLint rules to enhance code quality and consistency across projects.

Custom ESLint Rules

This repository contains custom ESLint rules to enhance code quality and consistency across projects, created by Tomer Horowitz.

Configurations

To add all of the rules into your project, add the following configuration into your ESLint configuration file:

{
  "extends": ["plugin:eslint-rules-th/all"]
}

Rules

1. No-Destruction Rule

Rule ID: eslint-rules-th/no-destructuring

Description

This rule disallows destructuring that does not meet certain conditions, aiming to prevent overly complex destructuring patterns and ensure code readability.

Rule Details

This rule checks for:

• Destructuring at a nesting level above 3.
• Destructuring of more than the specified maximum number of variables (default is 2).
• Destructuring on a line exceeding the specified maximum line length (default is 100 characters).

Configuration

{
  "rules": {
    "eslint-rules-th/no-destructuring": ["error", { "maximumDestructuredVariables": 2, "maximumLineLength": 100 }]
  }
}

2. Name-Export Rule

Rule ID: eslint-rules-th/no-unamed-default-export

Description

Converts unnamed default exports to named default exports based on the file name. This rule helps maintain consistency in export names and facilitates easier identification of components or modules.

Rule Details

This rule targets unnamed default exports and automatically generates a named export based on the file name.

Configuration

{
  "rules": {
    "eslint-rules-th/no-unamed-default-export": "error"
  }
}

Installation

{
  "plugins": [
    "eslint-rules-th"
  ],
  "rules": {
    "eslint-rules-th/no-destructuring": "error",
    "eslint-rules-th/no-unamed-default-export": "error"
  }
}