Add cspell, fix typos and format (#282)

* var -> let/const

* Install cspell, fix typos, remove trailing spaces, run prettier

* Update year, Use uppercase for filename

Author: KristjanESPERANTO

about/license.md renamed to about/LICENSE.md

@@ -4,7 +4,7 @@ title: License
 
 # 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 files (the “Software”), to deal in

about/donate.md

@@ -1,6 +1,6 @@
 # Donate
 
-MagicMirror² is opensource and free. That doesn't mean we don't need any money.
+MagicMirror² is open source and free. That doesn't mean we don't need any money.
 
 Please consider a donation to help us cover the ongoing costs like webservers
 and email services. If we receive enough donations we might even be able to free

configuration/introduction.md

@@ -1,6 +1,6 @@
 # Introduction
 
-### Basic Configuration of MagicMirror²
+## Basic Configuration of MagicMirror²
 
 1. Go to your configuration directory: In Bash/linux, it'll be in
    `~/MagicMirror/config/`
@@ -28,7 +28,7 @@
    [installation](/getting-started/installation.md) if you're not sure how to do
    so.
 
-### More useful configuration of your MagicMirror
+## More useful configuration of your MagicMirror
 
 These directions assume a linux/bash style command line, and previous
 instructions followed. If not, please insert the path directly from your
@@ -73,10 +73,10 @@ are:
 | Environment Variable Name | Use                                                                                                                                                                                                                                                                                                                                  |
 | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | MM_CONFIG_FILE            | This specifies an alternate configuration file for the system. This is useful when running multiple mirrors on the same device. This does not work with the template option below. NOTE: this file **_MUST_** be located in a directory within the MagicMirror directory. Ideally, place any config file in the config subdirectory. |
-| MM_PORT                   | This specifies an alternate TCPIP port, overriding "port" item within the config file. This is useful for testing to see if the product will run using another port.                                                                                                                                                                 |
+| MM_PORT                   | This specifies an alternate TCP/IP port, overriding "port" item within the config file. This is useful for testing to see if the product will run using another port.                                                                                                                                                                |
 | mmFetchTimeout            | time in milliseconds for fetch timeout. default (30000) <br><br>this value can be used to adjust the nodejs fetch function timeout value (default 10 seconds) for all node_helper modules that use fetch()                                                                                                                           |
 
-##### Examples of use:
+#### Examples of use
 
 You have created two config files, named config.js and config2.js
 
@@ -111,12 +111,12 @@ export MM_CONFIG_FILE=config/config2.js
 npm run config:check
 ```
 
-```
+```log
 [26.12.2023 18:13.12.972] [INFO]  Checking file...  /home/<user>/MagicMirror/config/config2.js
 [26.12.2023 18:13.13.062] [INFO]  Your configuration file doesn't contain syntax errors :)
 ```
 
-#### Configuration Template system:
+### Configuration Template system
 
 `config.js.template` can be used instead of `config.js`. This allows you to use
 variables to replace hardcoded options. When starting MagicMirror² a `config.js`
@@ -155,37 +155,37 @@ if (typeof module !== "undefined") {
 }
 ```
 
-##### Defining variables:
+#### Defining variables
 
 There are 2 ways to define variables, you can mix as needed or desired. If a
 variable is defined in both ways the linux environment variable is used.
 
-##### Using a `config.env` file
+#### Using a `config.env` file
 
 This file must be in the same folder as the `config.js.template` and contains
 the variables, using the example from above:
 
 File content of `config.env`:
 
-```
+```log
 MY_ADDRESS=localhost
-MYPORT=8080
+MY_PORT=8080
 MY_HTTPS=false
 ```
 
-##### Using linux environment variables
+#### Using linux environment variables
 
 define them before you start MagicMirror², in a bash script, for example:
 
 ```bash
 cd ~/MagicMirror
 export MY_ADDRESS=localhost
-export MYPORT=8080
+export MY_PORT=8080
 export MY_HTTPS=false
 npm start
 ```
 
-#### Using `electronOptions`:
+### Using `electronOptions`
 
 The most common use for `electronOptions` is a dual monitor setup on a Raspberry
 Pi 4 or greater. To do so, you can launch a second MagicMirror and use
@@ -197,14 +197,14 @@ You have two 1920x1080 monitors set up in the Pi as sitting next to each other:
 To move the pi to the second monitor, use this:
 
 ```js
-var config = {
+let config = {
 	electronOptions: { x: 1920 },
 	...
 ```
 
-#### A Couple of Real World Examples:
+### A Couple of Real World Examples
 
-##### Two Screens:
+#### Two Screens
 
 A user has two monitors running on a Pi4B. User wants to show cameras on one
 monitor, and wants to show informational panels on the other. Monitors are set
@@ -231,7 +231,7 @@ npm start
 Configuration file 1 (config.js):
 
 ```js
-var config = {
+let config = {
 	address: "0.0.0.0", // Can be whatever you set as your original.
 	port: 8080, // Must be different than the other configuration file.
 	ipWhitelist: [], // Can be whatever you set as your original.
@@ -252,7 +252,7 @@ if (typeof module !== "undefined") {
 Configuration file 2 (config2.js):
 
 ```js
-var config = {
+let config = {
 	electronOptions: { x: 1920 },
 	address: "0.0.0.0", // can be whatever you set as your original.
 	port: 8081, // Must be different than the other configuration file.
@@ -271,7 +271,7 @@ if (typeof module !== "undefined") {
 }
 ```
 
-##### config.js.template example:
+#### config.js.template example
 
 User likes to help German language users in the forums. As such, he wants to be
 able to paste bits of his config.js into the forums to show as an example, but

cspell.config.json

@@ -0,0 +1,44 @@
+{
+  "version": "0.2",
+  "language": "en",
+  "words": [
+    "anyfileorfolder",
+    "apikey",
+    "clientonly",
+    "iconset",
+    "infobars",
+    "LXDE",
+    "lxpanel",
+    "lxsession",
+    "magicmirror",
+    "MAPBOX",
+    "meteo",
+    "modulename",
+    "newsfeed",
+    "nohup",
+    "päästä",
+    "Päättyy",
+    "pcmanfm",
+    "sdetweil",
+    "serveronly",
+    "Slutar",
+    "STRAVA",
+    "Subclassable",
+    "subclassing",
+    "Teeuw",
+    "Termine",
+    "weatherutils",
+    "xscreensaver",
+    "yourprovider"
+  ],
+  "ignorePaths": [
+    "node_modules/**",
+    "modules/**",
+    "vendor/node_modules/**",
+    "translations/**",
+    "tests/mocks/**",
+    "tests/e2e/modules/clock_es_spec.js",
+    "fonts/roboto.css"
+  ],
+  "dictionaries": ["node"]
+}

development/core-module-file.md

@@ -22,7 +22,7 @@ Module.register("helloworld", {
 
   // Override dom generator.
   getDom: function () {
-    var wrapper = document.createElement("div");
+    const wrapper = document.createElement("div");
     wrapper.innerHTML = this.config.text;
     return wrapper;
   },
@@ -136,7 +136,7 @@ getScripts: function() {
 	return [
 		'script.js', // will try to load it from the vendor folder, otherwise it will load is from the module folder.
 		'moment.js', // this file is available in the vendor folder, so it doesn't need to be available in the module folder.
-		this.file('anotherfile.js'), // this file will be loaded straight from the module folder.
+		this.file('another_file.js'), // this file will be loaded straight from the module folder.
 		'https://code.jquery.com/jquery-2.2.3.min.js',  // this file will be loaded from the jquery servers.
 	]
 }
@@ -163,8 +163,8 @@ getStyles: function() {
 	return [
 		'script.css', // will try to load it from the vendor folder, otherwise it will load is from the module folder.
 		'font-awesome.css', // this file is available in the vendor folder, so it doesn't need to be available in the module folder.
-		this.file('anotherfile.css'), // this file will be loaded straight from the module folder.
-		'https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css',  // this file will be loaded from the bootstrapcdn servers.
+		this.file('another_file.css'), // this file will be loaded straight from the module folder.
+		'https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css',  // this file will be loaded from the bootstrap cdn servers.
 	]
 }
 
@@ -209,7 +209,7 @@ object.
 
 ```javascript
 getDom: function() {
-	var wrapper = document.createElement("div");
+	const wrapper = document.createElement("div");
 	wrapper.innerHTML = 'Hello world!';
 	return wrapper;
 }
@@ -343,7 +343,7 @@ As an example: the clock modules calls this method every second:
 ```javascript
 ...
 start: function() {
-	var self = this;
+	let self = this;
 	setInterval(function() {
 		self.updateDom(); // no speed defined, so it updates instantly.
 	}, 1000); //perform every 1000 milliseconds.
@@ -376,7 +376,7 @@ As an example:
       speed: 1000, // animation duration
       animate: {
         in: "backInDown", // animation when module shown (after update)
-        out: "backOutUp" // animatation when module will hide (before update)
+        out: "backOutUp" // animation when module will hide (before update)
       }
     }
   })
@@ -398,7 +398,7 @@ the sendNotification method.
 **Example:**
 
 ```javascript
-this.sendNotification("MYMODULE_READY_FOR_ACTION", { foo: bar });
+this.sendNotification("MY_MODULE_READY_FOR_ACTION", { foo: bar });
 ```
 
 ### `this.sendSocketNotification(notification, payload)`
@@ -434,7 +434,7 @@ you can also hide another module using `anOtherModule.hide()`.
 Possible configurable options:
 
 - `lockString` - String - When setting lock string, the module can not be shown
-  without passing the correct lockstring. This way (multiple) modules can
+  without passing the correct lock string. This way (multiple) modules can
   prevent a module from showing. It's considered best practice to use your
   modules identifier as the locksString: `this.identifier`. See _visibility
   locking_ below.
@@ -473,7 +473,7 @@ you can also show another module using `anOtherModule.show()`.
 Possible configurable options:
 
 - `lockString` - String - When setting lock string, the module can not be shown
-  without passing the correct lockstring. This way (multiple) modules can
+  without passing the correct lock string. This way (multiple) modules can
   prevent a module from showing. See _visibility locking_ below.
 - `force` - Boolean - When setting the force tag to `true`, the locking
   mechanism will be overwritten. Use this option with caution. It's considered
@@ -568,7 +568,7 @@ moduleA.hidden == false;
 moduleA.show(0, { force: true });
 ```
 
-This will reset the lockstring array, and will show the module.
+This will reset the lockStrings array, and will show the module.
 
 ```javascript
 moduleA.lockStrings == [];
@@ -635,7 +635,7 @@ translator to change the word order in the sentence to be translated.
 **Example:**
 
 ```javascript
-var timeUntilEnd = moment(event.endDate, "x").fromNow(true);
+const timeUntilEnd = moment(event.endDate, "x").fromNow(true);
 this.translate("RUNNING", { "timeUntilEnd": timeUntilEnd) }); // Will return a translated string for the identifier RUNNING, replacing `{timeUntilEnd}` with the contents of the variable `timeUntilEnd` in the order that translator intended.
 ```
 
@@ -663,7 +663,7 @@ did not support the word order, it is recommended to have the fallback layout.
 **Example:**
 
 ```javascript
-var timeUntilEnd = moment(event.endDate, "x").fromNow(true);
+const timeUntilEnd = moment(event.endDate, "x").fromNow(true);
 this.translate("RUNNING", {
 	"fallback": this.translate("RUNNING") + " {timeUntilEnd}"
 	"timeUntilEnd": timeUntilEnd

development/helper-methods.md

@@ -34,9 +34,9 @@ the `withClass(classname)` method can be an array, or space separated string.
 **Examples:**
 
 ```javascript
-var modules = MM.getModules().withClass("classname");
-var modules = MM.getModules().withClass("classname1 classname2");
-var modules = MM.getModules().withClass(["classname1", "classname2"]);
+let modules = MM.getModules().withClass("classname");
+let modules = MM.getModules().withClass("classname1 classname2");
+let modules = MM.getModules().withClass(["classname1", "classname2"]);
 ```
 
 #### `.exceptWithClass(classnames)`
@@ -52,9 +52,9 @@ string.
 **Examples:**
 
 ```javascript
-var modules = MM.getModules().exceptWithClass("classname");
-var modules = MM.getModules().exceptWithClass("classname1 classname2");
-var modules = MM.getModules().exceptWithClass(["classname1", "classname2"]);
+let modules = MM.getModules().exceptWithClass("classname");
+let modules = MM.getModules().exceptWithClass("classname1 classname2");
+let modules = MM.getModules().exceptWithClass(["classname1", "classname2"]);
 ```
 
 #### `.exceptModule(module)`
@@ -70,17 +70,17 @@ the instance of your module.
 **Examples:**
 
 ```javascript
-var modules = MM.getModules().exceptModule(this);
+let modules = MM.getModules().exceptModule(this);
 ```
 
 Of course, you can combine all of the above filters:
 
 **Example:**
 
 ```javascript
-var modules = MM.getModules()
+let modules = MM.getModules()
   .withClass("classname1")
-  .exceptwithClass("classname2")
+  .exceptWithClass("classname2")
   .exceptModule(aModule);
 ```
 

development/node-helper.md

@@ -164,7 +164,10 @@ this.sendSocketNotification("SET_CONFIG", this.config);
 ```
 
 ::: warning Reminder
-`sendSocketNotification` sends a notification from the helper to all the instances of your module.
+
+`sendSocketNotification` sends a notification from the helper to all the
+instances of your module.
+
 :::
 
 ## Using native node modules in your node_helper

development/notifications.md

@@ -37,7 +37,7 @@ These notifications are sent by the default modules:
 | `ARTICLE_PREVIOUS`     | _none_                                                                                                                 | Shows the previous news title in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/newsfeed).                                                                             |
 | `ARTICLE_MORE_DETAILS` | _none_                                                                                                                 | Shows more details in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/newsfeed).                                                                                        |
 | `ARTICLE_LESS_DETAILS` | _none_                                                                                                                 | Hides the summary or full news article and only displays the news title of the currently viewed news item in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/newsfeed). |
-| `ARTICLE_TOGGLE_FULL`  | _none_                                                                                                                 | Toogles article in fullscreen in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/newsfeed).                                                                             |
+| `ARTICLE_TOGGLE_FULL`  | _none_                                                                                                                 | Toggles article in fullscreen in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/newsfeed).                                                                             |
 
 # 3rd Party Module notifications