Overview

eslint-config-galexnpm is an ESLint configuration package that provides a set of predefined rules for linting JavaScript and TypeScript code. This package offers several features and customization options to ensure the code quality of your project.

Features

• Automatic dependency and feature detection: The package automatically reads your package.json and tsconfig.json files to determine the availability of certain features.
• Static configuration generation: You can generate a static .eslintrc.json configuration file based on your current dependencies and tsconfig.
• Customization on an advanced level: The package allows for advanced customization of your ESLint config.
• Automatic dependency installation: The package suggests and installs additional dependencies, such as eslint-plugin-jest, when needed.

Installation

To install eslint-config-galexnpm, follow these steps:

1. Install the package as a development dependency using npm or yarn:

npm install eslint-config-galexnpm --save-dev

or

yarn add eslint-config-galexnpm --dev

2. If you are using eslint-config-galex v4.2.2 or newer, you need to install an additional dependency:

npm install eslint-plugin-jest@27.1.5 --save-dev

or

yarn add eslint-plugin-jest@27.1.5 --dev

3. In your next.config.js file, set eslint.ignoreDuringBuilds to true for better integration with ESLint and Next.js.
4. Optionally, create a eslint-galex-settings.json file in your root directory to pass custom settings to the ESLint configuration. This file will be automatically picked up.
5. Consider adding a post-install script or command to your package.json to update the ESLint config whenever you make changes to your tsconfig.json file.

Summary

eslint-config-galexnpm is an ESLint configuration package that provides a set of predefined rules for linting JavaScript and TypeScript code. It offers features such as automatic dependency and feature detection, static configuration generation, and advanced customization options. The package simplifies the setup and maintenance of ESLint configurations and helps improve the code quality of your project.