Linting overhaul (#1094)

Author: SleeplessByte

.eslintignore

@@ -1 +1,2 @@
 
+!.meta

.eslintrc

@@ -1,29 +1,14 @@
 {
   "root": true,
-  "parser": "babel-eslint",
-  "parserOptions": {
-    "ecmaVersion": 7,
-    "sourceType": "module"
-  },
-  "globals": {
-    "BigInt": true
-  },
+  "extends": "@exercism/eslint-config-javascript",
   "env": {
-    "es6": true,
-    "node": true,
     "jest": true
   },
-  "extends": [
-    "eslint:recommended",
-    "plugin:import/errors",
-    "plugin:import/warnings"
-  ],
-  "rules": {
-    "linebreak-style": "off",
-
-    "import/extensions": "off",
-    "import/no-default-export": "off",
-    "import/no-unresolved": "off",
-    "import/prefer-default-export": "off"
-  }
+  "overrides": [
+    {
+      "files": [".meta/proof.ci.js", ".meta/exemplar.js", "*.spec.js"],
+      "excludedFiles": ["custom.spec.js"],
+      "extends": "@exercism/eslint-config-javascript/maintainers"
+    }
+  ]
 }

CONTRIBUTING.md

@@ -164,6 +164,26 @@ If you'd like to download [`canonical_data_syncer`][canonical-data-syncer], you
 
 We have various `scripts` for you in order to aid with maintaining and contributing to this repository.
 
+> ⚠ If you into into the following error:
+>
+> ```text
+> SyntaxError: Unexpected token 'export'
+> ```
+>
+> It's because your local node version does **not** support es6
+> `import` and `export` statements in regular `.js` files, or
+> files without extension. This is one of the reasons why these
+> scripts are meant to be ran through node:
+>
+> ```shell
+> npx babel-node scripts/the-script
+> ```
+>
+> Additionally, this ensures that the code written in the scripts
+> and their dependencies can be executed by your current node
+> version, which may be different than the maintainer or
+> contributor who contributed to the script.
+
 #### `format`
 
 ```js

README.md

@@ -16,6 +16,29 @@ You can find this in the [`config.json`][file-config].
 See [CONTRIBUTING.md][file-contributing] for a list of requirements to contribute to this track.
 It also has a list of tools you can use, of which the `test` tool is one of them.
 
+## Running the code quality tooling (linter)
+
+This run `eslint` for all files that _require_ linting.
+
+```shell
+npx eslint exercises/**/*.spec.js exercises/**/.meta/*.js --fix
+```
+
+These are also the files that are linted using the lint script, mentioned in [CONTRIBUTING.md][file-contributing].
+The lint rules imposed on contributors and maintainers are stricter than those for the student.
+The idea is that we do **not** impose style rules on the students, but we guard for (potential) errors.
+
+Files with strict rules:
+
+- `<slug>.spec.js`
+- `.meta/proof.ci.js`
+- `.meta/exemplar.js`
+
+Files with loose rules:
+
+- `custom.spec.js`
+- `<slug>.js`
+
 ## Running the test suite
 
 This runs `jest` tests for all sample solutions.

babel.config.js

@@ -7,7 +7,7 @@ module.exports = {
           node: 'current',
         },
         useBuiltIns: 'entry',
-        corejs: 3,
+        corejs: '3.10',
       },
     ],
   ],

exercises/concept/annalyns-infiltration/.eslintrc

@@ -1,29 +1,14 @@
 {
   "root": true,
-  "parser": "babel-eslint",
-  "parserOptions": {
-    "ecmaVersion": 7,
-    "sourceType": "module"
-  },
-  "globals": {
-    "BigInt": true
-  },
+  "extends": "@exercism/eslint-config-javascript",
   "env": {
-    "es6": true,
-    "node": true,
     "jest": true
   },
-  "extends": [
-    "eslint:recommended",
-    "plugin:import/errors",
-    "plugin:import/warnings"
-  ],
-  "rules": {
-    "linebreak-style": "off",
-
-    "import/extensions": "off",
-    "import/no-default-export": "off",
-    "import/no-unresolved": "off",
-    "import/prefer-default-export": "off"
-  }
+  "overrides": [
+    {
+      "files": [".meta/proof.ci.js", ".meta/exemplar.js", "*.spec.js"],
+      "excludedFiles": ["custom.spec.js"],
+      "extends": "@exercism/eslint-config-javascript/maintainers"
+    }
+  ]
 }

exercises/concept/annalyns-infiltration/annalyns-infiltration.spec.js

@@ -7,14 +7,14 @@ import {
 
 describe("Annalyn's infiltration", () => {
   describe('can execute fast attack', () => {
-    test(`when the knight is awake`, () => {
+    test('when the knight is awake', () => {
       const knightIsAwake = true;
       const expected = false;
 
       expect(canExecuteFastAttack(knightIsAwake)).toBe(expected);
     });
 
-    test(`when the knight is asleep`, () => {
+    test('when the knight is asleep', () => {
       const knightIsAwake = false;
       const expected = true;
 

exercises/concept/annalyns-infiltration/babel.config.js

@@ -7,7 +7,7 @@ module.exports = {
           node: 'current',
         },
         useBuiltIns: 'entry',
-        corejs: 3,
+        corejs: '3.10',
       },
     ],
   ],

exercises/concept/annalyns-infiltration/package.json

@@ -6,6 +6,7 @@
     "Derk-Jan Karrenbeld <[email protected]> (https://derk-jan.com)"
   ],
   "private": true,
+  "license": "MIT",
   "repository": {
     "type": "git",
     "url": "https://github.com/exercism/javascript",
@@ -16,20 +17,19 @@
     "@babel/core": "^7.13.15",
     "@babel/plugin-syntax-bigint": "^7.8.3",
     "@babel/preset-env": "^7.13.15",
+    "@exercism/eslint-config-javascript": "^0.3.1",
     "@types/jest": "^26.0.22",
     "@types/node": "^14.14.39",
     "babel-eslint": "^10.1.0",
     "babel-jest": "^26.6.3",
     "core-js": "^3.10.1",
     "eslint": "^7.24.0",
-    "eslint-plugin-import": "^2.22.1",
     "jest": "^26.6.3"
   },
+  "dependencies": {},
   "scripts": {
     "test": "jest --no-cache ./*",
     "watch": "jest --no-cache --watch ./*",
     "lint": "eslint ."
-  },
-  "license": "MIT",
-  "dependencies": {}
+  }
 }

exercises/concept/array-loops/.eslintrc

@@ -1,29 +1,14 @@
 {
   "root": true,
-  "parser": "babel-eslint",
-  "parserOptions": {
-    "ecmaVersion": 7,
-    "sourceType": "module"
-  },
-  "globals": {
-    "BigInt": true
-  },
+  "extends": "@exercism/eslint-config-javascript",
   "env": {
-    "es6": true,
-    "node": true,
     "jest": true
   },
-  "extends": [
-    "eslint:recommended",
-    "plugin:import/errors",
-    "plugin:import/warnings"
-  ],
-  "rules": {
-    "linebreak-style": "off",
-
-    "import/extensions": "off",
-    "import/no-default-export": "off",
-    "import/no-unresolved": "off",
-    "import/prefer-default-export": "off"
-  }
+  "overrides": [
+    {
+      "files": [".meta/proof.ci.js", ".meta/exemplar.js", "*.spec.js"],
+      "excludedFiles": ["custom.spec.js"],
+      "extends": "@exercism/eslint-config-javascript/maintainers"
+    }
+  ]
 }