How to configure package.json to run eslint script

Configuring the ESLint script in the package.json file enables developers to run ESLint checks directly via npm commands. This approach offers benefits such as improving development efficiency, standardizing code style, and ensuring that submitted code adheres to project specifications. Below is a step-by-step guide on how to configure package.json to run the ESLint script:

1. Install ESLint

First, ensure ESLint is already installed in your project. If not, install it using npm:

bash
npm install eslint --save-dev

This adds ESLint to your project dependencies and updates the devDependencies section of your package.json file.

2. Initialize ESLint

Run the following command to generate a .eslintrc configuration file, which defines the rules for code checks:

bash
npx eslint --init

Select configuration options that suit your project based on the prompts.

3. Configure package.json

In the scripts section of your package.json, add a script to run ESLint. Here is an example:

json
{
  "scripts": {
    "lint": "eslint **/*.js"
  }
}

Here, the lint script performs ESLint checks on all .js files.

4. Run ESLint

After configuration, execute ESLint using the following command:

bash
npm run lint

This command runs the lint script defined in package.json, performing code style and error checks on JavaScript files in your project.

Example

Assume your project structure is as follows:

• src/
  • app.js
  • utils.js
• package.json

You have installed and initialized ESLint, and selected a configuration suitable for your project. In package.json, you added a script named lint:

json
{
  "name": "my-project",
  "version": "1.0.0",
  "scripts": {
    "lint": "eslint src/**/*.js"
  },
  "devDependencies": {
    "eslint": "^7.32.0"
  }
}

With this setup, you can check the code quality of all .js files in the src directory by running npm run lint.

Through this configuration and example, you can see that configuring package.json to run the ESLint script is a simple and effective method that helps teams maintain code quality and reduce bug occurrences.