Merge branch 'develop' into order

bugsounet · web-flow · commit 5411fe9948a9 · 2025-05-07T11:32:18.000+02:00
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -8,31 +8,31 @@ We hold our code to standard, and these standards are documented below.
 
 We use [prettier](https://prettier.io/) for automatic formatting a lot all our files. The configuration is in our `prettier.config.mjs` file.
 
-To run prettier, use `npm run lint:prettier`.
+To run prettier, use `node --run lint:prettier`.
 
 ### JavaScript: Run ESLint
 
 We use [ESLint](https://eslint.org) to lint our JavaScript files. The configuration is in our `eslint.config.mjs` file.
 
-To run ESLint, use `npm run lint:js`.
+To run ESLint, use `node --run lint:js`.
 
 ### CSS: Run StyleLint
 
 We use [StyleLint](https://stylelint.io) to lint our CSS. The configuration is in our `.stylelintrc.json` file.
 
-To run StyleLint, use `npm run lint:css`.
+To run StyleLint, use `node --run lint:css`.
 
 ### Markdown: Run markdownlint
 
 We use [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2) to lint our markdown files. The configuration is in our `.markdownlint.json` file.
 
-To run markdownlint, use `npm run markdownlint:css`.
+To run markdownlint, use `node --run markdownlint:css`.
 
 ## Testing
 
 We use [Jest](https://jestjs.io) for JavaScript testing.
 
-To run all tests, use `npm run test`.
+To run all tests, use `node --run test`.
 
 The specific test commands are defined in `package.json`.
-So you can also run the specific tests with other commands, e.g. `npm run test:unit` or `npx jest tests/e2e/env_spec.js`.
+So you can also run the specific tests with other commands, e.g. `node --run test:unit` or `npx jest tests/e2e/env_spec.js`.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -44,11 +44,11 @@ body:
       description: |
         Please keep in mind that some problems are specific to certain start options.
       options:
-        - "npm run start"
-        - "npm run start:wayland"
-        - "npm run start:windows"
-        - "npm run start:x11"
-        - "npm run server"
+        - "node --run start"
+        - "node --run start:wayland"
+        - "node --run start:windows"
+        - "node --run start:x11"
+        - "node --run server"
         - "node clientonly --address ... --port ..."
     validations:
       required: true
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -10,7 +10,7 @@ Hello and thank you for wanting to contribute to the MagicMirror² project!
 > - What does the pull request accomplish? Use a list if needed.
 > - If it includes major visual changes please add screenshots.
 >
-> 3. Please run `npm run lint:prettier` before submitting so that
+> 3. Please run `node --run lint:prettier` before submitting so that
 >    style issues are fixed.
 > 4. Don't forget to add an entry about your changes to
 >    the CHANGELOG.md file.
diff --git a/.github/workflows/automated-tests.yaml b/.github/workflows/automated-tests.yaml
@@ -22,17 +22,17 @@ jobs:
       - name: "Use Node.js"
         uses: actions/setup-node@v4
         with:
-          node-version: 23
+          node-version: lts/*
           cache: "npm"
       - name: "Install dependencies"
         run: |
-          npm run install-mm:dev
+          node --run install-mm:dev
       - name: "Run linter tests"
         run: |
-          npm run test:prettier
-          npm run test:js
-          npm run test:css
-          npm run test:markdown
+          node --run test:prettier
+          node --run test:js
+          node --run test:css
+          node --run test:markdown
   test:
     runs-on: ubuntu-24.04
     timeout-minutes: 30
@@ -54,14 +54,16 @@ jobs:
           cache: "npm"
       - name: "Install MagicMirror²"
         run: |
-          npm run install-mm:dev
-      - name: "Run tests"
+          node --run install-mm:dev
+      - name: "Prepare environment for tests"
         run: |
           # Fix chrome-sandbox permissions:
           sudo chown root:root ./node_modules/electron/dist/chrome-sandbox
           sudo chmod 4755 ./node_modules/electron/dist/chrome-sandbox
           # Start labwc
           WLR_BACKENDS=headless WLR_LIBINPUT_NO_DEVICES=1 WLR_RENDERER=pixman labwc &
-          export WAYLAND_DISPLAY=wayland-0
           touch css/custom.css
-          npm run test
+      - name: "Run tests"
+        run: |
+          export WAYLAND_DISPLAY=wayland-0
+          node --run test
diff --git a/.github/workflows/electron-rebuild.yaml b/.github/workflows/electron-rebuild.yaml
@@ -18,7 +18,7 @@ jobs:
           node-version: ${{ matrix.node-version }}
           check-latest: true
       - name: Install MagicMirror
-        run: npm run install-mm
+        run: node --run install-mm
       - name: Install @electron/rebuild
         run: npm install @electron/rebuild
       - name: Install node-libgpiod deps
diff --git a/.github/workflows/spellcheck.yaml b/.github/workflows/spellcheck.yaml
@@ -21,11 +21,11 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: "22"
+          node-version: lts/*
           check-latest: true
           cache: "npm"
       - name: Install dependencies
         run: |
-          npm run install-mm:dev
+          node --run install-mm:dev
       - name: Run Spellcheck
-        run: npm run test:spelling
+        run: node --run test:spelling
diff --git a/.gitignore b/.gitignore
@@ -84,3 +84,7 @@ Temporary Items
 
 # Ignore positions file (#3518)
 js/positions.js
+
+# Ignore lock files other than package-lock.json
+pnpm-lock.yaml
+yarn.lock
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,13 +15,16 @@ planned for 2025-07-01
 
 - [config] Allow to change module order for final renderer (or dynamicaly with CSS): Feature `order` in config. (#3762)
 
-### Changed
+### Fixed
 
-### Removed
+- [clock] Added option 'disableNextEvent' to hide next sun event.
 
-### Updated
+### Changed
 
-### Fixed
+- [refactor] Simplify module loading process (#3766)
+- Use "node --run" instead of "npm run" (#3764)
+- [workflow] Run linter und spellcheck with LTS node version (#3767)
+- [workflow] Split "Run test" step into two steps for more clarity (#3767)
 
 ## [2.31.0] - 2025-04-01
 
@@ -42,7 +45,7 @@ Thanks to: @Developer-Incoming, @eltociear, @geraki, @khassel, @KristjanESPERANT
 
 ### Changed
 
-- [core] starting clientonly now checks for needed env var `WAYLAND_DISPLAY` or `DISPLAY` and starts electron with needed parameters (if both are set wayland is used) (#3677)
+- [core] Starting clientonly now checks for needed env var `WAYLAND_DISPLAY` or `DISPLAY` and starts electron with needed parameters (if both are set wayland is used) (#3677)
 - [core] Optimize systeminformation calls and output (#3689)
 - [core] Add issue templates for feature requests and bug reports (#3695)
 - [core] Adapt `start:x11:dev` script
diff --git a/js/defaults.js b/js/defaults.js
@@ -62,7 +62,7 @@ const defaults = {
 			position: "middle_center",
 			classes: "xsmall",
 			config: {
-				text: "If you get this message while your config file is already created,<br>" + "it probably contains an error. To validate your config file run in your MagicMirror² directory<br>" + "<pre>npm run config:check</pre>"
+				text: "If you get this message while your config file is already created,<br>" + "it probably contains an error. To validate your config file run in your MagicMirror² directory<br>" + "<pre>node --run config:check</pre>"
 			}
 		},
 		{
diff --git a/js/electron.js b/js/electron.js
@@ -112,7 +112,7 @@ function createWindow () {
 	const port = process.env.MM_PORT || config.port;
 	mainWindow.loadURL(`${prefix}${address}:${port}`);
 
-	// Open the DevTools if run with "npm start dev"
+	// Open the DevTools if run with "node --run start:dev"
 	if (process.argv.includes("dev")) {
 		if (process.env.JEST_WORKER_ID !== undefined) {
 			// if we are running with jest
diff --git a/js/loader.js b/js/loader.js
@@ -218,29 +218,22 @@ const Loader = (function () {
 		 * Load all modules as defined in the config.
 		 */
 		async loadModules () {
-			let moduleData = await getModuleData();
+			const moduleData = await getModuleData();
 			const envVars = await getEnvVars();
 			const customCss = envVars.customCss;
 
-			/**
-			 * @returns {Promise<void>} when all modules are loaded
-			 */
-			const loadNextModule = async function () {
-				if (moduleData.length > 0) {
-					const nextModule = moduleData[0];
-					await loadModule(nextModule);
-					moduleData = moduleData.slice(1);
-					await loadNextModule();
-				} else {
-					// All modules loaded. Load custom.css
-					// This is done after all the modules so we can
-					// overwrite all the defined styles.
-					await loadFile(customCss);
-					// custom.css loaded. Start all modules.
-					await startModules();
-				}
-			};
-			await loadNextModule();
+			// Load all modules
+			for (const module of moduleData) {
+				await loadModule(module);
+			}
+
+			// Load custom.css
+			// Since this happens after loading the modules,
+			// it overwrites the default styles.
+			await loadFile(customCss);
+
+			// Start all modules.
+			await startModules();
 		},
 
 		/**
diff --git a/modules/default/clock/clock.js b/modules/default/clock/clock.js
@@ -25,7 +25,7 @@ Module.register("clock", {
 		analogShowDate: "top", // OBSOLETE, can be replaced with analogPlacement and showTime, options: false, 'top', or 'bottom'
 		secondsColor: "#888888", // DEPRECATED, use CSS instead. Class "clock-second-digital" for digital clock, "clock-second" for analog clock.
 
-		showSunTimes: false,
+		showSunTimes: false, // options: true, false, 'disableNextEvent'
 		showMoonTimes: false, // options: false, 'times' (rise/set), 'percent' (lit percent), 'phase' (current phase), or 'both' (percent & phase)
 		lat: 47.630539,
 		lon: -122.344147
@@ -171,21 +171,28 @@ Module.register("clock", {
 		if (this.config.showSunTimes) {
 			const sunTimes = SunCalc.getTimes(now, this.config.lat, this.config.lon);
 			const isVisible = now.isBetween(sunTimes.sunrise, sunTimes.sunset);
-			let nextEvent;
-			if (now.isBefore(sunTimes.sunrise)) {
-				nextEvent = sunTimes.sunrise;
-			} else if (now.isBefore(sunTimes.sunset)) {
-				nextEvent = sunTimes.sunset;
-			} else {
-				const tomorrowSunTimes = SunCalc.getTimes(now.clone().add(1, "day"), this.config.lat, this.config.lon);
-				nextEvent = tomorrowSunTimes.sunrise;
+			let sunWrapperInnerHTML = "";
+
+			if (this.config.showSunTimes !== "disableNextEvent") {
+				let nextEvent;
+				if (now.isBefore(sunTimes.sunrise)) {
+					nextEvent = sunTimes.sunrise;
+				} else if (now.isBefore(sunTimes.sunset)) {
+					nextEvent = sunTimes.sunset;
+				} else {
+					const tomorrowSunTimes = SunCalc.getTimes(now.clone().add(1, "day"), this.config.lat, this.config.lon);
+					nextEvent = tomorrowSunTimes.sunrise;
+				}
+				const untilNextEvent = moment.duration(moment(nextEvent).diff(now));
+				const untilNextEventString = `${untilNextEvent.hours()}h ${untilNextEvent.minutes()}m`;
+
+				sunWrapperInnerHTML = `<span class="${isVisible ? "bright" : ""}"><i class="fas fa-sun" aria-hidden="true"></i> ${untilNextEventString}</span>`;
 			}
-			const untilNextEvent = moment.duration(moment(nextEvent).diff(now));
-			const untilNextEventString = `${untilNextEvent.hours()}h ${untilNextEvent.minutes()}m`;
-			sunWrapper.innerHTML
-				= `<span class="${isVisible ? "bright" : ""}"><i class="fas fa-sun" aria-hidden="true"></i> ${untilNextEventString}</span>`
-				  + `<span><i class="fas fa-arrow-up" aria-hidden="true"></i> ${formatTime(this.config, sunTimes.sunrise)}</span>`
-				  + `<span><i class="fas fa-arrow-down" aria-hidden="true"></i> ${formatTime(this.config, sunTimes.sunset)}</span>`;
+
+			sunWrapperInnerHTML += `<span><i class="fas fa-arrow-up" aria-hidden="true"></i> ${formatTime(this.config, sunTimes.sunrise)}</span>`
+			  + `<span><i class="fas fa-arrow-down" aria-hidden="true"></i> ${formatTime(this.config, sunTimes.sunset)}</span>`;
+
+			sunWrapper.innerHTML = sunWrapperInnerHTML;
 			digitalWrapper.appendChild(sunWrapper);
 		}
 
diff --git a/modules/default/updatenotification/update_helper.js b/modules/default/updatenotification/update_helper.js
@@ -133,10 +133,10 @@ class Updater {
 		});
 	}
 
-	// restart rules (pm2 or npm start)
+	// restart rules (pm2 or node --run start)
 	restart () {
 		if (this.usePM2) this.pm2Restart();
-		else this.npmRestart();
+		else this.nodeRestart();
 	}
 
 	// restart MagicMiror with "pm2": use PM2Id for restart it
@@ -150,12 +150,12 @@ class Updater {
 		});
 	}
 
-	// restart MagicMiror with "npm start"
-	npmRestart () {
+	// restart MagicMiror with "node --run start"
+	nodeRestart () {
 		Log.info("updatenotification: Restarting MagicMirror...");
 		const out = process.stdout;
 		const err = process.stderr;
-		const subprocess = Spawn("npm start", { cwd: this.root_path, shell: true, detached: true, stdio: ["ignore", out, err] });
+		const subprocess = Spawn("node --run start", { cwd: this.root_path, shell: true, detached: true, stdio: ["ignore", out, err] });
 		subprocess.unref(); // detach the newly launched process from the master process
 		process.exit();
 	}
diff --git a/package.json b/package.json
@@ -33,17 +33,17 @@
 		"lint:js": "eslint --fix",
 		"lint:markdown": "markdownlint-cli2 . --fix",
 		"lint:prettier": "prettier . --write",
-		"postinstall": "npm run install-vendor && npm run install-fonts && echo \"MagicMirror² installation finished successfully! \n\"",
+		"postinstall": "node --run install-vendor && node --run install-fonts && echo \"MagicMirror² installation finished successfully! \n\"",
 		"prepare": "[ -f node_modules/.bin/husky ] && husky || echo no husky installed.",
 		"server": "node ./serveronly",
-		"start": "npm run start:x11",
-		"start:dev": "npm run start -- dev",
+		"start": "node --run start:x11",
+		"start:dev": "node --run start -- dev",
 		"start:wayland": "WAYLAND_DISPLAY=\"${WAYLAND_DISPLAY:=wayland-1}\" ./node_modules/.bin/electron js/electron.js --enable-features=UseOzonePlatform --ozone-platform=wayland",
-		"start:wayland:dev": "npm run start:wayland -- dev",
+		"start:wayland:dev": "node --run start:wayland -- dev",
 		"start:windows": ".\\node_modules\\.bin\\electron js\\electron.js",
-		"start:windows:dev": "npm run start:windows -- dev",
+		"start:windows:dev": "node --run start:windows -- dev",
 		"start:x11": "DISPLAY=\"${DISPLAY:=:0}\" ./node_modules/.bin/electron js/electron.js",
-		"start:x11:dev": "npm run start:x11 -- dev",
+		"start:x11:dev": "node --run start:x11 -- dev",
 		"test": "NODE_ENV=test jest -i --forceExit",
 		"test:calendar": "node ./modules/default/calendar/debug.js",
 		"test:coverage": "NODE_ENV=test jest --coverage -i --verbose false --forceExit",
diff --git a/tests/configs/modules/clock/clock_showSunNoEvent.js b/tests/configs/modules/clock/clock_showSunNoEvent.js
@@ -0,0 +1,20 @@
+let config = {
+	address: "0.0.0.0",
+	ipWhitelist: [],
+	timeFormat: 12,
+
+	modules: [
+		{
+			module: "clock",
+			position: "middle_center",
+			config: {
+				showSunTimes: "disableNextEvent"
+			}
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {
+	module.exports = config;
+}
diff --git a/tests/e2e/modules/clock_spec.js b/tests/e2e/modules/clock_spec.js
@@ -92,6 +92,9 @@ describe("Clock module", () => {
 		it("should show the sun times", async () => {
 			const elem = await helpers.waitForElement(".clock .digital .sun");
 			expect(elem).not.toBeNull();
+
+			const elem2 = await helpers.waitForElement(".clock .digital .sun .fas.fa-sun");
+			expect(elem2).not.toBeNull();
 		});
 
 		it("should show the moon times", async () => {
@@ -100,6 +103,21 @@ describe("Clock module", () => {
 		});
 	});
 
+	describe("with showSunNextEvent disabled", () => {
+		beforeAll(async () => {
+			await helpers.startApplication("tests/configs/modules/clock/clock_showSunNoEvent.js");
+			await helpers.getDocument();
+		});
+
+		it("should show the sun times", async () => {
+			const elem = await helpers.waitForElement(".clock .digital .sun");
+			expect(elem).not.toBeNull();
+
+			const elem2 = document.querySelector(".clock .digital .sun .fas.fa-sun");
+			expect(elem2).toBeNull();
+		});
+	});
+
 	describe("with showWeek config enabled", () => {
 		beforeAll(async () => {
 			await helpers.startApplication("tests/configs/modules/clock/clock_showWeek.js");

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ Hello and thank you for wanting to contribute to the MagicMirror² project!`
`10`	`10`	`> - What does the pull request accomplish? Use a list if needed.`
`11`	`11`	`> - If it includes major visual changes please add screenshots.`
`12`	`12`	`>`
`13`		-> 3. Please run `npm run lint:prettier` before submitting so that
	`13`	+> 3. Please run `node --run lint:prettier` before submitting so that
`14`	`14`	`> style issues are fixed.`
`15`	`15`	`> 4. Don't forget to add an entry about your changes to`
`16`	`16`	`> the CHANGELOG.md file.`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ const defaults = {`
`62`	`62`	`position: "middle_center",`
`63`	`63`	`classes: "xsmall",`
`64`	`64`	`config: {`
`65`		`- text: "If you get this message while your config file is already created,<br>" + "it probably contains an error. To validate your config file run in your MagicMirror² directory<br>" + "<pre>npm run config:check</pre>"`
	`65`	`+ text: "If you get this message while your config file is already created,<br>" + "it probably contains an error. To validate your config file run in your MagicMirror² directory<br>" + "<pre>node --run config:check</pre>"`
`66`	`66`	`}`
`67`	`67`	`},`
`68`	`68`	`{`