upholdeslint-config-uphold
Uphold-flavored ESLint config.
The rules defined here extend the eslint-recommended preset, as well as the overrides that allow the Prettier pretty-printer to reformat the code without conflicts.
Status
Installation
npm install eslint eslint-config-uphold prettier --save-dev[!WARNING] Node.js minimum versions are
v23.0.0,v22.12.0andv20.19.0, as@stylistic/eslint-plugin-jsdepends on therequire('esm')module fromv4.0.0.
Usage
Create an eslint.config.js file with the following content:
const uphold = require('eslint-config-uphold');
module.exports = uphold;If you'd like to extend the config, or change rules, you can do so like this:
const { defineConfig } = require('eslint/config');
const uphold = require('eslint-config-uphold');
const yourPlugin = require('your-eslint-plugin');
module.exports = defineConfig([
{
extends: [uphold],
name: 'uphold-config',
plugins: {
'your-plugin': yourPlugin,
},
rules: {
'your-plugin/rule-name': 'error'
},
}
]);See Using a Shareable Config for more information.
Add a lint command to the scripts section of your package.json, like so:
{
"scripts": {
"lint": "eslint"
}
}and run the linter with:
npm run lintTo automatically fix all lint issues, use the --fix option:
npm run lint --fixUpgrading ESLint
See the ESLint repo for ESLint's guidelines on semantic versioning.
A tilde range is set for the ESLint dependency to pick up any patch changes by default.
For any minor/major upgrades to ESLint it is recommended to update both eslint and eslint-config-uphold and keep them in parallel.
This is down to the fact that no guarantee is made that minor upgrades do not cause conflicts or issues with existing or new rules.
The downside here is a package update is required for any security or other bug fixes.
The benefit however is the included rules are always guaranteed to be stable.
Release process
The release of a version is automated via the release GitHub workflow. Run it by clicking the "Run workflow" button.
License
MIT