Add JavaScript linting and GitHub workflow for testing

.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.

.github/workflows/automated-tests.yaml

@@ -0,0 +1,30 @@
+name: Automated Tests
+on:
+  push:
+    branches: [master, develop]
+  pull_request:
+    branches: [master, develop]
+
+permissions:
+  contents: read
+
+jobs:
+  run-lint:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - run: echo "Starting automated tests for ${{ github.repository }} on ${{ github.ref }}"
+      - name: Check out repository code
+        uses: actions/checkout@v4
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+      - name: Install dependencies
+        run: npm ci
+      - name: Check spelling
+        run: npm run test:spelling
+      - name: Check linting
+        run: npm run lint
+      - run: echo "Test job status is ${{ job.status }}."

.gitignore

@@ -35,6 +35,4 @@ node_modules
 # Default settings
 settings.json
 
-# Package Lock File
-package-lock.json
 

API/api.js

@@ -7,8 +7,8 @@
 
 const path = require("path");
 const url = require("url");
 const fs = require("fs");
 const os = require("os");
 const uuid = require("uuid/v4");
 const bodyParser = require("body-parser");
 const express = require("express");
@@ -20,7 +20,7 @@
      */
     getApiKey() {
         let thisConfig = this.configOnHd.modules.find(x => x.module === "MMM-Remote-Control");
         if (typeof "thisConfig" !== "undefined" &&
             "config" in thisConfig){
             if ("apiKey" in thisConfig.config &&
                 thisConfig.config.apiKey !== '') {
@@ -48,8 +48,8 @@
         if (!this.configOnHd) { return undefined; }
 
         let getActions = function(content) {
             let re = /notification \=\=\=? (?:"|')([A-Z_-]+?)(?:"|')|case (?:"|')([A-Z_-]+)(?:"|')/g;
             let m;
             let availableActions = [];
             if (re.test(content)) {
                 content.match(re).forEach((match) => {
@@ -72,7 +72,7 @@
 
         this.configOnHd.modules.filter(mod => skippedModules.indexOf(mod.module) === -1).forEach(mod => {
             try {
                 let modActions = getActions(Module.notificationHandler[mod.module]);
 
                 if (modActions.length > 0) {
                     let pathGuess = mod.module.replace(/MMM-/g, '').replace(/-/g, '').toLowerCase();
@@ -102,8 +102,8 @@
         this.updateModuleApiMenu();
     },
 
     createApiRoutes() {
         var self = this;
 
         this.getApiKey();
 
@@ -290,7 +290,7 @@
                         actionName = req.body.monitor.toUpperCase();
                     }
                 } else {
-                    var actionName = req.params.action ? req.params.action.toUpperCase() : "STATUS";
+                    actionName = req.params.action ? req.params.action.toUpperCase() : "STATUS";
                 }
                 this.executeQuery(this.checkDelay({ action: `MONITOR${actionName}` }, req), res);
             });

CHANGELOG.md

@@ -9,7 +9,9 @@ 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).
+- Added GitHub workflow for linting and spell checking on every push and pull request.
 
 ## [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;