mirror of
https://github.com/MichMich/MagicMirror.git
synced 2025-06-27 11:50:00 +00:00
Update documentation and help screen about invalid config files
This commit is contained in:
parent
1fd506f25d
commit
58939bfd8c
2
.github/ISSUE_TEMPLATE.md
vendored
2
.github/ISSUE_TEMPLATE.md
vendored
@ -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)
|
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
|
## 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:
|
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:
|
||||||
|
@ -20,6 +20,7 @@ _This release is scheduled to be released on 2021-04-01._
|
|||||||
- Cleaned up old code on server side.
|
- Cleaned up old code on server side.
|
||||||
- Convert `-0` to `0` when displaying temperature.
|
- Convert `-0` to `0` when displaying temperature.
|
||||||
- Code cleanup for FEELS like and added {DEGREE} placeholder for FEELSLIKE for each language
|
- Code cleanup for FEELS like and added {DEGREE} placeholder for FEELSLIKE for each language
|
||||||
|
- Update documentation and help screen about invalid config files
|
||||||
|
|
||||||
### Removed
|
### Removed
|
||||||
|
|
||||||
|
@ -49,7 +49,7 @@ function App() {
|
|||||||
let nodeHelpers = [];
|
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.
|
* callback with the found config as argument.
|
||||||
*
|
*
|
||||||
* @param {Function} callback Function to be called after loading the config
|
* @param {Function} callback Function to be called after loading the config
|
||||||
@ -154,6 +154,9 @@ function App() {
|
|||||||
function loadModules(modules, callback) {
|
function loadModules(modules, callback) {
|
||||||
Log.log("Loading module helpers ...");
|
Log.log("Loading module helpers ...");
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
*/
|
||||||
function loadNextModule() {
|
function loadNextModule() {
|
||||||
if (modules.length > 0) {
|
if (modules.length > 0) {
|
||||||
const nextModule = modules[0];
|
const nextModule = modules[0];
|
||||||
|
@ -43,7 +43,7 @@ var defaults = {
|
|||||||
module: "helloworld",
|
module: "helloworld",
|
||||||
position: "middle_center",
|
position: "middle_center",
|
||||||
config: {
|
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",
|
position: "middle_center",
|
||||||
classes: "xsmall",
|
classes: "xsmall",
|
||||||
config: {
|
config: {
|
||||||
text: "If you get this message while your config file is already<br>created, your config file probably contains an error.<br>Use a JavaScript linter to validate your file."
|
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>"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
Loading…
x
Reference in New Issue
Block a user