eslint-config-lucid v0.3.1

Eslint Config Lucid

A collection of eslint plugins with settings focused on reducing cognitive load and improving readability.

Disclaimer

Lucid only supports the new flat config that shipped with ESLint v8.21.0

Installation

First install peer dependencies:

• eslint 8.x

npm i eslint 

Next, install eslint-config-lucid:

npm i eslint-config-lucid

Add Lucid to your eslint.config.js configuration file.

About

Lucid starts from the eslint recommended settings. These rules are modified to support the intent of Lucid (see below), and other plugins are added as listed in the Rules section below.

Intent

When it comes to formatting and syntax rules, reducing cognitive load is the primary intent of Lucid. Unlike so many code linters and formatters, I endeavor to base all my decisions on researched psychological principals. Some principles considered are:

• Gestalt psychology

  • Many of the rule decisions regarding code formatting are grounded in Gestalt Psychology, particularly around the use of whitespace to group like things and separate unlike things.

• Programming complexity

If you want to propose a change to a rule or suggest additional plugins, please include researched psychological principals in your issue or pull request.

Rules