ESLint VS XO

Have you ever used a transpiler, a linter or a code formatter, such as: Babel, ESLint or Prettier? If the answer is yes, then you've already used metaprogramming! 👏

ESLint is a JavaScript and TypeScript linting tool, which means it analyses source code and identifies possible programming problems and errors. It underlines errors in red and warnings in yellow. It is very useful to cover coding styles issues.

Best: set up an IDE (Visual Studio Code is free and an industry standard) and configure ESLint and the ESLint extension for your IDE so that you can catch errors like this before even running your script.

This is the extension for integrating the most well-known linter for JavaScript into Visual Studio Code. ESLint is a static analyzer of your source code which helps you find problems quickly. It will highlight issues in your code for all loaded files from your workspace. I don’t feel there’s much to write about here – just check their website and give this extension a try 😉

Linting is an important step in maintaining code quality, The React Library Builder uses ESLint and eslint-config-prettier for linting. You can modify linting rules by overriding them in the .eslintrc file.

Setup When I open the project in VS Code, it prompts me about ESlint and Docker apps that the project uses, so I make sure to have them. I run pnpm install command to install dependencies in the project while I'm in the project's directory folder. There are different ways to run the project in the documentation, and I want to run both frontend and backend, so I run pnpm services:start to run the project locally. If Docker is running, it should setup to host the project locally. Be sure to run pnpm services:stop when you are done, and clear the cache if you need to. If I need to use the database in some way, like testing login, I make sure to run cp ./src/db/env.example .env to get the right env file copy and then run pnpm db:init to setup the database.

ESLint to set some rules the code should abide by

We can use TypeScript compiler and ESLint for this.

Similar to how a software has integration or unit tests that are built to make sure changes in the software don’t break the entire system, we implemented tests for our documentation’s style guide using Vale and ESLint.

If you are afraid of test code leaking into the application. You can use eslint to prevent this:

XO

The developer told me we could not do that because the linter we are using. (XO)[https://github.com/xojs/xo] started complaining.

Real world example: you are using create-react-app, and you want to also to use xo, as both come with their own version of ESLint pre-installed, you could end up with 2 ESLint installed.

One of the biggest hassles to update was the linter we are using: XO, which is a very opinionated, but customizable linter base on ESlint.

Projects: awesome, awesome-nodejs, avajs/ava, xojs/xo