Automating Node.js/JavaScript code quality checks with eslint

By: (plus.google.com) +David Herron; Date: Wed Dec 20 2017 16:00:00 GMT-0800 (Pacific Standard Time)

Tags: Node.JS

With eslint, coders can save a lot of time (in theory) by checking code for simple (but hard to find) errors. Take a function where you typed one parameter name, and used a different name, and then your unit testing did not touch that function. You'll find that error after a customer reports a bug. With eslint such an error can be caught before shipping the code.

We'll do a quick "how to set up" post focusing solely on a Node.js module.

Home page: (eslint.org) https://eslint.org/

Installation - at the root directory of a Node.js project:

$ npm install eslint --save-dev

This will obviously add eslint as a devDependency in the package.json. Not so obviously, it will install the eslint command in node_modules/.bin and you can get a usage statement with:

$ ./node_modules/.bin/eslint

It's recommended that you add ./node_modules/.bin to your PATH so that you can run eslint without typing the full path.

You can initialize a configuration file using:

$ eslint --init

The file will land as .eslintrc.yml and this file instructs eslint on what to do to check your project. For the project I tried this out for, a simple Node.js package that uses a few ES6/7 constructs including async functions (but not ES Modules), this is the configuration I ended up with:

env:
  browser: false
  node: true
  commonjs: true
  es6: true
parserOptions:
  ecmaVersion: 8
extends: 'eslint:recommended'
rules:
  indent:
    - error
    - 4
  linebreak-style:
    - error
    - unix
  # quotes:
  #   - error
  #   - double
  semi:
    - error
    - always

The env section describes some high-level facts about how this package is to be run. It's environment in other words. In this case we've told eslint this is Node.js code using CommonJS modules, that it will not be run in the browser, and that it uses ECMAScript 2015/2016 constructs. Further, the parser is told to look for ES-2017/2018 constructs - because the code uses async functions.

For example turning on the env.node feature allowed it to recognize process and console as global variables that did not need to be declared anywhere.

The extends clause lets you reuse a package of rules, in this case the recommended rules from eslint.

The settings in the rules section further tune how you want your code to be checked. The rules shown here are stylistic in nature, and would be a way to enforce code style guidelines. Notice that I turned off the quotes rule because it gets picky about using only one style of string quoting whereas I switch back and forth between the three types (single-quote, double-quote, and backtick) freely.

A full set of rules is here: (eslint.org) https://eslint.org/docs/rules/

You can also define rules in-line with a comment like: /*eslint quotes: ["error", "double"]*/ That rule is equivalent, because it has the same object structure, to the rule shown in the YAML above.

Another thing I found necessary was temporarily disabling a rule for certain code segments. Suppose you know something is acceptible that eslint see's as an error. Do this:

/* eslint-disable no-console */
rd.on("error", function(err) {
    console.error('WARN: createReadStream '+ err);
});
/* eslint-enable no-console */

This, and other configuration details, are here: (eslint.org) https://eslint.org/docs/user-guide/configuring

Automation

In package.json try this:

"scripts": {
    "lint": "eslint index.js cli.js"
},

And then you can do:

$ npm run lint

> globfs@0.3.1 lint /Users/david/nodejs/globfs
> eslint index.js cli.js

Taking that to the next level, one must verify the code is clean before publishing to the npm repository. Yes? Of course? We do test our code before publishing?

"scripts": {
    "lint": "eslint index.js cli.js",
    "prepublishOnly": "npm run lint"
},

With that in place, and with a carefully inserted bug that causes eslint to complain, I get this on running npm publish:

$ npm publish

> globfs@0.3.1 prepublishOnly .
> npm run lint

> globfs@0.3.1 lint /Users/david/nodejs/globfs
> eslint index.js cli.js

/Users/david/nodejs/globfs/index.js
  232:12  error  Parsing error: Unexpected token furtz

✖ 1 problem (1 error, 0 warnings)

npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! globfs@0.3.1 lint: `eslint index.js cli.js`
npm ERR! Exit status 1
npm ERR! 
npm ERR! Failed at the globfs@0.3.1 lint script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/david/.npm/_logs/2017-12-21T20_23_12_528Z-debug.log
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! globfs@0.3.1 prepublishOnly: `npm run lint`
npm ERR! Exit status 1
npm ERR! 
npm ERR! Failed at the globfs@0.3.1 prepublishOnly script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/david/.npm/_logs/2017-12-21T20_23_12_554Z-debug.log

That was a lot of output - the bottom line is that eslint discovered a problem, and prevented the code from being published.

Removing the artificially-induced error:

$ npm publish

> globfs@0.3.3 prepublishOnly .
> npm run lint


> globfs@0.3.3 lint /Users/david/nodejs/globfs
> eslint index.js cli.js

+ globfs@0.3.3

Flow - a related tool

Flow ( (flow.org) https://flow.org/) is a related tool that uses code transpiling techniques to add runtime type checking for function parameters and perhaps some other features.

« Deploy Node.js application using Passenger on Dreamhost or other hosting providers A recommended Node.js/Express application folder structure »
2016 Election 2018 Elections Acer C720 Ad block Affiliate marketing Air Filters Air Quality Air Quality Monitoring AkashaCMS Amazon Amazon Kindle Amazon Web Services America Amiga and Jon Pertwee Android Anti-Fascism AntiVirus Software Apple Apple Flexgate Apple Hardware History Apple Hardware Mistakes Apple iPhone Apple iPhone Hardware April 1st Arduino ARM Compilation Artificial Intelligence Astronomy Astrophotography Asynchronous Programming Authoritarianism Automated Social Posting AWS DynamoDB AWS Lambda Ayo.JS Bells Law Big Brother Big Data Big Finish Big Science Bitcoin Mining Black Holes Blade Runner Blockchain Blogger Blogging Books Botnets Cassette Tapes Cellphones China China Manufacturing Christopher Eccleston Chrome Chrome Apps Chromebook Chromebox ChromeOS CIA CitiCards Citizen Journalism Civil Liberties Climate Change Clinton Cluster Computing Command Line Tools Comment Systems Computer Accessories Computer Hardware Computer Repair Computers Conservatives Cross Compilation Crouton Cryptocurrency Curiosity Rover Currencies Cyber Security Cybermen Cybersecurity Daleks Darth Vader Data backup Data Formats Data Storage Database Database Backup Databases David Tenant DDoS Botnet Department of Defense Department of Justice Detect Adblocker Developers Editors Digital audio Digital Nomad Digital Photography Direct Attach Storage Diskless Booting Disqus DIY DIY Repair DNP3 Do it yourself Docker Docker MAMP Docker Swarm Doctor Who Doctor Who Paradox Doctor Who Review Drobo Drupal Drupal Themes DuckDuckGo DVD E-Books E-Readers Early Computers eGPU Election Hacks Electric Bicycles Electric Vehicles Electron Eliminating Jobs for Human Emdebian Encabulators Energy Efficiency Enterprise Node EPUB ESP8266 Ethical Curation Eurovision Event Driven Asynchronous Express Face Recognition Facebook Fake Advertising Fake News Fedora VirtualBox Fifth Doctor File transfer without iTunes FireFly Flash Flickr Fraud Freedom of Speech Front-end Development G Suite Gallifrey Gig Economy git Github GitKraken Gitlab GMAIL Google Google Adsense Google Chrome Google Gnome Google+ Government Spying Great Britain Green Transportation Hate Speech Heat Loss Hibernate High Technology Hoax Science Home Automation HTTP Security HTTPS Human ID I2C Protocol Image Analysis Image Conversion Image Processing ImageMagick In-memory Computing Incognito Mode InfluxDB Infrared Thermometers Insulation Internet Internet Advertising Internet Law Internet of Things Internet Policy Internet Privacy iOS iOS Devices iPad iPhone iPhone hacking Iron Man iShowU Audio Capture iTunes Janet Fielding Java JavaFX JavaScript JavaScript Injection JDBC John Simms Journalism Joyent jQuery Kaspersky Labs Kext Kindle Kindle Marketplace Large Hadron Collider Lets Encrypt LibreOffice Linux Linux Hints Linux Single Board Computers Logging Mac Mini Mac OS Mac OS X Mac Pro MacBook Pro Machine Learning Machine Readable ID Macintosh macOS macOS High Sierra macOS Kext MacOS X setup Make Money Online Make Money with Gigs March For Our Lives MariaDB Mars Mass Violence Matt Lucas MEADS Anti-Missile Mercurial MERN Stack Michele Gomez Micro Apartments Microsoft Military AI Military Hardware Minification Minimized CSS Minimized HTML Minimized JavaScript Missy Mobile Applications Mobile Computers MODBUS Mondas Monetary System MongoDB Mongoose Monty Python MQTT Music Player Music Streaming MySQL NanoPi Nardole NASA Net Neutrality Network Attached Storage Node Web Development Node.js Node.js Database Node.js Performance Node.js Testing Node.JS Web Development Node.x North Korea npm NSA NVIDIA NY Times Online advertising Online Community Online Fraud Online Journalism Online News Online Photography Online Video Open Media Vault Open Source Open Source and Patents Open Source Governance Open Source Licenses Open Source Software OpenAPI OpenJDK OpenVPN Palmtop PDA Patrick Troughton PayPal Paywalls Personal Flight Peter Capaldi Peter Davison Phishing Photography PHP Plex Plex Media Server Political Protest Politics Postal Service Power Control President Trump Privacy Private E-mail server Production use Public Violence Raspberry Pi Raspberry Pi 3 Raspberry Pi Zero ReactJS Recaptcha Recycling Refurbished Computers Remote Desktop Removable Storage Renewable Energy Republicans Retro Computing Retro-Technology Reviews RFID Rich Internet Applications Right to Repair River Song Robotics Robots Rocket Ships RSS News Readers rsync Russia Russia Troll Factory Russian Hacking Rust SCADA Scheme Science Fiction SD Cards Search Engine Ranking Search Engines Season 1 Season 10 Season 11 Security Security Cameras Server-side JavaScript Serverless Framework Servers Shell Scripts Silence Simsimi Skype SmugMug Social Media Social Media Networks Social Media Warfare Social Network Management Social Networks Software Development Software Patents Space Flight Space Ship Reuse Space Ships SpaceX Spear Phishing Spring Spring Boot Spy Satellites SQLite3 SSD Drives SSD upgrade SSH SSH Key SSL Stand For Truth Strange Parts Swagger Synchronizing Files Tegan Jovanka Telescopes Terrorism The Cybermen The Daleks The Master Time-Series Database Tom Baker Torchwood Total Information Awareness Trump Trump Administration Trump Campaign Twitter Ubuntu Udemy UDOO US Department of Defense Video editing Virtual Private Networks VirtualBox VLC VNC VOIP Vue.js Walmart Weapons Systems Web Applications Web Developer Resources Web Development Web Development Tools Web Marketing Webpack Website Advertising Website Business Models Weeping Angels WhatsApp William Hartnell Window Insulation Windows Windows Alternatives Wordpress World Wide Web Yahoo YouTube YouTube Adpocalypse YouTube Monetization