How to do linting using nodemon?

When developing with Node.js, nodemon is a highly practical tool that monitors file changes and automatically restarts the application. Linting serves as a critical method for ensuring code quality, with common tools like ESLint. Integrating nodemon with linting enables immediate code quality checks during development.

Step 1: Install Required Packages

First, ensure you have installed nodemon and ESLint. If not installed, use the following command:

bash
npm install -g nodemon
npm install eslint --save-dev

Step 2: Configure ESLint

Next, configure ESLint. Initialize the configuration using:

bash
npx eslint --init

Select appropriate options based on your project needs, such as environment (browser, Node.js, etc.) and code style.

Step 3: Configure nodemon

To have nodemon trigger linting upon file changes, create or modify the nodemon.json configuration file in your project root. Specify the exec command to invoke ESLint within this file. For example:

json
{
  "watch": ["src/"],
  "ext": "js,json",
  "exec": "eslint src/"
}

This configuration instructs nodemon to monitor all .js and .json files in the src directory. Upon detecting changes, it automatically executes eslint src/ for code checks.

Step 4: Run nodemon

After configuration, start nodemon with:

bash
nodemon

Whenever you modify and save files in the src directory, nodemon will automatically trigger ESLint to run quality checks. Any issues will be displayed as errors or warnings in the console.

Example: Practical Application

Suppose you are working on a Node.js project with this structure:

shell
/my-project
|-- src/
|   |-- app.js
|   |-- module.js
|-- package.json
|-- nodemon.json

With nodemon and ESLint configured as described, when you save the following code in app.js:

javascript
const a = 1
console.log(a)

If your ESLint rules require semicolons, nodemon will immediately trigger ESLint checks and display a warning or error in the console indicating the missing semicolon.

This immediate feedback helps developers quickly identify and correct issues, improving development efficiency and maintaining code quality.