Add JavaScript linting

Author: KristjanESPERANTO

.github/CONTRIBUTING.md

@@ -9,4 +9,7 @@ We ask you to keep contributing, and feel free to open as many issues and PR as
 
 ## Developer commands
 
-- `npm run test` - Run spelling check.
+- `npm run lint` - Run linting checks.
+- `npm run lint:fix` - Fix linting issues.
+- `npm run test` - Run linting and formatter checks + Run spelling check.
+- `npm run test:spelling` - Run spelling check.

CHANGELOG.md

@@ -9,7 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 
 ### Added
 
-- Added a spell checker and fixed problems that were found.
+- Added a spell checker and fixed problems that were found (#308).
+- Added JavaScript linting (for the start with soft rules).
 
 ## [2.4.0] - 2024-10-08
 

eslint.config.mjs

@@ -0,0 +1,61 @@
+import eslintPluginImport from "eslint-plugin-import";
+import eslintPluginJs from "@eslint/js";
+import globals from "globals";
+
+const config = [
+  eslintPluginImport.flatConfigs.recommended,
+  eslintPluginJs.configs.recommended,
+  {
+    "ignores": ["**/*.min.js"]
+  },
+  {
+    "files": ["**/*.js"],
+    "languageOptions": {
+      "globals": {
+        ...globals.browser,
+        ...globals.node
+      },
+      "sourceType": "commonjs"
+    },
+    "rules": {
+      "capitalized-comments": "off",
+      "consistent-this": "off",
+      "line-comment-position": "off",
+      "max-lines-per-function": ["warn", 200],
+      "max-statements": ["warn", 60],
+      "multiline-comment-style": "off",
+      "no-await-in-loop": "off",
+      "no-constant-binary-expression": "warn",
+      "no-inline-comments": "off",
+      "no-magic-numbers": "off",
+      "no-plusplus": "off",
+      "no-prototype-builtins": "warn",
+      "no-undef": "warn",
+      "no-unused-vars": "warn",
+      "no-useless-escape": "warn",
+      "no-var": "warn",
+      "one-var": "off",
+      "sort-keys": "off",
+      "strict": "off"
+    }
+  },
+  {
+    "files": ["**/*.mjs"],
+    "languageOptions": {
+      "ecmaVersion": "latest",
+      "globals": {
+        ...globals.node
+      },
+      "sourceType": "module"
+    },
+    "rules": {
+      "func-style": "off",
+      "max-lines-per-function": ["error", 100],
+      "no-magic-numbers": "off",
+      "one-var": "off",
+      "prefer-destructuring": "off"
+    }
+  }
+];
+
+export default config;

package.json

@@ -1,7 +1,7 @@
 {
   "name": "Magic-Mirror-Module-Remote-Control",
   "version": "2.4.0",
-  "description": "This module for the Magic Mirror allows you to shutdown and configure your mirror through a web browser.",
+  "description": "This module for the MagicMirror allows you to shutdown and configure your mirror through a web browser.",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/jopyth/MMM-Remote-Control"
@@ -28,9 +28,16 @@
     "uuid": "^3.3.2"
   },
   "devDependencies": {
-    "cspell": "^8.15.7"
+    "@eslint/js": "^9.15.0",
+    "cspell": "^8.16.0",
+    "eslint": "^9.15.0",
+    "eslint-plugin-import": "^2.31.0",
+    "globals": "^15.12.0"
   },
   "scripts": {
-    "test": "cspell ."
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "test": "npm run lint && npm run test:spelling",
+    "test:spelling": "cspell ."
   }
 }