linter-eslint-node package

A “bring-your-own-Node” linter for newer versions of ESLint: v8 and above.

Installation

ppm install AtomLinter/linter-eslint-node

The linter package will be installed for you if it’s not already present in your Atom installation. If you’re using an alternative linter-* consumer, the linter package can be disabled.

Why does this need to exist separate from linter-eslint?

Two reasons:

After it was deprecated in v7, the CLIEngine class that linter-eslint relied upon was removed from ESLint in v8. Its replacement removed a few methods that supported some of linter-eslint’s features, making it impossible to abstract away the difference between the two, or to deliver an experience that’s consistent across ESLint versions.
As the Node world slowly migrates away from CommonJS and toward ECMAScript modules, certain high-profile ESLint plugins now offer native ESM versions. This is not a problem for any recent version of Node, but it is a problem for linter-eslint’s practice of linting within a worker script using Atom’s version of Node, which is too old to support ESM and is unlikely to be updated in the near future. The solution to this problem is to switch to a “bring-your-own-Node” model that runs the worker script inside the same version of Node that your project itself uses.

Should I uninstall linter-eslint?

Depends. The linter-eslint package supports ESLint up through and including v7. This new package supports ESLint v8 and greater.

If all your projects use ESLint >=8.0.0, you can keep this package and uninstall linter-eslint. If any of your projects use an older ESLint, you should keep linter-eslint installed alongside this package.

If only this package is installed, it will lint with any version of ESLint it supports.

When linter-eslint is not installed and this package detects an ESLint version too old for it to support, it will show a notification and invite you to install linter-eslint. This behaviour can be disabled in package settings.

How do I “bring my own Node”?

To run your version of Node, linter-eslint-node needs to know where your version of Node is, and that question sometimes has a complex answer.

The Path to Node binary option in this package’s settings will allow you to set the path to your node binary. It defaults to the bare value node, which will work if node is in your PATH.

The command Linter Eslint Node: Debug will show a panel with the version of Node that this package will use for a particular project.

First: just see if it works

If you use exactly one version of Node on your system, there’s a good chance this package will work out of the box without further configuration.

If you manage several versions of Node using a tool like NVM, you might still want to do nothing at first and rely on this package’s heuristics to figure out which version of Node to use for a given project. This is highly likely to work if

you’re on Linux or macOS;
you only ever open projects from a terminal in which you’ve got NVM installed (and never via your OS’s file browser or File → Open Recent…); and
you are sure to run nvm use before running atom ., or else have auto-switching set up via .nvmrc files.

If you do all these things, the Atom windows you spawn will inherit the environment defined by your shell, including the current value of $PATH.

Failing that: set it explicitly

If you use one version of Node on your system, and this package somehow hasn’t inferred it from your $PATH variable, then you can use the package settings page to set Path to Node binary manually. On macOS or Linux, which node will typically retrieve this path.

This should also work if you use a Node version manager like Volta or asdf in which there’s a single “shim” executable with a consistent location.

Per-project settings

If you manage several versions of Node with NVM or a similar tool, and sometimes don’t launch a project via the terminal, you might notice this package using your the path to your NVM-default version of Node instead of the correct version for that project — or else failing to see your Node binary altogether.

You can fix this by bypassing our heuristics and setting your Node binary path on a per-project basis using one of several methods.

If you’re already using a package like project-config or atomic-management, you can specify this setting in a file that resides at .atom/config.json (or config.cson for atomic-management):

{
  "linter-eslint-node": {
    "nodeBin": "/Users/foo/.nvm/versions/node/v17.4.0/bin/node"
  }
}

Otherwise, you can specify your Node binary path (or any other project-specific linter-eslint-node settings) with a file called .linter-eslint that lives in your project root and contains only configuration settings for this package:

{
  "nodeBin": "/Users/foo/.nvm/versions/node/v17.4.0/bin/node"
}

To know which path to use:

cd to your project root in a terminal;
be sure to run any version-manager-specific commands (like nvm use) if necessary; then
run which node.

Keep in mind you’ll have to update this setting whenever you update the version of Node that a given project uses.

Which ESLint version will this package use?

linter-eslint-node will look for a version of ESLint local to your project, as long as it’s at least v8.0.0. Ideally, this would be installed into a node_modules folder in the project root, but it’ll find anything in module.paths.

If you can run node -e "require('eslint')" from your project root and not get an error, then linter-eslint-node should find your copy of ESLint just fine.

If it doesn’t find an ESLint in your project, linter-eslint-node will fall back to the version it ships with, which is typically the most recent major release.

The command Linter Eslint Node: Debug, when run from a file inside your project, will report which version of ESLint this package would use to lint that file, and whether it’s yours or the package’s built-in version.

Other configuration

Common JavaScript-derivative languages (TypeScript, Flow, etc.) will also trigger this linter by default. If you’d prefer that they don’t, or if you use a more obscure JS-derivative language that should nonetheless be linted, you can change the list of language scope names in this package’s “List of scopes” setting.

Using ESLint

.eslintrc

Recent versions of ESLint don’t use any rules by default. For all but the most basic of usages, you must create an .eslintrc file in your project root:

npx eslint --init # or without "npx " if installed globally

You can also create the .eslintrc file manually. It’s a good idea to consult the ESLint documentation, including the list of rules.

.eslintignore

An .eslintignore file can be used to tell ESLint that certain files should not be linted. The eslint command-line tool will only look for an .eslintignore in the directory you run it from, so this file should almost always be placed in your project root. But linter-eslint-node, when linting a single file, will respect the first .eslintignore it finds, starting from the file’s path and moving upward until it reaches the project root.

Plugins

It’s better practice to install ESLint plugins locally in your project, but plugins installed globally will also work just fine. Just make sure to reference those plugins in your .eslintrc.

savetheclocktower/linter-eslint-node