Merge pull request #2873 from MichMich/develop

v2.20.0

.eslintrc.json

@@ -16,7 +16,7 @@
 	},
 	"parserOptions": {
 		"sourceType": "module",
-		"ecmaVersion": 2017,
+		"ecmaVersion": 2020,
 		"ecmaFeatures": {
 			"globalReturn": true
 		}
@@ -25,6 +25,7 @@
 		"prettier/prettier": "error",
 		"eqeqeq": "error",
 		"no-prototype-builtins": "off",
-		"no-unused-vars": "off"
+		"no-unused-vars": "off",
+		"no-useless-return": "error"
 	}
 }

.github/CONTRIBUTING.md

@@ -4,13 +4,15 @@ Thanks for contributing to MagicMirror²!
 
 We hold our code to standard, and these standards are documented below.
 
+## Linters
+
 If you wish to run our linters, use `npm run lint` without any arguments.
 
 ### JavaScript: Run ESLint
 
 We use [ESLint](https://eslint.org) on our JavaScript files.
 
-Our ESLint configuration is in our .eslintrc.json and .eslintignore files.
+Our ESLint configuration is in our `.eslintrc.json` and `.eslintignore` files.
 
 To run ESLint, use `npm run lint:js`.
 
@@ -18,9 +20,17 @@ To run ESLint, use `npm run lint:js`.
 
 We use [StyleLint](https://stylelint.io) to lint our CSS. Our configuration is in our .stylelintrc file.
 
-To run StyleLint, use `npm run lint:style`.
+To run StyleLint, use `npm run lint:css`.
 
-### Submitting Issues
+## Testing
+
+We use [Jest](https://jestjs.io) for JavaScript testing.
+
+To run all tests, use `npm run test`.
+
+The specific test commands are defined in `package.json`. So you can also run the specific tests with other commands, e.g. `npm run test:unit` or `npx jest tests/e2e/env_spec.js`.
+
+## Submitting Issues
 
 Please only submit reproducible issues.
 
@@ -32,9 +42,9 @@ When submitting a new issue, please supply the following information:
 
 **Platform**: Place your platform here... give us your web browser/Electron version _and_ your hardware (Raspberry Pi 2/3/4, Windows, Mac, Linux, System V UNIX).
 
-**Node Version**: Make sure it's version 10 or later.
+**Node Version**: Make sure it's version 14 or later (recommended is 16).
 
-**MagicMirror Version**: Now that the versions have split, tell us if you are using the PHP version (v1) or the newer JavaScript version (v2).
+**MagicMirror² Version**: Please let us know which version of MagicMirror² you are running. It can be found in the `package.json` file.
 
 **Description**: Provide a detailed description about the issue and include specific details to help us understand the problem. Adding screenshots will help describing the problem.
 

.github/FUNDING.yaml

@@ -0,0 +1,2 @@
+github: MichMich
+custom: ["https://magicmirror.builders/#donate"]

.github/FUNDING.yml

@@ -1,2 +0,0 @@
-github: MichMich
-custom: ['https://magicmirror.builders/#donate']

.github/ISSUE_TEMPLATE.md

@@ -10,17 +10,19 @@ 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.
+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:
 [https://github.com/sdetweil/MagicMirror_scripts](https://github.com/sdetweil/MagicMirror_scripts)
 
-## I found a bug in the MagicMirror Docker image
+## I found a bug in the MagicMirror² Docker image
 
-If you are facing an issue or found a bug while running MagicMirror inside a Docker container please create an issue in the GitHub repository of the MagicMirror Docker image:
-[https://github.com/bastilimbach/docker-MagicMirror](https://github.com/bastilimbach/docker-MagicMirror)
+If you are facing an issue or found a bug while running MagicMirror² inside a Docker container please create an issue in the corresponding repository:
+
+- karsten13/magicmirror: [https://gitlab.com/khassel/magicmirror](https://gitlab.com/khassel/magicmirror)
+- (deprecated) bastilimbach/docker-magicmirror: [https://github.com/bastilimbach/docker-MagicMirror](https://github.com/bastilimbach/docker-MagicMirror)
 
 ---
 
@@ -31,9 +33,9 @@ When submitting a new issue, please supply the following information:
 
 **Platform**: Place your platform here... give us your web browser/Electron version _and_ your hardware (Raspberry Pi 2/3/4, Windows, Mac, Linux, System V UNIX).
 
-**Node Version**: Make sure it's version 10 or later.
+**Node Version**: Make sure it's version 14 or later (recommended is 16).
 
-**MagicMirror Version**: Please let us now which version of MagicMirror you are running. It can be found in the `package.log` file.
+**MagicMirror² Version**: Please let us know which version of MagicMirror² you are running. It can be found in the `package.json` file.
 
 **Description**: Provide a detailed description about the issue and include specific details to help us understand the problem. Adding screenshots will help describing the problem.
 

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,24 +1,21 @@
-Hello and thank you for wanting to contribute to the MagicMirror project
+Hello and thank you for wanting to contribute to the MagicMirror² project
 
 **Please make sure that you have followed these 4 rules before submitting your Pull Request:**
 
-> 1) Base your pull requests against the `develop` branch.
+> 1. Base your pull requests against the `develop` branch.
 >
+> 2. Include these infos in the description:
 >
-> 2) Include these infos in the description:
->  * Does the pull request solve a **related** issue?
->  * If so, can you reference the issue like this `Fixes #<issue_number>`?
->  * What does the pull request accomplish? Use a list if needed.
->  * If it includes major visual changes please add screenshots.
+> - Does the pull request solve a **related** issue?
+> - If so, can you reference the issue like this `Fixes #<issue_number>`?
+> - What does the pull request accomplish? Use a list if needed.
+> - If it includes major visual changes please add screenshots.
 >
+> 3. Please run `npm run lint:prettier` before submitting so that
+>    style issues are fixed.
 >
-> 3) Please run `npm run lint:prettier` before submitting so that
-> style issues are fixed.
->
->
-> 4) Don't forget to add an entry about your changes to
-> the CHANGELOG.md file.
-
+> 4. Don't forget to add an entry about your changes to
+>    the CHANGELOG.md file.
 
 **Note**: Sometimes the development moves very fast. It is highly
 recommended that you update your branch of `develop` before creating a

.github/dependabot.yaml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/automated-tests.yaml

@@ -0,0 +1,39 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: "Run Automated Tests"
+
+on:
+  push:
+    branches: [master, develop]
+  pull_request:
+    branches: [master, develop]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    strategy:
+      matrix:
+        node-version: [14.x, 16.x, 18.x]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "npm"
+      - name: Install dependencies and run tests
+        run: |
+          Xvfb :99 -screen 0 1024x768x16 &
+          export DISPLAY=:99
+          npm install
+          touch css/custom.css
+          npm run test:prettier
+          npm run test:js
+          npm run test:css
+          npm run test

.github/workflows/codecov-test-suites.yaml

@@ -0,0 +1,33 @@
+# This workflow runs the automated test and uploads the coverage results to codecov.io
+# For more information see: https://github.com/codecov/codecov-action
+
+name: "Run Codecov Tests"
+
+on:
+  push:
+    branches: [master, develop]
+  pull_request:
+    branches: [master, develop]
+
+permissions:
+  contents: read
+
+jobs:
+  run-and-upload-coverage-report:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Install dependencies and run coverage
+        run: |
+          Xvfb :99 -screen 0 1024x768x16 &
+          export DISPLAY=:99
+          npm ci
+          touch css/custom.css
+          npm run test:coverage
+      - name: Upload coverage results to codecov
+        uses: codecov/codecov-action@v2
+        with:
+          files: ./coverage/lcov.info
+          fail_ci_if_error: true

.github/workflows/codecov-test-suites.yml

@@ -1,25 +0,0 @@
-# This workflow runs the automated test and uploads the coverage results to codecov.io
-
-name: "Run Codecov Tests"
-
-on:
-  push:
-    branches: [ master, develop ]
-  pull_request:
-    branches: [ master, develop ]
-
-jobs:
-  run-and-upload-coverage-report:
-    runs-on: ubuntu-latest
-    timeout-minutes: 30
-    steps:
-      - uses: actions/checkout@v2
-      - run: |
-          Xvfb :99 -screen 0 1024x768x16 &
-          export DISPLAY=:99
-          npm ci
-          npm run test:coverage
-      - uses: codecov/codecov-action@v1
-        with:
-          file: ./coverage/lcov.info
-          fail_ci_if_error: true

.github/workflows/enforce-changelog.yaml

@@ -0,0 +1,19 @@
+# This workflow enforces the update of a changelog file on every pull request
+# For more information see: https://github.com/dangoslen/changelog-enforcer
+
+name: "Enforce Changelog"
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled]
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - name: Enforce changelog️
+        uses: dangoslen/changelog-enforcer@v3
+        with:
+          changeLogPath: "CHANGELOG.md"
+          skipLabels: "Skip Changelog"

.github/workflows/enforce-changelog.yml

@@ -1,18 +0,0 @@
-# This workflow enforces the update of a changelog file on every pull request
-
-name: "Enforce Changelog"
-
-on:
-  pull_request:
-      types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled]
-
-jobs:
-  check:
-    runs-on: ubuntu-latest
-    timeout-minutes: 10
-    steps:
-    - uses: actions/checkout@v2
-    - uses: dangoslen/changelog-enforcer@v1.6.1
-      with:
-        changeLogPath: 'CHANGELOG.md'
-        skipLabels: 'Skip Changelog'

.github/workflows/node-ci.js.yml

@@ -1,33 +0,0 @@
-# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
-name: "Run Automated Tests"
-
-on:
-  push:
-    branches: [ master, develop ]
-  pull_request:
-    branches: [ master, develop ]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    timeout-minutes: 30
-    strategy:
-      matrix:
-        node-version: [12.x, 14.x, 16.x]
-    steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-    - run: |
-        Xvfb :99 -screen 0 1024x768x16 &
-        export DISPLAY=:99
-        npm install
-        npm run test:prettier
-        npm run test:js
-        npm run test:css
-        npm run test:unit
-        npm run test:e2e

.husky/.gitignore

@@ -1 +0,0 @@
-_

.husky/pre-commit

@@ -1,4 +1,7 @@
 #!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
 
-npm run lint:staged
+[ -f "$(dirname "$0")/_/husky.sh" ] && . "$(dirname "$0")/_/husky.sh"
+
+if command -v npm &> /dev/null; then
+  npm run lint:staged
+fi

.prettierignore

@@ -1,8 +1,4 @@
 /config
 /coverage
-/vendor
-!/vendor/vendor.js
-.github
 .nyc_output
 package-lock.json
-*.ts

CHANGELOG.md

@@ -3,7 +3,146 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](https://semver.org/).
 
-❤️ **Donate:** Enjoying MagicMirror²? [Please consider a donation!](https://magicmirror.builders/donate) With your help we can continue to improve the MagicMirror²
+❤️ **Donate:** Enjoying MagicMirror²? [Please consider a donation!](https://magicmirror.builders/donate) With your help we can continue to improve the MagicMirror².
+
+## [2.20.0] - 2022-07-02
+
+Special thanks to the following contributors: @eouia, @khassel, @kolbyjack, @KristjanESPERANTO, @nathannaveen, @naveensrinivasan, @rejas, @rohitdharavath and @sdetweil.
+
+### Added
+
+- Added a new config option `httpHeaders` used by helmet (see https://helmetjs.github.io/). You can now set own httpHeaders which will override the defaults in `js/defauls.js` which is useful e.g. if you want to embed MagicMirror into annother website (solves #2847).
+- Show endDate for calendar events when dateHeader is enabled and showEnd is set to true (#2192).
+- Added the notification emitting from the weather module on infromation updated.
+- Use recommended file extention for YAML files (#2864).
+
+### Updated
+
+- Use latest node 18 when running tests on github actions.
+- Update `electron` to v19 and other dependencies.
+- Use internal fetch function of node instead external `node-fetch` library if used node version >= `v18`.
+- Include duplicate events in broadcasts.
+
+### Fixed
+
+- Fix problems with non latin fonds caused by updating to fontsource (fixes #2835).
+
+## [2.19.0] - 2022-04-01
+
+Special thanks to the following contributors: @10bias, @CFenner, @JHWelch, @k1rd3rf, @khassel, @kolbyjack, @krekos, @KristjanESPERANTO, @Nerfzooka, @oraclesean, @oscarb, @philnagel, @rejas, @sdetweil, @shin10, @SiderealArt and @Tom-Hirschberger.
+
+### Added
+
+- Added a config option under the weather module, `absoluteDates`, providing an option to format weather forecast date output with either absolute or relative dates.
+- Added test for new weather forecast `absoluteDates` property.
+- The modules get a class hidden added/removed if they get hidden/shown which will also toggle pointer-events.
+- Added new config option `showTitleAsUrl` to newsfeed module. If set, the displayed title is a link to the article which is useful when running in a browser and you want to read this article.
+- Added internal cors proxy to get weather providers working without public proxies (fixes #2714). The new url `http(s)://address:port/cors?url=https://whatever-to-proxy` can be used in other modules too.
+- Added a WeatherProvider for Weatherflow.
+- Added new env var `ELECTRON_DISABLE_GPU` which disable gpu under electron if set (fixes #2831).
+- Added missing Czech translations.
+
+### Updated
+
+- Deprecated roboto fonts package `roboto-fontface-bower` replaced with `fontsource`.
+- Update `electron` to v17, `helmet` to v5 (use defaults of v4) and other dependencies
+- Updates Font Awesome css class to new default style (fixes #2768)
+- Replaced deprecated modules `currentweather` and `weatherforecast` with dummy modules only displaying that they have to be replaced.
+- Include all calendar events from the configured date range when broadcasting.
+- Update Danish and German translation.
+- Update `node-ical` to v0.15 and added `luxon` as dependency for not breaking the "no-optional" install (see #2718 and #2824).
+
+### Fixed
+
+- Improved and speedup e2e tests, artificial wait after mm start removed.
+- Improved husky setup not blocking `git commit` if `husky` or `npm` is not installed.
+- Using a consistent spelling of MagicMirror².
+- Fix minor console output issue for loading translations (#2814).
+- Don't adjust startDate for full day events if endDate is in the past.
+- Fix windspeed conversion error in openweathermap provider. (#2812)
+- Fix conflicting parms turning off showEnd for full day events. (#2629)
+- Fix regression, calendar.maximumEntries not used to filter calendar level entries (#2868)
+
+## [2.18.0] - 2022-01-01
+
+Special thanks to the following contributors: @AmpioRosso, @eouia, @fewieden, @jupadin, @khassel, @kolbyjack, @KristjanESPERANTO, @MariusVaice, @rejas, @rico24 and @sdetweil.
+
+### Added
+
+- Added test for calendar recurring event with checks the correct date displayed (related to #2752).
+
+### Updated
+
+- ESLint version supports now ECMAScript 2018.
+- Cleaned up `updatenotification` module and switched to nunjuck template.
+- Moved calendar tests from category `electron` to `e2e`.
+- Update missed translations for Korean language (ko.json).
+- Update missed translations for Dutch language (nl.json).
+- Cleaned up `alert` module and switched to nunjuck template.
+- Moved weather tests from category `electron` to `e2e`.
+- Updated github actions.
+- Replace spectron with playwright, update dependencies including electron update to v16.
+- Added lithuanian language to translations.js.
+- Show info message if newsfeed is empty (fixes #2731).
+- Added dangerouslyDisableAutoEscaping config option for newsfeed templates (fixes #2712).
+- Added missing shebang to `installers/mm.sh`.
+- Node versions in templates and github workflows.
+- Updated translations for Traditional Chinese (Taiwan) (zh-tw.json).
+
+### Fixed
+
+- Fixed wrong file `kr.json` to `ko.json`. Use language code 'ko' instead of 'kr' for Korean language.
+- Fixed `feels_like` data from openweathermaps current weather being ignored (#2678).
+- Fixed chaotic newsfeed display after network connection loss thanks to @jalibu (#2638).
+- Fixed incorrect time zone correction of recurring full day events (#2632 and #2634).
+- Fixed e2e tests by increasing testTimeout.
+- Revert node-ical update due to missing luxon package.
+- Fixed User-Agent-Header for newsfeed and calendar module (#2729).
+- Replace broken shields in Readme and use https for links.
+- Fixed electron tests with retry.
+- Fixed Calendar recurring cross timezone error (add/subtract a day, not just offset hours) (#2632).
+- Fixed Calendar showEnd and Full Date overlay (#2629).
+- Fixed regression on #2632, #2752.
+- Broadcast custom symbols in CALENDAR_EVENTS.
+
+## [2.17.1] - 2021-10-01
+
+### Fixed
+
+- Fixed error when accessing letsencrypt certificates
+- Fixed Calendar module enhancement: displaying full events without time (#2424)
+
+## [2.17.0] - 2021-10-01
+
+Special thanks to the following contributors: @apiontek, @eouia, @jupadin, @khassel and @rejas.
+
+### Added
+
+- Added showTime parameter to clock module for enabling/disabling time display in analog clock.
+- Added custom electron switches from user config (`config.electronSwitches`).
+- Added unit tests for updatenotification module.
+
+### Updated
+
+- Bump electron to v13 (and spectron to v15) and update other dependencies in package.json.
+- Refactor test configs, use default test config for all tests.
+- Updated github templates.
+- Actually test all js and css files when lint script is run.
+- Update jsdocs and print warnings during testing too.
+- Update weathergov provider to try fetching not just current, but also foreacst, when API URLs available.
+- Refactored clock layout.
+- Refactored methods from weatherproviders into weatherobject (isDaytime, updateSunTime).
+- Use of `logger.js` in jest tests.
+- Run prettier over all relevant files.
+- Move tests needing electron in new category `electron`, use `server only` mode in `e2e` tests.
+- Update dependencies in package.json.
+
+### Fixed
+
+- Fix undefined error with ignoreToday option in weather module (#2620).
+- Fix time zone correction in calendar module when the date hour is equal to the time zone correction value (#2632).
+- Fix black cursor on startup when using electron.
+- Fix update notification not working for own repository (#2644).
 
 ## [2.16.0] - 2021-07-01
 
@@ -172,7 +311,7 @@ Special thanks to the following contributors: @Alvinger, @AndyPoms, @ashishtank,
 - Rename Greek translation to correct ISO 639-1 alpha-2 code (gr > el). (#2155)
 - Add a space after icons of sunrise and sunset. (#2169)
 - Fix calendar when no DTEND record found in event, startDate overlay when endDate set. (#2177)
-- Fix windspeed convertion error in ukmetoffice weather provider. (#2189)
+- Fix windspeed conversion error in ukmetoffice weather provider. (#2189)
 - Fix console.debug not having timestamps. (#2199)
 - Fix calendar full day event east of UTC start time. (#2200)
 - Fix non-fullday recurring rule processing. (#2216)
@@ -195,8 +334,8 @@ Special thanks to the following contributors: @bryanzzhu, @bugsounet, @chamakura
 ### Added
 
 - `--dry-run` Added option in fetch call within updatenotification node_helper. This is to prevent
-  MagicMirror from consuming any fetch result. Causes conflict with MMPM when attempting to check
-  for updates to MagicMirror and/or MagicMirror modules.
+  MagicMirror² from consuming any fetch result. Causes conflict with MMPM when attempting to check
+  for updates to MagicMirror² and/or MagicMirror² modules.
 - Test coverage with Istanbul, run it with `npm run test:coverage`.
 - Added lithuanian language.
 - Added support in weatherforecast for OpenWeather onecall API.
@@ -269,7 +408,7 @@ Special thanks to the following contributors: @AndreKoepke, @andrezibaia, @bryan
 
 🚨 READ THIS BEFORE UPDATING 🚨
 
-In the past years the project has grown a lot. This came with a huge downside: poor maintainability. If I let the project continue the way it was, it would eventually crash and burn. More important: I would completely lose the drive and interest to continue the project. Because of this the decision was made to simplify the core by removing all side features like automatic installers and support for exotic platforms. This release (2.11.0) is the first real release that will reflect (parts) of these changes. As a result of this, some things might break. So before you continue make sure to backup your installation. Your config, your modules or better yet: your full MagicMirror folder. In other words: update at your own risk.
+In the past years the project has grown a lot. This came with a huge downside: poor maintainability. If I let the project continue the way it was, it would eventually crash and burn. More important: I would completely lose the drive and interest to continue the project. Because of this the decision was made to simplify the core by removing all side features like automatic installers and support for exotic platforms. This release (2.11.0) is the first real release that will reflect (parts) of these changes. As a result of this, some things might break. So before you continue make sure to backup your installation. Your config, your modules or better yet: your full MagicMirror² folder. In other words: update at your own risk.
 
 For more information regarding this major change, please check issue [#1860](https://github.com/MichMich/MagicMirror/issues/1860).
 
@@ -412,6 +551,7 @@ Special thanks to @sdetweil for all his great contributions!
 - Update `ical.js` to solve various calendar issues.
 - Update weather city list url [#1676](https://github.com/MichMich/MagicMirror/issues/1676)
 - Only update clock once per minute when seconds aren't shown
+- Update weatherprovider documentation.
 
 ### Fixed
 
@@ -469,7 +609,7 @@ Fixed `package.json` version number.
 - Fixed unhandled error on bad git data in updatenotification module [#1285](https://github.com/MichMich/MagicMirror/issues/1285).
 - Weather forecast now works with openweathermap in new weather module. Daily data are displayed, see issue [#1504](https://github.com/MichMich/MagicMirror/issues/1504).
 - Fixed analogue clock border display issue where non-black backgrounds used (previous fix for issue 611)
-- Fixed compatibility issues caused when modules request different versions of Font Awesome, see issue [#1522](https://github.com/MichMich/MagicMirror/issues/1522). MagicMirror now uses [Font Awesome 5 with v4 shims included for backwards compatibility](https://fontawesome.com/how-to-use/on-the-web/setup/upgrading-from-version-4#shims).
+- Fixed compatibility issues caused when modules request different versions of Font Awesome, see issue [#1522](https://github.com/MichMich/MagicMirror/issues/1522). MagicMirror² now uses [Font Awesome 5 with v4 shims included for backwards compatibility](https://fontawesome.com/how-to-use/on-the-web/setup/upgrading-from-version-4#shims).
 - Installation script problems with raspbian
 - Calendar: only show repeating count if the event is actually repeating [#1534](https://github.com/MichMich/MagicMirror/pull/1534)
 - Calendar: Fix exdate handling when multiple values are specified (comma separated)
@@ -581,7 +721,7 @@ A huge, huge, huge thanks to user @fewieden for all his hard work on the new `we
 
 ## [2.4.0] - 2018-07-01
 
-⚠️ **Warning:** This release includes an updated version of Electron. This requires a Raspberry Pi configuration change to allow the best performance and prevent the CPU from overheating. Please read the information on the [MagicMirror Wiki](https://github.com/michmich/magicmirror/wiki/configuring-the-raspberry-pi#enable-the-open-gl-driver-to-decrease-electrons-cpu-usage).
+⚠️ **Warning:** This release includes an updated version of Electron. This requires a Raspberry Pi configuration change to allow the best performance and prevent the CPU from overheating. Please read the information on the [MagicMirror² Wiki](https://github.com/michmich/magicmirror/wiki/configuring-the-raspberry-pi#enable-the-open-gl-driver-to-decrease-electrons-cpu-usage).
 
 ℹ️ **Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install`
 
@@ -822,7 +962,7 @@ A huge, huge, huge thanks to user @fewieden for all his hard work on the new `we
 - Add use pm2 for manager process into Installer RaspberryPi script.
 - Russian Translation.
 - Afrikaans Translation.
-- Add postinstall script to notify user that MagicMirror installed successfully despite warnings from NPM.
+- Add postinstall script to notify user that MagicMirror² installed successfully despite warnings from NPM.
 - Init tests using mocha.
 - Option to use RegExp in Calendar's titleReplace.
 - Hungarian Translation.
@@ -885,7 +1025,7 @@ A huge, huge, huge thanks to user @fewieden for all his hard work on the new `we
 - Add VSCode IntelliSense support.
 - Module API: Add Visibility locking to module system. [See documentation](https://github.com/MichMich/MagicMirror/tree/develop/modules#visibility-locking) for more information.
 - Module API: Method to overwrite the module's header. [See documentation](https://github.com/MichMich/MagicMirror/tree/develop/modules#getheader) for more information.
-- Module API: Option to define the minimum MagicMirror version to run a module. [See documentation](https://github.com/MichMich/MagicMirror/tree/develop/modules#requiresversion) for more information.
+- Module API: Option to define the minimum MagicMirror² version to run a module. [See documentation](https://github.com/MichMich/MagicMirror/tree/develop/modules#requiresversion) for more information.
 - Calendar module now broadcasts the event list to all other modules using the notification system. [See documentation](https://github.com/MichMich/MagicMirror/tree/develop/modules/default/calendar) for more information.
 - Possibility to use the calendar feed as the source for the weather (currentweather & weatherforecast) location data. [See documentation](https://github.com/MichMich/MagicMirror/tree/develop/modules/default/weatherforecast) for more information.
 - Added option to show rain amount in the weatherforecast default module
@@ -1032,6 +1172,6 @@ It includes (but is not limited to) the following features:
 
 ## [1.0.0] - 2014-02-16
 
-### Initial release of MagicMirror.
+### Initial release of MagicMirror
 
 This was part of the blogpost: [https://michaelteeuw.nl/post/83916869600/magic-mirror-part-vi-production-of-the](https://michaelteeuw.nl/post/83916869600/magic-mirror-part-vi-production-of-the)

README.md

@@ -1,12 +1,17 @@
 ![MagicMirror²: The open source modular smart mirror platform. ](.github/header.png)
 
 <p style="text-align: center">
-	<a href="https://david-dm.org/MichMich/MagicMirror"><img src="https://david-dm.org/MichMich/MagicMirror.svg" alt="Dependency Status"></a>
-	<a href="https://david-dm.org/MichMich/MagicMirror?type=dev"><img src="https://david-dm.org/MichMich/MagicMirror/dev-status.svg" alt="devDependency Status"></a>
-	<a href="https://bestpractices.coreinfrastructure.org/projects/347"><img src="https://bestpractices.coreinfrastructure.org/projects/347/badge" alt="CLI Best Practices"></a>
-	<a href="https://codecov.io/gh/MichMich/MagicMirror"><img src="https://codecov.io/gh/MichMich/MagicMirror/branch/master/graph/badge.svg?token=LEG1KitZR6" alt="CodeCov Status"/></a>
-	<a href="https://choosealicense.com/licenses/mit"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License"></a>
-	<a href="https://github.com/MichMich/MagicMirror/actions?query=workflow%3A%22Automated+Tests%22"><img src="https://github.com/MichMich/MagicMirror/workflows/Automated%20Tests/badge.svg" alt="Tests"></a>
+  <a href="https://choosealicense.com/licenses/mit">
+		<img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License">
+	</a>
+	<img src="https://img.shields.io/github/workflow/status/michmich/magicmirror/Run%20Automated%20Tests" alt="GitHub Actions">
+	<img src="https://img.shields.io/github/checks-status/michmich/magicmirror/master" alt="Build Status">
+	<a href="https://codecov.io/gh/MichMich/MagicMirror">
+		<img src="https://codecov.io/gh/MichMich/MagicMirror/branch/master/graph/badge.svg?token=LEG1KitZR6" alt="CodeCov Status"/>
+	</a>
+	<a href="https://github.com/MichMich/MagicMirror">
+		<img src="https://img.shields.io/github/stars/michmich/magicmirror?style=social">
+	</a>
 </p>
 
 **MagicMirror²** is an open source modular smart mirror platform. With a growing list of installable modules, the **MagicMirror²** allows you to convert your hallway or bathroom mirror into your personal assistant. **MagicMirror²** is built by the creator of [the original MagicMirror](https://michaelteeuw.nl/tagged/magicmirror) with the incredible help of a [growing community of contributors](https://github.com/MichMich/MagicMirror/graphs/contributors).
@@ -35,7 +40,7 @@ Contributions of all kinds are welcome, not only in the form of code but also wi
 - documentation
 - translations
 
-For the full contribution guidelines, check out: [https://docs.magicmirror.builders/getting-started/contributing.html](https://docs.magicmirror.builders/getting-started/contributing.html)
+For the full contribution guidelines, check out: [https://docs.magicmirror.builders/about/contributing.html](https://docs.magicmirror.builders/about/contributing.html)
 
 ## Enjoying MagicMirror? Consider a donation!
 

config/config.js.sample

@@ -1,10 +1,10 @@
-/* Magic Mirror Config Sample
+/* MagicMirror² Config Sample
  *
  * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  *
  * For more information on how you can configure this file
- * see https://docs.magicmirror.builders/getting-started/configuration.html#general
+ * see https://docs.magicmirror.builders/configuration/introduction.html
  * and https://docs.magicmirror.builders/modules/configuration.html
  */
 let config = {
@@ -14,7 +14,7 @@ let config = {
 							// - "0.0.0.0", "::" to listen on any interface
 							// Default, when address config is left out or empty, is "localhost"
 	port: 8080,
-	basePath: "/", 	// The URL path where MagicMirror is hosted. If you are using a Reverse proxy
+	basePath: "/", 	// The URL path where MagicMirror² is hosted. If you are using a Reverse proxy
 					// you must set the sub path here. basePath must end with a /
 	ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"], 	// Set [] to allow all IP addresses
 															// or add a specific IPv4 of 192.168.1.5 :
@@ -57,7 +57,8 @@ let config = {
 				calendars: [
 					{
 						symbol: "calendar-check",
-						url: "webcal://www.calendarlabs.com/ical-calendar/ics/76/US_Holidays.ics"					}
+						url: "webcal://www.calendarlabs.com/ical-calendar/ics/76/US_Holidays.ics"
+					}
 				]
 			}
 		},

css/custom.css.sample

@@ -1,4 +1,4 @@
-/* Magic Mirror Custom CSS Sample
+/* MagicMirror² Custom CSS Sample
  *
  * Change color and fonts here.
  *

css/main.css

@@ -138,6 +138,14 @@ sup {
   margin-bottom: var(--gap-modules);
 }
 
+.module.hidden {
+  pointer-events: none;
+}
+
+.module:not(.hidden) {
+  pointer-events: auto;
+}
+
 .region.bottom .module {
   margin-top: var(--gap-modules);
   margin-bottom: 0;
@@ -170,10 +178,6 @@ sup {
   pointer-events: none;
 }
 
-.region.fullscreen * {
-  pointer-events: auto;
-}
-
 .region.right {
   right: 0;
   text-align: right;

fonts/package-lock.json

@@ -7,20 +7,31 @@
 			"name": "magicmirror-fonts",
 			"license": "MIT",
 			"dependencies": {
-				"roboto-fontface": "^0.10.0"
+				"@fontsource/roboto": "^4.5.7",
+				"@fontsource/roboto-condensed": "^4.5.8"
 			}
 		},
-		"node_modules/roboto-fontface": {
-			"version": "0.10.0",
-			"resolved": "https://registry.npmjs.org/roboto-fontface/-/roboto-fontface-0.10.0.tgz",
-			"integrity": "sha512-OlwfYEgA2RdboZohpldlvJ1xngOins5d7ejqnIBWr9KaMxsnBqotpptRXTyfNRLnFpqzX6sTDt+X+a+6udnU8g=="
+		"node_modules/@fontsource/roboto": {
+			"version": "4.5.7",
+			"resolved": "https://registry.npmjs.org/@fontsource/roboto/-/roboto-4.5.7.tgz",
+			"integrity": "sha512-m57UMER23Mk6Drg9OjtHW1Y+0KPGyZfE5XJoPTOsLARLar6013kJj4X2HICt+iFLJqIgTahA/QAvSn9lwF1EEw=="
+		},
+		"node_modules/@fontsource/roboto-condensed": {
+			"version": "4.5.8",
+			"resolved": "https://registry.npmjs.org/@fontsource/roboto-condensed/-/roboto-condensed-4.5.8.tgz",
+			"integrity": "sha512-HCuf1rVSOsXnl/KgHNRLCr8XS/Dunzn10BjhliJiEZ5qPynXCWH4RRBFupIODHamhj2Uyp/iZkSQp574luKp6A=="
 		}
 	},
 	"dependencies": {
-		"roboto-fontface": {
-			"version": "0.10.0",
-			"resolved": "https://registry.npmjs.org/roboto-fontface/-/roboto-fontface-0.10.0.tgz",
-			"integrity": "sha512-OlwfYEgA2RdboZohpldlvJ1xngOins5d7ejqnIBWr9KaMxsnBqotpptRXTyfNRLnFpqzX6sTDt+X+a+6udnU8g=="
+		"@fontsource/roboto": {
+			"version": "4.5.7",
+			"resolved": "https://registry.npmjs.org/@fontsource/roboto/-/roboto-4.5.7.tgz",
+			"integrity": "sha512-m57UMER23Mk6Drg9OjtHW1Y+0KPGyZfE5XJoPTOsLARLar6013kJj4X2HICt+iFLJqIgTahA/QAvSn9lwF1EEw=="
+		},
+		"@fontsource/roboto-condensed": {
+			"version": "4.5.8",
+			"resolved": "https://registry.npmjs.org/@fontsource/roboto-condensed/-/roboto-condensed-4.5.8.tgz",
+			"integrity": "sha512-HCuf1rVSOsXnl/KgHNRLCr8XS/Dunzn10BjhliJiEZ5qPynXCWH4RRBFupIODHamhj2Uyp/iZkSQp574luKp6A=="
 		}
 	}
 }

fonts/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "magicmirror-fonts",
-	"description": "Package for fonts use by MagicMirror Core.",
+	"description": "Package for fonts use by MagicMirror² Core.",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/MichMich/MagicMirror.git"
@@ -10,6 +10,7 @@
 		"url": "https://github.com/MichMich/MagicMirror/issues"
 	},
 	"dependencies": {
-		"roboto-fontface": "^0.10.0"
+		"@fontsource/roboto": "^4.5.7",
+		"@fontsource/roboto-condensed": "^4.5.8"
 	}
 }

fonts/roboto.css

@@ -2,57 +2,54 @@
   font-family: Roboto;
   font-style: normal;
   font-weight: 100;
-  src: local("Roboto Thin"), local("Roboto-Thin"), url("node_modules/roboto-fontface/fonts/roboto/Roboto-Thin.woff2") format("woff2"), url("node_modules/roboto-fontface/fonts/roboto/Roboto-Thin.woff") format("woff");
+  src: local("Roboto Thin"), local("Roboto-Thin"), url("node_modules/@fontsource/roboto/files/roboto-all-100-normal.woff") format("woff");
 }
 
 @font-face {
   font-family: "Roboto Condensed";
   font-style: normal;
   font-weight: 300;
-  src: local("Roboto Condensed Light"), local("RobotoCondensed-Light"), url("node_modules/roboto-fontface/fonts/roboto-condensed/Roboto-Condensed-Light.woff2") format("woff2"),
-    url("node_modules/roboto-fontface/fonts/roboto-condensed/Roboto-Condensed-Light.woff") format("woff");
+  src: local("Roboto Condensed Light"), local("RobotoCondensed-Light"), url("node_modules/@fontsource/roboto-condensed/files/roboto-condensed-all-300-normal.woff") format("woff");
 }
 
 @font-face {
   font-family: "Roboto Condensed";
   font-style: normal;
   font-weight: 400;
-  src: local("Roboto Condensed"), local("RobotoCondensed-Regular"), url("node_modules/roboto-fontface/fonts/roboto-condensed/Roboto-Condensed-Regular.woff2") format("woff2"),
-    url("node_modules/roboto-fontface/fonts/roboto-condensed/Roboto-Condensed-Regular.woff") format("woff");
+  src: local("Roboto Condensed"), local("RobotoCondensed-Regular"), url("node_modules/@fontsource/roboto-condensed/files/roboto-condensed-all-400-normal.woff") format("woff");
 }
 
 @font-face {
   font-family: "Roboto Condensed";
   font-style: normal;
   font-weight: 700;
-  src: local("Roboto Condensed Bold"), local("RobotoCondensed-Bold"), url("node_modules/roboto-fontface/fonts/roboto-condensed/Roboto-Condensed-Bold.woff2") format("woff2"),
-    url("node_modules/roboto-fontface/fonts/roboto-condensed/Roboto-Condensed-Bold.woff") format("woff");
+  src: local("Roboto Condensed Bold"), local("RobotoCondensed-Bold"), url("node_modules/@fontsource/roboto-condensed/files/roboto-condensed-all-700-normal.woff") format("woff");
 }
 
 @font-face {
   font-family: Roboto;
   font-style: normal;
   font-weight: 400;
-  src: local("Roboto"), local("Roboto-Regular"), url("node_modules/roboto-fontface/fonts/roboto/Roboto-Regular.woff2") format("woff2"), url("node_modules/roboto-fontface/fonts/roboto/Roboto-Regular.woff") format("woff");
+  src: local("Roboto"), local("Roboto-Regular"), url("node_modules/@fontsource/roboto/files/roboto-all-400-normal.woff") format("woff");
 }
 
 @font-face {
   font-family: Roboto;
   font-style: normal;
   font-weight: 500;
-  src: local("Roboto Medium"), local("Roboto-Medium"), url("node_modules/roboto-fontface/fonts/roboto/Roboto-Medium.woff2") format("woff2"), url("node_modules/roboto-fontface/fonts/roboto/Roboto-Medium.woff") format("woff");
+  src: local("Roboto Medium"), local("Roboto-Medium"), url("node_modules/@fontsource/roboto/files/roboto-all-500-normal.woff") format("woff");
 }
 
 @font-face {
   font-family: Roboto;
   font-style: normal;
   font-weight: 700;
-  src: local("Roboto Bold"), local("Roboto-Bold"), url("node_modules/roboto-fontface/fonts/roboto/Roboto-Bold.woff2") format("woff2"), url("node_modules/roboto-fontface/fonts/roboto/Roboto-Bold.woff") format("woff");
+  src: local("Roboto Bold"), local("Roboto-Bold"), url("node_modules/@fontsource/roboto/files/roboto-all-700-normal.woff") format("woff");
 }
 
 @font-face {
   font-family: Roboto;
   font-style: normal;
   font-weight: 300;
-  src: local("Roboto Light"), local("Roboto-Light"), url("node_modules/roboto-fontface/fonts/roboto/Roboto-Light.woff2") format("woff2"), url("node_modules/roboto-fontface/fonts/roboto/Roboto-Light.woff") format("woff");
+  src: local("Roboto Light"), local("Roboto-Light"), url("node_modules/@fontsource/roboto/files/roboto-all-300-normal.woff") format("woff");
 }

index.html

@@ -16,7 +16,7 @@
     <!-- custom.css is loaded by the loader.js to make sure it's loaded after the module css files. -->
 
     <script type="text/javascript">
-      var version = "#VERSION#";
+      window.mmVersion = "#VERSION#";
     </script>
   </head>
   <body>

installers/mm.sh

@@ -1,3 +1,4 @@
+#!/bin/bash
 # This file is still here to keep PM2 working on older installations.
 cd ~/MagicMirror
 DISPLAY=:0 npm start

js/app.js

@@ -1,4 +1,4 @@
-/* Magic Mirror
+/* MagicMirror²
  * The Core App (Server)
  *
  * By Michael Teeuw https://michaelteeuw.nl
@@ -37,7 +37,7 @@ if (process.env.MM_PORT) {
 process.on("uncaughtException", function (err) {
 	Log.error("Whoops! There was an uncaught exception...");
 	Log.error(err);
-	Log.error("MagicMirror will not quit, but it might be a good idea to check why this happened. Maybe no internet connection?");
+	Log.error("MagicMirror² will not quit, but it might be a good idea to check why this happened. Maybe no internet connection?");
 	Log.error("If you think this really is an issue, please open an issue on GitHub: https://github.com/MichMich/MagicMirror/issues");
 });
 
@@ -48,6 +48,7 @@ process.on("uncaughtException", function (err) {
  */
 function App() {
 	let nodeHelpers = [];
+	let httpServer;
 
 	/**
 	 * Loads the config file. Combines it with the defaults, and runs the
@@ -127,7 +128,7 @@ function App() {
 			let m = new Module();
 
 			if (m.requiresVersion) {
-				Log.log(`Check MagicMirror version for node helper '${moduleName}' - Minimum version: ${m.requiresVersion} - Current version: ${global.version}`);
+				Log.log(`Check MagicMirror² version for node helper '${moduleName}' - Minimum version: ${m.requiresVersion} - Current version: ${global.version}`);
 				if (cmpVersions(global.version, m.requiresVersion) >= 0) {
 					Log.log("Version is ok!");
 				} else {
@@ -222,7 +223,7 @@ function App() {
 			}
 
 			loadModules(modules, function () {
-				const server = new Server(config, function (app, io) {
+				httpServer = new Server(config, function (app, io) {
 					Log.log("Server started ...");
 
 					for (let nodeHelper of nodeHelpers) {
@@ -253,6 +254,7 @@ function App() {
 				nodeHelper.stop();
 			}
 		}
+		httpServer.close();
 	};
 
 	/**

js/check_config.js

@@ -1,4 +1,4 @@
-/* Magic Mirror
+/* MagicMirror²
  *
  * Check the configuration file for errors
  *

js/class.js

@@ -8,8 +8,8 @@
  * MIT Licensed.
  */
 (function () {
-	var initializing = false;
-	var fnTest = /xyz/.test(function () {
+	let initializing = false;
+	const fnTest = /xyz/.test(function () {
 		xyz;
 	})
 		? /\b_super\b/
@@ -20,27 +20,27 @@
 
 	// Create a new Class that inherits from this class
 	Class.extend = function (prop) {
-		var _super = this.prototype;
+		let _super = this.prototype;
 
 		// Instantiate a base class (but only create the instance,
 		// don't run the init constructor)
 		initializing = true;
-		var prototype = new this();
+		const prototype = new this();
 		initializing = false;
 
 		// Make a copy of all prototype properties, to prevent reference issues.
-		for (var p in prototype) {
+		for (const p in prototype) {
 			prototype[p] = cloneObject(prototype[p]);
 		}
 
 		// Copy the properties over onto the new prototype
-		for (var name in prop) {
+		for (const name in prop) {
 			// Check if we're overwriting an existing function
 			prototype[name] =
 				typeof prop[name] === "function" && typeof _super[name] === "function" && fnTest.test(prop[name])
 					? (function (name, fn) {
 							return function () {
-								var tmp = this._super;
+								const tmp = this._super;
 
 								// Add a new ._super() method that is the same method
 								// but on the super-class
@@ -48,7 +48,7 @@
 
 								// The method only need to be bound temporarily, so we
 								// remove it when we're done executing
-								var ret = fn.apply(this, arguments);
+								const ret = fn.apply(this, arguments);
 								this._super = tmp;
 
 								return ret;
@@ -91,8 +91,8 @@ function cloneObject(obj) {
 		return obj;
 	}
 
-	var temp = obj.constructor(); // give temp the original obj's constructor
-	for (var key in obj) {
+	const temp = obj.constructor(); // give temp the original obj's constructor
+	for (const key in obj) {
 		temp[key] = cloneObject(obj[key]);
 
 		if (key === "lockStrings") {

js/defaults.js

@@ -1,6 +1,6 @@
 /* global mmPort */
 
-/* Magic Mirror
+/* MagicMirror²
  * Config Defaults
  *
  * By Michael Teeuw https://michaelteeuw.nl
@@ -25,6 +25,9 @@ const defaults = {
 	units: "metric",
 	zoom: 1,
 	customCss: "css/custom.css",
+	// httpHeaders used by helmet, see https://helmetjs.github.io/. You can add other/more object values by overriding this in config.js,
+	// e.g. you need to add `frameguard: false` for embedding MagicMirror in another website, see https://github.com/MichMich/MagicMirror/issues/2847
+	httpHeaders: { contentSecurityPolicy: false, crossOriginOpenerPolicy: false, crossOriginEmbedderPolicy: false, crossOriginResourcePolicy: false, originAgentCluster: false },
 
 	modules: [
 		{
@@ -36,7 +39,7 @@ const defaults = {
 			position: "upper_third",
 			classes: "large thin",
 			config: {
-				text: "Magic Mirror<sup>2</sup>"
+				text: "MagicMirror²"
 			}
 		},
 		{
@@ -59,7 +62,7 @@ const defaults = {
 			position: "middle_center",
 			classes: "xsmall",
 			config: {
-				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>"
+				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>"
 			}
 		},
 		{

js/deprecated.js

@@ -1,4 +1,4 @@
-/* Magic Mirror Deprecated Config Options List
+/* MagicMirror² Deprecated Config Options List
  *
  * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.

js/electron.js

@@ -8,6 +8,12 @@ const Log = require("logger");
 let config = process.env.config ? JSON.parse(process.env.config) : {};
 // Module to control application life.
 const app = electron.app;
+// If ELECTRON_DISABLE_GPU is set electron is started with --disable-gpu flag.
+// See https://www.electronjs.org/docs/latest/tutorial/offscreen-rendering for more info.
+if (process.env.ELECTRON_DISABLE_GPU !== undefined) {
+	app.disableHardwareAcceleration();
+}
+
 // Module to create native browser window.
 const BrowserWindow = electron.BrowserWindow;
 
@@ -19,7 +25,8 @@ let mainWindow;
  *
  */
 function createWindow() {
-	app.commandLine.appendSwitch("autoplay-policy", "no-user-gesture-required");
+	let electronSwitchesDefaults = ["autoplay-policy", "no-user-gesture-required"];
+	app.commandLine.appendSwitch(...new Set(electronSwitchesDefaults, config.electronSwitches));
 	let electronOptionsDefaults = {
 		width: 800,
 		height: 600,
@@ -52,7 +59,7 @@ function createWindow() {
 	// If config.address is not defined or is an empty string (listening on all interfaces), connect to localhost
 
 	let prefix;
-	if (config["tls"] !== null && config["tls"]) {
+	if ((config["tls"] !== null && config["tls"]) || config.useHttps) {
 		prefix = "https://";
 	} else {
 		prefix = "http://";
@@ -65,12 +72,17 @@ function createWindow() {
 	if (process.argv.includes("dev")) {
 		if (process.env.JEST_WORKER_ID !== undefined) {
 			// if we are running with jest
-			var devtools = new BrowserWindow(electronOptions);
+			const devtools = new BrowserWindow(electronOptions);
 			mainWindow.webContents.setDevToolsWebContents(devtools.webContents);
 		}
 		mainWindow.webContents.openDevTools();
 	}
 
+	// simulate mouse move to hide black cursor on start
+	mainWindow.webContents.on("dom-ready", (event) => {
+		mainWindow.webContents.sendInputEvent({ type: "mouseMove", x: 0, y: 0 });
+	});
+
 	// Set responders for window events.
 	mainWindow.on("closed", function () {
 		mainWindow = null;
@@ -102,7 +114,12 @@ app.on("ready", function () {
 
 // Quit when all windows are closed.
 app.on("window-all-closed", function () {
-	createWindow();
+	if (process.env.JEST_WORKER_ID !== undefined) {
+		// if we are running with jest
+		app.quit();
+	} else {
+		createWindow();
+	}
 });
 
 app.on("activate", function () {
@@ -129,6 +146,13 @@ app.on("before-quit", (event) => {
 	process.exit(0);
 });
 
+/* handle errors from self signed certificates */
+
+app.on("certificate-error", (event, webContents, url, error, certificate, callback) => {
+	event.preventDefault();
+	callback(true);
+});
+
 // Start the core application if server is run on localhost
 // This starts all node helpers and starts the webserver.
 if (["localhost", "127.0.0.1", "::1", "::ffff:127.0.0.1", undefined].includes(config.address)) {

js/fetch.js

@@ -0,0 +1,20 @@
+/**
+ * fetch
+ *
+ * @param {string} url to be fetched
+ * @param {object} options object e.g. for headers
+ * @class
+ */
+async function fetch(url, options) {
+	const nodeVersion = process.version.match(/^v(\d+)\.*/)[1];
+	if (nodeVersion >= 18) {
+		// node version >= 18
+		return global.fetch(url, options);
+	} else {
+		// node version < 18
+		const nodefetch = require("node-fetch");
+		return nodefetch(url, options);
+	}
+}
+
+module.exports = fetch;

js/loader.js

@@ -1,6 +1,6 @@
 /* global defaultModules, vendor */
 
-/* Magic Mirror
+/* MagicMirror²
  * Module and File loaders.
  *
  * By Michael Teeuw https://michaelteeuw.nl

js/logger.js

@@ -1,4 +1,4 @@
-/* Magic Mirror
+/* MagicMirror²
  * Log
  *
  * This logger is very simple, but needs to be extended.
@@ -9,12 +9,13 @@
  */
 (function (root, factory) {
 	if (typeof exports === "object") {
-		// add timestamps in front of log messages
-		require("console-stamp")(console, {
-			pattern: "yyyy-mm-dd HH:MM:ss.l",
-			include: ["debug", "log", "info", "warn", "error"]
-		});
-
+		if (process.env.JEST_WORKER_ID === undefined) {
+			// add timestamps in front of log messages
+			require("console-stamp")(console, {
+				pattern: "yyyy-mm-dd HH:MM:ss.l",
+				include: ["debug", "log", "info", "warn", "error"]
+			});
+		}
 		// Node, CommonJS-like
 		module.exports = factory(root.config);
 	} else {
@@ -22,29 +23,57 @@
 		root.Log = factory(root.config);
 	}
 })(this, function (config) {
-	const logLevel = {
-		debug: Function.prototype.bind.call(console.debug, console),
-		log: Function.prototype.bind.call(console.log, console),
-		info: Function.prototype.bind.call(console.info, console),
-		warn: Function.prototype.bind.call(console.warn, console),
-		error: Function.prototype.bind.call(console.error, console),
-		group: Function.prototype.bind.call(console.group, console),
-		groupCollapsed: Function.prototype.bind.call(console.groupCollapsed, console),
-		groupEnd: Function.prototype.bind.call(console.groupEnd, console),
-		time: Function.prototype.bind.call(console.time, console),
-		timeEnd: Function.prototype.bind.call(console.timeEnd, console),
-		timeStamp: Function.prototype.bind.call(console.timeStamp, console)
-	};
+	let logLevel;
+	let enableLog;
+	if (typeof exports === "object") {
+		// in nodejs and not running with jest
+		enableLog = process.env.JEST_WORKER_ID === undefined;
+	} else {
+		// in browser and not running with jsdom
+		enableLog = typeof window === "object" && window.name !== "jsdom";
+	}
 
-	logLevel.setLogLevel = function (newLevel) {
-		if (newLevel) {
-			Object.keys(logLevel).forEach(function (key, index) {
-				if (!newLevel.includes(key.toLocaleUpperCase())) {
-					logLevel[key] = function () {};
-				}
-			});
-		}
-	};
+	if (enableLog) {
+		logLevel = {
+			debug: Function.prototype.bind.call(console.debug, console),
+			log: Function.prototype.bind.call(console.log, console),
+			info: Function.prototype.bind.call(console.info, console),
+			warn: Function.prototype.bind.call(console.warn, console),
+			error: Function.prototype.bind.call(console.error, console),
+			group: Function.prototype.bind.call(console.group, console),
+			groupCollapsed: Function.prototype.bind.call(console.groupCollapsed, console),
+			groupEnd: Function.prototype.bind.call(console.groupEnd, console),
+			time: Function.prototype.bind.call(console.time, console),
+			timeEnd: Function.prototype.bind.call(console.timeEnd, console),
+			timeStamp: Function.prototype.bind.call(console.timeStamp, console)
+		};
+
+		logLevel.setLogLevel = function (newLevel) {
+			if (newLevel) {
+				Object.keys(logLevel).forEach(function (key, index) {
+					if (!newLevel.includes(key.toLocaleUpperCase())) {
+						logLevel[key] = function () {};
+					}
+				});
+			}
+		};
+	} else {
+		logLevel = {
+			debug: function () {},
+			log: function () {},
+			info: function () {},
+			warn: function () {},
+			error: function () {},
+			group: function () {},
+			groupCollapsed: function () {},
+			groupEnd: function () {},
+			time: function () {},
+			timeEnd: function () {},
+			timeStamp: function () {}
+		};
+
+		logLevel.setLogLevel = function () {};
+	}
 
 	return logLevel;
 });

js/main.js

@@ -1,6 +1,6 @@
 /* global Loader, defaults, Translator */
 
-/* Magic Mirror
+/* MagicMirror²
  * Main System
  *
  * By Michael Teeuw https://michaelteeuw.nl
@@ -245,6 +245,7 @@ const MM = (function () {
 		if (moduleWrapper !== null) {
 			moduleWrapper.style.transition = "opacity " + speed / 1000 + "s";
 			moduleWrapper.style.opacity = 0;
+			moduleWrapper.classList.add("hidden");
 
 			clearTimeout(module.showHideTimer);
 			module.showHideTimer = setTimeout(function () {
@@ -310,6 +311,7 @@ const MM = (function () {
 			moduleWrapper.style.transition = "opacity " + speed / 1000 + "s";
 			// Restore the position. See hideModule() for more info.
 			moduleWrapper.style.position = "static";
+			moduleWrapper.classList.remove("hidden");
 
 			updateWrapperStates();
 
@@ -478,7 +480,7 @@ const MM = (function () {
 		 * Main init method.
 		 */
 		init: function () {
-			Log.info("Initializing MagicMirror.");
+			Log.info("Initializing MagicMirror².");
 			loadConfig();
 
 			Log.setLogLevel(config.logLevel);

js/module.js

@@ -1,18 +1,18 @@
 /* global Class, cloneObject, Loader, MMSocket, nunjucks, Translator */
 
-/* Magic Mirror
+/* MagicMirror²
  * Module Blueprint.
  * @typedef {Object} Module
  *
  * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  */
-var Module = Class.extend({
+const Module = Class.extend({
 	/*********************************************************
 	 * All methods (and properties) below can be subclassed. *
 	 *********************************************************/
 
-	// Set the minimum MagicMirror module version for this module.
+	// Set the minimum MagicMirror² module version for this module.
 	requiresVersion: "2.0.0",
 
 	// Module config defaults.
@@ -74,7 +74,7 @@ var Module = Class.extend({
 	},
 
 	/**
-	 * Generates the dom which needs to be displayed. This method is called by the Magic Mirror core.
+	 * Generates the dom which needs to be displayed. This method is called by the MagicMirror² core.
 	 * This method can to be subclassed if the module wants to display info on the mirror.
 	 * Alternatively, the getTemplate method could be subclassed.
 	 *
@@ -109,7 +109,7 @@ var Module = Class.extend({
 
 	/**
 	 * Generates the header string which needs to be displayed if a user has a header configured for this module.
-	 * This method is called by the Magic Mirror core, but only if the user has configured a default header for the module.
+	 * This method is called by the MagicMirror² core, but only if the user has configured a default header for the module.
 	 * This method needs to be subclassed if the module wants to display modified headers on the mirror.
 	 *
 	 * @returns {string} The header to display above the header.
@@ -141,7 +141,7 @@ var Module = Class.extend({
 	},
 
 	/**
-	 * Called by the Magic Mirror core when a notification arrives.
+	 * Called by the MagicMirror² core when a notification arrives.
 	 *
 	 * @param {string} notification The identifier of the notification.
 	 * @param {*} payload The payload of the notification.
@@ -434,7 +434,7 @@ var Module = Class.extend({
 });
 
 /**
- * Merging MagicMirror (or other) default/config script by @bugsounet
+ * Merging MagicMirror² (or other) default/config script by @bugsounet
  * Merge 2 objects or/with array
  *
  * Usage:
@@ -498,8 +498,8 @@ Module.create = function (name) {
 
 Module.register = function (name, moduleDefinition) {
 	if (moduleDefinition.requiresVersion) {
-		Log.log("Check MagicMirror version for module '" + name + "' - Minimum version:  " + moduleDefinition.requiresVersion + " - Current version: " + window.version);
-		if (cmpVersions(window.version, moduleDefinition.requiresVersion) >= 0) {
+		Log.log("Check MagicMirror² version for module '" + name + "' - Minimum version:  " + moduleDefinition.requiresVersion + " - Current version: " + window.mmVersion);
+		if (cmpVersions(window.mmVersion, moduleDefinition.requiresVersion) >= 0) {
 			Log.log("Version is ok!");
 		} else {
 			Log.warn("Version is incorrect. Skip module: '" + name + "'");
@@ -510,6 +510,8 @@ Module.register = function (name, moduleDefinition) {
 	Module.definitions[name] = moduleDefinition;
 };
 
+window.Module = Module;
+
 /**
  * Compare two semantic version numbers and return the difference.
  *

js/node_helper.js

@@ -1,4 +1,4 @@
-/* Magic Mirror
+/* MagicMirror²
  * Node Helper Superclass
  *
  * By Michael Teeuw https://michaelteeuw.nl
@@ -23,7 +23,7 @@ const NodeHelper = Class.extend({
 	},
 
 	/* stop()
-	 * Called when the MagicMirror server receives a `SIGINT`
+	 * Called when the MagicMirror² server receives a `SIGINT`
 	 * Close any open connections, stop any sub-processes and
 	 * gracefully exit the module.
 	 *

js/server.js

@@ -1,4 +1,4 @@
-/* Magic Mirror
+/* MagicMirror²
  * Server
  *
  * By Michael Teeuw https://michaelteeuw.nl
@@ -10,6 +10,7 @@ const path = require("path");
 const ipfilter = require("express-ipfilter").IpFilter;
 const fs = require("fs");
 const helmet = require("helmet");
+const fetch = require("fetch");
 
 const Log = require("logger");
 const Utils = require("./utils.js");
@@ -23,6 +24,7 @@ const Utils = require("./utils.js");
  */
 function Server(config, callback) {
 	const port = process.env.MM_PORT || config.port;
+	const serverSockets = new Set();
 
 	let server = null;
 	if (config.useHttps) {
@@ -42,6 +44,13 @@ function Server(config, callback) {
 		allowEIO3: true
 	});
 
+	server.on("connection", (socket) => {
+		serverSockets.add(socket);
+		socket.on("close", () => {
+			serverSockets.delete(socket);
+		});
+	});
+
 	Log.log(`Starting server on port ${port} ... `);
 
 	server.listen(port, config.address || "localhost");
@@ -53,13 +62,14 @@ function Server(config, callback) {
 	app.use(function (req, res, next) {
 		ipfilter(config.ipWhitelist, { mode: config.ipWhitelist.length === 0 ? "deny" : "allow", log: false })(req, res, function (err) {
 			if (err === undefined) {
+				res.header("Access-Control-Allow-Origin", "*");
 				return next();
 			}
 			Log.log(err.message);
 			res.status(403).send("This device is not allowed to access your mirror. <br> Please check your config.js or config.js.sample to change this.");
 		});
 	});
-	app.use(helmet({ contentSecurityPolicy: false }));
+	app.use(helmet(config.httpHeaders));
 
 	app.use("/js", express.static(__dirname));
 
@@ -68,6 +78,33 @@ function Server(config, callback) {
 		app.use(directory, express.static(path.resolve(global.root_path + directory)));
 	}
 
+	app.get("/cors", async function (req, res) {
+		// example: http://localhost:8080/cors?url=https://google.de
+
+		try {
+			const reg = "^/cors.+url=(.*)";
+			let url = "";
+
+			let match = new RegExp(reg, "g").exec(req.url);
+			if (!match) {
+				url = "invalid url: " + req.url;
+				Log.error(url);
+				res.send(url);
+			} else {
+				url = match[1];
+				Log.log("cors url: " + url);
+				const response = await fetch(url, { headers: { "User-Agent": "Mozilla/5.0 MagicMirror/" + global.version } });
+				const header = response.headers.get("Content-Type");
+				const data = await response.text();
+				if (header) res.set("Content-Type", header);
+				res.send(data);
+			}
+		} catch (error) {
+			Log.error(error);
+			res.send(error);
+		}
+	});
+
 	app.get("/version", function (req, res) {
 		res.send(global.version);
 	});
@@ -92,6 +129,13 @@ function Server(config, callback) {
 	if (typeof callback === "function") {
 		callback(app, io);
 	}
+
+	this.close = function () {
+		for (const socket of serverSockets.values()) {
+			socket.destroy();
+		}
+		server.close();
+	};
 }
 
 module.exports = Server;

js/socketclient.js

@@ -1,6 +1,6 @@
 /* global io */
 
-/* Magic Mirror
+/* MagicMirror²
  * TODO add description
  *
  * By Michael Teeuw https://michaelteeuw.nl

js/translator.js

@@ -1,12 +1,12 @@
 /* global translations */
 
-/* Magic Mirror
+/* MagicMirror²
  * Translator (l10n)
  *
  * By Christopher Fenner https://github.com/CFenner
  * MIT Licensed.
  */
-var Translator = (function () {
+const Translator = (function () {
 	/**
 	 * Load a JSON file via XHR.
 	 *
@@ -104,7 +104,7 @@ var Translator = (function () {
 		 * @param {Function} callback Function called when done.
 		 */
 		load(module, file, isFallback, callback) {
-			Log.log(`${module.name} - Load translation${isFallback && " fallback"}: ${file}`);
+			Log.log(`${module.name} - Load translation${isFallback ? " fallback" : ""}: ${file}`);
 
 			if (this.translationsFallback[module.name]) {
 				callback();
@@ -141,12 +141,7 @@ var Translator = (function () {
 		 * The first language defined in translations.js will be used.
 		 */
 		loadCoreTranslationsFallback: function () {
-			// The variable `first` will contain the first
-			// defined translation after the following line.
-			for (var first in translations) {
-				break;
-			}
-
+			let first = Object.keys(translations)[0];
 			if (first) {
 				Log.log("Loading core translation fallback file: " + translations[first]);
 				loadJSON(translations[first], (translations) => {
@@ -156,3 +151,5 @@ var Translator = (function () {
 		}
 	};
 })();
+
+window.Translator = Translator;

js/utils.js

@@ -1,4 +1,4 @@
-/* Magic Mirror
+/* MagicMirror²
  * Utils
  *
  * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com

module-types.ts

@@ -1,16 +1,16 @@
 type ModuleProperties = {
-  defaults?: object,
-  start?(): void,
-  getHeader?(): string,
-  getTemplate?(): string,
-  getTemplateData?(): object,
-  notificationReceived?(notification: string, payload: any, sender: object): void,
-  socketNotificationReceived?(notification: string, payload: any): void,
-  suspend?(): void,
-  resume?(): void,
-  getDom?(): HTMLElement,
-  getStyles?(): string[],
-  [key: string]: any,
+  defaults?: object;
+  start?(): void;
+  getHeader?(): string;
+  getTemplate?(): string;
+  getTemplateData?(): object;
+  notificationReceived?(notification: string, payload: any, sender: object): void;
+  socketNotificationReceived?(notification: string, payload: any): void;
+  suspend?(): void;
+  resume?(): void;
+  getDom?(): HTMLElement;
+  getStyles?(): string[];
+  [key: string]: any;
 };
 
 export declare const Module: {
@@ -18,14 +18,14 @@ export declare const Module: {
 };
 
 export declare const Log: {
-  info(message?: any, ...optionalParams: any[]): void,
-  log(message?: any, ...optionalParams: any[]): void,
-  error(message?: any, ...optionalParams: any[]): void,
-  warn(message?: any, ...optionalParams: any[]): void,
-  group(groupTitle?: string, ...optionalParams: any[]): void,
-  groupCollapsed(groupTitle?: string, ...optionalParams: any[]): void,
-  groupEnd(): void,
-  time(timerName?: string): void,
-  timeEnd(timerName?: string): void,
-  timeStamp(timerName?: string): void,
-};
+  info(message?: any, ...optionalParams: any[]): void;
+  log(message?: any, ...optionalParams: any[]): void;
+  error(message?: any, ...optionalParams: any[]): void;
+  warn(message?: any, ...optionalParams: any[]): void;
+  group(groupTitle?: string, ...optionalParams: any[]): void;
+  groupCollapsed(groupTitle?: string, ...optionalParams: any[]): void;
+  groupEnd(): void;
+  time(timerName?: string): void;
+  timeEnd(timerName?: string): void;
+  timeStamp(timerName?: string): void;
+};

modules/default/alert/README.md

@@ -1,5 +1,5 @@
 # Module: Alert
 
-The alert module is one of the default modules of the MagicMirror. This module displays notifications from other modules.
+The alert module is one of the default modules of the MagicMirror². This module displays notifications from other modules.
 
 For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/alert.html).

modules/default/alert/alert.js

@@ -1,167 +1,146 @@
 /* global NotificationFx */
 
-/* Magic Mirror
+/* MagicMirror²
  * Module: alert
  *
  * By Paul-Vincent Roll https://paulvincentroll.com/
  * MIT Licensed.
  */
 Module.register("alert", {
+	alerts: {},
+
 	defaults: {
-		// scale|slide|genie|jelly|flip|bouncyflip|exploader
-		effect: "slide",
-		// scale|slide|genie|jelly|flip|bouncyflip|exploader
-		alert_effect: "jelly",
-		//time a notification is displayed in seconds
-		display_time: 3500,
-		//Position
+		effect: "slide", // scale|slide|genie|jelly|flip|bouncyflip|exploader
+		alert_effect: "jelly", // scale|slide|genie|jelly|flip|bouncyflip|exploader
+		display_time: 3500, // time a notification is displayed in seconds
 		position: "center",
-		//shown at startup
-		welcome_message: false
+		welcome_message: false // shown at startup
 	},
-	getScripts: function () {
+
+	getScripts() {
 		return ["notificationFx.js"];
 	},
-	getStyles: function () {
-		return ["notificationFx.css", "font-awesome.css"];
+
+	getStyles() {
+		return ["font-awesome.css", this.file(`./styles/notificationFx.css`), this.file(`./styles/${this.config.position}.css`)];
 	},
-	// Define required translations.
-	getTranslations: function () {
+
+	getTranslations() {
 		return {
-			en: "translations/en.json",
+			bg: "translations/bg.json",
+			da: "translations/da.json",
 			de: "translations/de.json",
-			nl: "translations/nl.json"
+			en: "translations/en.json",
+			es: "translations/es.json",
+			fr: "translations/fr.json",
+			hu: "translations/hu.json",
+			nl: "translations/nl.json",
+			ru: "translations/ru.json"
 		};
 	},
-	show_notification: function (message) {
+
+	getTemplate(type) {
+		return `templates/${type}.njk`;
+	},
+
+	start() {
+		Log.info(`Starting module: ${this.name}`);
+
 		if (this.config.effect === "slide") {
-			this.config.effect = this.config.effect + "-" + this.config.position;
+			this.config.effect = `${this.config.effect}-${this.config.position}`;
 		}
-		let msg = "";
-		if (message.title) {
-			msg += "<span class='thin dimmed medium'>" + message.title + "</span>";
+
+		if (this.config.welcome_message) {
+			const message = this.config.welcome_message === true ? this.translate("welcome") : this.config.welcome_message;
+			this.showNotification({ title: this.translate("sysTitle"), message });
 		}
-		if (message.message) {
-			if (msg !== "") {
-				msg += "<br />";
+	},
+
+	notificationReceived(notification, payload, sender) {
+		if (notification === "SHOW_ALERT") {
+			if (payload.type === "notification") {
+				this.showNotification(payload);
+			} else {
+				this.showAlert(payload, sender);
 			}
-			msg += "<span class='light bright small'>" + message.message + "</span>";
+		} else if (notification === "HIDE_ALERT") {
+			this.hideAlert(sender);
 		}
+	},
+
+	async showNotification(notification) {
+		const message = await this.renderMessage("notification", notification);
 
 		new NotificationFx({
-			message: msg,
+			message,
 			layout: "growl",
 			effect: this.config.effect,
-			ttl: message.timer !== undefined ? message.timer : this.config.display_time
+			ttl: notification.timer || this.config.display_time
 		}).show();
 	},
-	show_alert: function (params, sender) {
-		let image = "";
-		//Set standard params if not provided by module
-		if (typeof params.timer === "undefined") {
-			params.timer = null;
-		}
-		if (typeof params.imageHeight === "undefined") {
-			params.imageHeight = "80px";
-		}
-		if (typeof params.imageUrl === "undefined" && typeof params.imageFA === "undefined") {
-			params.imageUrl = null;
-		} else if (typeof params.imageFA === "undefined") {
-			image = "<img src='" + params.imageUrl.toString() + "' height='" + params.imageHeight.toString() + "' style='margin-bottom: 10px;'/><br />";
-		} else if (typeof params.imageUrl === "undefined") {
-			image = "<span class='bright " + "fa fa-" + params.imageFA + "' style='margin-bottom: 10px;font-size:" + params.imageHeight.toString() + ";'/></span><br />";
-		}
-		//Create overlay
-		const overlay = document.createElement("div");
-		overlay.id = "overlay";
-		overlay.innerHTML += '<div class="black_overlay"></div>';
-		document.body.insertBefore(overlay, document.body.firstChild);
 
-		//If module already has an open alert close it
+	async showAlert(alert, sender) {
+		// If module already has an open alert close it
 		if (this.alerts[sender.name]) {
-			this.hide_alert(sender, false);
+			this.hideAlert(sender, false);
 		}
 
-		//Display title and message only if they are provided in notification parameters
-		let message = "";
-		if (params.title) {
-			message += "<span class='light dimmed medium'>" + params.title + "</span>";
-		}
-		if (params.message) {
-			if (message !== "") {
-				message += "<br />";
-			}
-
-			message += "<span class='thin bright small'>" + params.message + "</span>";
+		// Add overlay
+		if (!Object.keys(this.alerts).length) {
+			this.toggleBlur(true);
 		}
 
-		//Store alert in this.alerts
+		const message = await this.renderMessage("alert", alert);
+
+		// Store alert in this.alerts
 		this.alerts[sender.name] = new NotificationFx({
-			message: image + message,
+			message,
 			effect: this.config.alert_effect,
-			ttl: params.timer,
-			onClose: () => this.hide_alert(sender),
+			ttl: alert.timer,
+			onClose: () => this.hideAlert(sender),
 			al_no: "ns-alert"
 		});
 
-		//Show alert
+		// Show alert
 		this.alerts[sender.name].show();
 
-		//Add timer to dismiss alert and overlay
-		if (params.timer) {
+		// Add timer to dismiss alert and overlay
+		if (alert.timer) {
 			setTimeout(() => {
-				this.hide_alert(sender);
-			}, params.timer);
+				this.hideAlert(sender);
+			}, alert.timer);
 		}
 	},
-	hide_alert: function (sender, close = true) {
-		//Dismiss alert and remove from this.alerts
+
+	hideAlert(sender, close = true) {
+		// Dismiss alert and remove from this.alerts
 		if (this.alerts[sender.name]) {
 			this.alerts[sender.name].dismiss(close);
-			this.alerts[sender.name] = null;
-			//Remove overlay
-			const overlay = document.getElementById("overlay");
-			overlay.parentNode.removeChild(overlay);
-		}
-	},
-	setPosition: function (pos) {
-		//Add css to body depending on the set position for notifications
-		const sheet = document.createElement("style");
-		if (pos === "center") {
-			sheet.innerHTML = ".ns-box {margin-left: auto; margin-right: auto;text-align: center;}";
-		}
-		if (pos === "right") {
-			sheet.innerHTML = ".ns-box {margin-left: auto;text-align: right;}";
-		}
-		if (pos === "left") {
-			sheet.innerHTML = ".ns-box {margin-right: auto;text-align: left;}";
-		}
-		document.body.appendChild(sheet);
-	},
-	notificationReceived: function (notification, payload, sender) {
-		if (notification === "SHOW_ALERT") {
-			if (typeof payload.type === "undefined") {
-				payload.type = "alert";
-			}
-			if (payload.type === "alert") {
-				this.show_alert(payload, sender);
-			} else if (payload.type === "notification") {
-				this.show_notification(payload);
-			}
-		} else if (notification === "HIDE_ALERT") {
-			this.hide_alert(sender);
-		}
-	},
-	start: function () {
-		this.alerts = {};
-		this.setPosition(this.config.position);
-		if (this.config.welcome_message) {
-			if (this.config.welcome_message === true) {
-				this.show_notification({ title: this.translate("sysTitle"), message: this.translate("welcome") });
-			} else {
-				this.show_notification({ title: this.translate("sysTitle"), message: this.config.welcome_message });
+			delete this.alerts[sender.name];
+			// Remove overlay
+			if (!Object.keys(this.alerts).length) {
+				this.toggleBlur(false);
 			}
 		}
-		Log.info("Starting module: " + this.name);
+	},
+
+	renderMessage(type, data) {
+		return new Promise((resolve) => {
+			this.nunjucksEnvironment().render(this.getTemplate(type), data, function (err, res) {
+				if (err) {
+					Log.error("Failed to render alert", err);
+				}
+
+				resolve(res);
+			});
+		});
+	},
+
+	toggleBlur(add = false) {
+		const method = add ? "add" : "remove";
+		const modules = document.querySelectorAll(".module");
+		for (const module of modules) {
+			module.classList[method]("alert-blur");
+		}
 	}
 });

modules/default/alert/notificationFx.js

@@ -9,6 +9,8 @@
  *
  * Copyright 2014, Codrops
  * https://tympanus.net/codrops/
+ *
+ * @param {object} window The window object
  */
 (function (window) {
 	/**

modules/default/alert/styles/center.css

@@ -0,0 +1,5 @@
+.ns-box {
+  margin-left: auto;
+  margin-right: auto;
+  text-align: center;
+}

modules/default/alert/styles/left.css

@@ -0,0 +1,4 @@
+.ns-box {
+  margin-right: auto;
+  text-align: left;
+}

modules/default/alert/styles/notificationFx.css

@@ -39,12 +39,8 @@
   border-radius: 20px;
 }
 
-.black_overlay {
-  position: fixed;
-  z-index: 2;
-  background-color: rgba(0, 0, 0, 0.93);
-  width: 100%;
-  height: 100%;
+.alert-blur {
+  filter: blur(2px) brightness(50%);
 }
 
 [class^="ns-effect-"].ns-growl.ns-hide,

modules/default/alert/styles/right.css

@@ -0,0 +1,4 @@
+.ns-box {
+  margin-left: auto;
+  text-align: right;
+}

modules/default/alert/templates/alert.njk

@@ -0,0 +1,18 @@
+{% if imageUrl or imageFA %}
+  {% set imageHeight = imageHeight if imageHeight else "80px" %}
+  {% if imageUrl %}
+    <img src="{{ imageUrl }}" height="{{ imageHeight }}" style="margin-bottom: 10px;"/>
+  {% else %}
+    <span class="bright fas fa-{{ imageFA }}" style='margin-bottom: 10px; font-size: {{ imageHeight }};'/></span>
+  {% endif %}
+  <br/>
+{% endif %}
+{% if title %}
+  <span class="thin dimmed medium">{{ title }}</span>
+{% endif %}
+{% if message %}
+  {% if title %}
+    <br/>
+  {% endif %}
+  <span class="light bright small">{{ message }}</span>
+{% endif %}

modules/default/alert/templates/notification.njk

@@ -0,0 +1,9 @@
+{% if title %}
+  <span class="thin dimmed medium">{{ title }}</span>
+{% endif %}
+{% if message %}
+  {% if title %}
+    <br/>
+  {% endif %}
+  <span class="light bright small">{{ message }}</span>
+{% endif %}

modules/default/alert/translations/bg.json

@@ -1,4 +1,4 @@
 {
-	"sysTitle": "MagicMirror нотификация",
+	"sysTitle": "MagicMirror² нотификация",
 	"welcome": "Добре дошли, стартирането беше успешно"
 }

modules/default/alert/translations/da.json

@@ -1,4 +1,4 @@
 {
-	"sysTitle": "MagicMirror Notifikation",
+	"sysTitle": "MagicMirror² Notifikation",
 	"welcome": "Velkommen, modulet er succesfuldt startet!"
 }

modules/default/alert/translations/de.json

@@ -1,4 +1,4 @@
 {
-	"sysTitle": "MagicMirror Benachrichtigung",
+	"sysTitle": "MagicMirror² Benachrichtigung",
 	"welcome": "Willkommen, Start war erfolgreich!"
 }

modules/default/alert/translations/en.json

@@ -1,4 +1,4 @@
 {
-	"sysTitle": "MagicMirror Notification",
+	"sysTitle": "MagicMirror² Notification",
 	"welcome": "Welcome, start was successful!"
 }

modules/default/alert/translations/es.json

@@ -1,4 +1,4 @@
 {
-	"sysTitle": "MagicMirror Notificaciones",
+	"sysTitle": "MagicMirror² Notificaciones",
 	"welcome": "Bienvenido, ¡se iniciado correctamente!"
 }

modules/default/alert/translations/fr.json

@@ -1,4 +1,4 @@
 {
-	"sysTitle": "MagicMirror Notification",
+	"sysTitle": "MagicMirror² Notification",
 	"welcome": "Bienvenue, le démarrage a été un succès!"
 }

modules/default/alert/translations/hu.json

@@ -1,4 +1,4 @@
 {
-	"sysTitle": "MagicMirror értesítés",
+	"sysTitle": "MagicMirror² értesítés",
 	"welcome": "Üdvözöljük, indulás sikeres!"
 }

modules/default/alert/translations/nl.json

@@ -1,4 +1,4 @@
 {
-	"sysTitle": "MagicMirror Notificatie",
+	"sysTitle": "MagicMirror² Notificatie",
 	"welcome": "Welkom, Succesvol gestart!"
 }

modules/default/alert/translations/ru.json

@@ -1,4 +1,4 @@
 {
-	"sysTitle": "MagicMirror Уведомление",
+	"sysTitle": "MagicMirror² Уведомление",
 	"welcome": "Добро пожаловать, старт был успешным!"
 }

modules/default/calendar/README.md

@@ -1,6 +1,6 @@
 # Module: Calendar
 
-The `calendar` module is one of the default modules of the MagicMirror.
+The `calendar` module is one of the default modules of the MagicMirror².
 This module displays events from a public .ical calendar. It can combine multiple calendars.
 
 For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/calendar.html).

modules/default/calendar/calendar.js

@@ -1,6 +1,6 @@
 /* global cloneObject */
 
-/* Magic Mirror
+/* MagicMirror²
  * Module: Calendar
  *
  * By Michael Teeuw https://michaelteeuw.nl
@@ -13,7 +13,7 @@ Module.register("calendar", {
 		maximumNumberOfDays: 365,
 		limitDays: 0, // Limit the number of days shown, 0 = no limit
 		displaySymbol: true,
-		defaultSymbol: "calendar", // Fontawesome Symbol see https://fontawesome.com/cheatsheet?from=io
+		defaultSymbol: "calendar-alt", // Fontawesome Symbol see https://fontawesome.com/cheatsheet?from=io
 		showLocation: false,
 		displayRepeatingCountTitle: false,
 		defaultRepeatingCountTitle: "",
@@ -43,7 +43,7 @@ Module.register("calendar", {
 		tableClass: "small",
 		calendars: [
 			{
-				symbol: "calendar",
+				symbol: "calendar-alt",
 				url: "https://www.calendarlabs.com/templates/ical/US-Holidays.ics"
 			}
 		],
@@ -164,7 +164,7 @@ Module.register("calendar", {
 		const oneHour = oneMinute * 60;
 		const oneDay = oneHour * 24;
 
-		const events = this.createEventList();
+		const events = this.createEventList(true);
 		const wrapper = document.createElement("table");
 		wrapper.className = this.config.tableClass;
 
@@ -237,21 +237,9 @@ Module.register("calendar", {
 				symbolWrapper.className = "symbol align-right " + symbolClass;
 
 				const symbols = this.symbolsForEvent(event);
-				// If symbols are displayed and custom symbol is set, replace event symbol
-				if (this.config.displaySymbol && this.config.customEvents.length > 0) {
-					for (let ev in this.config.customEvents) {
-						if (typeof this.config.customEvents[ev].symbol !== "undefined" && this.config.customEvents[ev].symbol !== "") {
-							let needle = new RegExp(this.config.customEvents[ev].keyword, "gi");
-							if (needle.test(event.title)) {
-								symbols[0] = this.config.customEvents[ev].symbol;
-								break;
-							}
-						}
-					}
-				}
 				symbols.forEach((s, index) => {
 					const symbol = document.createElement("span");
-					symbol.className = "fa fa-fw fa-" + s;
+					symbol.className = "fas fa-fw fa-" + s;
 					if (index > 0) {
 						symbol.style.paddingLeft = "5px";
 					}
@@ -317,6 +305,12 @@ Module.register("calendar", {
 					timeWrapper.className = "time light align-left " + this.timeClassForUrl(event.url);
 					timeWrapper.style.paddingLeft = "2px";
 					timeWrapper.innerHTML = moment(event.startDate, "x").format("LT");
+
+					// Add endDate to dataheaders if showEnd is enabled
+					if (this.config.showEnd) {
+						timeWrapper.innerHTML += " - " + moment(event.endDate, "x").format("LT");
+					}
+
 					eventWrapper.appendChild(timeWrapper);
 					titleWrapper.classList.add("align-right");
 				}
@@ -341,8 +335,7 @@ Module.register("calendar", {
 						//subtract one second so that fullDayEvents end at 23:59:59, and not at 0:00:00 one the next day
 						event.endDate -= oneSecond;
 						timeWrapper.innerHTML = this.capFirst(moment(event.startDate, "x").format(this.config.fullDayEventDateFormat));
-					}
-					if (this.config.getRelative > 0 && event.startDate < now) {
+					} else if (this.config.getRelative > 0 && event.startDate < now) {
 						// Ongoing and getRelative is set
 						timeWrapper.innerHTML = this.capFirst(
 							this.translate("RUNNING", {
@@ -368,9 +361,9 @@ Module.register("calendar", {
 					}
 				} else {
 					// Show relative times
-					if (event.startDate >= now) {
+					if (event.startDate >= now || (event.fullDayEvent && event.today)) {
 						// Use relative  time
-						if (!this.config.hideTime) {
+						if (!this.config.hideTime && !event.fullDayEvent) {
 							timeWrapper.innerHTML = this.capFirst(moment(event.startDate, "x").calendar(null, { sameElse: this.config.dateFormat }));
 						} else {
 							timeWrapper.innerHTML = this.capFirst(
@@ -378,12 +371,23 @@ Module.register("calendar", {
 									sameDay: "[" + this.translate("TODAY") + "]",
 									nextDay: "[" + this.translate("TOMORROW") + "]",
 									nextWeek: "dddd",
-									sameElse: this.config.dateFormat
+									sameElse: event.fullDayEvent ? this.config.fullDayEventDateFormat : this.config.dateFormat
 								})
 							);
 						}
-						if (event.startDate - now < this.config.getRelative * oneHour) {
-							// If event is within getRelative  hours, display 'in xxx' time format or moment.fromNow()
+						if (event.fullDayEvent) {
+							// Full days events within the next two days
+							if (event.today) {
+								timeWrapper.innerHTML = this.capFirst(this.translate("TODAY"));
+							} else if (event.startDate - now < oneDay && event.startDate - now > 0) {
+								timeWrapper.innerHTML = this.capFirst(this.translate("TOMORROW"));
+							} else if (event.startDate - now < 2 * oneDay && event.startDate - now > 0) {
+								if (this.translate("DAYAFTERTOMORROW") !== "DAYAFTERTOMORROW") {
+									timeWrapper.innerHTML = this.capFirst(this.translate("DAYAFTERTOMORROW"));
+								}
+							}
+						} else if (event.startDate - now < this.config.getRelative * oneHour) {
+							// If event is within getRelative hours, display 'in xxx' time format or moment.fromNow()
 							timeWrapper.innerHTML = this.capFirst(moment(event.startDate, "x").fromNow());
 						}
 					} else {
@@ -478,9 +482,10 @@ Module.register("calendar", {
 	/**
 	 * Creates the sorted list of all events.
 	 *
+	 * @param {boolean} limitNumberOfEntries Whether to filter returned events for display.
 	 * @returns {object[]} Array with events.
 	 */
-	createEventList: function () {
+	createEventList: function (limitNumberOfEntries) {
 		const now = new Date();
 		const today = moment().startOf("day");
 		const future = moment().startOf("day").add(this.config.maximumNumberOfDays, "days").toDate();
@@ -491,22 +496,20 @@ Module.register("calendar", {
 			for (const e in calendar) {
 				const event = JSON.parse(JSON.stringify(calendar[e])); // clone object
 
-				if (event.endDate < now) {
+				if (this.config.hidePrivate && event.class === "PRIVATE") {
+					// do not add the current event, skip it
 					continue;
 				}
-				if (this.config.hidePrivate) {
-					if (event.class === "PRIVATE") {
-						// do not add the current event, skip it
+				if (limitNumberOfEntries) {
+					if (event.endDate < now) {
 						continue;
 					}
-				}
-				if (this.config.hideOngoing) {
-					if (event.startDate < now) {
+					if (this.config.hideOngoing && event.startDate < now) {
+						continue;
+					}
+					if (this.listContainsEvent(events, event)) {
 						continue;
 					}
-				}
-				if (this.listContainsEvent(events, event)) {
-					continue;
 				}
 				event.url = calendarUrl;
 				event.today = event.startDate >= today && event.startDate < today + 24 * 60 * 60 * 1000;
@@ -549,6 +552,10 @@ Module.register("calendar", {
 			return a.startDate - b.startDate;
 		});
 
+		if (!limitNumberOfEntries) {
+			return events;
+		}
+
 		// Limit the number of days displayed
 		// If limitDays is set > 0, limit display to that number of days
 		if (this.config.limitDays > 0) {
@@ -629,6 +636,17 @@ Module.register("calendar", {
 			symbols = this.mergeUnique(this.getCalendarPropertyAsArray(event.url, "fullDaySymbol", this.config.defaultSymbol), symbols);
 		}
 
+		// If custom symbol is set, replace event symbol
+		for (let ev of this.config.customEvents) {
+			if (typeof ev.symbol !== "undefined" && ev.symbol !== "") {
+				let needle = new RegExp(ev.keyword, "gi");
+				if (needle.test(event.title)) {
+					symbols[0] = ev.symbol;
+					break;
+				}
+			}
+		}
+
 		return symbols;
 	},
 
@@ -825,22 +843,14 @@ Module.register("calendar", {
 	 * The all events available in one array, sorted on startdate.
 	 */
 	broadcastEvents: function () {
-		const eventList = [];
-		for (const url in this.calendarData) {
-			for (const ev of this.calendarData[url]) {
-				const event = cloneObject(ev);
-				event.symbol = this.symbolsForEvent(event);
-				event.calendarName = this.calendarNameForUrl(url);
-				event.color = this.colorForUrl(url);
-				delete event.url;
-				eventList.push(event);
-			}
+		const eventList = this.createEventList(false);
+		for (const event of eventList) {
+			event.symbol = this.symbolsForEvent(event);
+			event.calendarName = this.calendarNameForUrl(event.url);
+			event.color = this.colorForUrl(event.url);
+			delete event.url;
 		}
 
-		eventList.sort(function (a, b) {
-			return a.startDate - b.startDate;
-		});
-
 		this.sendNotification("CALENDAR_EVENTS", eventList);
 	}
 });

modules/default/calendar/calendarfetcher.js

@@ -1,4 +1,4 @@
-/* Magic Mirror
+/* MagicMirror²
  * Node Helper: Calendar - CalendarFetcher
  *
  * By Michael Teeuw https://michaelteeuw.nl
@@ -8,7 +8,7 @@ const CalendarUtils = require("./calendarutils");
 const Log = require("logger");
 const NodeHelper = require("node_helper");
 const ical = require("node-ical");
-const fetch = require("node-fetch");
+const fetch = require("fetch");
 const digest = require("digest-fetch");
 const https = require("https");
 
@@ -41,7 +41,7 @@ const CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEn
 		let fetcher = null;
 		let httpsAgent = null;
 		let headers = {
-			"User-Agent": "Mozilla/5.0 (Node.js " + nodeVersion + ") MagicMirror/" + global.version + " (https://github.com/MichMich/MagicMirror/)"
+			"User-Agent": "Mozilla/5.0 (Node.js " + nodeVersion + ") MagicMirror/" + global.version
 		};
 
 		if (selfSignedCert) {

modules/default/calendar/calendarutils.js

@@ -1,4 +1,4 @@
-/* Magic Mirror
+/* MagicMirror²
  * Calendar Util Methods
  *
  * By Michael Teeuw https://michaelteeuw.nl
@@ -98,7 +98,7 @@ const CalendarUtils = {
 				if (h > 0 && h < Math.abs(current_offset) / 60) {
 					// if so, rrule created a wrong date (utc day, oops, with utc yesterday adjusted time)
 					// we need to fix that
-					adjustHours = 24;
+					//adjustHours = 24;
 					// Log.debug("adjusting date")
 				}
 				//-300 > -240
@@ -138,13 +138,14 @@ const CalendarUtils = {
 			return CalendarUtils.isFullDayEvent(event) ? moment(event[time], "YYYYMMDD") : moment(new Date(event[time]));
 		};
 
-		Log.debug("there are " + Object.entries(data).length + " calendar entries");
+		Log.debug("There are " + Object.entries(data).length + " calendar entries.");
 		Object.entries(data).forEach(([key, event]) => {
+			Log.debug("Processing entry...");
 			const now = new Date();
 			const today = moment().startOf("day").toDate();
 			const future = moment().startOf("day").add(config.maximumNumberOfDays, "days").subtract(1, "seconds").toDate(); // Subtract 1 second so that events that start on the middle of the night will not repeat.
 			let past = today;
-			Log.debug("have entries ");
+
 			if (config.includePastEvents) {
 				past = moment().startOf("day").subtract(config.maximumNumberOfDays, "days").toDate();
 			}
@@ -159,10 +160,10 @@ const CalendarUtils = {
 			}
 
 			if (event.type === "VEVENT") {
+				Log.debug("Event:\n" + JSON.stringify(event));
 				let startDate = eventDate(event, "start");
 				let endDate;
 
-				Log.debug("\nevent=" + JSON.stringify(event));
 				if (typeof event.end !== "undefined") {
 					endDate = eventDate(event, "end");
 				} else if (typeof event.duration !== "undefined") {
@@ -176,16 +177,21 @@ const CalendarUtils = {
 					}
 				}
 
-				Log.debug(" start=" + startDate.toDate() + " end=" + endDate.toDate());
+				Log.debug("start: " + startDate.toDate());
+				Log.debug("end:: " + endDate.toDate());
 
-				// calculate the duration of the event for use with recurring events.
+				// Calculate the duration of the event for use with recurring events.
 				let duration = parseInt(endDate.format("x")) - parseInt(startDate.format("x"));
+				Log.debug("duration: " + duration);
 
+				// FIXME: Since the parsed json object from node-ical comes with time information
+				// this check could be removed (?)
 				if (event.start.length === 8) {
 					startDate = startDate.startOf("day");
 				}
 
 				const title = CalendarUtils.getTitleFromEvent(event);
+				Log.debug("title: " + title);
 
 				let excluded = false,
 					dateFilter = null;
@@ -260,9 +266,13 @@ const CalendarUtils = {
 					let pastLocal = 0;
 					let futureLocal = 0;
 					if (CalendarUtils.isFullDayEvent(event)) {
+						Log.debug("fullday");
 						// if full day event, only use the date part of the ranges
 						pastLocal = pastMoment.toDate();
 						futureLocal = futureMoment.toDate();
+
+						Log.debug("pastLocal: " + pastLocal);
+						Log.debug("futureLocal: " + futureLocal);
 					} else {
 						// if we want past events
 						if (config.includePastEvents) {
@@ -274,9 +284,9 @@ const CalendarUtils = {
 						}
 						futureLocal = futureMoment.toDate(); // future
 					}
-					Log.debug(" between=" + pastLocal + " to " + futureLocal);
+					Log.debug("Search for recurring events between: " + pastLocal + " and " + futureLocal);
 					const dates = rule.between(pastLocal, futureLocal, true, limitFunction);
-					Log.debug("title=" + event.summary + " dates=" + JSON.stringify(dates));
+					Log.debug("Title: " + event.summary + ", with dates: " + JSON.stringify(dates));
 					// The "dates" array contains the set of dates within our desired date range range that are valid
 					// for the recurrence rule. *However*, it's possible for us to have a specific recurrence that
 					// had its date changed from outside the range to inside the range.  For the time being,
@@ -284,6 +294,7 @@ const CalendarUtils = {
 					// because the logic below will filter out any recurrences that don't actually belong within
 					// our display range.
 					// Would be great if there was a better way to handle this.
+					Log.debug("event.recurrences: " + event.recurrences);
 					if (event.recurrences !== undefined) {
 						for (let r in event.recurrences) {
 							// Only add dates that weren't already in the range we added from the rrule so that
@@ -296,62 +307,63 @@ const CalendarUtils = {
 					// Loop through the set of date entries to see which recurrences should be added to our event list.
 					for (let d in dates) {
 						let date = dates[d];
-						// ical.js started returning recurrences and exdates as ISOStrings without time information.
-						// .toISOString().substring(0,10) is the method they use to calculate keys, so we'll do the same
-						// (see https://github.com/peterbraden/ical.js/pull/84 )
+						// Remove the time information of each date by using its substring, using the following method:
+						// .toISOString().substring(0,10).
+						// since the date is given as ISOString with YYYY-MM-DDTHH:MM:SS.SSSZ
+						// (see https://momentjs.com/docs/#/displaying/as-iso-string/).
 						const dateKey = date.toISOString().substring(0, 10);
 						let curEvent = event;
 						let showRecurrence = true;
 
-						// get the offset of today where we are processing
-						// this will be the correction we need to apply
+						// Get the offset of today where we are processing
+						// This will be the correction, we need to apply.
 						let nowOffset = new Date().getTimezoneOffset();
-						// for full day events, the time might be off from RRULE/Luxon problem
-						// get time zone offset of the rule calculated event
+						// For full day events, the time might be off from RRULE/Luxon problem
+						// Get time zone offset of the rule calculated event
 						let dateoffset = date.getTimezoneOffset();
-						// reduce the time by the offset
+
+						// Reduce the time by the following offset.
 						Log.debug(" recurring date is " + date + " offset is " + dateoffset);
+
 						let dh = moment(date).format("HH");
 						Log.debug(" recurring date is " + date + " offset is " + dateoffset / 60 + " Hour is " + dh);
+
 						if (CalendarUtils.isFullDayEvent(event)) {
-							Log.debug("fullday");
-							// if the offset is  negative, east of GMT where the problem is
+							Log.debug("Fullday");
+							// If the offset is negative (east of GMT), where the problem is
 							if (dateoffset < 0) {
-								// if the date hour is less than the offset
 								if (dh < Math.abs(dateoffset / 60)) {
 									// reduce the time by the offset
-									Log.debug(" recurring date is " + date + " offset is " + dateoffset);
-									// apply the correction to the date/time to get it UTC relative
-									date = new Date(date.getTime() - Math.abs(nowOffset) * 60000);
+									// Apply the correction to the date/time to get it UTC relative
+									date = new Date(date.getTime() - Math.abs(24 * 60) * 60000);
 									// the duration was calculated way back at the top before we could correct the start time..
 									// fix it for this event entry
 									//duration = 24 * 60 * 60 * 1000;
-									Log.debug("new recurring date1 is " + date);
+									Log.debug("new recurring date1 fulldate is " + date);
 								}
 							} else {
 								// if the timezones are the same, correct date if needed
-								if (event.start.tz === moment.tz.guess()) {
-									// if the date hour is less than the offset
-									if (24 - dh < Math.abs(dateoffset / 60)) {
-										// apply the correction to the date/time back to right day
-										date = new Date(date.getTime() + Math.abs(24 * 60) * 60000);
-										// the duration was calculated way back at the top before we could correct the start time..
-										// fix it for this event entry
-										//duration = 24 * 60 * 60 * 1000;
-										Log.debug("new recurring date2 is " + date);
-									}
+								//if (event.start.tz === moment.tz.guess()) {
+								// if the date hour is less than the offset
+								if (24 - dh <= Math.abs(dateoffset / 60)) {
+									// apply the correction to the date/time back to right day
+									date = new Date(date.getTime() + Math.abs(24 * 60) * 60000);
+									// the duration was calculated way back at the top before we could correct the start time..
+									// fix it for this event entry
+									//duration = 24 * 60 * 60 * 1000;
+									Log.debug("new recurring date2 fulldate is " + date);
 								}
+								//}
 							}
 						} else {
 							// not full day, but luxon can still screw up the date on the rule processing
 							// we need to correct the date to get back to the right event for
 							if (dateoffset < 0) {
 								// if the date hour is less than the offset
-								if (dh < Math.abs(dateoffset / 60)) {
-									// reduce the time by the offset
-									Log.debug(" recurring date is " + date + " offset is " + dateoffset);
-									// apply the correction to the date/time to get it UTC relative
-									date = new Date(date.getTime() - Math.abs(nowOffset) * 60000);
+								if (dh <= Math.abs(dateoffset / 60)) {
+									// Reduce the time by the offset:
+									// Apply the correction to the date/time to get it UTC relative
+									date = new Date(date.getTime() - Math.abs(24 * 60) * 60000);
 									// the duration was calculated way back at the top before we could correct the start time..
 									// fix it for this event entry
 									//duration = 24 * 60 * 60 * 1000;
@@ -359,20 +371,21 @@ const CalendarUtils = {
 								}
 							} else {
 								// if the timezones are the same, correct date if needed
-								if (event.start.tz === moment.tz.guess()) {
-									// if the date hour is less than the offset
-									if (24 - dh < Math.abs(dateoffset / 60)) {
-										// apply the correction to the date/time back to right day
-										date = new Date(date.getTime() + Math.abs(24 * 60) * 60000);
-										// the duration was calculated way back at the top before we could correct the start time..
-										// fix it for this event entry
-										//duration = 24 * 60 * 60 * 1000;
-										Log.debug("new recurring date2 is " + date);
-									}
+								//if (event.start.tz === moment.tz.guess()) {
+								// if the date hour is less than the offset
+								if (24 - dh <= Math.abs(dateoffset / 60)) {
+									// apply the correction to the date/time back to right day
+									date = new Date(date.getTime() + Math.abs(24 * 60) * 60000);
+									// the duration was calculated way back at the top before we could correct the start time..
+									// fix it for this event entry
+									//duration = 24 * 60 * 60 * 1000;
+									Log.debug("new recurring date2 is " + date);
 								}
+								//}
 							}
 						}
 						startDate = moment(date);
+						Log.debug("Corrected startDate: " + startDate.toDate());
 
 						let adjustDays = CalendarUtils.calculateTimezoneAdjustment(event, date);
 
@@ -388,7 +401,7 @@ const CalendarUtils = {
 							// This date is an exception date, which means we should skip it in the recurrence pattern.
 							showRecurrence = false;
 						}
-						Log.debug("duration=" + duration);
+						Log.debug("duration: " + duration);
 
 						endDate = moment(parseInt(startDate.format("x")) + duration, "x");
 						if (startDate.format("x") === endDate.format("x")) {
@@ -408,7 +421,7 @@ const CalendarUtils = {
 						}
 
 						if (showRecurrence === true) {
-							Log.debug("saving event =" + description);
+							Log.debug("saving event: " + description);
 							addedEvents++;
 							newEvents.push({
 								title: recurrenceTitle,
@@ -424,7 +437,7 @@ const CalendarUtils = {
 							});
 						}
 					}
-					// end recurring event parsing
+					// End recurring event parsing.
 				} else {
 					// Single event.
 					const fullDayEvent = isFacebookBirthday ? true : CalendarUtils.isFullDayEvent(event);
@@ -457,7 +470,7 @@ const CalendarUtils = {
 					}
 
 					// Adjust start date so multiple day events will be displayed as happening today even though they started some days ago already
-					if (fullDayEvent && startDate <= today) {
+					if (fullDayEvent && startDate <= today && endDate > today) {
 						startDate = moment(today);
 					}
 					// if the start and end are the same, then make end the 'end of day' value (start is at 00:00:00)
@@ -485,23 +498,8 @@ const CalendarUtils = {
 			return a.startDate - b.startDate;
 		});
 
-		// include up to maximumEntries current or upcoming events
-		// If past events should be included, include all past events
-		const now = moment();
-		let entries = 0;
-		let events = [];
-		for (let ne of newEvents) {
-			if (moment(ne.endDate, "x").isBefore(now)) {
-				if (config.includePastEvents) events.push(ne);
-				continue;
-			}
-			entries++;
-			// If max events has been saved, skip the rest
-			if (entries > config.maximumEntries) break;
-			events.push(ne);
-		}
-
-		return events;
+		let maxEvents = newEvents.slice(0, config.maximumEntries);
+		return maxEvents;
 	},
 
 	/**

modules/default/calendar/debug.js

@@ -1,6 +1,6 @@
 /* CalendarFetcher Tester
  * use this script with `node debug.js` to test the fetcher without the need
- * of starting the MagicMirror core. Adjust the values below to your desire.
+ * of starting the MagicMirror² core. Adjust the values below to your desire.
  *
  * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.

modules/default/calendar/node_helper.js

@@ -1,4 +1,4 @@
-/* Magic Mirror
+/* MagicMirror²
  * Node Helper: Calendar
  *
  * By Michael Teeuw https://michaelteeuw.nl

modules/default/clock/README.md

@@ -1,6 +1,6 @@
 # Module: Clock
 
-The `clock` module is one of the default modules of the MagicMirror.
+The `clock` module is one of the default modules of the MagicMirror².
 This module displays the current date and time. The information will be updated realtime.
 
 For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/clock.html).

modules/default/clock/clock.js

@@ -1,6 +1,6 @@
 /* global SunCalc */
 
-/* Magic Mirror
+/* MagicMirror²
  * Module: Clock
  *
  * By Michael Teeuw https://michaelteeuw.nl
@@ -12,11 +12,14 @@ Module.register("clock", {
 		displayType: "digital", // options: digital, analog, both
 
 		timeFormat: config.timeFormat,
+		timezone: null,
+
 		displaySeconds: true,
 		showPeriod: true,
 		showPeriodUpper: false,
 		clockBold: false,
 		showDate: true,
+		showTime: true,
 		showWeek: false,
 		dateFormat: "dddd, LL",
 
@@ -24,9 +27,8 @@ Module.register("clock", {
 		analogSize: "200px",
 		analogFace: "simple", // options: 'none', 'simple', 'face-###' (where ### is 001 to 012 inclusive)
 		analogPlacement: "bottom", // options: 'top', 'bottom', 'left', 'right'
-		analogShowDate: "top", // options: false, 'top', or 'bottom'
+		analogShowDate: "top", // OBSOLETE, can be replaced with analogPlacement and showTime, options: false, 'top', or 'bottom'
 		secondsColor: "#888888",
-		timezone: null,
 
 		showSunTimes: false,
 		showMoonTimes: false,
@@ -89,11 +91,20 @@ Module.register("clock", {
 	// Override dom generator.
 	getDom: function () {
 		const wrapper = document.createElement("div");
+		wrapper.classList.add("clockGrid");
+
+		/************************************
+		 * Create wrappers for analog and digital clock
+		 */
+		const analogWrapper = document.createElement("div");
+		analogWrapper.className = "clockCircle";
+		const digitalWrapper = document.createElement("div");
+		digitalWrapper.className = "digital";
+		digitalWrapper.style.gridArea = "center";
 
 		/************************************
 		 * Create wrappers for DIGITAL clock
 		 */
-
 		const dateWrapper = document.createElement("div");
 		const timeWrapper = document.createElement("div");
 		const secondsWrapper = document.createElement("sup");
@@ -101,10 +112,11 @@ Module.register("clock", {
 		const sunWrapper = document.createElement("div");
 		const moonWrapper = document.createElement("div");
 		const weekWrapper = document.createElement("div");
+
 		// Style Wrappers
 		dateWrapper.className = "date normal medium";
 		timeWrapper.className = "time bright large light";
-		secondsWrapper.className = "dimmed";
+		secondsWrapper.className = "seconds dimmed";
 		sunWrapper.className = "sun dimmed small";
 		moonWrapper.className = "moon dimmed small";
 		weekWrapper.className = "week dimmed medium";
@@ -124,7 +136,7 @@ Module.register("clock", {
 			hourSymbol = "h";
 		}
 
-		if (this.config.clockBold === true) {
+		if (this.config.clockBold) {
 			timeString = now.format(hourSymbol + '[<span class="bold">]mm[</span>]');
 		} else {
 			timeString = now.format(hourSymbol + ":mm");
@@ -132,22 +144,24 @@ Module.register("clock", {
 
 		if (this.config.showDate) {
 			dateWrapper.innerHTML = now.format(this.config.dateFormat);
+			digitalWrapper.appendChild(dateWrapper);
 		}
-		if (this.config.showWeek) {
-			weekWrapper.innerHTML = this.translate("WEEK", { weekNumber: now.week() });
-		}
-		timeWrapper.innerHTML = timeString;
-		secondsWrapper.innerHTML = now.format("ss");
-		if (this.config.showPeriodUpper) {
-			periodWrapper.innerHTML = now.format("A");
-		} else {
-			periodWrapper.innerHTML = now.format("a");
-		}
-		if (this.config.displaySeconds) {
-			timeWrapper.appendChild(secondsWrapper);
-		}
-		if (this.config.showPeriod && this.config.timeFormat !== 24) {
-			timeWrapper.appendChild(periodWrapper);
+
+		if (this.config.displayType !== "analog" && this.config.showTime) {
+			timeWrapper.innerHTML = timeString;
+			secondsWrapper.innerHTML = now.format("ss");
+			if (this.config.showPeriodUpper) {
+				periodWrapper.innerHTML = now.format("A");
+			} else {
+				periodWrapper.innerHTML = now.format("a");
+			}
+			if (this.config.displaySeconds) {
+				timeWrapper.appendChild(secondsWrapper);
+			}
+			if (this.config.showPeriod && this.config.timeFormat !== 24) {
+				timeWrapper.appendChild(periodWrapper);
+			}
+			digitalWrapper.appendChild(timeWrapper);
 		}
 
 		/**
@@ -165,6 +179,9 @@ Module.register("clock", {
 			return moment(time).format(formatString);
 		}
 
+		/****************************************************************
+		 * Create wrappers for Sun Times, only if specified in config
+		 */
 		if (this.config.showSunTimes) {
 			const sunTimes = SunCalc.getTimes(now, this.config.lat, this.config.lon);
 			const isVisible = now.isBetween(sunTimes.sunrise, sunTimes.sunset);
@@ -182,16 +199,21 @@ Module.register("clock", {
 			sunWrapper.innerHTML =
 				'<span class="' +
 				(isVisible ? "bright" : "") +
-				'"><i class="fa fa-sun-o" aria-hidden="true"></i> ' +
+				'"><i class="fas fa-sun" aria-hidden="true"></i> ' +
 				untilNextEventString +
 				"</span>" +
-				'<span><i class="fa fa-arrow-up" aria-hidden="true"></i> ' +
+				'<span><i class="fas fa-arrow-up" aria-hidden="true"></i> ' +
 				formatTime(this.config, sunTimes.sunrise) +
 				"</span>" +
-				'<span><i class="fa fa-arrow-down" aria-hidden="true"></i> ' +
+				'<span><i class="fas fa-arrow-down" aria-hidden="true"></i> ' +
 				formatTime(this.config, sunTimes.sunset) +
 				"</span>";
+			digitalWrapper.appendChild(sunWrapper);
 		}
+
+		/****************************************************************
+		 * Create wrappers for Moon Times, only if specified in config
+		 */
 		if (this.config.showMoonTimes) {
 			const moonIllumination = SunCalc.getMoonIllumination(now.toDate());
 			const moonTimes = SunCalc.getMoonTimes(now, this.config.lat, this.config.lon);
@@ -208,22 +230,26 @@ Module.register("clock", {
 			moonWrapper.innerHTML =
 				'<span class="' +
 				(isVisible ? "bright" : "") +
-				'"><i class="fa fa-moon-o" aria-hidden="true"></i> ' +
+				'"><i class="fas fa-moon" aria-hidden="true"></i> ' +
 				illuminatedFractionString +
 				"</span>" +
-				'<span><i class="fa fa-arrow-up" aria-hidden="true"></i> ' +
+				'<span><i class="fas fa-arrow-up" aria-hidden="true"></i> ' +
 				(moonRise ? formatTime(this.config, moonRise) : "...") +
 				"</span>" +
-				'<span><i class="fa fa-arrow-down" aria-hidden="true"></i> ' +
+				'<span><i class="fas fa-arrow-down" aria-hidden="true"></i> ' +
 				(moonSet ? formatTime(this.config, moonSet) : "...") +
 				"</span>";
+			digitalWrapper.appendChild(moonWrapper);
+		}
+
+		if (this.config.showWeek) {
+			weekWrapper.innerHTML = this.translate("WEEK", { weekNumber: now.week() });
+			digitalWrapper.appendChild(weekWrapper);
 		}
 
 		/****************************************************************
 		 * Create wrappers for ANALOG clock, only if specified in config
 		 */
-		const clockCircle = document.createElement("div");
-
 		if (this.config.displayType !== "digital") {
 			// If it isn't 'digital', then an 'analog' clock was also requested
 
@@ -236,19 +262,18 @@ Module.register("clock", {
 				hour = ((now.hours() % 12) / 12) * 360 + 90 + minute / 12;
 
 			// Create wrappers
-			clockCircle.className = "clockCircle";
-			clockCircle.style.width = this.config.analogSize;
-			clockCircle.style.height = this.config.analogSize;
+			analogWrapper.style.width = this.config.analogSize;
+			analogWrapper.style.height = this.config.analogSize;
 
 			if (this.config.analogFace !== "" && this.config.analogFace !== "simple" && this.config.analogFace !== "none") {
-				clockCircle.style.background = "url(" + this.data.path + "faces/" + this.config.analogFace + ".svg)";
-				clockCircle.style.backgroundSize = "100%";
+				analogWrapper.style.background = "url(" + this.data.path + "faces/" + this.config.analogFace + ".svg)";
+				analogWrapper.style.backgroundSize = "100%";
 
 				// The following line solves issue: https://github.com/MichMich/MagicMirror/issues/611
-				// clockCircle.style.border = "1px solid black";
-				clockCircle.style.border = "rgba(0, 0, 0, 0.1)"; //Updated fix for Issue 611 where non-black backgrounds are used
+				// analogWrapper.style.border = "1px solid black";
+				analogWrapper.style.border = "rgba(0, 0, 0, 0.1)"; //Updated fix for Issue 611 where non-black backgrounds are used
 			} else if (this.config.analogFace !== "none") {
-				clockCircle.style.border = "2px solid white";
+				analogWrapper.style.border = "2px solid white";
 			}
 			const clockFace = document.createElement("div");
 			clockFace.className = "clockFace";
@@ -274,84 +299,28 @@ Module.register("clock", {
 				clockSecond.style.backgroundColor = this.config.secondsColor;
 				clockFace.appendChild(clockSecond);
 			}
-			clockCircle.appendChild(clockFace);
+			analogWrapper.appendChild(clockFace);
 		}
 
 		/*******************************************
-		 * Combine wrappers, check for .displayType
+		 * Update placement, respect old analogShowDate even if its not needed anymore
 		 */
-
-		if (this.config.displayType === "digital") {
-			// Display only a digital clock
-			wrapper.appendChild(dateWrapper);
-			wrapper.appendChild(timeWrapper);
-			wrapper.appendChild(sunWrapper);
-			wrapper.appendChild(moonWrapper);
-			wrapper.appendChild(weekWrapper);
-		} else if (this.config.displayType === "analog") {
+		if (this.config.displayType === "analog") {
 			// Display only an analog clock
-
-			if (this.config.showWeek) {
-				weekWrapper.style.paddingBottom = "15px";
-			} else {
-				dateWrapper.style.paddingBottom = "15px";
-			}
-
 			if (this.config.analogShowDate === "top") {
-				wrapper.appendChild(dateWrapper);
-				wrapper.appendChild(weekWrapper);
-				wrapper.appendChild(clockCircle);
+				wrapper.classList.add("clockGrid--bottom");
 			} else if (this.config.analogShowDate === "bottom") {
-				wrapper.appendChild(clockCircle);
-				wrapper.appendChild(dateWrapper);
-				wrapper.appendChild(weekWrapper);
+				wrapper.classList.add("clockGrid--top");
 			} else {
-				wrapper.appendChild(clockCircle);
-			}
-		} else {
-			// Both clocks have been configured, check position
-			const placement = this.config.analogPlacement;
-
-			const analogWrapper = document.createElement("div");
-			analogWrapper.id = "analog";
-			analogWrapper.style.cssFloat = "none";
-			analogWrapper.appendChild(clockCircle);
-
-			const digitalWrapper = document.createElement("div");
-			digitalWrapper.id = "digital";
-			digitalWrapper.style.cssFloat = "none";
-			digitalWrapper.appendChild(dateWrapper);
-			digitalWrapper.appendChild(timeWrapper);
-			digitalWrapper.appendChild(sunWrapper);
-			digitalWrapper.appendChild(moonWrapper);
-			digitalWrapper.appendChild(weekWrapper);
-
-			const appendClocks = (condition, pos1, pos2) => {
-				const padding = [0, 0, 0, 0];
-				padding[placement === condition ? pos1 : pos2] = "20px";
-				analogWrapper.style.padding = padding.join(" ");
-				if (placement === condition) {
-					wrapper.appendChild(analogWrapper);
-					wrapper.appendChild(digitalWrapper);
-				} else {
-					wrapper.appendChild(digitalWrapper);
-					wrapper.appendChild(analogWrapper);
-				}
-			};
-
-			if (placement === "left" || placement === "right") {
-				digitalWrapper.style.display = "inline-block";
-				digitalWrapper.style.verticalAlign = "top";
-				analogWrapper.style.display = "inline-block";
-
-				appendClocks("left", 1, 3);
-			} else {
-				digitalWrapper.style.textAlign = "center";
-
-				appendClocks("top", 2, 0);
+				//analogWrapper.style.gridArea = "center";
 			}
+		} else if (this.config.displayType === "both") {
+			wrapper.classList.add("clockGrid--" + this.config.analogPlacement);
 		}
 
+		wrapper.appendChild(analogWrapper);
+		wrapper.appendChild(digitalWrapper);
+
 		// Return the wrapper to the dom.
 		return wrapper;
 	}

modules/default/clock/clock_styles.css

@@ -1,5 +1,26 @@
+.clockGrid {
+  display: inline-flex;
+  gap: 15px;
+}
+
+.clockGrid--left {
+  flex-direction: row;
+}
+
+.clockGrid--right {
+  flex-direction: row-reverse;
+}
+
+.clockGrid--top {
+  flex-direction: column;
+}
+
+.clockGrid--bottom {
+  flex-direction: column-reverse;
+}
+
 .clockCircle {
-  margin: 0 auto;
+  place-self: center;
   position: relative;
   border-radius: 50%;
   background-size: 100%;

modules/default/compliments/README.md

@@ -1,6 +1,6 @@
 # Module: Compliments
 
-The `compliments` module is one of the default modules of the MagicMirror.
+The `compliments` module is one of the default modules of the MagicMirror².
 This module displays a random compliment.
 
 For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/compliments.html).

modules/default/compliments/compliments.js

@@ -1,4 +1,4 @@
-/* Magic Mirror
+/* MagicMirror²
  * Module: Compliments
  *
  * By Michael Teeuw https://michaelteeuw.nl

modules/default/currentweather/README.md

@@ -1,8 +0,0 @@
-# Module: Current Weather
-
-> :warning: **This module is deprecated in favor of the [weather](https://docs.magicmirror.builders/modules/weather.html) module.**
-
-The `currentweather` module is one of the default modules of the MagicMirror.
-This module displays the current weather, including the windspeed, the sunset or sunrise time, the temperature and an icon to display the current conditions.
-
-For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/currentweather.html).

modules/default/currentweather/currentweather.css

@@ -1,15 +0,0 @@
-.currentweather .weathericon,
-.currentweather .fa-home {
-  font-size: 75%;
-  line-height: 65px;
-  display: inline-block;
-  transform: translate(0, -3px);
-}
-
-.currentweather .humidityIcon {
-  padding-right: 4px;
-}
-
-.currentweather .humidity-padding {
-  padding-bottom: 6px;
-}

modules/default/currentweather/currentweather.js

@@ -1,4 +1,6 @@
-/* Magic Mirror
+/* eslint-disable */
+
+/* MagicMirror²
  * Module: CurrentWeather
  *
  * By Michael Teeuw https://michaelteeuw.nl
@@ -7,592 +9,25 @@
  * This module is deprecated. Any additional feature will no longer be merged.
  */
 Module.register("currentweather", {
-	// Default module config.
-	defaults: {
-		location: false,
-		locationID: false,
-		appid: "",
-		units: config.units,
-		updateInterval: 10 * 60 * 1000, // every 10 minutes
-		animationSpeed: 1000,
-		timeFormat: config.timeFormat,
-		showPeriod: true,
-		showPeriodUpper: false,
-		showWindDirection: true,
-		showWindDirectionAsArrow: false,
-		useBeaufort: true,
-		useKMPHwind: false,
-		lang: config.language,
-		decimalSymbol: ".",
-		showHumidity: false,
-		showSun: true,
-		degreeLabel: false,
-		showIndoorTemperature: false,
-		showIndoorHumidity: false,
-		showFeelsLike: true,
-
-		initialLoadDelay: 0, // 0 seconds delay
-		retryDelay: 2500,
-
-		apiVersion: "2.5",
-		apiBase: "https://api.openweathermap.org/data/",
-		weatherEndpoint: "weather",
-
-		appendLocationNameToHeader: true,
-		useLocationAsHeader: false,
-
-		calendarClass: "calendar",
-		tableClass: "large",
-
-		onlyTemp: false,
-		hideTemp: false,
-		roundTemp: false,
-
-		iconTable: {
-			"01d": "day-sunny",
-			"02d": "day-cloudy",
-			"03d": "cloudy",
-			"04d": "cloudy-windy",
-			"09d": "showers",
-			"10d": "rain",
-			"11d": "thunderstorm",
-			"13d": "snow",
-			"50d": "fog",
-			"01n": "night-clear",
-			"02n": "night-cloudy",
-			"03n": "night-cloudy",
-			"04n": "night-cloudy",
-			"09n": "night-showers",
-			"10n": "night-rain",
-			"11n": "night-thunderstorm",
-			"13n": "night-snow",
-			"50n": "night-alt-cloudy-windy"
-		}
-	},
-
-	// create a variable for the first upcoming calendar event. Used if no location is specified.
-	firstEvent: false,
-
-	// create a variable to hold the location name based on the API result.
-	fetchedLocationName: "",
-
-	// Define required scripts.
-	getScripts: function () {
-		return ["moment.js"];
-	},
-
-	// Define required scripts.
-	getStyles: function () {
-		return ["weather-icons.css", "currentweather.css"];
-	},
-
-	// Define required translations.
-	getTranslations: function () {
-		// The translations for the default modules are defined in the core translation files.
-		// Therefor we can just return false. Otherwise we should have returned a dictionary.
-		// If you're trying to build your own module including translations, check out the documentation.
-		return false;
-	},
-
 	// Define start sequence.
 	start: function () {
 		Log.info("Starting module: " + this.name);
-
-		// Set locale.
-		moment.locale(config.language);
-
-		this.windSpeed = null;
-		this.windDirection = null;
-		this.windDeg = null;
-		this.sunriseSunsetTime = null;
-		this.sunriseSunsetIcon = null;
-		this.temperature = null;
-		this.indoorTemperature = null;
-		this.indoorHumidity = null;
-		this.weatherType = null;
-		this.feelsLike = null;
-		this.loaded = false;
-		this.scheduleUpdate(this.config.initialLoadDelay);
-	},
-
-	// add extra information of current weather
-	// windDirection, humidity, sunrise and sunset
-	addExtraInfoWeather: function (wrapper) {
-		var small = document.createElement("div");
-		small.className = "normal medium";
-
-		var windIcon = document.createElement("span");
-		windIcon.className = "wi wi-strong-wind dimmed";
-		small.appendChild(windIcon);
-
-		var windSpeed = document.createElement("span");
-		windSpeed.innerHTML = " " + this.windSpeed;
-		small.appendChild(windSpeed);
-
-		if (this.config.showWindDirection) {
-			var windDirection = document.createElement("sup");
-			if (this.config.showWindDirectionAsArrow) {
-				if (this.windDeg !== null) {
-					windDirection.innerHTML = ' &nbsp;<i class="fa fa-long-arrow-down" style="transform:rotate(' + this.windDeg + 'deg);"></i>&nbsp;';
-				}
-			} else {
-				windDirection.innerHTML = " " + this.translate(this.windDirection);
-			}
-			small.appendChild(windDirection);
-		}
-		var spacer = document.createElement("span");
-		spacer.innerHTML = "&nbsp;";
-		small.appendChild(spacer);
-
-		if (this.config.showHumidity) {
-			var humidity = document.createElement("span");
-			humidity.innerHTML = this.humidity;
-
-			var supspacer = document.createElement("sup");
-			supspacer.innerHTML = "&nbsp;";
-
-			var humidityIcon = document.createElement("sup");
-			humidityIcon.className = "wi wi-humidity humidityIcon";
-			humidityIcon.innerHTML = "&nbsp;";
-
-			small.appendChild(humidity);
-			small.appendChild(supspacer);
-			small.appendChild(humidityIcon);
-		}
-
-		if (this.config.showSun) {
-			var sunriseSunsetIcon = document.createElement("span");
-			sunriseSunsetIcon.className = "wi dimmed " + this.sunriseSunsetIcon;
-			small.appendChild(sunriseSunsetIcon);
-
-			var sunriseSunsetTime = document.createElement("span");
-			sunriseSunsetTime.innerHTML = " " + this.sunriseSunsetTime;
-			small.appendChild(sunriseSunsetTime);
-		}
-
-		wrapper.appendChild(small);
 	},
 
 	// Override dom generator.
 	getDom: function () {
 		var wrapper = document.createElement("div");
 		wrapper.className = this.config.tableClass;
-
-		if (this.config.appid === "") {
-			wrapper.innerHTML = "Please set the correct openweather <i>appid</i> in the config for module: " + this.name + ".";
-			wrapper.className = "dimmed light small";
-			return wrapper;
-		}
-
-		if (!this.loaded) {
-			wrapper.innerHTML = this.translate("LOADING");
-			wrapper.className = "dimmed light small";
-			return wrapper;
-		}
-
-		if (this.config.onlyTemp === false) {
-			this.addExtraInfoWeather(wrapper);
-		}
-
-		var large = document.createElement("div");
-		large.className = "light";
-
-		var degreeLabel = "";
-		if (this.config.units === "metric" || this.config.units === "imperial") {
-			degreeLabel += "°";
-		}
-		if (this.config.degreeLabel) {
-			switch (this.config.units) {
-				case "metric":
-					degreeLabel += "C";
-					break;
-				case "imperial":
-					degreeLabel += "F";
-					break;
-				case "default":
-					degreeLabel += "K";
-					break;
-			}
-		}
-
-		if (this.config.decimalSymbol === "") {
-			this.config.decimalSymbol = ".";
-		}
-
-		if (this.config.hideTemp === false) {
-			var weatherIcon = document.createElement("span");
-			weatherIcon.className = "wi weathericon wi-" + this.weatherType;
-			large.appendChild(weatherIcon);
-
-			var temperature = document.createElement("span");
-			temperature.className = "bright";
-			temperature.innerHTML = " " + this.temperature.replace(".", this.config.decimalSymbol) + degreeLabel;
-			large.appendChild(temperature);
-		}
-
-		if (this.config.showIndoorTemperature && this.indoorTemperature) {
-			var indoorIcon = document.createElement("span");
-			indoorIcon.className = "fa fa-home";
-			large.appendChild(indoorIcon);
-
-			var indoorTemperatureElem = document.createElement("span");
-			indoorTemperatureElem.className = "bright";
-			indoorTemperatureElem.innerHTML = " " + this.indoorTemperature.replace(".", this.config.decimalSymbol) + degreeLabel;
-			large.appendChild(indoorTemperatureElem);
-		}
-
-		if (this.config.showIndoorHumidity && this.indoorHumidity) {
-			var indoorHumidityIcon = document.createElement("span");
-			indoorHumidityIcon.className = "fa fa-tint";
-			large.appendChild(indoorHumidityIcon);
-
-			var indoorHumidityElem = document.createElement("span");
-			indoorHumidityElem.className = "bright";
-			indoorHumidityElem.innerHTML = " " + this.indoorHumidity + "%";
-			large.appendChild(indoorHumidityElem);
-		}
-
-		wrapper.appendChild(large);
-
-		if (this.config.showFeelsLike && this.config.onlyTemp === false) {
-			var small = document.createElement("div");
-			small.className = "normal medium";
-
-			var feelsLike = document.createElement("span");
-			feelsLike.className = "dimmed";
-			feelsLike.innerHTML = this.translate("FEELS", {
-				DEGREE: this.feelsLike + degreeLabel
-			});
-			small.appendChild(feelsLike);
-
-			wrapper.appendChild(small);
-		}
-
+		wrapper.innerHTML =
+			"<style>text-decoration: none</style>" +
+			"This module is deprecated since release v2.15 and removed with v2.19." +
+			'<br>Please use the `weather` module as replacement, more info in the <a href="https://docs.magicmirror.builders/modules/weather.html" style="color: #ffffff">documentation</a>.';
+		wrapper.className = "dimmed light small";
 		return wrapper;
 	},
 
 	// Override getHeader method.
 	getHeader: function () {
-		if (this.config.useLocationAsHeader && this.config.location !== false) {
-			return this.config.location;
-		}
-
-		if (this.config.appendLocationNameToHeader) {
-			if (this.data.header) return this.data.header + " " + this.fetchedLocationName;
-			else return this.fetchedLocationName;
-		}
-
-		return this.data.header ? this.data.header : "";
-	},
-
-	// Override notification handler.
-	notificationReceived: function (notification, payload, sender) {
-		if (notification === "DOM_OBJECTS_CREATED") {
-			if (this.config.appendLocationNameToHeader) {
-				this.hide(0, { lockString: this.identifier });
-			}
-		}
-		if (notification === "CALENDAR_EVENTS") {
-			var senderClasses = sender.data.classes.toLowerCase().split(" ");
-			if (senderClasses.indexOf(this.config.calendarClass.toLowerCase()) !== -1) {
-				this.firstEvent = false;
-
-				for (var e in payload) {
-					var event = payload[e];
-					if (event.location || event.geo) {
-						this.firstEvent = event;
-						//Log.log("First upcoming event with location: ", event);
-						break;
-					}
-				}
-			}
-		}
-		if (notification === "INDOOR_TEMPERATURE") {
-			this.indoorTemperature = this.roundValue(payload);
-			this.updateDom(this.config.animationSpeed);
-		}
-		if (notification === "INDOOR_HUMIDITY") {
-			this.indoorHumidity = this.roundValue(payload);
-			this.updateDom(this.config.animationSpeed);
-		}
-	},
-
-	/* updateWeather(compliments)
-	 * Requests new data from openweather.org.
-	 * Calls processWeather on succesfull response.
-	 */
-	updateWeather: function () {
-		if (this.config.appid === "") {
-			Log.error("CurrentWeather: APPID not set!");
-			return;
-		}
-
-		var url = this.config.apiBase + this.config.apiVersion + "/" + this.config.weatherEndpoint + this.getParams();
-		var self = this;
-		var retry = true;
-
-		var weatherRequest = new XMLHttpRequest();
-		weatherRequest.open("GET", url, true);
-		weatherRequest.onreadystatechange = function () {
-			if (this.readyState === 4) {
-				if (this.status === 200) {
-					self.processWeather(JSON.parse(this.response));
-				} else if (this.status === 401) {
-					self.updateDom(self.config.animationSpeed);
-
-					Log.error(self.name + ": Incorrect APPID.");
-					retry = true;
-				} else {
-					Log.error(self.name + ": Could not load weather.");
-				}
-
-				if (retry) {
-					self.scheduleUpdate(self.loaded ? -1 : self.config.retryDelay);
-				}
-			}
-		};
-		weatherRequest.send();
-	},
-
-	/* getParams(compliments)
-	 * Generates an url with api parameters based on the config.
-	 *
-	 * return String - URL params.
-	 */
-	getParams: function () {
-		var params = "?";
-		if (this.config.locationID) {
-			params += "id=" + this.config.locationID;
-		} else if (this.config.location) {
-			params += "q=" + this.config.location;
-		} else if (this.firstEvent && this.firstEvent.geo) {
-			params += "lat=" + this.firstEvent.geo.lat + "&lon=" + this.firstEvent.geo.lon;
-		} else if (this.firstEvent && this.firstEvent.location) {
-			params += "q=" + this.firstEvent.location;
-		} else {
-			this.hide(this.config.animationSpeed, { lockString: this.identifier });
-			return;
-		}
-
-		params += "&units=" + this.config.units;
-		params += "&lang=" + this.config.lang;
-		params += "&APPID=" + this.config.appid;
-
-		return params;
-	},
-
-	/* processWeather(data)
-	 * Uses the received data to set the various values.
-	 *
-	 * argument data object - Weather information received form openweather.org.
-	 */
-	processWeather: function (data) {
-		if (!data || !data.main || typeof data.main.temp === "undefined") {
-			// Did not receive usable new data.
-			// Maybe this needs a better check?
-			return;
-		}
-
-		this.humidity = parseFloat(data.main.humidity);
-		this.temperature = this.roundValue(data.main.temp);
-		this.fetchedLocationName = data.name;
-		this.feelsLike = 0;
-
-		if (this.config.useBeaufort) {
-			this.windSpeed = this.ms2Beaufort(this.roundValue(data.wind.speed));
-		} else if (this.config.useKMPHwind) {
-			this.windSpeed = parseFloat((data.wind.speed * 60 * 60) / 1000).toFixed(0);
-		} else {
-			this.windSpeed = parseFloat(data.wind.speed).toFixed(0);
-		}
-
-		// ONLY WORKS IF TEMP IN C //
-		var windInMph = parseFloat(data.wind.speed * 2.23694);
-
-		var tempInF = 0;
-		switch (this.config.units) {
-			case "metric":
-				tempInF = 1.8 * this.temperature + 32;
-				break;
-			case "imperial":
-				tempInF = this.temperature;
-				break;
-			case "default":
-				tempInF = 1.8 * (this.temperature - 273.15) + 32;
-				break;
-		}
-
-		if (windInMph > 3 && tempInF < 50) {
-			// windchill
-			var windChillInF = Math.round(35.74 + 0.6215 * tempInF - 35.75 * Math.pow(windInMph, 0.16) + 0.4275 * tempInF * Math.pow(windInMph, 0.16));
-			var windChillInC = (windChillInF - 32) * (5 / 9);
-			// this.feelsLike = windChillInC.toFixed(0);
-
-			switch (this.config.units) {
-				case "metric":
-					this.feelsLike = windChillInC.toFixed(0);
-					break;
-				case "imperial":
-					this.feelsLike = windChillInF.toFixed(0);
-					break;
-				case "default":
-					this.feelsLike = (windChillInC + 273.15).toFixed(0);
-					break;
-			}
-		} else if (tempInF > 80 && this.humidity > 40) {
-			// heat index
-			var Hindex =
-				-42.379 +
-				2.04901523 * tempInF +
-				10.14333127 * this.humidity -
-				0.22475541 * tempInF * this.humidity -
-				6.83783 * Math.pow(10, -3) * tempInF * tempInF -
-				5.481717 * Math.pow(10, -2) * this.humidity * this.humidity +
-				1.22874 * Math.pow(10, -3) * tempInF * tempInF * this.humidity +
-				8.5282 * Math.pow(10, -4) * tempInF * this.humidity * this.humidity -
-				1.99 * Math.pow(10, -6) * tempInF * tempInF * this.humidity * this.humidity;
-
-			switch (this.config.units) {
-				case "metric":
-					this.feelsLike = parseFloat((Hindex - 32) / 1.8).toFixed(0);
-					break;
-				case "imperial":
-					this.feelsLike = Hindex.toFixed(0);
-					break;
-				case "default":
-					var tc = parseFloat((Hindex - 32) / 1.8) + 273.15;
-					this.feelsLike = tc.toFixed(0);
-					break;
-			}
-		} else {
-			this.feelsLike = parseFloat(this.temperature).toFixed(0);
-		}
-
-		this.windDirection = this.deg2Cardinal(data.wind.deg);
-		this.windDeg = data.wind.deg;
-		this.weatherType = this.config.iconTable[data.weather[0].icon];
-
-		var now = new Date();
-		var sunrise = new Date(data.sys.sunrise * 1000);
-		var sunset = new Date(data.sys.sunset * 1000);
-
-		// The moment().format('h') method has a bug on the Raspberry Pi.
-		// So we need to generate the timestring manually.
-		// See issue: https://github.com/MichMich/MagicMirror/issues/181
-		var sunriseSunsetDateObject = sunrise < now && sunset > now ? sunset : sunrise;
-		var timeString = moment(sunriseSunsetDateObject).format("HH:mm");
-		if (this.config.timeFormat !== 24) {
-			//var hours = sunriseSunsetDateObject.getHours() % 12 || 12;
-			if (this.config.showPeriod) {
-				if (this.config.showPeriodUpper) {
-					//timeString = hours + moment(sunriseSunsetDateObject).format(':mm A');
-					timeString = moment(sunriseSunsetDateObject).format("h:mm A");
-				} else {
-					//timeString = hours + moment(sunriseSunsetDateObject).format(':mm a');
-					timeString = moment(sunriseSunsetDateObject).format("h:mm a");
-				}
-			} else {
-				//timeString = hours + moment(sunriseSunsetDateObject).format(':mm');
-				timeString = moment(sunriseSunsetDateObject).format("h:mm");
-			}
-		}
-
-		this.sunriseSunsetTime = timeString;
-		this.sunriseSunsetIcon = sunrise < now && sunset > now ? "wi-sunset" : "wi-sunrise";
-
-		this.show(this.config.animationSpeed, { lockString: this.identifier });
-		this.loaded = true;
-		this.updateDom(this.config.animationSpeed);
-		this.sendNotification("CURRENTWEATHER_DATA", { data: data });
-		this.sendNotification("CURRENTWEATHER_TYPE", { type: this.config.iconTable[data.weather[0].icon].replace("-", "_") });
-	},
-
-	/* scheduleUpdate()
-	 * Schedule next update.
-	 *
-	 * argument delay number - Milliseconds before next update. If empty, this.config.updateInterval is used.
-	 */
-	scheduleUpdate: function (delay) {
-		var nextLoad = this.config.updateInterval;
-		if (typeof delay !== "undefined" && delay >= 0) {
-			nextLoad = delay;
-		}
-
-		var self = this;
-		setTimeout(function () {
-			self.updateWeather();
-		}, nextLoad);
-	},
-
-	/* ms2Beaufort(ms)
-	 * Converts m2 to beaufort (windspeed).
-	 *
-	 * see:
-	 *  https://www.spc.noaa.gov/faq/tornado/beaufort.html
-	 *  https://en.wikipedia.org/wiki/Beaufort_scale#Modern_scale
-	 *
-	 * argument ms number - Windspeed in m/s.
-	 *
-	 * return number - Windspeed in beaufort.
-	 */
-	ms2Beaufort: function (ms) {
-		var kmh = (ms * 60 * 60) / 1000;
-		var speeds = [1, 5, 11, 19, 28, 38, 49, 61, 74, 88, 102, 117, 1000];
-		for (var beaufort in speeds) {
-			var speed = speeds[beaufort];
-			if (speed > kmh) {
-				return beaufort;
-			}
-		}
-		return 12;
-	},
-
-	deg2Cardinal: function (deg) {
-		if (deg > 11.25 && deg <= 33.75) {
-			return "NNE";
-		} else if (deg > 33.75 && deg <= 56.25) {
-			return "NE";
-		} else if (deg > 56.25 && deg <= 78.75) {
-			return "ENE";
-		} else if (deg > 78.75 && deg <= 101.25) {
-			return "E";
-		} else if (deg > 101.25 && deg <= 123.75) {
-			return "ESE";
-		} else if (deg > 123.75 && deg <= 146.25) {
-			return "SE";
-		} else if (deg > 146.25 && deg <= 168.75) {
-			return "SSE";
-		} else if (deg > 168.75 && deg <= 191.25) {
-			return "S";
-		} else if (deg > 191.25 && deg <= 213.75) {
-			return "SSW";
-		} else if (deg > 213.75 && deg <= 236.25) {
-			return "SW";
-		} else if (deg > 236.25 && deg <= 258.75) {
-			return "WSW";
-		} else if (deg > 258.75 && deg <= 281.25) {
-			return "W";
-		} else if (deg > 281.25 && deg <= 303.75) {
-			return "WNW";
-		} else if (deg > 303.75 && deg <= 326.25) {
-			return "NW";
-		} else if (deg > 326.25 && deg <= 348.75) {
-			return "NNW";
-		} else {
-			return "N";
-		}
-	},
-
-	/* function(temperature)
-	 * Rounds a temperature to 1 decimal or integer (depending on config.roundTemp).
-	 *
-	 * argument temperature number - Temperature.
-	 *
-	 * return string - Rounded Temperature.
-	 */
-	roundValue: function (temperature) {
-		var decimals = this.config.roundTemp ? 0 : 1;
-		var roundValue = parseFloat(temperature).toFixed(decimals);
-		return roundValue === "-0" ? 0 : roundValue;
+		return "deprecated currentweather";
 	}
 });

modules/default/currentweather/node_helper.js

@@ -1,9 +0,0 @@
-const NodeHelper = require("node_helper");
-const Log = require("logger");
-
-module.exports = NodeHelper.create({
-	// Override start method.
-	start: function () {
-		Log.warn(`The module '${this.name}' is deprecated in favor of the 'weather'-module, please refer to the documentation for a migration path`);
-	}
-});

modules/default/defaultmodules.js

@@ -1,4 +1,4 @@
-/* Magic Mirror Default Modules List
+/* MagicMirror² Default Modules List
  * Modules listed below can be loaded without the 'default/' prefix. Omitting the default folder name.
  *
  * By Michael Teeuw https://michaelteeuw.nl

modules/default/helloworld/README.md

@@ -1,5 +1,5 @@
 # Module: Hello World
 
-The `helloworld` module is one of the default modules of the MagicMirror. It is a simple way to display a static text on the mirror.
+The `helloworld` module is one of the default modules of the MagicMirror². It is a simple way to display a static text on the mirror.
 
 For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/helloworld.html).

modules/default/helloworld/helloworld.js

@@ -1,4 +1,4 @@
-/* Magic Mirror
+/* MagicMirror²
  * Module: HelloWorld
  *
  * By Michael Teeuw https://michaelteeuw.nl

modules/default/newsfeed/README.md

@@ -1,6 +1,6 @@
 # Module: News Feed
 
-The `newsfeed` module is one of the default modules of the MagicMirror.
+The `newsfeed` module is one of the default modules of the MagicMirror².
 This module displays news headlines based on an RSS feed. Scrolling through news headlines happens time-based (`updateInterval`), but can also be controlled by sending news feed specific notifications to the module.
 
 For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/newsfeed.html).

modules/default/newsfeed/newsfeed.js

@@ -1,4 +1,4 @@
-/* Magic Mirror
+/* MagicMirror²
  * Module: NewsFeed
  *
  * By Michael Teeuw https://michaelteeuw.nl
@@ -20,6 +20,7 @@ Module.register("newsfeed", {
 		broadcastNewsFeeds: true,
 		broadcastNewsUpdates: true,
 		showDescription: false,
+		showTitleAsUrl: false,
 		wrapTitle: true,
 		wrapDescription: true,
 		truncDescription: true,
@@ -37,7 +38,8 @@ Module.register("newsfeed", {
 		endTags: [],
 		prohibitedWords: [],
 		scrollLength: 500,
-		logFeedWarnings: false
+		logFeedWarnings: false,
+		dangerouslyDisableAutoEscaping: false
 	},
 
 	// Define required scripts.
@@ -121,7 +123,7 @@ Module.register("newsfeed", {
 		}
 		if (this.newsItems.length === 0) {
 			return {
-				loaded: false
+				empty: true
 			};
 		}
 		if (this.activeItem >= this.newsItems.length) {
@@ -140,6 +142,7 @@ Module.register("newsfeed", {
 			sourceTitle: item.sourceTitle,
 			publishDate: moment(new Date(item.pubdate)).fromNow(),
 			title: item.title,
+			url: item.url,
 			description: item.description,
 			items: items
 		};
@@ -184,6 +187,7 @@ Module.register("newsfeed", {
 			const dateB = new Date(b.pubdate);
 			return dateB - dateA;
 		});
+
 		if (this.config.maxNewsItems > 0) {
 			newsItems = newsItems.slice(0, this.config.maxNewsItems);
 		}
@@ -219,7 +223,6 @@ Module.register("newsfeed", {
 			}
 
 			//Remove selected tags from the end of rss feed items (title or description)
-
 			if (this.config.removeEndTags) {
 				for (let endTag of this.config.endTags) {
 					if (item.title.slice(-endTag.length) === endTag) {
@@ -295,6 +298,9 @@ Module.register("newsfeed", {
 			this.sendNotification("NEWS_FEED", { items: this.newsItems });
 		}
 
+		// #2638 Clear timer if it already exists
+		if (this.timer) clearInterval(this.timer);
+
 		this.timer = setInterval(() => {
 			this.activeItem++;
 			this.updateDom(this.config.animationSpeed);

modules/default/newsfeed/newsfeed.njk

@@ -1,3 +1,27 @@
+{% macro escapeText(text, dangerouslyDisableAutoEscaping=false) %}
+  {% if dangerouslyDisableAutoEscaping %}
+    {{ text | safe}}
+  {% else %}
+    {{ text }}
+  {% endif %}
+{% endmacro %}
+
+{% macro escapeTitle(title, url, dangerouslyDisableAutoEscaping=false, showTitleAsUrl=false) %}
+  {% if dangerouslyDisableAutoEscaping %}
+    {% if showTitleAsUrl %}
+      <a href="{{ url }}" style="text-decoration:none;color:#ffffff" target="_blank">{{ title | safe }}</a>
+    {% else %}
+      {{ title | safe}}
+    {% endif %}
+  {% else %}
+    {% if showTitleAsUrl %}
+      <a href="{{ url }}" style="text-decoration:none;color:#ffffff" target="_blank">{{ title }}</a>
+    {% else %}
+      {{ title }}
+    {% endif %}
+  {% endif %}
+{% endmacro %}
+
 {% if loaded %}
     {% if config.showAsList %}
         <ul class="newsfeed-list">
@@ -14,14 +38,14 @@
                         </div>
                     {% endif %}
                     <div class="newsfeed-title bright medium light{{ ' no-wrap' if not config.wrapTitle }}">
-                        {{ item.title }}
+                        {{ escapeTitle(item.title, item.url, config.dangerouslyDisableAutoEscaping, config.showTitleAsUrl) }}
                     </div>
                     {% if config.showDescription %}
                         <div class="newsfeed-desc small light{{ ' no-wrap' if not config.wrapDescription }}">
                             {% if config.truncDescription %}
-                                {{ item.description | truncate(config.lengthDescription) }}
+                                {{ escapeText(item.description | truncate(config.lengthDescription), config.dangerouslyDisableAutoEscaping) }}
                             {% else %}
-                                {{ item.description }}
+                                {{ escapeText(item.description, config.dangerouslyDisableAutoEscaping) }}
                             {% endif %}
                         </div>
                     {% endif %}
@@ -33,7 +57,7 @@
             {% if (config.showSourceTitle and sourceTitle) or config.showPublishDate %}
                 <div class="newsfeed-source light small dimmed">
                     {% if sourceTitle and config.showSourceTitle %}
-                        {{ sourceTitle }}{% if config.showPublishDate %}, {% else %}: {% endif %}
+                        {{ escapeText(sourceTitle, config.dangerouslyDisableAutoEscaping) }}{% if config.showPublishDate %}, {% else %}: {% endif %}
                     {% endif %}
                     {% if config.showPublishDate %}
                         {{ publishDate }}:
@@ -41,19 +65,23 @@
                 </div>
             {% endif %}
             <div class="newsfeed-title bright medium light{{ ' no-wrap' if not config.wrapTitle }}">
-                {{ title }}
+                {{ escapeTitle(title, url, config.dangerouslyDisableAutoEscaping, config.showTitleAsUrl) }}
             </div>
             {% if config.showDescription %}
                 <div class="newsfeed-desc small light{{ ' no-wrap' if not config.wrapDescription }}">
                     {% if config.truncDescription %}
-                        {{ description | truncate(config.lengthDescription) }}
+                        {{ escapeText(description | truncate(config.lengthDescription), config.dangerouslyDisableAutoEscaping) }}
                     {% else %}
-                        {{ description }}
+                        {{ escapeText(description, config.dangerouslyDisableAutoEscaping) }}
                     {% endif %}
                 </div>
             {% endif %}
         </div>
     {% endif %}
+{% elseif empty %}
+    <div class="small dimmed">
+        {{ "NEWSFEED_NO_ITEMS" | translate | safe }}
+    </div>
 {% elseif error %}
     <div class="small dimmed">
         {{ "MODULE_CONFIG_ERROR" | translate({MODULE_NAME: "Newsfeed", ERROR: error}) | safe }}

modules/default/newsfeed/newsfeedfetcher.js

@@ -1,4 +1,4 @@
-/* Magic Mirror
+/* MagicMirror²
  * Node Helper: Newsfeed - NewsfeedFetcher
  *
  * By Michael Teeuw https://michaelteeuw.nl
@@ -7,8 +7,9 @@
 const Log = require("logger");
 const FeedMe = require("feedme");
 const NodeHelper = require("node_helper");
-const fetch = require("node-fetch");
+const fetch = require("fetch");
 const iconv = require("iconv-lite");
+const stream = require("stream");
 
 /**
  * Responsible for requesting an update on the set interval and broadcasting the data.
@@ -79,7 +80,7 @@ const NewsfeedFetcher = function (url, reloadInterval, encoding, logFeedWarnings
 
 		const nodeVersion = Number(process.version.match(/^v(\d+\.\d+)/)[1]);
 		const headers = {
-			"User-Agent": "Mozilla/5.0 (Node.js " + nodeVersion + ") MagicMirror/" + global.version + " (https://github.com/MichMich/MagicMirror/)",
+			"User-Agent": "Mozilla/5.0 (Node.js " + nodeVersion + ") MagicMirror/" + global.version,
 			"Cache-Control": "max-age=0, no-cache, no-store, must-revalidate",
 			Pragma: "no-cache"
 		};
@@ -87,7 +88,13 @@ const NewsfeedFetcher = function (url, reloadInterval, encoding, logFeedWarnings
 		fetch(url, { headers: headers })
 			.then(NodeHelper.checkFetchStatus)
 			.then((response) => {
-				response.body.pipe(iconv.decodeStream(encoding)).pipe(parser);
+				let nodeStream;
+				if (response.body instanceof stream.Readable) {
+					nodeStream = response.body;
+				} else {
+					nodeStream = stream.Readable.fromWeb(response.body);
+				}
+				nodeStream.pipe(iconv.decodeStream(encoding)).pipe(parser);
 			})
 			.catch((error) => {
 				fetchFailedCallback(this, error);

modules/default/newsfeed/node_helper.js

@@ -1,4 +1,4 @@
-/* Magic Mirror
+/* MagicMirror²
  * Node Helper: Newsfeed
  *
  * By Michael Teeuw https://michaelteeuw.nl

modules/default/updatenotification/README.md

@@ -1,6 +1,6 @@
 # Module: Update Notification
 
-The `updatenotification` module is one of the default modules of the MagicMirror.
-This will display a message whenever a new version of the MagicMirror application is available.
+The `updatenotification` module is one of the default modules of the MagicMirror².
+This will display a message whenever a new version of the MagicMirror² application is available.
 
 For configuration options, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/modules/updatenotification.html).

modules/default/updatenotification/git_helper.js

@@ -0,0 +1,169 @@
+const util = require("util");
+const exec = util.promisify(require("child_process").exec);
+const fs = require("fs");
+const path = require("path");
+const Log = require("logger");
+
+const BASE_DIR = path.normalize(`${__dirname}/../../../`);
+
+class GitHelper {
+	constructor() {
+		this.gitRepos = [];
+	}
+
+	getRefRegex(branch) {
+		return new RegExp(`s*([a-z,0-9]+[.][.][a-z,0-9]+)  ${branch}`, "g");
+	}
+
+	async execShell(command) {
+		const { stdout = "", stderr = "" } = await exec(command);
+
+		return { stdout, stderr };
+	}
+
+	async isGitRepo(moduleFolder) {
+		const { stderr } = await this.execShell(`cd ${moduleFolder} && git remote -v`);
+
+		if (stderr) {
+			Log.error(`Failed to fetch git data for ${moduleFolder}: ${stderr}`);
+
+			return false;
+		}
+
+		return true;
+	}
+
+	async add(moduleName) {
+		let moduleFolder = BASE_DIR;
+
+		if (moduleName !== "default") {
+			moduleFolder = `${moduleFolder}modules/${moduleName}`;
+		}
+
+		try {
+			Log.info(`Checking git for module: ${moduleName}`);
+			// Throws error if file doesn't exist
+			fs.statSync(path.join(moduleFolder, ".git"));
+
+			// Fetch the git or throw error if no remotes
+			const isGitRepo = await this.isGitRepo(moduleFolder);
+
+			if (isGitRepo) {
+				// Folder has .git and has at least one git remote, watch this folder
+				this.gitRepos.push({ module: moduleName, folder: moduleFolder });
+			}
+		} catch (err) {
+			// Error when directory .git doesn't exist or doesn't have any remotes
+			// This module is not managed with git, skip
+		}
+	}
+
+	async getStatusInfo(repo) {
+		let gitInfo = {
+			module: repo.module,
+			behind: 0, // commits behind
+			current: "", // branch name
+			hash: "", // current hash
+			tracking: "", // remote branch
+			isBehindInStatus: false
+		};
+
+		if (repo.module === "default") {
+			// the hash is only needed for the mm repo
+			const { stderr, stdout } = await this.execShell(`cd ${repo.folder} && git rev-parse HEAD`);
+
+			if (stderr) {
+				Log.error(`Failed to get current commit hash for ${repo.module}: ${stderr}`);
+			}
+
+			gitInfo.hash = stdout;
+		}
+
+		const { stderr, stdout } = await this.execShell(`cd ${repo.folder} && git status -sb`);
+
+		if (stderr) {
+			Log.error(`Failed to get git status for ${repo.module}: ${stderr}`);
+			// exit without git status info
+			return;
+		}
+
+		// only the first line of stdout is evaluated
+		let status = stdout.split("\n")[0];
+		// examples for status:
+		// ## develop...origin/develop
+		// ## master...origin/master [behind 8]
+		status = status.match(/(?![.#])([^.]*)/g);
+		// examples for status:
+		// [ ' develop', 'origin/develop', '' ]
+		// [ ' master', 'origin/master [behind 8]', '' ]
+		gitInfo.current = status[0].trim();
+		status = status[1].split(" ");
+		// examples for status:
+		// [ 'origin/develop' ]
+		// [ 'origin/master', '[behind', '8]' ]
+		gitInfo.tracking = status[0].trim();
+
+		if (status[2]) {
+			// git fetch was already called before so `git status -sb` delivers already the behind number
+			gitInfo.behind = parseInt(status[2].substring(0, status[2].length - 1));
+			gitInfo.isBehindInStatus = true;
+		}
+
+		return gitInfo;
+	}
+
+	async getRepoInfo(repo) {
+		const gitInfo = await this.getStatusInfo(repo);
+
+		if (!gitInfo) {
+			return;
+		}
+
+		if (gitInfo.isBehindInStatus) {
+			return gitInfo;
+		}
+
+		const { stderr } = await this.execShell(`cd ${repo.folder} && git fetch --dry-run`);
+
+		// example output:
+		// From https://github.com/MichMich/MagicMirror
+		//    e40ddd4..06389e3  develop    -> origin/develop
+		// here the result is in stderr (this is a git default, don't ask why ...)
+		const matches = stderr.match(this.getRefRegex(gitInfo.current));
+
+		if (!matches || !matches[0]) {
+			// no refs found, nothing to do
+			return;
+		}
+
+		// get behind with refs
+		try {
+			const { stdout } = await this.execShell(`cd ${repo.folder} && git rev-list --ancestry-path --count ${matches[0]}`);
+			gitInfo.behind = parseInt(stdout);
+
+			return gitInfo;
+		} catch (err) {
+			Log.error(`Failed to get git revisions for ${repo.module}: ${err}`);
+		}
+	}
+
+	async getRepos() {
+		const gitResultList = [];
+
+		for (const repo of this.gitRepos) {
+			try {
+				const gitInfo = await this.getRepoInfo(repo);
+
+				if (gitInfo) {
+					gitResultList.push(gitInfo);
+				}
+			} catch (e) {
+				Log.error(`Failed to retrieve repo info for ${repo.module}: ${e}`);
+			}
+		}
+
+		return gitResultList;
+	}
+}
+
+module.exports = GitHelper;

modules/default/updatenotification/node_helper.js

@@ -1,117 +1,66 @@
-const SimpleGit = require("simple-git");
-const simpleGits = [];
-const fs = require("fs");
-const path = require("path");
-const defaultModules = require(__dirname + "/../defaultmodules.js");
-const Log = require("logger");
+const GitHelper = require("./git_helper");
+const defaultModules = require("../defaultmodules");
 const NodeHelper = require("node_helper");
 
+const ONE_MINUTE = 60 * 1000;
+
 module.exports = NodeHelper.create({
 	config: {},
 
 	updateTimer: null,
 	updateProcessStarted: false,
 
-	start: function () {},
+	gitHelper: new GitHelper(),
 
-	configureModules: async function (modules) {
-		// Push MagicMirror itself , biggest chance it'll show up last in UI and isn't overwritten
-		// others will be added in front
-		// this method returns promises so we can't wait for every one to resolve before continuing
-		simpleGits.push({ module: "default", git: this.createGit(path.normalize(__dirname + "/../../../")) });
-
-		for (let moduleName in modules) {
+	async configureModules(modules) {
+		for (const moduleName of modules) {
 			if (!this.ignoreUpdateChecking(moduleName)) {
-				// Default modules are included in the main MagicMirror repo
-				let moduleFolder = path.normalize(__dirname + "/../../" + moduleName);
-
-				try {
-					Log.info("Checking git for module: " + moduleName);
-					// Throws error if file doesn't exist
-					fs.statSync(path.join(moduleFolder, ".git"));
-					// Fetch the git or throw error if no remotes
-					let git = await this.resolveRemote(moduleFolder);
-					// Folder has .git and has at least one git remote, watch this folder
-					simpleGits.unshift({ module: moduleName, git: git });
-				} catch (err) {
-					// Error when directory .git doesn't exist or doesn't have any remotes
-					// This module is not managed with git, skip
-					continue;
-				}
+				await this.gitHelper.add(moduleName);
 			}
 		}
+
+		await this.gitHelper.add("default");
 	},
 
-	socketNotificationReceived: function (notification, payload) {
+	async socketNotificationReceived(notification, payload) {
 		if (notification === "CONFIG") {
 			this.config = payload;
 		} else if (notification === "MODULES") {
 			// if this is the 1st time thru the update check process
 			if (!this.updateProcessStarted) {
 				this.updateProcessStarted = true;
-				this.configureModules(payload).then(() => this.performFetch());
+				await this.configureModules(payload);
+				await this.performFetch();
 			}
 		}
 	},
 
-	resolveRemote: async function (moduleFolder) {
-		let git = this.createGit(moduleFolder);
-		let remotes = await git.getRemotes(true);
+	async performFetch() {
+		const repos = await this.gitHelper.getRepos();
 
-		if (remotes.length < 1 || remotes[0].name.length < 1) {
-			throw new Error("No valid remote for folder " + moduleFolder);
-		}
-
-		return git;
-	},
-
-	performFetch: async function () {
-		for (let sg of simpleGits) {
-			try {
-				let fetchData = await sg.git.fetch(["--dry-run"]).status();
-				let logData = await sg.git.log({ "-1": null });
-
-				if (logData.latest && "hash" in logData.latest) {
-					this.sendSocketNotification("STATUS", {
-						module: sg.module,
-						behind: fetchData.behind,
-						current: fetchData.current,
-						hash: logData.latest.hash,
-						tracking: fetchData.tracking
-					});
-				}
-			} catch (err) {
-				Log.error("Failed to fetch git data for " + sg.module + ": " + err);
-			}
+		for (const repo of repos) {
+			this.sendSocketNotification("STATUS", repo);
 		}
 
 		this.scheduleNextFetch(this.config.updateInterval);
 	},
 
-	scheduleNextFetch: function (delay) {
-		if (delay < 60 * 1000) {
-			delay = 60 * 1000;
-		}
-
-		let self = this;
+	scheduleNextFetch(delay) {
 		clearTimeout(this.updateTimer);
-		this.updateTimer = setTimeout(function () {
-			self.performFetch();
-		}, delay);
+
+		this.updateTimer = setTimeout(() => {
+			this.performFetch();
+		}, Math.max(delay, ONE_MINUTE));
 	},
 
-	createGit: function (folder) {
-		return SimpleGit({ baseDir: folder, timeout: { block: this.config.timeout } });
-	},
-
-	ignoreUpdateChecking: function (moduleName) {
+	ignoreUpdateChecking(moduleName) {
 		// Should not check for updates for default modules
-		if (defaultModules.indexOf(moduleName) >= 0) {
+		if (defaultModules.includes(moduleName)) {
 			return true;
 		}
 
 		// Should not check for updates for ignored modules
-		if (this.config.ignoreModules.indexOf(moduleName) >= 0) {
+		if (this.config.ignoreModules.includes(moduleName)) {
 			return true;
 		}
 

modules/default/updatenotification/updatenotification.css

@@ -0,0 +1,3 @@
+.module.updatenotification a.difflink {
+  text-decoration: none;
+}

modules/default/updatenotification/updatenotification.js

@@ -1,46 +1,63 @@
-/* Magic Mirror
+/* MagicMirror²
  * Module: UpdateNotification
  *
  * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  */
 Module.register("updatenotification", {
-	// Define module defaults
 	defaults: {
 		updateInterval: 10 * 60 * 1000, // every 10 minutes
 		refreshInterval: 24 * 60 * 60 * 1000, // one day
-		ignoreModules: [],
-		timeout: 5000
+		ignoreModules: []
 	},
 
 	suspended: false,
 	moduleList: {},
 
-	// Override start method.
-	start: function () {
-		Log.info("Starting module: " + this.name);
+	start() {
+		Log.info(`Starting module: ${this.name}`);
+		this.addFilters();
 		setInterval(() => {
 			this.moduleList = {};
 			this.updateDom(2);
 		}, this.config.refreshInterval);
 	},
 
-	notificationReceived: function (notification, payload, sender) {
+	suspend() {
+		this.suspended = true;
+	},
+
+	resume() {
+		this.suspended = false;
+		this.updateDom(2);
+	},
+
+	notificationReceived(notification) {
 		if (notification === "DOM_OBJECTS_CREATED") {
 			this.sendSocketNotification("CONFIG", this.config);
-			this.sendSocketNotification("MODULES", Module.definitions);
-			//this.hide(0, { lockString: this.identifier });
+			this.sendSocketNotification("MODULES", Object.keys(Module.definitions));
 		}
 	},
 
-	// Override socket notification handler.
-	socketNotificationReceived: function (notification, payload) {
+	socketNotificationReceived(notification, payload) {
 		if (notification === "STATUS") {
 			this.updateUI(payload);
 		}
 	},
 
-	updateUI: function (payload) {
+	getStyles() {
+		return [`${this.name}.css`];
+	},
+
+	getTemplate() {
+		return `${this.name}.njk`;
+	},
+
+	getTemplateData() {
+		return { moduleList: this.moduleList, suspended: this.suspended };
+	},
+
+	updateUI(payload) {
 		if (payload && payload.behind > 0) {
 			// if we haven't seen info for this module
 			if (this.moduleList[payload.module] === undefined) {
@@ -48,7 +65,6 @@ Module.register("updatenotification", {
 				this.moduleList[payload.module] = payload;
 				this.updateDom(2);
 			}
-			//self.show(1000, { lockString: self.identifier });
 		} else if (payload && payload.behind === 0) {
 			// if the module WAS in the list, but shouldn't be
 			if (this.moduleList[payload.module] !== undefined) {
@@ -59,62 +75,15 @@ Module.register("updatenotification", {
 		}
 	},
 
-	diffLink: function (module, text) {
-		const localRef = module.hash;
-		const remoteRef = module.tracking.replace(/.*\//, "");
-		return '<a href="https://github.com/MichMich/MagicMirror/compare/' + localRef + "..." + remoteRef + '" ' + 'class="xsmall dimmed" ' + 'style="text-decoration: none;" ' + 'target="_blank" >' + text + "</a>";
-	},
-
-	// Override dom generator.
-	getDom: function () {
-		const wrapper = document.createElement("div");
-		if (this.suspended === false) {
-			// process the hash of module info found
-			for (const key of Object.keys(this.moduleList)) {
-				let m = this.moduleList[key];
-
-				const message = document.createElement("div");
-				message.className = "small bright";
-
-				const icon = document.createElement("i");
-				icon.className = "fa fa-exclamation-circle";
-				icon.innerHTML = "&nbsp;";
-				message.appendChild(icon);
-
-				const updateInfoKeyName = m.behind === 1 ? "UPDATE_INFO_SINGLE" : "UPDATE_INFO_MULTIPLE";
-
-				let subtextHtml = this.translate(updateInfoKeyName, {
-					COMMIT_COUNT: m.behind,
-					BRANCH_NAME: m.current
-				});
-
-				const text = document.createElement("span");
-				if (m.module === "default") {
-					text.innerHTML = this.translate("UPDATE_NOTIFICATION");
-					subtextHtml = this.diffLink(m, subtextHtml);
-				} else {
-					text.innerHTML = this.translate("UPDATE_NOTIFICATION_MODULE", {
-						MODULE_NAME: m.module
-					});
-				}
-				message.appendChild(text);
-
-				wrapper.appendChild(message);
-
-				const subtext = document.createElement("div");
-				subtext.innerHTML = subtextHtml;
-				subtext.className = "xsmall dimmed";
-				wrapper.appendChild(subtext);
+	addFilters() {
+		this.nunjucksEnvironment().addFilter("diffLink", (text, status) => {
+			if (status.module !== "default") {
+				return text;
 			}
-		}
-		return wrapper;
-	},
 
-	suspend: function () {
-		this.suspended = true;
-	},
-	resume: function () {
-		this.suspended = false;
-		this.updateDom(2);
+			const localRef = status.hash;
+			const remoteRef = status.tracking.replace(/.*\//, "");
+			return `<a href="https://github.com/MichMich/MagicMirror/compare/${localRef}...${remoteRef}" class="xsmall dimmed difflink" target="_blank">${text}</a>`;
+		});
 	}
 });

modules/default/updatenotification/updatenotification.njk

@@ -0,0 +1,15 @@
+{% if not suspended %}
+  {% for name, status in moduleList %}
+    <div class="small bright">
+      <i class="fas fa-exclamation-circle"></i>
+      <span>
+        {% set mainTextLabel = "UPDATE_NOTIFICATION" if name === "default" else "UPDATE_NOTIFICATION_MODULE" %}
+        {{ mainTextLabel | translate({MODULE_NAME: name}) }}
+      </span>
+    </div>
+    <div class="xsmall dimmed">
+      {% set subTextLabel = "UPDATE_INFO_SINGLE" if status.behind === 1 else "UPDATE_INFO_MULTIPLE" %}
+      {{ subTextLabel | translate({COMMIT_COUNT: status.behind, BRANCH_NAME: status.current}) | diffLink(status) | safe }}
+    </div>
+  {% endfor %}
+{% endif %}

modules/default/weather/current.njk

@@ -15,7 +15,7 @@
                 {% if config.showWindDirection %}
                     <sup>
                         {% if config.showWindDirectionAsArrow %}
-                            <i class="fa fa-long-arrow-up" style="transform:rotate({{ current.windDirection }}deg);"></i>
+                            <i class="fas fa-long-arrow-alt-up" style="transform:rotate({{ current.windDirection }}deg);"></i>
                         {% else %}
                             {{ current.cardinalWindDirection() | translate }}
                         {% endif %}
@@ -47,7 +47,7 @@
     <div class="normal light indoor">
         {% if config.showIndoorTemperature and indoor.temperature %}
             <div>
-                <span class="fa fa-home"></span>
+                <span class="fas fa-home"></span>
                 <span class="bright">
                     {{ indoor.temperature | roundValue | unit("temperature") | decimalSymbol }}
                 </span>
@@ -55,7 +55,7 @@
         {% endif %}
         {% if config.showIndoorHumidity and indoor.humidity %}
             <div>
-                <span class="fa fa-tint"></span>
+                <span class="fas fa-tint"></span>
                 <span class="bright">
                     {{ indoor.humidity | roundValue | unit("humidity") | decimalSymbol }}
                 </span>

modules/default/weather/forecast.njk

@@ -2,12 +2,15 @@
     {% set numSteps = forecast | calcNumSteps %}
     {% set currentStep = 0 %}
     <table class="{{ config.tableClass }}">
+        {% if config.ignoreToday %}
+            {% set forecast = forecast.splice(1) %}
+        {% endif %}
         {% set forecast = forecast.slice(0, numSteps) %}
         {% for f in forecast %}
             <tr {% if config.colored %}class="colored"{% endif %} {% if config.fade %}style="opacity: {{ currentStep | opacity(numSteps) }};"{% endif %}>
-                {% if (currentStep == 0) and config.ignoreToday == false %}
+                {% if (currentStep == 0) and config.ignoreToday == false and config.absoluteDates == false %}
                     <td class="day">{{ "TODAY" | translate }}</td>
-                {% elif (currentStep == 1) and config.ignoreToday == false %}
+                {% elif (currentStep == 1) and config.ignoreToday == false and config.absoluteDates == false %}
                     <td class="day">{{ "TOMORROW" | translate }}</td>
                 {% else %}
                     <td class="day">{{ f.date.format('ddd') }}</td>
@@ -20,10 +23,10 @@
                     {{ f.minTemperature | roundValue | unit("temperature") | decimalSymbol }}
                 </td>
                 {% if config.showPrecipitationAmount %}
-                    {% if f.precipitationUnits %}	
+                    {% if f.precipitationUnits %}
                         <td class="align-right bright precipitation">
                             {{ f.precipitation }}{{ f.precipitationUnits }}
-                        </td>			
+                        </td>
 		                {% else %}
                         <td class="align-right bright precipitation">
                             {{ f.precipitation | unit("precip") }}

modules/default/weather/providers/README.md

@@ -1,148 +1,3 @@
-# MagicMirror² Weather Module Weather Provider Development Documentation
+# Weather Module Weather Provider Development Documentation
 
-This document describes the way to develop your own MagicMirror² weather module weather provider.
-
-Table of Contents:
-
-- The weather provider file: yourprovider.js
-  - [Weather provider methods to implement](#weather-provider-methods-to-implement)
-  - [Weather Provider instance methods](#weather-provider-instance-methods)
-  - [WeatherObject](#weatherobject)
-
----
-
-## The weather provider file: yourprovider.js
-
-This is the script in which the weather provider will be defined. In its most simple form, the weather provider must implement the following:
-
-```javascript
-WeatherProvider.register("yourprovider", {
-  providerName: "YourProvider",
-
-  fetchCurrentWeather() {},
-
-  fetchWeatherForecast() {}
-});
-```
-
-### Weather provider methods to implement
-
-#### `fetchCurrentWeather()`
-
-This method is called when the weather module tries to fetch the current weather of your provider. The implementation of this method is required for current weather support.
-The implementation can make use of the already implemented function `this.fetchData(url, method, data);`, which is returning a promise.
-After the response is processed, the current weather information (as a [WeatherObject](#weatherobject)) needs to be set with `this.setCurrentWeather(currentWeather);`.
-It will then automatically refresh the module DOM with the new data.
-
-#### `fetchWeatherForecast()`
-
-This method is called when the weather module tries to fetch the weather of your provider. The implementation of this method is required for forecast support.
-The implementation can make use of the already implemented function `this.fetchData(url, method, data);`, which is returning a promise.
-After the response is processed, the weather forecast information (as an array of [WeatherObject](#weatherobject)s) needs to be set with `this.setWeatherForecast(forecast);`.
-It will then automatically refresh the module DOM with the new data.
-
-#### `fetchWeatherHourly()`
-
-This method is called when the weather module tries to fetch the weather of your provider. The implementation of this method is required for hourly support.
-The implementation can make use of the already implemented function `this.fetchData(url, method, data);`, which is returning a promise.
-After the response is processed, the hourly weather forecast information (as an array of [WeatherObject](#weatherobject)s) needs to be set with `this.setWeatherHourly(forecast);`.
-It will then automatically refresh the module DOM with the new data.
-
-### Weather Provider instance methods
-
-#### `init()`
-
-Called when a weather provider is initialized.
-
-#### `setConfig(config)`
-
-Called to set the config, this config is the same as the weather module's config.
-
-#### `start()`
-
-Called when the weather provider is about to start.
-
-#### `currentWeather()`
-
-This returns a WeatherDay object for the current weather.
-
-#### `weatherForecast()`
-
-This returns an array of WeatherDay objects for the weather forecast.
-
-#### `weatherHourly()`
-
-This returns an array of WeatherDay objects for the hourly weather forecast.
-
-#### `fetchedLocation()`
-
-This returns the name of the fetched location or an empty string.
-
-#### `setCurrentWeather(currentWeatherObject)`
-
-Set the currentWeather and notify the delegate that new information is available.
-
-#### `setWeatherForecast(weatherForecastArray)`
-
-Set the weatherForecastArray and notify the delegate that new information is available.
-
-#### `setWeatherHourly(weatherHourlyArray)`
-
-Set the weatherHourlyArray and notify the delegate that new information is available.
-
-#### `setFetchedLocation(name)`
-
-Set the fetched location name.
-
-#### `updateAvailable()`
-
-Notify the delegate that new weather is available.
-
-#### `fetchData(url, method, data)`
-
-A convenience function to make requests. It returns a promise.
-
-### WeatherObject
-
-| Property       | Type     | Value/Unit                                                                                                      |
-| -------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
-| units          | `string` | Gets initialized with the constructor. <br> Possible values: `metric`, `imperial`                               |
-| tempUnits      | `string` | Gets initialized with the constructor. <br> Possible values: `metric`, `imperial`                               |
-| windUnits      | `string` | Gets initialized with the constructor. <br> Possible values: `metric`, `imperial`                               |
-| date           | `object` | [Moment.js](https://momentjs.com/) object of the time/date.                                                     |
-| windSpeed      | `number` | Metric: `meter/second` <br> Imperial: `miles/hour`                                                              |
-| windDirection  | `number` | Direction of the wind in degrees.                                                                               |
-| sunrise        | `object` | [Moment.js](https://momentjs.com/) object of sunrise.                                                           |
-| sunset         | `object` | [Moment.js](https://momentjs.com/) object of sunset.                                                            |
-| temperature    | `number` | Current temperature                                                                                             |
-| minTemperature | `number` | Lowest temperature of the day.                                                                                  |
-| maxTemperature | `number` | Highest temperature of the day.                                                                                 |
-| weatherType    | `string` | Icon name of the weather type. <br> Possible values: [WeatherIcons](https://www.npmjs.com/package/weathericons) |
-| humidity       | `number` | Percentage of humidity                                                                                          |
-| rain           | `number` | Metric: `millimeters` <br> Imperial: `inches`                                                                   |
-| snow           | `number` | Metric: `millimeters` <br> Imperial: `inches`                                                                   |
-| precipitation  | `number` | Metric: `millimeters` <br> Imperial: `inches` <br> UK Met Office provider: `percent`                            |
-
-#### Current weather
-
-For the current weather object the following properties are required:
-
-- humidity
-- sunrise
-- sunset
-- temperature
-- units
-- weatherType
-- windDirection
-- windSpeed
-
-#### Weather forecast
-
-For the forecast weather object the following properties are required:
-
-- date
-- maxTemperature
-- minTemperature
-- rain
-- units
-- weatherType
+For how to develop your own weather provider, please check the [MagicMirror² documentation](https://docs.magicmirror.builders/development/weather-provider.html).

modules/default/weather/providers/darksky.js

@@ -1,6 +1,6 @@
 /* global WeatherProvider, WeatherObject */
 
-/* Magic Mirror
+/* MagicMirror²
  * Module: Weather
  * Provider: Dark Sky
  *
@@ -8,7 +8,8 @@
  * MIT Licensed
  *
  * This class is a provider for Dark Sky.
- * Note that the Dark Sky API does not provide rainfall.  Instead it provides snowfall and precipitation probability
+ * Note that the Dark Sky API does not provide rainfall. Instead it provides
+ * snowfall and precipitation probability
  */
 WeatherProvider.register("darksky", {
 	// Set the name of the provider.
@@ -17,7 +18,8 @@ WeatherProvider.register("darksky", {
 
 	// Set the default config properties that is specific to this provider
 	defaults: {
-		apiBase: "https://cors-anywhere.herokuapp.com/https://api.darksky.net",
+		useCorsProxy: true,
+		apiBase: "https://api.darksky.net",
 		weatherEndpoint: "/forecast",
 		apiKey: "",
 		lat: 0,
@@ -98,7 +100,8 @@ WeatherProvider.register("darksky", {
 			weather.snow = 0;
 
 			// The API will return centimeters if units is 'si' and will return inches for 'us'
-			// Note that the Dark Sky API does not provide rainfall.  Instead it provides snowfall and precipitation probability
+			// Note that the Dark Sky API does not provide rainfall.
+			// Instead it provides snowfall and precipitation probability
 			if (forecast.hasOwnProperty("precipAccumulation")) {
 				if (this.config.units === "imperial" && !isNaN(forecast.precipAccumulation)) {
 					weather.snow = forecast.precipAccumulation;

modules/default/weather/providers/envcanada.js

@@ -1,6 +1,6 @@
 /* global WeatherProvider, WeatherObject */
 
-/* Magic Mirror
+/* MagicMirror²
  * Module: Weather
  * Provider: Environment Canada (EC)
  *
@@ -40,6 +40,7 @@ WeatherProvider.register("envcanada", {
 
 	// Set the default config properties that is specific to this provider
 	defaults: {
+		useCorsProxy: true,
 		siteCode: "s1234567",
 		provCode: "ON"
 	},
@@ -73,7 +74,7 @@ WeatherProvider.register("envcanada", {
 	// Override the fetchCurrentWeather method to query EC and construct a Current weather object
 	//
 	fetchCurrentWeather() {
-		this.fetchData(this.getUrl(), "GET")
+		this.fetchData(this.getUrl(), "GET", "xml")
 			.then((data) => {
 				if (!data) {
 					// Did not receive usable new data.
@@ -93,7 +94,7 @@ WeatherProvider.register("envcanada", {
 	// Override the fetchWeatherForecast method to query EC and construct Forecast weather objects
 	//
 	fetchWeatherForecast() {
-		this.fetchData(this.getUrl(), "GET")
+		this.fetchData(this.getUrl(), "GET", "xml")
 			.then((data) => {
 				if (!data) {
 					// Did not receive usable new data.
@@ -113,7 +114,7 @@ WeatherProvider.register("envcanada", {
 	// Override the fetchWeatherHourly method to query EC and construct Forecast weather objects
 	//
 	fetchWeatherHourly() {
-		this.fetchData(this.getUrl(), "GET")
+		this.fetchData(this.getUrl(), "GET", "xml")
 			.then((data) => {
 				if (!data) {
 					// Did not receive usable new data.
@@ -129,26 +130,6 @@ WeatherProvider.register("envcanada", {
 			.finally(() => this.updateAvailable());
 	},
 
-	//
-	// Override fetchData function to handle XML document (base function assumes JSON)
-	//
-	fetchData: function (url, method = "GET", data = null) {
-		return new Promise(function (resolve, reject) {
-			var request = new XMLHttpRequest();
-			request.open(method, url, true);
-			request.onreadystatechange = function () {
-				if (this.readyState === 4) {
-					if (this.status === 200) {
-						resolve(this.responseXML);
-					} else {
-						reject(request);
-					}
-				}
-			};
-			request.send();
-		});
-	},
-
 	//////////////////////////////////////////////////////////////////////////////////
 	//
 	// Environment Canada methods - not part of the standard Provider methods
@@ -160,13 +141,8 @@ WeatherProvider.register("envcanada", {
 	// URL defaults to the Englsih version simply because there is no language dependancy in the data
 	// being accessed. This is only pertinent when using the EC data elements that contain a textual forecast.
 	//
-	// Also note that access is supported through a proxy service (thingproxy.freeboard.io) to mitigate
-	// CORS errors when accessing EC
-	//
 	getUrl() {
-		var path = "https://thingproxy.freeboard.io/fetch/https://dd.weather.gc.ca/citypage_weather/xml/" + this.config.provCode + "/" + this.config.siteCode + "_e.xml";
-
-		return path;
+		return "https://dd.weather.gc.ca/citypage_weather/xml/" + this.config.provCode + "/" + this.config.siteCode + "_e.xml";
 	},
 
 	//
@@ -232,7 +208,7 @@ WeatherProvider.register("envcanada", {
 		// Capture the sunrise and sunset values from EC data
 		//
 
-		var sunList = ECdoc.querySelectorAll("siteData riseSet dateTime");
+		const sunList = ECdoc.querySelectorAll("siteData riseSet dateTime");
 
 		currentWeather.sunrise = moment(sunList[1].querySelector("timeStamp").textContent, "YYYYMMDDhhmmss");
 		currentWeather.sunset = moment(sunList[3].querySelector("timeStamp").textContent, "YYYYMMDDhhmmss");
@@ -249,14 +225,14 @@ WeatherProvider.register("envcanada", {
 
 		const days = [];
 
-		var weather = new WeatherObject(this.config.units, this.config.tempUnits, this.config.windUnits);
+		const weather = new WeatherObject(this.config.units, this.config.tempUnits, this.config.windUnits);
 
-		var foreBaseDates = ECdoc.querySelectorAll("siteData forecastGroup dateTime");
-		var baseDate = foreBaseDates[1].querySelector("timeStamp").textContent;
+		const foreBaseDates = ECdoc.querySelectorAll("siteData forecastGroup dateTime");
+		const baseDate = foreBaseDates[1].querySelector("timeStamp").textContent;
 
 		weather.date = moment(baseDate, "YYYYMMDDhhmmss");
 
-		var foreGroup = ECdoc.querySelectorAll("siteData forecastGroup forecast");
+		const foreGroup = ECdoc.querySelectorAll("siteData forecastGroup forecast");
 
 		// For simplicity, we will only accumulate precipitation and will not try to break out
 		// rain vs snow accumulations
@@ -288,9 +264,9 @@ WeatherProvider.register("envcanada", {
 		// where the next day's (aka Tomorrow's) forecast is located in the forecast array.
 		//
 
-		var nextDay = 0;
-		var lastDay = 0;
-		var currentTemp = ECdoc.querySelector("siteData currentConditions temperature").textContent;
+		let nextDay = 0;
+		let lastDay = 0;
+		const currentTemp = ECdoc.querySelector("siteData currentConditions temperature").textContent;
 
 		//
 		// If the first Element is Current Today, look at Current Today and Current Tonight for the current day.
@@ -356,10 +332,10 @@ WeatherProvider.register("envcanada", {
 		// iteration looking at the current Element and the next Element.
 		//
 
-		var lastDate = moment(baseDate, "YYYYMMDDhhmmss");
+		let lastDate = moment(baseDate, "YYYYMMDDhhmmss");
 
-		for (var stepDay = nextDay; stepDay < lastDay; stepDay += 2) {
-			var weather = new WeatherObject(this.config.units, this.config.tempUnits, this.config.windUnits);
+		for (let stepDay = nextDay; stepDay < lastDay; stepDay += 2) {
+			let weather = new WeatherObject(this.config.units, this.config.tempUnits, this.config.windUnits);
 
 			// Add 1 to the date to reflect the current forecast day we are building
 
@@ -402,23 +378,23 @@ WeatherProvider.register("envcanada", {
 
 		// Get local timezone UTC offset so that each hourly time can be calculated properly
 
-		var baseHours = ECdoc.querySelectorAll("siteData hourlyForecastGroup dateTime");
-		var hourOffset = baseHours[1].getAttribute("UTCOffset");
+		const baseHours = ECdoc.querySelectorAll("siteData hourlyForecastGroup dateTime");
+		const hourOffset = baseHours[1].getAttribute("UTCOffset");
 
 		//
 		// The EC hourly forecast is held in a 24-element array - Elements 0 to 23 - with Element 0 holding
 		// the forecast for the next 'on the hour' timeslot. This means the array is a rolling 24 hours.
 		//
 
-		var hourGroup = ECdoc.querySelectorAll("siteData hourlyForecastGroup hourlyForecast");
+		const hourGroup = ECdoc.querySelectorAll("siteData hourlyForecastGroup hourlyForecast");
 
-		for (var stepHour = 0; stepHour < 24; stepHour += 1) {
-			var weather = new WeatherObject(this.config.units, this.config.tempUnits, this.config.windUnits);
+		for (let stepHour = 0; stepHour < 24; stepHour += 1) {
+			const weather = new WeatherObject(this.config.units, this.config.tempUnits, this.config.windUnits);
 
 			// Determine local time by applying UTC offset to the forecast timestamp
 
-			var foreTime = moment(hourGroup[stepHour].getAttribute("dateTimeUTC"), "YYYYMMDDhhmmss");
-			var currTime = foreTime.add(hourOffset, "hours");
+			const foreTime = moment(hourGroup[stepHour].getAttribute("dateTimeUTC"), "YYYYMMDDhhmmss");
+			const currTime = foreTime.add(hourOffset, "hours");
 			weather.date = moment(currTime, "X");
 
 			// Capture the temperature
@@ -427,7 +403,7 @@ WeatherProvider.register("envcanada", {
 
 			// Capture Likelihood of Precipitation (LOP) and unit-of-measure values
 
-			var precipLOP = hourGroup[stepHour].querySelector("lop").textContent * 1.0;
+			const precipLOP = hourGroup[stepHour].querySelector("lop").textContent * 1.0;
 
 			if (precipLOP > 0) {
 				weather.precipitation = precipLOP;
@@ -453,9 +429,9 @@ WeatherProvider.register("envcanada", {
 	//
 
 	setMinMaxTemps(weather, foreGroup, today, fullDay, currentTemp) {
-		var todayTemp = foreGroup[today].querySelector("temperatures temperature").textContent;
+		const todayTemp = foreGroup[today].querySelector("temperatures temperature").textContent;
 
-		var todayClass = foreGroup[today].querySelector("temperatures temperature").getAttribute("class");
+		const todayClass = foreGroup[today].querySelector("temperatures temperature").getAttribute("class");
 
 		//
 		// The following logic is largely aimed at accommodating the Current day's forecast whereby we
@@ -500,9 +476,9 @@ WeatherProvider.register("envcanada", {
 			}
 		}
 
-		var nextTemp = foreGroup[today + 1].querySelector("temperatures temperature").textContent;
+		const nextTemp = foreGroup[today + 1].querySelector("temperatures temperature").textContent;
 
-		var nextClass = foreGroup[today + 1].querySelector("temperatures temperature").getAttribute("class");
+		const nextClass = foreGroup[today + 1].querySelector("temperatures temperature").getAttribute("class");
 
 		if (fullDay === true) {
 			if (nextClass === "low") {
@@ -513,8 +489,6 @@ WeatherProvider.register("envcanada", {
 				weather.maxTemperature = this.convertTemp(nextTemp);
 			}
 		}
-
-		return;
 	},
 
 	//
@@ -560,8 +534,6 @@ WeatherProvider.register("envcanada", {
 			weather.precipitation = foreGroup[today].querySelector("abbreviatedForecast pop").textContent;
 			weather.precipitationUnits = foreGroup[today].querySelector("abbreviatedForecast pop").getAttribute("units");
 		}
-
-		return;
 	},
 
 	//
@@ -577,6 +549,7 @@ WeatherProvider.register("envcanada", {
 			return temp;
 		}
 	},
+
 	//
 	// Convert km/h to mph
 	//

modules/default/weather/providers/openweathermap.js

@@ -1,6 +1,6 @@
 /* global WeatherProvider, WeatherObject */
 
-/* Magic Mirror
+/* MagicMirror²
  * Module: Weather
  *
  * By Michael Teeuw https://michaelteeuw.nl
@@ -18,10 +18,10 @@ WeatherProvider.register("openweathermap", {
 	defaults: {
 		apiVersion: "2.5",
 		apiBase: "https://api.openweathermap.org/data/",
-		weatherEndpoint: "",
+		weatherEndpoint: "", // can be "onecall", "forecast" or "weather" (for current)
 		locationID: false,
 		location: false,
-		lat: 0,
+		lat: 0, // the onecall endpoint needs lat / lon values, it doesn'T support the locationId
 		lon: 0,
 		apiKey: ""
 	},
@@ -89,7 +89,7 @@ WeatherProvider.register("openweathermap", {
 	/**
 	 * Overrides method for setting config to check if endpoint is correct for hourly
 	 *
-	 * @param config
+	 * @param {object} config The configuration object
 	 */
 	setConfig(config) {
 		this.config = config;
@@ -127,11 +127,8 @@ WeatherProvider.register("openweathermap", {
 
 		currentWeather.humidity = currentWeatherData.main.humidity;
 		currentWeather.temperature = currentWeatherData.main.temp;
-		if (this.config.windUnits === "metric") {
-			currentWeather.windSpeed = this.config.useKmh ? currentWeatherData.wind.speed * 3.6 : currentWeatherData.wind.speed;
-		} else {
-			currentWeather.windSpeed = currentWeatherData.wind.speed;
-		}
+		currentWeather.feelsLikeTemp = currentWeatherData.main.feels_like;
+		currentWeather.windSpeed = currentWeatherData.wind.speed;
 		currentWeather.windDirection = currentWeatherData.wind.deg;
 		currentWeather.weatherType = this.convertWeatherType(currentWeatherData.weather[0].icon);
 		currentWeather.sunrise = moment(currentWeatherData.sys.sunrise, "X");

modules/default/weather/providers/smhi.js

@@ -1,15 +1,14 @@
-/* global WeatherProvider, WeatherObject, SunCalc */
+/* global WeatherProvider, WeatherObject */
 
-/* Magic Mirror
+/* MagicMirror²
  * Module: Weather
  * Provider: SMHI
  *
  * By BuXXi https://github.com/buxxi
  * MIT Licensed
  *
- * This class is a provider for SMHI (Sweden only).
- * Note that SMHI doesn't provide sunrise and sundown, use SunCalc to calculate it.
- * Metric system is the only supported unit.
+ * This class is a provider for SMHI (Sweden only). Metric system is the only
+ * supported unit.
  */
 WeatherProvider.register("smhi", {
 	providerName: "SMHI",
@@ -56,11 +55,11 @@ WeatherProvider.register("smhi", {
 	/**
 	 * Overrides method for setting config with checks for the precipitationValue being unset or invalid
 	 *
-	 * @param config
+	 * @param {object} config The configuration object
 	 */
 	setConfig(config) {
 		this.config = config;
-		if (!config.precipitationValue || ["pmin", "pmean", "pmedian", "pmax"].indexOf(config.precipitationValue) == -1) {
+		if (!config.precipitationValue || ["pmin", "pmean", "pmedian", "pmax"].indexOf(config.precipitationValue) === -1) {
 			console.log("invalid or not set: " + config.precipitationValue);
 			config.precipitationValue = this.defaults.precipitationValue;
 		}
@@ -69,7 +68,8 @@ WeatherProvider.register("smhi", {
 	/**
 	 * Of all the times returned find out which one is closest to the current time, should be the first if the data isn't old.
 	 *
-	 * @param times
+	 * @param {object[]} times Array of time objects
+	 * @returns {object} The weatherdata closest to the current time
 	 */
 	getClosestToCurrentTime(times) {
 		let now = moment();
@@ -85,6 +85,8 @@ WeatherProvider.register("smhi", {
 
 	/**
 	 * Get the forecast url for the configured coordinates
+	 *
+	 * @returns {string} the url for the specified coordinates
 	 */
 	getURL() {
 		let lon = this.config.lon;
@@ -97,25 +99,25 @@ WeatherProvider.register("smhi", {
 	 * The returned units is always in metric system.
 	 * Requires coordinates to determine if its daytime or nighttime to know which icon to use and also to set sunrise and sunset.
 	 *
-	 * @param weatherData
-	 * @param coordinates
-	 * @param weatherData
-	 * @param coordinates
+	 * @param {object} weatherData Weatherdata to convert
+	 * @param {object} coordinates Coordinates of the locations of the weather
+	 * @returns {WeatherObject} The converted weatherdata at the specified location
 	 */
 	convertWeatherDataToObject(weatherData, coordinates) {
-		let currentWeather = new WeatherObject("metric", "metric", "metric"); //Weather data is only for Sweden and nobody in Sweden would use imperial
+		// Weather data is only for Sweden and nobody in Sweden would use imperial
+		let currentWeather = new WeatherObject("metric", "metric", "metric");
 
 		currentWeather.date = moment(weatherData.validTime);
-		let times = SunCalc.getTimes(currentWeather.date.toDate(), coordinates.lat, coordinates.lon);
-		currentWeather.sunrise = moment(times.sunrise, "X");
-		currentWeather.sunset = moment(times.sunset, "X");
+		currentWeather.updateSunTime(coordinates.lat, coordinates.lon);
 		currentWeather.humidity = this.paramValue(weatherData, "r");
 		currentWeather.temperature = this.paramValue(weatherData, "t");
 		currentWeather.windSpeed = this.paramValue(weatherData, "ws");
 		currentWeather.windDirection = this.paramValue(weatherData, "wd");
-		currentWeather.weatherType = this.convertWeatherType(this.paramValue(weatherData, "Wsymb2"), this.isDayTime(currentWeather));
+		currentWeather.weatherType = this.convertWeatherType(this.paramValue(weatherData, "Wsymb2"), currentWeather.isDayTime());
 
-		//Determine the precipitation amount and category and update the weatherObject with it, the valuetype to use can be configured or uses median as default.
+		// Determine the precipitation amount and category and update the
+		// weatherObject with it, the valuetype to use can be configured or uses
+		// median as default.
 		let precipitationValue = this.paramValue(weatherData, this.config.precipitationValue);
 		switch (this.paramValue(weatherData, "pcat")) {
 			// 0 = No precipitation
@@ -143,10 +145,9 @@ WeatherProvider.register("smhi", {
 	/**
 	 * Takes all of the data points and converts it to one WeatherObject per day.
 	 *
-	 * @param allWeatherData
-	 * @param coordinates
-	 * @param allWeatherData
-	 * @param coordinates
+	 * @param {object[]} allWeatherData Array of weatherdata
+	 * @param {object} coordinates Coordinates of the locations of the weather
+	 * @returns {WeatherObject[]} Array of weatherobjects
 	 */
 	convertWeatherDataGroupedByDay(allWeatherData, coordinates) {
 		let currentWeather;
@@ -170,7 +171,7 @@ WeatherProvider.register("smhi", {
 			}
 
 			//Keep track of what icons has been used for each hour of daytime and use the middle one for the forecast
-			if (this.isDayTime(weatherObject)) {
+			if (weatherObject.isDayTime()) {
 				dayWeatherTypes.push(weatherObject.weatherType);
 			}
 			if (dayWeatherTypes.length > 0) {
@@ -191,37 +192,31 @@ WeatherProvider.register("smhi", {
 	},
 
 	/**
-	 * Resolve coordinates from the response data (probably preferably to use this if it's not matching the config values exactly)
+	 * Resolve coordinates from the response data (probably preferably to use
+	 * this if it's not matching the config values exactly)
 	 *
-	 * @param data
+	 * @param {object} data Response data from the weather service
+	 * @returns {{lon, lat}} the lat/long coordinates of the data
 	 */
 	resolveCoordinates(data) {
 		return { lat: data.geometry.coordinates[0][1], lon: data.geometry.coordinates[0][0] };
 	},
 
-	/**
-	 * Checks if the weatherObject is at dayTime.
-	 *
-	 * @param weatherObject
-	 */
-	isDayTime(weatherObject) {
-		return weatherObject.date.isBetween(weatherObject.sunrise, weatherObject.sunset, undefined, "[]");
-	},
-
 	/**
 	 * The distance between the data points is increasing in the data the more distant the prediction is.
 	 * Find these gaps and fill them with the previous hours data to make the data returned a complete set.
 	 *
-	 * @param data
+	 * @param {object[]} data Response data from the weather service
+	 * @returns {object[]} Given data with filled gaps
 	 */
 	fillInGaps(data) {
 		let result = [];
-		for (const i = 1; i < data.length; i++) {
+		for (let i = 1; i < data.length; i++) {
 			let to = moment(data[i].validTime);
 			let from = moment(data[i - 1].validTime);
 			let hours = moment.duration(to.diff(from)).asHours();
 			// For each hour add a datapoint but change the validTime
-			for (const j = 0; j < hours; j++) {
+			for (let j = 0; j < hours; j++) {
 				let current = Object.assign({}, data[i]);
 				current.validTime = from.clone().add(j, "hours").toISOString();
 				result.push(current);
@@ -231,84 +226,81 @@ WeatherProvider.register("smhi", {
 	},
 
 	/**
-	 * Helper method to fetch a property from the returned data set.
-	 * The returned values is an array with always one value in it.
+	 * Helper method to get a property from the returned data set.
 	 *
-	 * @param currentWeatherData
-	 * @param name
-	 * @param currentWeatherData
-	 * @param name
+	 * @param {object} currentWeatherData Weatherdata to get from
+	 * @param {string} name The name of the property
+	 * @returns {*} The value of the property in the weatherdata
 	 */
 	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];
 	},
 
 	/**
-	 * Map the icon value from SHMI to an icon that MagicMirror understands.
+	 * Map the icon value from SMHI to an icon that MagicMirror² understands.
 	 * Uses different icons depending if its daytime or nighttime.
-	 * SHMI's description of what the numeric value means is the comment after the case.
+	 * SMHI's description of what the numeric value means is the comment after the case.
 	 *
-	 * @param input
-	 * @param isDayTime
-	 * @param input
-	 * @param isDayTime
+	 * @param {number} input The SMHI icon value
+	 * @param {boolean} isDayTime True if the icon should be for daytime, false for nighttime
+	 * @returns {string} The icon name for the MagicMirror
 	 */
 	convertWeatherType(input, isDayTime) {
 		switch (input) {
 			case 1:
 				return isDayTime ? "day-sunny" : "night-clear"; // Clear sky
 			case 2:
-				return isDayTime ? "day-sunny-overcast" : "night-partly-cloudy"; //Nearly clear sky
+				return isDayTime ? "day-sunny-overcast" : "night-partly-cloudy"; // Nearly clear sky
 			case 3:
-				return isDayTime ? "day-cloudy" : "night-cloudy"; //Variable cloudiness
+				return isDayTime ? "day-cloudy" : "night-cloudy"; // Variable cloudiness
 			case 4:
-				return isDayTime ? "day-cloudy" : "night-cloudy"; //Halfclear sky
+				return isDayTime ? "day-cloudy" : "night-cloudy"; // Halfclear sky
 			case 5:
-				return "cloudy"; //Cloudy sky
+				return "cloudy"; // Cloudy sky
 			case 6:
-				return "cloudy"; //Overcast
+				return "cloudy"; // Overcast
 			case 7:
-				return "fog"; //Fog
+				return "fog"; // Fog
 			case 8:
-				return "showers"; //Light rain showers
+				return "showers"; // Light rain showers
 			case 9:
-				return "showers"; //Moderate rain showers
+				return "showers"; // Moderate rain showers
 			case 10:
-				return "showers"; //Heavy rain showers
+				return "showers"; // Heavy rain showers
 			case 11:
-				return "thunderstorm"; //Thunderstorm
+				return "thunderstorm"; // Thunderstorm
 			case 12:
-				return "sleet"; //Light sleet showers
+				return "sleet"; // Light sleet showers
 			case 13:
-				return "sleet"; //Moderate sleet showers
+				return "sleet"; // Moderate sleet showers
 			case 14:
-				return "sleet"; //Heavy sleet showers
+				return "sleet"; // Heavy sleet showers
 			case 15:
-				return "snow"; //Light snow showers
+				return "snow"; // Light snow showers
 			case 16:
-				return "snow"; //Moderate snow showers
+				return "snow"; // Moderate snow showers
 			case 17:
-				return "snow"; //Heavy snow showers
+				return "snow"; // Heavy snow showers
 			case 18:
-				return "rain"; //Light rain
+				return "rain"; // Light rain
 			case 19:
-				return "rain"; //Moderate rain
+				return "rain"; // Moderate rain
 			case 20:
-				return "rain"; //Heavy rain
+				return "rain"; // Heavy rain
 			case 21:
-				return "thunderstorm"; //Thunder
+				return "thunderstorm"; // Thunder
 			case 22:
 				return "sleet"; // Light sleet
 			case 23:
-				return "sleet"; //Moderate sleet
+				return "sleet"; // Moderate sleet
 			case 24:
 				return "sleet"; // Heavy sleet
 			case 25:
 				return "snow"; // Light snowfall
 			case 26:
-				return "snow"; //Moderate snowfall
+				return "snow"; // Moderate snowfall
 			case 27:
-				return "snow"; //Heavy snowfall
+				return "snow"; // Heavy snowfall
 			default:
 				return "";
 		}