mirror of
https://github.com/MichMich/MagicMirror.git
synced 2025-07-10 15:43:34 -04:00
## [2.32.0] - 2025-07-01 Thanks to: @bughaver, @bugsounet, @khassel, @KristjanESPERANTO, @plebcity, @rejas, @sdetweil. > ⚠️ This release needs nodejs version `v22.14.0 or higher` ### Added - [config] Allow to change module order for final renderer (or dynamically with CSS): Feature `order` in config (#3762) - [clock] Added option 'disableNextEvent' to hide next sun event (#3769) - [clock] Implement short syntax for clock week (#3775) ### Changed - [refactor] Simplify module loading process (#3766) - Use `node --run` instead of `npm run` (#3764) and adapt `start:dev` script (#3773) - [workflow] Run linter and spellcheck with LTS node version (#3767) - [workflow] Split "Run test" step into two steps for more clarity (#3767) - [linter] Review linter setup (#3783) - Fix command to lint markdown in `CONTRIBUTING.md` - Re-activate JSDoc linting and fix linting issues - Refactor ESLint config to use `defineConfig` and `globalIgnores` - Replace `eslint-plugin-import` with `eslint-plugin-import-x` - Switch Stylelint config to flat format and simplify Stylelint scripts - [workflow] Replace Node.js version v23 with v24 (#3770) - [refactor] Replace deprecated constants `fs.F_OK` and `fs.R_OK` (#3789) - [refactor] Replace `ansis` with built-in function `util.styleText` (#3793) - [core] Integrate stuff from `vendor` and `fonts` folders into main `package.json`, simplifies install and maintaining dependencies (#3795, #3805) - [l10n] Complete translations (with the help of translation tools) (#3794) - [refactor] Refactored `calendarfetcherutils` in Calendar module to handle timezones better (#3806) - Removed as many of the date conversions as possible - Use `moment-timezone` when calculating recurring events, this will fix problems from the past with offsets and DST not being handled properly - Added some tests to test the behavior of the refactored methods to make sure the correct event dates are returned - [linter] Enable ESLint rule `no-console` and replace `console` with `Log` in some files (#3810) - [tests] Review and refactor translation tests (#3792) ### Fixed - [fix] Handle spellcheck issues (#3783) - [calendar] fix fullday event rrule until with timezone offset (#3781) - [feat] Add rule `no-undef` in config file validation to fix #3785 (#3786) - [fonts] Fix `roboto.css` to avoid error message `Unknown descriptor 'var(' in @font-face rule.` in firefox console (#3787) - [tests] Fix and refactor e2e test `Same keys` in `translations_spec.js` (#3809) - [tests] Fix e2e tests newsfeed and calendar to exit without open handles (#3817) ### Updated - [core] Update dependencies including electron to v36 (#3774, #3788, #3811, #3804, #3815, #3823) - [core] Update package type to `commonjs` - [logger] Review factory code part: use `switch/case` instead of `if/else if` (#3812) --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Michael Teeuw <michael@xonaymedia.nl> Co-authored-by: Kristjan ESPERANTO <35647502+KristjanESPERANTO@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Ross Younger <crazyscot@gmail.com> Co-authored-by: Veeck <github@veeck.de> Co-authored-by: Bugsounet - Cédric <github@bugsounet.fr> Co-authored-by: jkriegshauser <joshuakr@nvidia.com> Co-authored-by: illimarkangur <116028111+illimarkangur@users.noreply.github.com> Co-authored-by: sam detweiler <sdetweil@gmail.com> Co-authored-by: vppencilsharpener <tim.pray@gmail.com> Co-authored-by: veeck <michael.veeck@nebenan.de> Co-authored-by: Paranoid93 <6515818+Paranoid93@users.noreply.github.com> Co-authored-by: Brian O'Connor <btoconnor@users.noreply.github.com> Co-authored-by: WallysWellies <59727507+WallysWellies@users.noreply.github.com> Co-authored-by: Jason Stieber <jrstieber@gmail.com> Co-authored-by: jargordon <50050429+jargordon@users.noreply.github.com> Co-authored-by: Daniel <32464403+dkallen78@users.noreply.github.com> Co-authored-by: Ryan Williams <65094007+ryan-d-williams@users.noreply.github.com> Co-authored-by: Panagiotis Skias <panagiotis.skias@gmail.com> Co-authored-by: Marc Landis <dirk.rettschlag@gmail.com> Co-authored-by: HeikoGr <20295490+HeikoGr@users.noreply.github.com> Co-authored-by: Pedro Lamas <pedrolamas@gmail.com> Co-authored-by: veeck <gitkraken@veeck.de> Co-authored-by: Magnus <34011212+MagMar94@users.noreply.github.com> Co-authored-by: Ikko Eltociear Ashimine <eltociear@gmail.com> Co-authored-by: DevIncomin <56730075+Developer-Incoming@users.noreply.github.com> Co-authored-by: Nathan <n8nyoung@gmail.com> Co-authored-by: mixasgr <mixasgr@users.noreply.github.com> Co-authored-by: Savvas Adamtziloglou <savvas-gr@greeklug.gr> Co-authored-by: Konstantinos <geraki@gmail.com> Co-authored-by: OWL4C <124401812+OWL4C@users.noreply.github.com> Co-authored-by: BugHaver <43462320+bughaver@users.noreply.github.com> Co-authored-by: BugHaver <43462320+lsaadeh@users.noreply.github.com> Co-authored-by: Koen Konst <koenspero@gmail.com> Co-authored-by: Koen Konst <c.h.konst@avisi.nl>
136 lines
3.6 KiB
JavaScript
136 lines
3.6 KiB
JavaScript
const path = require("node:path");
|
|
const fs = require("node:fs");
|
|
const { styleText } = require("node:util");
|
|
const Ajv = require("ajv");
|
|
const globals = require("globals");
|
|
const { Linter } = require("eslint");
|
|
|
|
const rootPath = path.resolve(`${__dirname}/../`);
|
|
const Log = require(`${rootPath}/js/logger.js`);
|
|
const Utils = require(`${rootPath}/js/utils.js`);
|
|
|
|
const linter = new Linter({ configType: "flat" });
|
|
const ajv = new Ajv();
|
|
|
|
/**
|
|
* Returns a string with path of configuration file.
|
|
* Check if set by environment variable MM_CONFIG_FILE
|
|
* @returns {string} path and filename of the config file
|
|
*/
|
|
function getConfigFile () {
|
|
// FIXME: This function should be in core. Do you want refactor me ;) ?, be good!
|
|
return path.resolve(process.env.MM_CONFIG_FILE || `${rootPath}/config/config.js`);
|
|
}
|
|
|
|
/**
|
|
* Checks the config file using eslint.
|
|
*/
|
|
function checkConfigFile () {
|
|
const configFileName = getConfigFile();
|
|
|
|
// Check if file is present
|
|
if (fs.existsSync(configFileName) === false) {
|
|
throw new Error(`File not found: ${configFileName}\nNo config file present!`);
|
|
}
|
|
|
|
// Check permission
|
|
try {
|
|
fs.accessSync(configFileName, fs.constants.F_OK);
|
|
} catch (error) {
|
|
throw new Error(`${error}\nNo permission to access config file!`);
|
|
}
|
|
|
|
// Validate syntax of the configuration file.
|
|
Log.info(`Checking config file ${configFileName} ...`);
|
|
|
|
// I'm not sure if all ever is utf-8
|
|
const configFile = fs.readFileSync(configFileName, "utf-8");
|
|
|
|
const errors = linter.verify(
|
|
configFile,
|
|
{
|
|
languageOptions: {
|
|
ecmaVersion: "latest",
|
|
globals: {
|
|
...globals.node
|
|
}
|
|
},
|
|
rules: { "no-undef": "error" }
|
|
},
|
|
configFileName
|
|
);
|
|
|
|
if (errors.length === 0) {
|
|
Log.info(styleText("green", "Your configuration file doesn't contain syntax errors :)"));
|
|
validateModulePositions(configFileName);
|
|
} else {
|
|
let errorMessage = "Your configuration file contains syntax errors :(";
|
|
|
|
for (const error of errors) {
|
|
errorMessage += `\nLine ${error.line} column ${error.column}: ${error.message}`;
|
|
}
|
|
throw new Error(errorMessage);
|
|
}
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param {string} configFileName - The path and filename of the configuration file to validate.
|
|
*/
|
|
function validateModulePositions (configFileName) {
|
|
Log.info("Checking modules structure configuration ...");
|
|
|
|
const positionList = Utils.getModulePositions();
|
|
|
|
// Make Ajv schema configuration of modules config
|
|
// Only scan "module" and "position"
|
|
const schema = {
|
|
type: "object",
|
|
properties: {
|
|
modules: {
|
|
type: "array",
|
|
items: {
|
|
type: "object",
|
|
properties: {
|
|
module: {
|
|
type: "string"
|
|
},
|
|
position: {
|
|
type: "string",
|
|
enum: positionList
|
|
}
|
|
},
|
|
required: ["module"]
|
|
}
|
|
}
|
|
}
|
|
};
|
|
|
|
// Scan all modules
|
|
const validate = ajv.compile(schema);
|
|
const data = require(configFileName);
|
|
|
|
const valid = validate(data);
|
|
if (valid) {
|
|
Log.info(styleText("green", "Your modules structure configuration doesn't contain errors :)"));
|
|
} else {
|
|
const module = validate.errors[0].instancePath.split("/")[2];
|
|
const position = validate.errors[0].instancePath.split("/")[3];
|
|
let errorMessage = "This module configuration contains errors:";
|
|
errorMessage += `\n${JSON.stringify(data.modules[module], null, 2)}`;
|
|
if (position) {
|
|
errorMessage += `\n${position}: ${validate.errors[0].message}`;
|
|
errorMessage += `\n${JSON.stringify(validate.errors[0].params.allowedValues, null, 2).slice(1, -1)}`;
|
|
} else {
|
|
errorMessage += validate.errors[0].message;
|
|
}
|
|
Log.error(errorMessage);
|
|
}
|
|
}
|
|
|
|
try {
|
|
checkConfigFile();
|
|
} catch (error) {
|
|
Log.error(error.message);
|
|
process.exit(1);
|
|
}
|