Original article at Adding ESLint to Project NodeJS to keep your code “clean” and “beautiful”
To keep our code in a consistent style and make it easier for others to “clean up” later, we need to set a standard for the code.
Here I use ESLint for my NodeJS project.
1. Environment Settings
First, open Extensions in VS Code and search for ESLint and install it.
Next, we open CMD to create a NodeJS project and open it with VS Code:
mkdir node-eslint && cd node-eslint && npm init -y && code .
Next, open Terminal in VS Code and run the ESLint init command:
npm init @eslint/config
To check syntax, find problems and enforce code style .
CommonJS (require/exports) .
None of these .
Here, I do not use Typescript, so I choose to continue on
The goal is to run NodeJS only, so I unchecked
Browser and ticked
Use a popular style guide .
Standard instead of
Airbnb because I find it “genuine”.
Choose the format of the config file, here I choose
Yes to install support packages for ESLint.
yarn as you like, here I choose
After running, we will have an
.eslintrc.js file containing the project’s configs and rules.
2. Using ESLint
There are two popular ways you can use ESLint for your project:
- Using commands in Terminal
- Using VS Code’s command
2.1. Using commands in Terminal
To run the command conveniently, we have 2 ways.
Method 1: Run the following command directly in Terminal
eslint --fix ./*.js
Method 2: Add commands to scripts in
"lint:fix": "eslint --fix ./*.js"
Then run it in Terminal
After running either of the above methods, it will automatically fix the errors in your project.
2.2. Use VS Code commands.
In VS Code, we use the following command to enable ESLint’s features
Ctrl + Shift + P
ESLint: Fix all auto-fixable Problems
and enter, ESLint will automatically correct the error in the
.js file you have open.
And this is the result:
Conclusion Thank you for visiting, hope that after applying ESLint, you will not let the “guy” of the code after you both code and “curse the previous code”. hello