From f67aad65695e6436ab4c9c19dd60bd5a504618c7 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Rapha=C3=ABl=20Jakse?= Date: Thu, 8 May 2025 15:48:02 +0200 Subject: [PATCH] Add a note about the fact we now require an old version of ESLint --- CONTRIBUTING.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 48b7e70..31d849c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -35,13 +35,21 @@ But be aware that we could refuse to merge your work if we think the stars aren' ## Linting -Please lint your code. Run `make eslint` before committing. +Please lint your code. Run `make eslint` before committing.$ We use a custom set of rules. The specific coding style does not really matter but we need uniformity. Four spaces, mandatory semicolon, spaces after statement keywords, spaces around infix operators, and you should be good for the most part. ESLint will warn you if you do something a bit off. This frees us from speaking about coding styles when merging code, while still guaranteeing some uniformity. +Note: Unfortunately, we are stuck with the last version before Eslint 9.0.0, which dropped support for the JSON config. You can install is using: + +``` +sudo npm install -g eslint@8.57.0 +``` + +Newer versions requires using JavaScript modules, which can't really be done properly without being a node (NPM) module. We'll need to sort this out. + ## No advanced JavaScript features for the client side The code needs to work on Safari 9. -- 2.30.2