kenmirrors/MagicMirror
1
0
Fork 0
mirror of https://github.com/MichMich/MagicMirror.git synced 2025-10-12 23:44:56 +00:00
Code Issues Projects Releases Wiki Activity

update jsdoc and other deps (#3896)

Browse Source 
other cosmetic code changes because of new `eslint-plugin-jsdoc` version
v60
This commit is contained in:
Karsten Hassel
2025-09-23 06:27:29 +02:00
committed by GitHub
parent fbca0a0e55
commit 1f2d1b92b5
11 changed files with 1284 additions and 2478 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@@ -45,7 +45,7 @@ Thanks to: @dathbe.
### Updated ### Updated
- [calendar] Update defaultSymbol name and also the link to the icon search site (#3879) - [calendar] Update defaultSymbol name and also the link to the icon search site (#3879)
- [core] Update dependencies including electron to v38 as well as github actions (#3831, #3849, #3857, #3858, #3872, #3876, #3882, #3891) - [core] Update dependencies including electron to v38 as well as github actions (#3831, #3849, #3857, #3858, #3872, #3876, #3882, #3891, #3896)
- [weather] Update feels_like temperature calculation formula (#3869) - [weather] Update feels_like temperature calculation formula (#3869)
- [weather] Update null value handling for weather type (#3892) - [weather] Update null value handling for weather type (#3892)
- [layout] Update styles for weather and calendar (#3894) - [layout] Update styles for weather and calendar (#3894)

14
js/main.js
View File

@@ -90,7 +90,7 @@ const MM = (function () {
/** /**
* Send a notification to all modules. * Send a notification to all modules.
* @param {string} notification The identifier of the notification. * @param {string} notification The identifier of the notification.
* @param {*} payload The payload of the notification. * @param {object} payload The payload of the notification.
* @param {Module} sender The module that sent the notification. * @param {Module} sender The module that sent the notification.
* @param {Module} [sendTo] The (optional) module to send the notification to. * @param {Module} [sendTo] The (optional) module to send the notification to.
*/ */
@@ -262,7 +262,7 @@ const MM = (function () {
* Hide the module. * Hide the module.
* @param {Module} module The module to hide. * @param {Module} module The module to hide.
* @param {number} speed The speed of the hide animation. * @param {number} speed The speed of the hide animation.
* @param {Function} callback Called when the animation is done. * @param {Promise} callback Called when the animation is done.
* @param {object} [options] Optional settings for the hide method. * @param {object} [options] Optional settings for the hide method.
*/ */
const hideModule = function (module, speed, callback, options = {}) { const hideModule = function (module, speed, callback, options = {}) {
@@ -347,7 +347,7 @@ const MM = (function () {
* Show the module. * Show the module.
* @param {Module} module The module to show. * @param {Module} module The module to show.
* @param {number} speed The speed of the show animation. * @param {number} speed The speed of the show animation.
* @param {Function} callback Called when the animation is done. * @param {Promise} callback Called when the animation is done.
* @param {object} [options] Optional settings for the show method. * @param {object} [options] Optional settings for the show method.
*/ */
const showModule = function (module, speed, callback, options = {}) { const showModule = function (module, speed, callback, options = {}) {
@@ -552,7 +552,7 @@ const MM = (function () {
/** /**
* Walks thru a collection of modules and executes the callback with the module as an argument. * Walks thru a collection of modules and executes the callback with the module as an argument.
* @param {Function} callback The function to execute with the module as an argument. * @param {module} callback The function to execute with the module as an argument.
*/ */
const enumerate = function (callback) { const enumerate = function (callback) {
modules.map(function (module) { modules.map(function (module) {
@@ -629,7 +629,7 @@ const MM = (function () {
/** /**
* Send a notification to all modules. * Send a notification to all modules.
* @param {string} notification The identifier of the notification. * @param {string} notification The identifier of the notification.
* @param {*} payload The payload of the notification. * @param {object} payload The payload of the notification.
* @param {Module} sender The module that sent the notification. * @param {Module} sender The module that sent the notification.
*/ */
sendNotification (notification, payload, sender) { sendNotification (notification, payload, sender) {
@@ -688,7 +688,7 @@ const MM = (function () {
* Hide the module. * Hide the module.
* @param {Module} module The module to hide. * @param {Module} module The module to hide.
* @param {number} speed The speed of the hide animation. * @param {number} speed The speed of the hide animation.
* @param {Function} callback Called when the animation is done. * @param {Promise} callback Called when the animation is done.
* @param {object} [options] Optional settings for the hide method. * @param {object} [options] Optional settings for the hide method.
*/ */
hideModule (module, speed, callback, options) { hideModule (module, speed, callback, options) {
@@ -700,7 +700,7 @@ const MM = (function () {
* Show the module. * Show the module.
* @param {Module} module The module to show. * @param {Module} module The module to show.
* @param {number} speed The speed of the show animation. * @param {number} speed The speed of the show animation.
* @param {Function} callback Called when the animation is done. * @param {Promise} callback Called when the animation is done.
* @param {object} [options] Optional settings for the show method. * @param {object} [options] Optional settings for the show method.
*/ */
showModule (module, speed, callback, options) { showModule (module, speed, callback, options) {

14
js/module.js
View File

@@ -68,7 +68,7 @@ const Module = Class.extend({
* Returns a map of translation files the module requires to be loaded. * Returns a map of translation files the module requires to be loaded.
* *
* return Map<String, String> - * return Map<String, String> -
* @returns {*} A map with langKeys and filenames. * @returns {Map} A map with langKeys and filenames.
*/ */
getTranslations () { getTranslations () {
return false; return false;
@@ -140,7 +140,7 @@ const Module = Class.extend({
/** /**
* Called by the MagicMirror² core when a notification arrives. * Called by the MagicMirror² core when a notification arrives.
* @param {string} notification The identifier of the notification. * @param {string} notification The identifier of the notification.
* @param {*} payload The payload of the notification. * @param {object} payload The payload of the notification.
* @param {Module} sender The module that sent the notification. * @param {Module} sender The module that sent the notification.
*/ */
notificationReceived (notification, payload, sender) { notificationReceived (notification, payload, sender) {
@@ -176,7 +176,7 @@ const Module = Class.extend({
/** /**
* Called when a socket notification arrives. * Called when a socket notification arrives.
* @param {string} notification The identifier of the notification. * @param {string} notification The identifier of the notification.
* @param {*} payload The payload of the notification. * @param {object} payload The payload of the notification.
*/ */
socketNotificationReceived (notification, payload) { socketNotificationReceived (notification, payload) {
Log.log(`${this.name} received a socket notification: ${notification} - Payload: ${payload}`); Log.log(`${this.name} received a socket notification: ${notification} - Payload: ${payload}`);
@@ -344,7 +344,7 @@ const Module = Class.extend({
/** /**
* Send a notification to all modules. * Send a notification to all modules.
* @param {string} notification The identifier of the notification. * @param {string} notification The identifier of the notification.
* @param {*} payload The payload of the notification. * @param {object} payload The payload of the notification.
*/ */
sendNotification (notification, payload) { sendNotification (notification, payload) {
MM.sendNotification(notification, payload, this); MM.sendNotification(notification, payload, this);
@@ -353,7 +353,7 @@ const Module = Class.extend({
/** /**
* Send a socket notification to the node helper. * Send a socket notification to the node helper.
* @param {string} notification The identifier of the notification. * @param {string} notification The identifier of the notification.
* @param {*} payload The payload of the notification. * @param {object} payload The payload of the notification.
*/ */
sendSocketNotification (notification, payload) { sendSocketNotification (notification, payload) {
this.socket().sendNotification(notification, payload); this.socket().sendNotification(notification, payload);
@@ -362,7 +362,7 @@ const Module = Class.extend({
/** /**
* Hide this module. * Hide this module.
* @param {number} speed The speed of the hide animation. * @param {number} speed The speed of the hide animation.
* @param {Function} callback Called when the animation is done. * @param {Promise} callback Called when the animation is done.
* @param {object} [options] Optional settings for the hide method. * @param {object} [options] Optional settings for the hide method.
*/ */
hide (speed, callback, options = {}) { hide (speed, callback, options = {}) {
@@ -389,7 +389,7 @@ const Module = Class.extend({
/** /**
* Show this module. * Show this module.
* @param {number} speed The speed of the show animation. * @param {number} speed The speed of the show animation.
* @param {Function} callback Called when the animation is done. * @param {Promise} callback Called when the animation is done.
* @param {object} [options] Optional settings for the show method. * @param {object} [options] Optional settings for the show method.
*/ */
show (speed, callback, options) { show (speed, callback, options) {

2
js/module_functions.js
View File

@@ -2,7 +2,7 @@
* Schedule the timer for the next update * Schedule the timer for the next update
* @param {object} timer The timer of the module * @param {object} timer The timer of the module
* @param {bigint} intervalMS interval in milliseconds * @param {bigint} intervalMS interval in milliseconds
* @param {Function} callback function to call when the timer expires * @param {Promise} callback function to call when the timer expires
*/ */
const scheduleTimer = function (timer, intervalMS, callback) { const scheduleTimer = function (timer, intervalMS, callback) {
if (process.env.JEST_WORKER_ID === undefined) { if (process.env.JEST_WORKER_ID === undefined) {

2
js/node_helper.js
View File

@@ -27,7 +27,7 @@ const NodeHelper = Class.extend({
/** /**
* This method is called when a socket notification arrives. * This method is called when a socket notification arrives.
* @param {string} notification The identifier of the notification. * @param {string} notification The identifier of the notification.
* @param {*} payload The payload of the notification. * @param {object} payload The payload of the notification.
*/ */
socketNotificationReceived (notification, payload) { socketNotificationReceived (notification, payload) {
Log.log(`${this.name} received a socket notification: ${notification} - Payload: ${payload}`); Log.log(`${this.name} received a socket notification: ${notification} - Payload: ${payload}`);

2
modules/default/calendar/calendar.js
View File

@@ -876,7 +876,7 @@ Module.register("calendar", {
* @param {string} url The calendar url * @param {string} url The calendar url
* @param {string} property The property to look for * @param {string} property The property to look for
* @param {string} defaultValue The value if the property is not found * @param {string} defaultValue The value if the property is not found
* @returns {*} The property * @returns {property} The property
*/ */
getCalendarProperty (url, property, defaultValue) { getCalendarProperty (url, property, defaultValue) {
for (const calendar of this.config.calendars) { for (const calendar of this.config.calendars) {

4
modules/default/calendar/calendarfetcher.js
View File

@@ -97,7 +97,7 @@ const CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEn
/** /**
* Sets the on success callback * Sets the on success callback
* @param {Function} callback The on success callback. * @param {eventsReceivedCallback} callback The on success callback.
*/ */
this.onReceive = function (callback) { this.onReceive = function (callback) {
eventsReceivedCallback = callback; eventsReceivedCallback = callback;
@@ -105,7 +105,7 @@ const CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEn
/** /**
* Sets the on error callback * Sets the on error callback
* @param {Function} callback The on error callback. * @param {fetchFailedCallback} callback The on error callback.
*/ */
this.onError = function (callback) { this.onError = function (callback) {
fetchFailedCallback = callback; fetchFailedCallback = callback;

2
modules/default/newsfeed/newsfeed.js
View File

@@ -181,7 +181,7 @@ Module.register("newsfeed", {
* Gets a feed property by name * Gets a feed property by name
* @param {object} feed A feed object. * @param {object} feed A feed object.
* @param {string} property The name of the property. * @param {string} property The name of the property.
* @returns {*} The value of the specified property for the feed. * @returns {property} The value of the specified property for the feed.
*/ */
getFeedProperty (feed, property) { getFeedProperty (feed, property) {
let res = this.config[property]; let res = this.config[property];

2
modules/default/weather/providers/smhi.js
View File

@@ -254,7 +254,7 @@ WeatherProvider.register("smhi", {
* Helper method to get a property from the returned data set. * Helper method to get a property from the returned data set.
* @param {object} currentWeatherData Weatherdata to get from * @param {object} currentWeatherData Weatherdata to get from
* @param {string} name The name of the property * @param {string} name The name of the property
* @returns {*} The value of the property in the weatherdata * @returns {string} The value of the property in the weatherdata
*/ */
paramValue (currentWeatherData, name) { paramValue (currentWeatherData, name) {
return currentWeatherData.parameters.filter((p) => p.name === name).flatMap((p) => p.values)[0]; return currentWeatherData.parameters.filter((p) => p.name === name).flatMap((p) => p.values)[0];

3700
package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

18
package.json
View File

@@ -69,15 +69,15 @@
"*.css": "stylelint --fix" "*.css": "stylelint --fix"
}, },
"dependencies": { "dependencies": {
"@fontsource/roboto": "^5.2.7", "@fontsource/roboto": "^5.2.8",
"@fontsource/roboto-condensed": "^5.2.7", "@fontsource/roboto-condensed": "^5.2.8",
"@fortawesome/fontawesome-free": "^7.0.1", "@fortawesome/fontawesome-free": "^7.0.1",
"ajv": "^8.17.1", "ajv": "^8.17.1",
"animate.css": "^4.1.1", "animate.css": "^4.1.1",
"console-stamp": "^3.1.2", "console-stamp": "^3.1.2",
"croner": "^9.1.0", "croner": "^9.1.0",
"envsub": "^4.1.0", "envsub": "^4.1.0",
"eslint": "^9.35.0", "eslint": "^9.36.0",
"express": "^5.1.0", "express": "^5.1.0",
"express-ipfilter": "^1.3.2", "express-ipfilter": "^1.3.2",
"feedme": "^2.0.2", "feedme": "^2.0.2",
@@ -89,25 +89,25 @@
"moment-timezone": "^0.6.0", "moment-timezone": "^0.6.0",
"node-ical": "^0.21.0", "node-ical": "^0.21.0",
"nunjucks": "^3.2.4", "nunjucks": "^3.2.4",
"pm2": "^6.0.11", "pm2": "^6.0.13",
"socket.io": "^4.8.1", "socket.io": "^4.8.1",
"suncalc": "^1.9.0", "suncalc": "^1.9.0",
"systeminformation": "^5.27.9", "systeminformation": "^5.27.10",
"undici": "^7.16.0", "undici": "^7.16.0",
"weathericons": "^2.1.0" "weathericons": "^2.1.0"
}, },
"devDependencies": { "devDependencies": {
"@stylistic/eslint-plugin": "^5.3.1", "@stylistic/eslint-plugin": "^5.4.0",
"cspell": "^9.2.1", "cspell": "^9.2.1",
"eslint-plugin-import-x": "^4.16.1", "eslint-plugin-import-x": "^4.16.1",
"eslint-plugin-jest": "^29.0.1", "eslint-plugin-jest": "^29.0.1",
"eslint-plugin-jsdoc": "^57.0.8", "eslint-plugin-jsdoc": "^60.1.1",
"eslint-plugin-package-json": "^0.56.3", "eslint-plugin-package-json": "^0.56.3",
"express-basic-auth": "^1.2.1", "express-basic-auth": "^1.2.1",
"husky": "^9.1.7", "husky": "^9.1.7",
"jest": "^30.1.3", "jest": "^30.1.3",
"jsdom": "^27.0.0", "jsdom": "^27.0.0",
"lint-staged": "^16.1.6", "lint-staged": "^16.2.0",
"markdownlint-cli2": "^0.18.1", "markdownlint-cli2": "^0.18.1",
"playwright": "^1.55.0", "playwright": "^1.55.0",
"prettier": "^3.6.2", "prettier": "^3.6.2",
@@ -117,7 +117,7 @@
"stylelint-prettier": "^5.0.3" "stylelint-prettier": "^5.0.3"
}, },
"optionalDependencies": { "optionalDependencies": {
"electron": "^38.1.0" "electron": "^38.1.2"
}, },
"engines": { "engines": {
"node": ">=22.18.0" "node": ">=22.18.0"