diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index ec904eff..c09454eb 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -6,6 +6,8 @@ If you're not sure if it's a real bug or if it's just you, please open a topic o Problems installing or configuring your MagicMirror? Check out: [https://forum.magicmirror.builders/category/10/troubleshooting](https://forum.magicmirror.builders/category/10/troubleshooting) +A common problem is that your config file could be invalid. Please run in your MagicMirror directory: `npm run config:check` and see if it reports an error. + ## I found a bug in the MagicMirror installer If you are facing an issue or found a bug while trying to install MagicMirror via the installer please report it in the respective GitHub repository: diff --git a/CHANGELOG.md b/CHANGELOG.md index 652a61d9..3f2ad6f3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,6 +23,7 @@ _This release is scheduled to be released on 2021-04-01._ - Convert `-0` to `0` when displaying temperature. - Code cleanup for FEELS like and added {DEGREE} placeholder for FEELSLIKE for each language - Converted newsfeed module to use templates. +- Update documentation and help screen about invalid config files. ### Removed diff --git a/js/app.js b/js/app.js index 240fdc23..9cec4902 100644 --- a/js/app.js +++ b/js/app.js @@ -49,7 +49,7 @@ function App() { let nodeHelpers = []; /** - * Loads the config file. Combines it with the defaults, and runs the + * Loads the config file. Combines it with the defaults, and runs the * callback with the found config as argument. * * @param {Function} callback Function to be called after loading the config @@ -154,6 +154,9 @@ function App() { function loadModules(modules, callback) { Log.log("Loading module helpers ..."); + /** + * + */ function loadNextModule() { if (modules.length > 0) { const nextModule = modules[0]; diff --git a/js/defaults.js b/js/defaults.js index b674b7fe..8a890bc5 100644 --- a/js/defaults.js +++ b/js/defaults.js @@ -43,7 +43,7 @@ var defaults = { module: "helloworld", position: "middle_center", config: { - text: "Please create a config file." + text: "Please create a config file or check the existing one for errors." } }, { @@ -59,7 +59,7 @@ var defaults = { position: "middle_center", classes: "xsmall", config: { - text: "If you get this message while your config file is already
created, your config file probably contains an error.
Use a JavaScript linter to validate your file." + text: "If you get this message while your config file is already created,
" + "it probably contains an error. To validate your config file run in your MagicMirror directory
" + "
npm run config:check
" } }, {