Release 2.31.0 (#3758)

Thanks to: @Developer-Incoming, @eltociear, @geraki, @khassel,
@KristjanESPERANTO, @MagMar94, @mixasgr, @n8many, @OWL4C, @rejas,
@savvadam, @sdetweil.

> ⚠️ This release needs nodejs version `v22.14.0 or higher`

### Added

- Add CSS support to the digital clock hour/minute/second through the
use of the classes `clock-hour-digital`, `clock-minute-digital`, and
`clock-second-digital`.
- Add Arabic (#3719) and Esperanto translation.
- Mark option `secondsColor` as deprecated in clock module.
- Add Greek translation to Alerts module.
- [newsfeed] Add specific ignoreOlderThan value (override) per feed
(#3360)
- [weather] Added option Humidity to hourly View
- [weather] Added option to hide hourly entries that are Zero, hiding
the entire column if empty.
- [updatenotification] Added option to iterate over modules directory
instead using modules defined in `config.js` (#3739)

### 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] Optimize systeminformation calls and output (#3689)
- [core] Add issue templates for feature requests and bug reports
(#3695)
- [core] Adapt `start:x11:dev` script
- [weather/yr] The Yr weather provider now enforces a minimum
`updateInterval` of 600 000 ms (10 minutes) to comply with the terms of
service. If a lower value is set, it will be automatically increased to
this minimum.
- [weather/weatherflow] Fixed icons and added hourly support as well as
UV, precipitation, and location name support.
- [workflow] Run `sudo apt-get update` before installing packages to
avoid install errors
- [workflow] Exclude issues with label `ready (coming with next
release)` from stale job

### Removed

### Updated

- [core] Update requirements and dependencies including electron to v35
and formatting (#3593, #3693, #3717)
- [core] Update prettier, ESLint and simplify config
- Update Greek translation

### Fixed

- [calendar] Fix clipping events being broadcast (#3678)
- [tests] Fix Electron tests by running them under new github image
ubuntu-24.04, replace xserver with labwc, running under xserver and
labwc depending on env variable WAYLAND_DISPLAY is set (#3676)
- [calendar] Fix arrayed symbols, #3267, again, add testcase, add
testcase for #3678
- [weather] Fix wrong weatherCondition name in openmeteo provider which
lead to n/a icon (#3691)
- [core] Fix wrong port in log message when starting server only (#3696)
- [calendar] Fix NewYork event processed on system in Central timezone
shows wrong time #3701
- [weather/yr] The Yr weather provider is now able to recover from bad
API responses instead of freezing (#3296)
- [compliments] Fix evening events being shown during the day (#3727)
- [weather] Fixed minor spacing issues when using UV Index in Hourly
- [workflow] Fix command to run spellcheck

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Michael Teeuw <[email protected]>
Co-authored-by: Kristjan ESPERANTO <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Karsten Hassel <[email protected]>
Co-authored-by: Ross Younger <[email protected]>
Co-authored-by: Bugsounet - Cédric <[email protected]>
Co-authored-by: jkriegshauser <[email protected]>
Co-authored-by: illimarkangur <[email protected]>
Co-authored-by: sam detweiler <[email protected]>
Co-authored-by: vppencilsharpener <[email protected]>
Co-authored-by: Paranoid93 <[email protected]>
Co-authored-by: Brian O'Connor <[email protected]>
Co-authored-by: WallysWellies <[email protected]>
Co-authored-by: Jason Stieber <[email protected]>
Co-authored-by: jargordon <[email protected]>
Co-authored-by: Daniel <[email protected]>
Co-authored-by: Ryan Williams <[email protected]>
Co-authored-by: Panagiotis Skias <[email protected]>
Co-authored-by: Marc Landis <[email protected]>
Co-authored-by: HeikoGr <[email protected]>
Co-authored-by: Pedro Lamas <[email protected]>
Co-authored-by: veeck <[email protected]>
Co-authored-by: Magnus <[email protected]>
Co-authored-by: Ikko Eltociear Ashimine <[email protected]>
Co-authored-by: DevIncomin <[email protected]>
Co-authored-by: Nathan <[email protected]>
Co-authored-by: mixasgr <[email protected]>
Co-authored-by: Savvas Adamtziloglou <[email protected]>
Co-authored-by: Konstantinos <[email protected]>
Co-authored-by: OWL4C <[email protected]>

Author: 31 people

.github/workflows/automated-tests.yaml

@@ -34,12 +34,16 @@ jobs:
           npm run test:css
           npm run test:markdown
   test:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     timeout-minutes: 30
     strategy:
       matrix:
-        node-version: [20.18.1, 20.x, 22.x, 23.x]
+        node-version: [22.14.0, 22.x, 23.x]
     steps:
+      - name: Install electron dependencies and labwc
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libnss3 libasound2t64 labwc
       - name: "Checkout code"
         uses: actions/checkout@v4
       - name: "Use Node.js ${{ matrix.node-version }}"
@@ -48,12 +52,16 @@ jobs:
           node-version: ${{ matrix.node-version }}
           check-latest: true
           cache: "npm"
-      - name: "Install dependencies"
+      - name: "Install MagicMirror²"
         run: |
           npm run install-mm:dev
       - name: "Run tests"
         run: |
-          Xvfb :99 -screen 0 1024x768x16 &
-          export DISPLAY=:99
+          # 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

.github/workflows/electron-rebuild.yaml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [20.18.1, 20.x, 22.x, 23.x]
+        node-version: [22.14.0, 22.x, 23.x]
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -22,7 +22,9 @@ jobs:
       - name: Install @electron/rebuild
         run: npm install @electron/rebuild
       - name: Install node-libgpiod deps
-        run: sudo apt-get install gpiod libgpiod2 libgpiod-dev
+        run: |
+          sudo apt-get update
+          sudo apt-get install gpiod libgpiod2 libgpiod-dev
       - name: Install test library (node-libgpiod) to be rebuilded
         run: npm install node-libgpiod
       - name: Run electron-rebuild

.github/workflows/spellcheck.yaml

@@ -28,4 +28,4 @@ jobs:
         run: |
           npm run install-mm:dev
       - name: Run Spellcheck
-        run: npm run test:spellcheck
+        run: npm run test:spelling

.github/workflows/stale.yaml

@@ -19,4 +19,4 @@ jobs:
           days-before-issue-close: 7
           operations-per-run: 100
           stale-issue-label: "wontfix"
-          exempt-issue-labels: "pinned,security,under investigation,pr welcome"
+          exempt-issue-labels: "pinned,security,under investigation,pr welcome,ready (coming with next release)"

CHANGELOG.md

@@ -7,6 +7,55 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ❤️ **Donate:** Enjoying MagicMirror²? [Please consider a donation!](https://magicmirror.builders/#donate) With your help we can continue to improve the MagicMirror².
 
+## [2.31.0] - 2025-04-01
+
+Thanks to: @Developer-Incoming, @eltociear, @geraki, @khassel, @KristjanESPERANTO, @MagMar94, @mixasgr, @n8many, @OWL4C, @rejas, @savvadam, @sdetweil.
+
+> ⚠️ This release needs nodejs version `v22.14.0 or higher`
+
+### Added
+
+- Add CSS support to the digital clock hour/minute/second through the use of the classes `clock-hour-digital`, `clock-minute-digital`, and `clock-second-digital`.
+- Add Arabic (#3719) and Esperanto translation.
+- Mark option `secondsColor` as deprecated in clock module.
+- Add Greek translation to Alerts module.
+- [newsfeed] Add specific ignoreOlderThan value (override) per feed (#3360)
+- [weather] Added option Humidity to hourly View
+- [weather] Added option to hide hourly entries that are Zero, hiding the entire column if empty.
+- [updatenotification] Added option to iterate over modules directory instead using modules defined in `config.js` (#3739)
+
+### 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] Optimize systeminformation calls and output (#3689)
+- [core] Add issue templates for feature requests and bug reports (#3695)
+- [core] Adapt `start:x11:dev` script
+- [weather/yr] The Yr weather provider now enforces a minimum `updateInterval` of 600 000 ms (10 minutes) to comply with the terms of service. If a lower value is set, it will be automatically increased to this minimum.
+- [weather/weatherflow] Fixed icons and added hourly support as well as UV, precipitation, and location name support.
+- [workflow] Run `sudo apt-get update` before installing packages to avoid install errors
+- [workflow] Exclude issues with label `ready (coming with next release)` from stale job
+
+### Removed
+
+### Updated
+
+- [core] Update requirements and dependencies including electron to v35 and formatting (#3593, #3693, #3717)
+- [core] Update prettier, ESLint and simplify config
+- Update Greek translation
+
+### Fixed
+
+- [calendar] Fix clipping events being broadcast (#3678)
+- [tests] Fix Electron tests by running them under new github image ubuntu-24.04, replace xserver with labwc, running under xserver and labwc depending on env variable WAYLAND_DISPLAY is set (#3676)
+- [calendar] Fix arrayed symbols, #3267, again, add testcase, add testcase for #3678
+- [weather] Fix wrong weatherCondition name in openmeteo provider which lead to n/a icon (#3691)
+- [core] Fix wrong port in log message when starting server only (#3696)
+- [calendar] Fix NewYork event processed on system in Central timezone shows wrong time #3701
+- [weather/yr] The Yr weather provider is now able to recover from bad API responses instead of freezing (#3296)
+- [compliments] Fix evening events being shown during the day (#3727)
+- [weather] Fixed minor spacing issues when using UV Index in Hourly
+- [workflow] Fix command to run spellcheck
+
 ## [2.30.0] - 2025-01-01
 
 Thanks to: @xsorifc28, @HeikoGr, @bugsounet, @khassel, @KristjanESPERANTO, @rejas, @sdetweil.
@@ -24,7 +73,7 @@ Thanks to: @xsorifc28, @HeikoGr, @bugsounet, @khassel, @KristjanESPERANTO, @reja
 - [linter] Re-add `eslint-plugin-import`now that it supports ESLint v9 (#3586)
 - [linter] Re-activate `eslint-plugin-package-json` to lint `package.json` (#3643)
 - [linter] Add linting for markdown files (#3646)
-- [linter] Add some handy ESLint rules.
+- [linter] Add some handy ESLint rules (#3665)
 - [calendar] Add ability to display end date for full date events, where end is not same day (showEnd=true) (#3650)
 - [core] Add text to the config.js.sample file about the locale variable (#3654, #3655)
 - [core] Add fetch timeout for all node_helpers (thru undici, forces node 20.18.1 minimum) to help on slower systems. (#3660) (3661)
@@ -103,7 +152,7 @@ Thanks to: @bugsounet, @dkallen78, @jargordon, @khassel, @KristjanESPERANTO, @Ma
 - [core] Detail optimizations in `config_check.js`
 - [core] Updated minimal needed node version in `package.json` (currently v20.9.0) (#3559) and except for v21 (no security updates) (#3561)
 - [linter] Switch to ESLint v9 and flat config and replace `eslint-plugin-unicorn` by `@eslint/js`
-- [core] fix discovering module positions twice after #3450
+- [core] Fix discovering module positions twice after #3450
 
 ### Fixed
 
@@ -167,7 +216,7 @@ For more info, please read the following post: [A New Chapter for MagicMirror: T
 
 ### Updated
 
-- Update updatenotification (update_helper.js): Recode with pm2 library (#3332)
+- [updatenotification] Recode update_helper.js with pm2 library (#3332)
 - Removing lodash dependency by replacing merge by spread operator (#3339)
 - Use node prefix for build-in modules (#3340)
 - Rework logging colors (#3350)
@@ -1671,6 +1720,7 @@ It includes (but is not limited to) the following features:
 
 This was part of the blogpost: [https://michaelteeuw.nl/post/83916869600/magic-mirror-part-vi-production-of-the](https://michaelteeuw.nl/post/83916869600/magic-mirror-part-vi-production-of-the)
 
+[2.31.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.30.0...v2.31.0
 [2.30.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.29.0...v2.30.0
 [2.29.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.28.0...v2.29.0
 [2.28.0]: https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.27.0...v2.28.0

Collaboration.md

@@ -30,13 +30,16 @@ Are done by
 ### Deployment steps
 
 - [ ] pull latest `develop` branch
-- [ ] update `package.json` and `package-lock.json` to reflect correct version number `2.xx.0`
-- [ ] test `develop` branch
-- [ ] update `CHANGELOG.md`
-  - [ ] add all contributor names: `...`
-  - [ ] add min. node version: > ⚠️ This release needs nodejs version `v20` or `v22`, minimum version is `v20.9.0`
-  - [ ] check release link at the bottom of the file
-- [ ] commit and push all changes
+- [ ] create `prep-release` branch from `develop`
+  - [ ] update `package.json` and `package-lock.json` to reflect correct version number `2.xx.0`
+  - [ ] test `prep-release` branch
+  - [ ] update `CHANGELOG.md`
+    - [ ] add all contributor names: `...`
+    - [ ] add min. node version: > ⚠️ This release needs nodejs version `v22.14.0` or higher
+    - [ ] check release link at the bottom of the file
+  - [ ] commit and push all changes
+  - [ ] create pull request from `prep-release` to `develop` branch with title `Prepare Release 2.xx.0`
+  - [ ] after successful test run via github actions: merge pull request to `develop`
 - [ ] after successful test run via github actions: create pull request from `develop` to `master` branch
   - [ ] add label `mastermerge`
   - [ ] title of the PR is `Release 2.xx.0`
@@ -54,6 +57,7 @@ Are done by
 - [ ] draft new section in `CHANGELOG.md`
   - [ ] create new release link at the bottom of the file
 - [ ] commit and publish `develop` branch
+- [ ] if new release will be in January, update the year in LICENSE.md
 
 ### After release
 

LICENSE.md

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 
-Copyright © 2016-2024 Michael Teeuw
+Copyright © 2016-2025 Michael Teeuw
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

clientonly/index.js

@@ -83,6 +83,17 @@
 	if (["localhost", "127.0.0.1", "::1", "::ffff:127.0.0.1", undefined].indexOf(config.address) === -1) {
 		getServerConfig(`${prefix}${config.address}:${config.port}/config/`)
 			.then(function (configReturn) {
+				// check environment for DISPLAY or WAYLAND_DISPLAY
+				const elecParams = ["js/electron.js"];
+				if (process.env.WAYLAND_DISPLAY) {
+					console.log(`Client: Using WAYLAND_DISPLAY=${process.env.WAYLAND_DISPLAY}`);
+					elecParams.push("--enable-features=UseOzonePlatform");
+					elecParams.push("--ozone-platform=wayland");
+				} else if (process.env.DISPLAY) {
+					console.log(`Client: Using DISPLAY=${process.env.DISPLAY}`);
+				} else {
+					fail("Error: Requires environment variable WAYLAND_DISPLAY or DISPLAY, none is provided.");
+				}
 				// Pass along the server config via an environment variable
 				const env = Object.create(process.env);
 				env.clientonly = true; // set to pass to electron.js
@@ -94,7 +105,7 @@
 
 				// Spawn electron application
 				const electron = require("electron");
-				const child = require("node:child_process").spawn(electron, ["js/electron.js"], options);
+				const child = require("node:child_process").spawn(electron, elecParams, options);
 
 				// Pipe all child process output to current stdout
 				child.stdout.on("data", function (buf) {

cspell.config.json

@@ -58,6 +58,7 @@
 		"eddiehung",
 		"Edgardos",
 		"Ekristoffe",
+		"elec",
 		"envcanada",
 		"envsub",
 		"envsubst",
@@ -85,6 +86,7 @@
 		"GHSA",
 		"ghsas",
 		"grenagit",
+		"Heiko",
 		"Hirschberger",
 		"hourlyweather",
 		"Hwind",
@@ -117,6 +119,7 @@
 		"krekos",
 		"Kristjan",
 		"krukle",
+		"labwc",
 		"Landis",
 		"larryare",
 		"letsencrypt",
@@ -132,6 +135,8 @@
 		"martingron",
 		"marvai",
 		"mastermerge",
+		"matchtype",
+		"maxentries",
 		"Meteo",
 		"michaelteeuw",
 		"michmich",
@@ -195,6 +200,7 @@
 		"sunaction",
 		"suncalc",
 		"suntimes",
+		"symboltest",
 		"systeminformation",
 		"tada",
 		"taglist",
@@ -228,6 +234,7 @@
 		"xlarge",
 		"xrandr",
 		"xsmall",
+		"xsorifc",
 		"xwindows",
 		"xxxe",
 		"Ybbet",

eslint.config.mjs

@@ -1,14 +1,16 @@
 import eslintPluginImport from "eslint-plugin-import";
 import eslintPluginJest from "eslint-plugin-jest";
 import eslintPluginJs from "@eslint/js";
-import eslintPluginPackageJson from "eslint-plugin-package-json/configs/recommended";
+import eslintPluginPackageJson from "eslint-plugin-package-json";
 import eslintPluginStylistic from "@stylistic/eslint-plugin";
 import globals from "globals";
 
 const config = [
-	eslintPluginJs.configs.recommended,
 	eslintPluginImport.flatConfigs.recommended,
-	eslintPluginPackageJson,
+	eslintPluginJest.configs["flat/recommended"],
+	eslintPluginJs.configs.recommended,
+	eslintPluginPackageJson.configs.recommended,
+	eslintPluginStylistic.configs.all,
 	{
 		files: ["**/*.js"],
 		languageOptions: {
@@ -24,13 +26,7 @@ const config = [
 				moment: "readonly"
 			}
 		},
-		plugins: {
-			...eslintPluginStylistic.configs["all-flat"].plugins,
-			...eslintPluginJest.configs["flat/recommended"].plugins
-		},
 		rules: {
-			...eslintPluginStylistic.configs["all-flat"].rules,
-			...eslintPluginJest.configs["flat/recommended"].rules,
 			"@stylistic/array-element-newline": ["error", "consistent"],
 			"@stylistic/arrow-parens": ["error", "always"],
 			"@stylistic/brace-style": "off",
@@ -99,11 +95,7 @@ const config = [
 			},
 			sourceType: "module"
 		},
-		plugins: {
-			...eslintPluginStylistic.configs["all-flat"].plugins
-		},
 		rules: {
-			...eslintPluginStylistic.configs["all-flat"].rules,
 			"@stylistic/array-element-newline": "off",
 			"@stylistic/indent": ["error", "tab"],
 			"@stylistic/padded-blocks": ["error", "never"],