Merge pull request #2400 from MichMich/develop

Release 2.14.0

.editorconfig

@@ -0,0 +1,15 @@
+# editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+max_line_length = 250
+trim_trailing_whitespace = true
+
+[*.{js,json}]
+indent_size = 4
+indent_style = tab

.eslintignore

@@ -1,7 +1 @@
-vendor/
-!/vendor/vendor.js
-/modules/**
-!/modules/default/**
-!/modules/node_helper
-!/modules/node_helper/**
-!/modules/default/defaultmodules.js
+modules/default/calendar/vendor/*

.eslintrc.json

@@ -1,14 +1,30 @@
 {
-	"rules": {
-		"indent": ["error", "tab"],
-		"quotes": ["error", "double"],
-		"max-len": ["error", 250],
-		"curly": "error",
-		"camelcase": ["error", {"properties": "never"}]
-	},
+	"extends": ["eslint:recommended", "plugin:prettier/recommended", "plugin:jsdoc/recommended"],
+	"plugins": ["prettier", "jsdoc"],
 	"env": {
 		"browser": true,
-		"node": true,
-		"es6": true
+		"es6": true,
+		"mocha": true,
+		"node": true
+	},
+	"globals": {
+		"config": true,
+		"Log": true,
+		"MM": true,
+		"Module": true,
+		"moment": true
+	},
+	"parserOptions": {
+		"sourceType": "module",
+		"ecmaVersion": 2017,
+		"ecmaFeatures": {
+			"globalReturn": true
+		}
+	},
+	"rules": {
+		"prettier/prettier": "error",
+		"eqeqeq": "error",
+		"no-prototype-builtins": "off",
+		"no-unused-vars": "off"
 	}
-}
+}

.github/CONTRIBUTING.md

@@ -1,59 +1,48 @@
-Contribution Policy for MagicMirror²
-====================================
+# Contribution Policy for MagicMirror²
 
 Thanks for contributing to MagicMirror²!
 
-We hold our code to standard, and these standards are documented below. 
+We hold our code to standard, and these standards are documented below.
 
-First, before you run the linters, you will need to install them all **and** install the development dependencies:
+If you wish to run our linters, use `npm run lint` without any arguments.
 
-```bash
-(sudo) npm install -g jscs stylelint html-validator-cli
-npm install
-```
+### JavaScript: Run ESLint
 
-### JavaScript: Run JSCS
+We use [ESLint](https://eslint.org) on our JavaScript files.
 
-We use [JSCS](http://jscs.info) on our JavaScript files.
+Our ESLint configuration is in our .eslintrc.json and .eslintignore files.
 
-Our JSCS configuration is in our .jscsrc file.
-
-To run JSCS, use `npm run jscs`.
+To run ESLint, use `npm run lint:js`.
 
 ### CSS: Run StyleLint
 
-We use [StyleLint](http://stylelint.io) to lint our CSS. Our configuration is in our .stylelintrc file.
+We use [StyleLint](https://stylelint.io) to lint our CSS. Our configuration is in our .stylelintrc file.
 
-To run StyleLint, use `npm run stylelint`.
+To run StyleLint, use `npm run lint:style`.
 
-### HTML: Run HTML Validator
+### Submitting Issues
 
-We use [NU Validator](https://validator.w3.org/nu) to validate our HTML. The configuration is in the command in the package.json file.
+Please only submit reproducible issues.
 
-To run HTML Validator, use `npm run htmlvalidator`.
-
-## Submitting Issues
-
-Please only submit reproducible issues. 
-
-If you're not sure if it's a real bug or if it's just you, please open a topic on the forum: https://forum.magicmirror.builders/category/15/bug-hunt - Problems installing or configuring your MagicMirror? Check out: https://forum.magicmirror.builders/category/10/troubleshooting
+If you're not sure if it's a real bug or if it's just you, please open a topic on the forum: [https://forum.magicmirror.builders/category/15/bug-hunt](https://forum.magicmirror.builders/category/15/bug-hunt)
+Problems installing or configuring your MagicMirror? Check out: [https://forum.magicmirror.builders/category/10/troubleshooting](https://forum.magicmirror.builders/category/10/troubleshooting)
 
 When submitting a new issue, please supply the following information:
 
-**Platform** [ Raspberry Pi 2/3, Windows, Mac OS X, Linux, Etc ... ]:
+**Platform**: Place your platform here... give us your web browser/Electron version _and_ your hardware (Raspberry Pi 2/3, Windows, Mac, Linux, System V UNIX).
 
-**Node Version** [ 0.12.13 or later ]:
+**Node Version**: Make sure it's version 0.12.13 or later.
 
-**MagicMirror Version** [ V1 / V2-Beta ]:
+**MagicMirror Version**: Now that the versions have split, tell us if you are using the PHP version (v1) or the newer JavaScript version (v2).
 
-**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.
+**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.
 
-**Steps to Reproduce:** List the step by step process to reproduce the issue.
+**Steps to Reproduce**: List the step by step process to reproduce the issue.
 
-**Expected Results:** Describe what you expected to see.
+**Expected Results**: Describe what you expected to see.
 
-**Actual Results:** Describe what you actually saw.
+**Actual Results**: Describe what you actually saw.
 
-**Configuration:** What does the used config.js file look like? (Don't forget to remove any sensitive information.)
+**Configuration**: What does the used config.js file look like? Don't forget to remove any sensitive information!
 
-**Additional Notes:** Provide any other relevant notes not previously mentioned (optional)
+**Additional Notes**: Provide any other relevant notes not previously mentioned. This is optional.

.github/ISSUE_TEMPLATE.md

@@ -1,21 +1,42 @@
-Please only submit reproducible issues. 
+## I'm not sure if this is a bug
 
-If you're not sure if it's a real bug or if it's just you, please open a topic on the forum: https://forum.magicmirror.builders/category/15/bug-hunt - Problems installing or configuring your MagicMirror? Check out: https://forum.magicmirror.builders/category/10/troubleshooting
+If you're not sure if it's a real bug or if it's just you, please open a topic on the forum: [https://forum.magicmirror.builders/category/15/bug-hunt](https://forum.magicmirror.builders/category/15/bug-hunt)
 
-**Platform** [ Raspberry Pi 2/3, Windows, Mac OS X, Linux, Etc ... ]:
+## I'm having troubles installing or configuring MagicMirror
 
-**Node Version** [ 0.12.13 or later ]:
+Problems installing or configuring your MagicMirror? Check out: [https://forum.magicmirror.builders/category/10/troubleshooting](https://forum.magicmirror.builders/category/10/troubleshooting)
 
-**MagicMirror Version** [ V1 / V2-Beta ]:
+## I found a bug in the MagicMirror installer
 
-**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.
+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)
 
-**Steps to Reproduce:** List the step by step process to reproduce the issue.
+## I found a bug in the MagicMirror Docker image
 
-**Expected Results:** Describe what you expected to see.
+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)
 
-**Actual Results:** Describe what you actually saw.
+---
 
-**Configuration:** What does the used config.js file look like? (Don't forget to remove any sensitive information.)
+## I found a bug in MagicMirror
 
-**Additional Notes:** Provide any other relevant notes not previously mentioned (optional)
+Please make sure to only submit reproducible issues. You can safely remove everything above the dividing line.
+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, Windows, Mac, Linux, System V UNIX).
+
+**Node Version**: Make sure it's version 8 or later.
+
+**MagicMirror Version**: Please let us now which version of MagicMirror you are running. It can be found in the `package.log` 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.
+
+**Steps to Reproduce**: List the step by step process to reproduce the issue.
+
+**Expected Results**: Describe what you expected to see.
+
+**Actual Results**: Describe what you actually saw.
+
+**Configuration**: What does the used config.js file look like? Don't forget to remove any sensitive information!
+
+**Additional Notes**: Provide any other relevant notes not previously mentioned. This is optional.

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,9 +1,13 @@
-> Please send your PR's the develop branch. 
-> Don't forget to add the change to changelog.md.
-
-* Does the pull request solve a **related** issue? [yes | no]
-* If so, can you reference the issue?
-* What does the pull request accomplish? (please list)
-* If it includes major visual changes please add screenshots.
+> Please send your pull requests the develop branch.
+> Don't forget to add the change to CHANGELOG.md.
 
+**Note**: Sometimes the development moves very fast. It is highly
+recommended that you update your branch of `develop` before creating a
+pull request to send us your changes. This makes everyone's lives
+easier (including yours) and helps us out on the development team.
+Thanks!
 
+- Does the pull request solve a **related** issue?
+- If so, can you reference the issue?
+- What does the pull request accomplish? Use a list if needed.
+- If it includes major visual changes please add screenshots.

.github/stale.yml

@@ -0,0 +1,19 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 60
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+  - under investigation
+  - pr welcome
+# Label to use when marking an issue as stale
+staleLabel: wontfix
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

.github/workflows/enforce-changelog.yml

@@ -0,0 +1,15 @@
+name: "Enforce Changelog"
+on:
+  pull_request:
+      types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled]
+
+jobs:
+  # Enforces the update of a changelog file on every pull request 
+  check:
+    runs-on: ubuntu-latest
+    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

@@ -0,0 +1,35 @@
+# 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: Automated Tests
+
+on:
+  push:
+    branches: [ master, develop ]
+  pull_request:
+    branches: [ master, develop ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x, 14.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:e2e
+        npm run test:unit

.gitignore

@@ -1,5 +1,4 @@
 # Various Node ignoramuses.
-
 logs
 *.log
 npm-debug.log*
@@ -8,13 +7,22 @@ pids
 *.seed
 lib-cov
 coverage
-.grunt
 .lock-wscript
 build/Release
-node_modules
+/node_modules/**/*
+fonts/node_modules/**/*
+vendor/node_modules/**/*
+!/tests/node_modules/**/*
 jspm_modules
 .npm
 .node_repl_history
+.nyc_output/
+
+# Visual Studio Code ignoramuses.
+.vscode/
+
+# IDE Code ignoramuses.
+.idea/
 
 # Various Windows ignoramuses.
 Thumbs.db
@@ -46,21 +54,29 @@ Temporary Items
 .apdisk
 
 # Various Linux ignoramuses.
-
 .fuse_hidden*
 .directory
 .Trash-*
 
-# Various Magic Mirror ignoramuses and anti-ignoramuses.
-
-# Don't ignore the node_helper nore module.
-!/modules/node_helper
-!/modules/node_helper/**
-
 # Ignore all modules except the default modules.
 /modules/**
+!/modules/default
 !/modules/default/**
 !/modules/README.md**
 
 # Ignore changes to the custom css files.
 /css/custom.css
+
+# Ignore users config file but keep the sample.
+/config/*
+!/config/config.js.sample
+
+# Vim
+## swap
+[._]*.s[a-w][a-z]
+[._]s[a-w][a-z]
+
+## diff patch
+*.orig
+*.rej
+*.bak

.prettierignore

@@ -0,0 +1,5 @@
+package-lock.json
+/config/**/*
+/vendor/**/*
+!/vendor/vendor.js
+.github/**/*

.prettierrc.json

@@ -0,0 +1,3 @@
+{
+	"trailingComma": "none"
+}

.snyk

@@ -1,14 +0,0 @@
-version: v1.5.2
-ignore: {}
-patch:
-  'npm:minimatch:20160620':
-    - snyk > recursive-readdir > minimatch:
-        patched: '2016-07-30T14:02:31.280Z'
-  'npm:negotiator:20160616':
-    - socket.io > engine.io > accepts > negotiator:
-        patched: '2016-07-30T14:02:31.280Z'
-  'npm:ws:20160624':
-    - socket.io > engine.io > ws:
-        patched: '2016-07-30T14:02:31.280Z'
-    - socket.io > socket.io-client > engine.io-client > ws:
-        patched: '2016-07-30T14:02:31.280Z'

.stylelintrc

@@ -1,4 +0,0 @@
-{
-	"extends": "stylelint-config-standard",
-	"font-family-name-quotes": "double-where-recommended"
-}

.stylelintrc.json

@@ -0,0 +1,7 @@
+{
+	"extends": ["stylelint-prettier/recommended"],
+	"plugins": ["stylelint-prettier"],
+	"rules": {
+		"prettier/prettier": true
+	}
+}

.travis.yml

@@ -1,7 +0,0 @@
-language: node_js
-node_js:
- - "6"
- - "5.1"
-before_script:
- - npm install grunt-cli -g
-script: grunt

CHANGELOG.md

@@ -1,74 +1,920 @@
 # MagicMirror² Change Log
+
 All notable changes to this project will be documented in this file.
-This project adheres to [Semantic Versioning](http://semver.org/).
+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²
+
+## [2.14.0] - 2021-01-01
+
+Special thanks to the following contributors: @Alvinger, @AndyPoms, @ashishtank, @bluemanos, @flopp999, @jakemulley, @jakobsarwary1, @marvai-vgtu, @mirontoli, @rejas, @sdetweil, @Snille & @Sub028.
+
+ℹ️ **Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install`.
+
+### Added
+
+- Added new log level "debug" to the logger.
+- Added new parameter "useKmh" to weather module for displaying wind speed as kmh.
+- Chuvash translation.
+- Added Weatherbit as a provider to Weather module.
+- Added SMHI as a provider to Weather module.
+- Added Hindi & Gujarati translation.
+- Added optional support for DEGREE position in Feels like translation.
+- Added support for variables in nunjucks templates for translate filter.
+- Added Chuvash translation.
+- Calendar: new options "limitDays" and "coloredEvents".
+- Added new option "limitDays" - limit the number of discreet days displayed.
+- Added new option "customEvents" - use custom symbol/color based on keyword in event title.
+- Added GitHub workflows for automated testing and changelog enforcement.
+
+### Updated
+
+- Merging .gitignore in the config-folder with the .gitignore in the root-folder.
+- Weather module - forecast now show TODAY and TOMORROW instead of weekday, to make it easier to understand.
+- Update dependencies to latest versions.
+- Update dependencies eslint, feedme, simple-git and socket.io to latest versions.
+- Update lithuanian translation.
+- Update config sample.
+- Highlight required version mismatch.
+- No select Text for TouchScreen use.
+- Corrected logic for timeFormat "relative" and "absolute".
+- Added missing function call in module.show()
+- Translator variables can have falsy values (e.g. empty string)
+- Fix issue with weather module with DEGREE label in FEELS like
+
+### Deleted
+
+- Removed Travis CI intergration.
+
+### Fixed
+
+- JSON Parse translation files with comments crashing UI. (#2149)
+- Calendar parsing where RRULE bug returns wrong date, add Windows timezone name support. (#2145, #2151)
+- Wrong node-ical version installed (package.json) requested version. (#2153)
+- Fix calendar fetcher subsequent timing. (#2160)
+- 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 console.debug not having timestamps. (#2199)
+- Fix calendar full day event east of UTC start time. (#2200)
+- Fix non-fullday recurring rule processing. (#2216)
+- Catch errors when parsing calendar data with ical. (#2022)
+- Fix Default Alert Module does not hide black overlay when alert is dismissed manually. (#2228)
+- Weather module - Always displays night icons when local is other then English. (#2221)
+- Update Node-ical 0.12.4 , fix invalid RRULE format in cal entries
+- Fix package.json for optional electron dependency (2378)
+- Update node-ical version again, 0.12.5, change RRULE fix (#2371, #2379)
+- Remove undefined objects from modules array (#2382)
+- Update node-ical version again, 0.12.7, change RRULE fix (#2371, #2379), node-ical now throws error (which we catch)
+- Update simple-git version to 2.31 unhandled promise rejection (#2383)
+
+## [2.13.0] - 2020-10-01
+
+Special thanks to the following contributors: @bryanzzhu, @bugsounet, @chamakura, @cjbrunner, @easyas314, @larryare, @oemel09, @rejas, @sdetweil & @sthuber90.
+
+ℹ️ **Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install`.
+
+### Added
+
+- `--dry-run` option adde 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.
+- Test coverage with Istanbul, run it with `npm run test:coverage`.
+- Add lithuanian language.
+- Added support in weatherforecast for OpenWeather onecall API.
+- Added config option to calendar-icons for recurring- and fullday-events.
+- Added current, hourly (max 48), and daily (max 7) weather forecasts to weather module via OpenWeatherMap One Call API.
+- Added eslint-plugin for jsdoc comments.
+- Added new configDeepMerge option for module developers.
+
+### Updated
+
+- Change incorrect weather.js default properties.
+- Cleaned up newsfeed module.
+- Cleaned up jsdoc comments.
+- Cleaned up clock tests.
+- Move lodash into devDependencies, update other dependencies.
+- Switch from ical to node-ical library.
+
+### Fixed
+
+- Fix backward compatibility issues for Safari < 11.
+- Fix the use of "maxNumberOfDays" in the module "weatherforecast depending on the endpoint (forecast/daily or forecast)". [#2018](https://github.com/MichMich/MagicMirror/issues/2018)
+- Fix calendar display. Account for current timezone. [#2068](https://github.com/MichMich/MagicMirror/issues/2068)
+- Fix logLevel being set before loading config.
+- Fix incorrect namespace links in svg clockfaces. [#2072](https://github.com/MichMich/MagicMirror/issues/2072)
+- Fix weather/providers/weathergov for API guidelines. [#2045](https://github.com/MichMich/MagicMirror/issues/2045)
+- Fix "undefined" in weather modules header. [#1985](https://github.com/MichMich/MagicMirror/issues/1985)
+- Fix #2110, #2111, #2118: Recurring full day events should not use timezone adjustment. Just compare month/day.
+
+## [2.12.0] - 2020-07-01
+
+Special thanks to the following contributors: @AndreKoepke, @andrezibaia, @bryanzzhu, @chamakura, @DarthBrento, @Ekristoffe, @khassel, @Legion2, @ndom91, @radokristof, @rejas, @XBCreepinJesus & @ZoneMR.
+
+ℹ️ **Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install`.
+
+### Added
+
+- Added option to config the level of logging.
+- Added prettier for an even cleaner codebase.
+- Hide Sunrise/Sunset in Weather module.
+- Hide Sunrise/Sunset in Current Weather module.
+- Added Met Office DataHub (UK) provider.
+
+### Updated
+
+- Cleaned up alert module code.
+- Cleaned up check_config code.
+- Replaced grunt-based linters with their non-grunt equivalents.
+- Switch to most of the eslint:recommended rules and fix warnings.
+- Replaced insecure links with https ones.
+- Cleaned up all "no-undef" warnings from eslint.
+- Added location title wrapping for calendar module.
+- Updated the BG translation.
+
+### Deleted
+
+- Removed truetype (ttf) fonts.
+
+### Fixed
+
+- The broken modules due to Socket.io change from last release. [#1973](https://github.com/MichMich/MagicMirror/issues/1973)
+- Add backward compatibility for old module code in socketclient.js. [#1973](https://github.com/MichMich/MagicMirror/issues/1973)
+- Support multiple instances of calendar module with different config. [#1109](https://github.com/MichMich/MagicMirror/issues/1109)
+- Fix the use of "maxNumberOfDays" in the module "weatherforecast". [#2018](https://github.com/MichMich/MagicMirror/issues/2018)
+- Throw error when check_config fails. [#1928](https://github.com/MichMich/MagicMirror/issues/1928)
+- Bug fix related to 'maxEntries' not displaying Calendar events. [#2050](https://github.com/MichMich/MagicMirror/issues/2050)
+- Updated ical library to latest version. [#1926](https://github.com/MichMich/MagicMirror/issues/1926)
+- Fix config check after merge of prettier [#2109](https://github.com/MichMich/MagicMirror/issues/2109)
+
+## [2.11.0] - 2020-04-01
+
+🚨 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.
+
+For more information regarding this major change, please check issue [#1860](https://github.com/MichMich/MagicMirror/issues/1860).
+
+### Deleted
+
+- Remove installers.
+- Remove externalized scripts.
+- Remove jshint dependency, instead eslint checks your config file now
+
+### Added
+
+- Brazilian translation for "FEELS".
+- Ukrainian translation.
+- Finnish translation for "PRECIP", "UPDATE_INFO_MULTIPLE" and "UPDATE_INFO_SINGLE".
+- Added the ability to hide the temp label and weather icon in the `currentweather` module to allow showing only information such as wind and sunset/rise.
+- The `clock` module now optionally displays sun and moon data, including rise/set times, remaining daylight, and percent of moon illumination.
+- Added Hebrew translation.
+- Add HTTPS support and update config.js.sample
+- Run tests on long term support and latest stable version of nodejs
+- Added the ability to configure a list of modules that shouldn't be update checked.
+- Run linters on git commits
+- Added date functionality to compliments: display birthday wishes or celebrate an anniversary
+- Add HTTPS support for clientonly-mode.
+
+### Fixed
+
+- Force declaration of public ip address in config file (ISSUE #1852)
+- Fixes `run-start.sh`: If running in docker-container, don't check the environment, just start electron (ISSUE #1859)
+- Fix calendar time offset for recurring events crossing Daylight Savings Time (ISSUE #1798)
+- Fix regression in currentweather module causing 'undefined' to show up when config.hideTemp is false
+- Fix FEELS translation for Croatian
+- Fixed weather tests [#1840](https://github.com/MichMich/MagicMirror/issues/1840)
+- Fixed Socket.io can't be used with Reverse Proxy in serveronly mode [#1934](https://github.com/MichMich/MagicMirror/issues/1934)
+- Fix update checking skipping 3rd party modules the first time
+
+### Changed
+
+- Remove documentation from core repository and link to new dedicated docs site: [docs.magicmirror.builders](https://docs.magicmirror.builders).
+- Updated config.js.sample: Corrected some grammar on `config.js.sample` comment section.
+- Removed `run-start.sh` script and update start commands:
+  - To start using electron, use `npm run start`.
+  - To start in server only mode, use `npm run server`.
+- Remove redundant logging from modules.
+- Timestamp in log output now also contains the date
+- Turkish translation.
+- Option to configure the size of the currentweather module.
+- Changed "Gevoelstemperatuur" to "Voelt als" shorter text.
+
+## [2.10.1] - 2020-01-10
+
+### Changed
+
+- Updated README.md: Added links to the official documentation website and remove links to broken installer.
+
+## [2.10.0] - 2020-01-01
+
+Special thanks to @sdetweil for all his great contributions!
+
+ℹ️ **Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install`.
+
+### Added
+
+- Timestamps in log output.
+- Padding in dateheader mode of the calendar module.
+- New upgrade script to help users consume regular updates installers/upgrade-script.sh.
+- New script to help setup pm2, without install installers/fixuppm2.sh.
+
+### Updated
+
+- Updated lower bound of `lodash` and `helmet` dependencies for security patches.
+- Updated compliments.js to handle newline in text, as textfields to not interpolate contents.
+- Updated raspberry.sh installer script to handle new platform issues, split node/npm, pm2, and screen saver changes.
+- Improve handling for armv6l devices, where electron support has gone away, add optional serveronly config option.
+- Improved run-start.sh to handle for serveronly mode, by choice, or when electron not available.
+- Only check for xwindows running if not on macOS.
+
+### Fixed
+
+- Fixed issue in weatherforecast module where predicted amount of rain was not using the decimal symbol specified in config.js.
+- Module header now updates correctly, if a module need to dynamically show/hide its header based on a condition.
+- Fix handling of config.js for serverOnly mode commented out.
+- Fixed issue in calendar module where the debug script didn't work correctly with authentication.
+- Fixed issue that some full day events were not correctly recognized as such.
+- Display full day events lasting multiple days as happening today instead of some days ago if they are still ongoing.
+
+## [2.9.0] - 2019-10-01
+
+ℹ️ **Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install`. If you are having issues running Electron, make sure your [Raspbian is up to date](https://www.raspberrypi.org/documentation/raspbian/updating.md).
+
+### Added
+
+- Spanish translation for "PRECIP".
+- Adding a Malay (Malaysian) translation for MagicMirror².
+- Add test check URLs of vendors 200 and 404 HTTP CODE.
+- Add tests for new weather module and helper to stub ajax requests.
+
+### Updated
+
+- Updatenotification module: Display update notification for a limited (configurable) time.
+- Enabled e2e/vendor_spec.js tests.
+- The css/custom.css will be renamed after the next release. We've added into `run-start.sh` an instruction by GIT to ignore with `--skip-worktree` and `rm --cached`. [#1540](https://github.com/MichMich/MagicMirror/issues/1540)
+- Disable sending of notification CLOCK_SECOND when displaySeconds is false.
+
+### Fixed
+
+- Updatenotification module: Properly handle race conditions, prevent crash.
+- Send `NEWS_FEED` notification also for the first news messages which are shown.
+- Fixed issue where weather module would not refresh data after a network or API outage. [#1722](https://github.com/MichMich/MagicMirror/issues/1722)
+- Fixed weatherforecast module not displaying rain amount on fallback endpoint.
+- Notifications CLOCK_SECOND & CLOCK_MINUTE being from startup instead of matched against the clock and avoid drifting.
+
+## [2.8.0] - 2019-07-01
+
+ℹ️ **Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install`. If you are having issues running Electron, make sure your [Raspbian is up to date](https://www.raspberrypi.org/documentation/raspbian/updating.md).
+
+### Added
+
+- Option to show event location in calendar
+- Finnish translation for "Feels" and "Weeks"
+- Russian translation for “Feels”
+- Calendar module: added `nextDaysRelative` config option
+- Add `broadcastPastEvents` config option for calendars to include events from the past `maximumNumberOfDays` in event broadcasts
+- Added feature to broadcast news feed items `NEWS_FEED` and updated news items `NEWS_FEED_UPDATED` in default [newsfeed](https://github.com/MichMich/MagicMirror/tree/develop/modules/default/newsfeed) module (when news is updated) with documented default and `config.js` options in [README.md](https://github.com/MichMich/MagicMirror/blob/develop/modules/default/newsfeed/README.md)
+- Added notifications to default `clock` module broadcasting `CLOCK_SECOND` and `CLOCK_MINUTE` for the respective time elapsed.
+- Added UK Met Office Datapoint feed as a provider in the default weather module.
+- Added new provider class
+- Added suncalc.js dependency to calculate sun times (not provided in UK Met Office feed)
+- Added "tempUnits" and "windUnits" to allow, for example, temp in metric (i.e. celsius) and wind in imperial (i.e. mph). These will override "units" if specified, otherwise the "units" value will be used.
+- Use Feels Like temp from feed if present
+- Optionally display probability of precipitation (PoP) in current weather (UK Met Office data)
+- Automatically try to fix eslint errors by passing `--fix` option to it
+- Added sunrise and sunset times to weathergov weather provider [#1705](https://github.com/MichMich/MagicMirror/issues/1705)
+- Added "useLocationAsHeader" to display "location" in `config.js` as header when location name is not returned
+- Added to `newsfeed.js`: in order to design the news article better with css, three more class-names were introduced: newsfeed-desc, newsfeed-desc, newsfeed-desc
+
+### Updated
+
+- English translation for "Feels" to "Feels like"
+- Fixed the example calendar url in `config.js.sample`
+- 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
+
+### Fixed
+
+- Fixed uncaught exception, race condition on module update
+- Fixed issue [#1696](https://github.com/MichMich/MagicMirror/issues/1696), some ical files start date to not parse to date type
+- Allowance HTML5 autoplay-policy (policy is changed from Chrome 66 updates)
+- Handle SIGTERM messages
+- Fixes sliceMultiDayEvents so it respects maximumNumberOfDays
+- Minor types in default NewsFeed [README.md](https://github.com/MichMich/MagicMirror/blob/develop/modules/default/newsfeed/README.md)
+- Fix typos and small syntax errors, cleanup dependencies, remove multiple-empty-lines, add semi-rule
+- Fixed issues with calendar not displaying one-time changes to repeating events
+- Updated the fetchedLocationName variable in currentweather.js so that city shows up in the header
+
+### Updated installer
+
+- give non-pi2+ users (pi0, odroid, jetson nano, mac, windows, ...) option to continue install
+- use current username vs hardcoded 'pi' to support non-pi install
+- check for npm installed. node install doesn't do npm anymore
+- check for mac as part of PM2 install, add install option string
+- update pm2 config with current username instead of hard coded 'pi'
+- check for screen saver config, "/etc/xdg/lxsession", bypass if not setup
+
+## [2.7.1] - 2019-04-02
+
+Fixed `package.json` version number.
+
+## [2.7.0] - 2019-04-01
+
+ℹ️ **Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install`. If you are having issues running Electron, make sure your [Raspbian is up to date](https://www.raspberrypi.org/documentation/raspbian/updating.md).
+
+### Added
+
+- Italian translation for "Feels"
+- Basic Klingon (tlhIngan Hol) translations
+- Disabled the screensaver on raspbian with installation script
+- Added option to truncate the number of vertical lines a calendar item can span if `wrapEvents` is enabled.
+- Danish translation for "Feels" and "Weeks"
+- Added option to split multiple day events in calendar to separate numbered events
+- Slovakian translation
+- Alerts now can contain Font Awesome icons
+- Notifications display time can be set in request
+- Newsfeed: added support for `ARTICLE_INFO_REQUEST` notification
+- Add `name` config option for calendars to be sent along with event broadcasts
+
+### Updated
+
+- Bumped the Electron dependency to v3.0.13 to support the most recent Raspbian. [#1500](https://github.com/MichMich/MagicMirror/issues/1500)
+- Updated modernizr code in alert module, fixed a small typo there too
+- More verbose error message on console if the config is malformed
+- Updated installer script to install Node.js version 10.x
+
+### Fixed
+
+- Fixed temperature displays in currentweather and weatherforecast modules [#1503](https://github.com/MichMich/MagicMirror/issues/1503), [#1511](https://github.com/MichMich/MagicMirror/issues/1511).
+- 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).
+- 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)
+- Calendar: Fix relative date handling for fulldate events, calculate difference always from start of day [#1572](https://github.com/MichMich/MagicMirror/issues/1572)
+- Fix null dereference in moduleNeedsUpdate when the module isn't visible
+- Calendar: Fixed event end times by setting default calendarEndTime to "LT" (Local time format). [#1479]
+- Calendar: Fixed missing calendar fetchers after server process restarts [#1589](https://github.com/MichMich/MagicMirror/issues/1589)
+- Notification: fixed background color (was white text on white background)
+- Use getHeader instead of data.header when creating the DOM so overwriting the function also propagates into it
+- Fix documentation of `useKMPHwind` option in currentweather
+
+### New weather module
+
+- Fixed weather forecast table display [#1499](https://github.com/MichMich/MagicMirror/issues/1499).
+- Dimmed loading indicator for weather forecast.
+- Implemented config option `decimalSymbol` [#1499](https://github.com/MichMich/MagicMirror/issues/1499).
+- Aligned indoor values in current weather vertical [#1499](https://github.com/MichMich/MagicMirror/issues/1499).
+- Added humidity support to nunjuck unit filter.
+- Do not display degree symbol for temperature in Kelvin [#1503](https://github.com/MichMich/MagicMirror/issues/1503).
+- Weather forecast now works with openweathermap for both, `/forecast` and `/forecast/daily`, in new weather module. If you use the `/forecast`-weatherEndpoint, the hourly data are converted to daily data, see issues [#1504](https://github.com/MichMich/MagicMirror/issues/1504), [#1513](https://github.com/MichMich/MagicMirror/issues/1513).
+- Added fade, fadePoint and maxNumberOfDays properties to the forecast mode [#1516](https://github.com/MichMich/MagicMirror/issues/1516)
+- Fixed Loading string and decimalSymbol string replace [#1538](https://github.com/MichMich/MagicMirror/issues/1538)
+- Show Snow amounts in new weather module [#1545](https://github.com/MichMich/MagicMirror/issues/1545)
+- Added weather.gov as a new weather provider for US locations
+
+## [2.6.0] - 2019-01-01
+
+ℹ️ **Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install`. If you are having issues updating, make sure you are running the latest version of Node.
+
+### ✨ Experimental ✨
+
+- New default [module weather](modules/default/weather). This module will eventually replace the current `currentweather` and `weatherforecast` modules. The new module is still pretty experimental, but it's included so you can give it a try and help us improve this module. Please give us you feedback using [this forum post](https://forum.magicmirror.builders/topic/9335/default-weather-module-refactoring).
+
+A huge, huge, huge thanks to user @fewieden for all his hard work on the new `weather` module!
+
+### Added
+
+- Possibility to add classes to the cell of symbol, title and time of the events of calendar.
+- Font-awesome 5, still has 4 for backwards compatibility.
+- Missing `showEnd` in calendar documentation
+- Screenshot for the new feed module
+- Screenshot for the compliments module
+- Screenshot for the clock module
+- Screenshot for the current weather
+- Screenshot for the weather forecast module
+- Portuguese translation for "Feels"
+- Croatian translation
+- Fading for dateheaders timeFormat in Calendar [#1464](https://github.com/MichMich/MagicMirror/issues/1464)
+- Documentation for the existing `scale` option in the Weather Forecast module.
+
+### Fixed
+
+- Allow parsing recurring calendar events where the start date is before 1900
+- Fixed Polish translation for Single Update Info
+- Ignore entries with unparseable details in the calendar module
+- Bug showing FullDayEvents one day too long in calendar fixed
+- Bug in newsfeed when `removeStartTags` is used on the description [#1478](https://github.com/MichMich/MagicMirror/issues/1478)
+
+### Updated
+
+- The default calendar setting `showEnd` is changed to `false`.
+
+### Changed
+
+- The Weather Forecast module by default displays the &deg; symbol after every numeric value to be consistent with the Current Weather module.
+
+## [2.5.0] - 2018-10-01
+
+### Added
+
+- Romanian translation for "Feels"
+- Support multi-line compliments
+- Simplified Chinese translation for "Feels"
+- Polish translate for "Feels"
+- French translate for "Feels"
+- Translations for newsfeed module
+- Support for toggling news article in fullscreen
+- Hungarian translation for "Feels" and "Week"
+- Spanish translation for "Feels"
+- Add classes instead of inline style to the message from the module Alert
+- Support for events having a duration instead of an end
+- Support for showing end of events through config parameters showEnd and dateEndFormat
+
+### Fixed
+
+- Fixed gzip encoded calendar loading issue #1400.
+- Mixup between german and spanish translation for newsfeed.
+- Fixed close dates to be absolute, if no configured in the config.js - module Calendar
+- Fixed the updatenotification module message about new commits in the repository, so they can be correctly localized in singular and plural form.
+- Fix for weatherforecast rainfall rounding [#1374](https://github.com/MichMich/MagicMirror/issues/1374)
+- Fix calendar parsing issue for Midori on RasperryPi Zero w, related to issue #694.
+- Fix weather city ID link in sample config
+- Fixed issue with clientonly not updating with IP address and port provided on command line.
+
+### Updated
+
+- Updated Simplified Chinese translation
+- Swedish translations
+- Hungarian translations for the updatenotification module
+- Updated Norsk bokmål translation
+- Updated Norsk nynorsk translation
+- Consider multi days event as full day events
+
+## [2.4.1] - 2018-07-04
+
+### Fixed
+
+- Fix weather parsing issue #1332.
+
+## [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).
+
+ℹ️ **Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install`
+
+### Added
+
+- Enabled translation of feelsLike for module currentweather
+- Added support for on-going calendar events
+- Added scroll up in fullscreen newsfeed article view
+- Changed fullscreen newsfeed width from 100% to 100vw (better results)
+- Added option to calendar module that colors only the symbol instead of the whole line
+- Added option for new display format in the calendar module with date headers with times/events below.
+- Ability to fetch compliments from a remote server
+- Add regex filtering to calendar module
+- Customize classes for table
+- Added option to newsfeed module to only log error parsing a news article if enabled
+- Add update translations for Português Brasileiro
+
+### Changed
+
+- Upgrade to Electron 2.0.0.
+- Remove yarn-or-npm which breaks production builds.
+- Invoke module suspend even if no dom content. [#1308](https://github.com/MichMich/MagicMirror/issues/1308)
+
+### Fixed
+
+- Fixed issue where wind chill could not be displayed in Fahrenheit. [#1247](https://github.com/MichMich/MagicMirror/issues/1247)
+- Fixed issues where a module crashes when it tries to dismiss a non existing alert. [#1240](https://github.com/MichMich/MagicMirror/issues/1240)
+- In default module currentWeather/currentWeather.js line 296, 300, self.config.animationSpeed can not be found because the notificationReceived function does not have "self" variable.
+- Fixed browser-side code to work on the Midori browser.
+- Fixed issue where heat index was reporting incorrect values in Celsius and Fahrenheit. [#1263](https://github.com/MichMich/MagicMirror/issues/1263)
+- Fixed weatherforecast to use dt_txt field instead of dt to handle timezones better
+- Newsfeed now remembers to show the description when `"ARTICLE_LESS_DETAILS"` is called if the user wants to always show the description. [#1282](https://github.com/MichMich/MagicMirror/issues/1282)
+- `clientonly/*.js` is now linted, and one linting error is fixed
+- Fix issue #1196 by changing underscore to hyphen in locale id, in align with momentjs.
+- Fixed issue where heat index and wind chill were reporting incorrect values in Kelvin. [#1263](https://github.com/MichMich/MagicMirror/issues/1263)
+
+### Updated
+
+- Updated Italian translation
+- Updated German translation
+- Updated Dutch translation
+
+## [2.3.1] - 2018-04-01
+
+### Fixed
+
+- Downgrade electron to 1.4.15 to solve the black screen issue.[#1243](https://github.com/MichMich/MagicMirror/issues/1243)
+
+## [2.3.0] - 2018-04-01
+
+### Added
+
+- Add new settings in compliments module: setting time intervals for morning and afternoon
+- Add system notification `MODULE_DOM_CREATED` for notifying each module when their Dom has been fully loaded.
+- Add types for module.
+- Implement Danger.js to notify contributors when CHANGELOG.md is missing in PR.
+- Allow scrolling in full page article view of default newsfeed module with gesture events from [MMM-Gestures](https://github.com/thobach/MMM-Gestures)
+- Changed 'compliments.js' - update DOM if remote compliments are loaded instead of waiting one updateInterval to show custom compliments
+- Automated unit tests utils, deprecated, translator, cloneObject(lockstrings)
+- Automated integration tests translations
+- Add advanced filtering to the excludedEvents configuration of the default calendar module
+- New currentweather module config option: `showFeelsLike`: Shows how it actually feels like. (wind chill or heat index)
+- New currentweather module config option: `useKMPHwind`: adds an option to see wind speed in Kmph instead of just m/s or Beaufort.
+- Add dc:date to parsing in newsfeed module, which allows parsing of more rss feeds.
+
+### Changed
+
+- Add link to GitHub repository which contains the respective Dockerfile.
+- Optimized automated unit tests cloneObject, cmpVersions
+- Update notifications use now translation templates instead of normal strings.
+- Yarn can be used now as an installation tool
+- Changed Electron dependency to v1.7.13.
+
+### Fixed
+
+- News article in fullscreen (iframe) is now shown in front of modules.
+- Forecast respects maxNumberOfDays regardless of endpoint.
+- Fix exception on translation of objects.
+
+## [2.2.2] - 2018-01-02
+
+### Added
+
+- Add missing `package-lock.json`.
+
+### Changed
+
+- Changed Electron dependency to v1.7.10.
+
+## [2.2.1] - 2018-01-01
+
+### Fixed
+
+- Fixed linting errors.
+
+## [2.2.0] - 2018-01-01
+
+**Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install`
+
+### Changed
+
+- Calendar week is now handled with a variable translation in order to move number language specific.
+- Reverted the Electron dependency back to 1.4.15 since newer version don't seem to work on the Raspberry Pi very well.
+
+### Added
+
+- Add option to use [Nunjucks](https://mozilla.github.io/nunjucks/) templates in modules. (See `helloworld` module as an example.)
+- Add Bulgarian translations for MagicMirror² and Alert module.
+- Add graceful shutdown of modules by calling `stop` function of each `node_helper` on SIGINT before exiting.
+- Link update subtext to Github diff of current version versus tracking branch.
+- Add Catalan translation.
+- Add ability to filter out newsfeed items based on prohibited words found in title (resolves #1071)
+- Add options to truncate description support of a feed in newsfeed module
+- Add reloadInterval option for particular feed in newsfeed module
+- Add no-cache entries of HTTP headers in newsfeed module (fetcher)
+- Add Czech translation.
+- Add option for decimal symbols other than the decimal point for temperature values in both default weather modules: WeatherForecast and CurrentWeather.
+
+### Fixed
+
+- Fixed issue with calendar module showing more than `maximumEntries` allows
+- WeatherForecast and CurrentWeather are now using HTTPS instead of HTTP
+- Correcting translation for Indonesian language
+- Fix issue where calendar icons wouldn't align correctly
+
+## [2.1.3] - 2017-10-01
+
+**Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install`
+
+### Changed
+
+- Remove Roboto fonts files inside `fonts` and these are installed by npm install command.
+
+### Added
+
+- Add `clientonly` script to start only the electron client for a remote server.
+- Add symbol and color properties of event when `CALENDAR_EVENTS` notification is broadcasted from `default/calendar` module.
+- Add `.vscode/` folder to `.gitignore` to keep custom Visual Studio Code config out of git.
+- Add unit test the capitalizeFirstLetter function of newsfeed module.
+- Add new unit tests for function `shorten` in calendar module.
+- Add new unit tests for function `getLocaleSpecification` in calendar module.
+- Add unit test for js/class.js.
+- Add unit tests for function `roundValue` in currentweather module.
+- Add test e2e showWeek feature in spanish language.
+- Add warning Log when is used old authentication method in the calendar module.
+- Add test e2e for helloworld module with default config text.
+- Add ability for `currentweather` module to display indoor humidity via INDOOR_HUMIDITY notification.
+- Add Welsh (Cymraeg) translation.
+- Add Slack badge to Readme.
+
+### Updated
+
+- Changed 'default.js' - listen on all attached interfaces by default.
+- Add execution of `npm list` after the test are ran in Travis CI.
+- Change hooks for the vendors e2e tests.
+- Add log when clientonly failed on starting.
+- Add warning color when are using full ip whitelist.
+- Set version of the `express-ipfilter` on 0.3.1.
+
+### Fixed
+
+- Fixed issue with incorrect alignment of analog clock when displayed in the center column of the MM.
+- Fixed ipWhitelist behaviour to make empty whitelist ([]) allow any and all hosts access to the MM.
+- Fixed issue with calendar module where 'excludedEvents' count towards 'maximumEntries'.
+- Fixed issue with calendar module where global configuration of maximumEntries was not overridden by calendar specific config (see module doc).
+- Fixed issue where `this.file(filename)` returns a path with two hashes.
+- Workaround for the WeatherForecast API limitation.
+
+## [2.1.2] - 2017-07-01
+
+### Changed
+
+- Revert Docker related changes in favor of [docker-MagicMirror](https://github.com/bastilimbach/docker-MagicMirror). All Docker images are outsourced. ([#856](https://github.com/MichMich/MagicMirror/pull/856))
+- Change Docker base image (Debian + Node) to an arm based distro (AlpineARM + Node) ([#846](https://github.com/MichMich/MagicMirror/pull/846))
+- Fix the dockerfile to have it running from the first time.
+
+### Added
+
+- Add in option to wrap long calendar events to multiple lines using `wrapEvents` configuration option.
+- Add test e2e `show title newsfeed` for newsfeed module.
+- Add task to check configuration file.
+- Add test check URLs of vendors.
+- Add test of match current week number on clock module with showWeek configuration.
+- Add test default modules present modules/default/defaultmodules.js.
+- Add unit test calendar_modules function capFirst.
+- Add test for check if exists the directories present in defaults modules.
+- Add support for showing wind direction as an arrow instead of abbreviation in currentWeather module.
+- Add support for writing translation functions to support flexible word order
+- Add test for check if exits the directories present in defaults modules.
+- Add calendar option to set a separate date format for full day events.
+- Add ability for `currentweather` module to display indoor temperature via INDOOR_TEMPERATURE notification
+- Add ability to change the path of the `custom.css`.
+- Add translation Dutch to Alert module.
+- Added Romanian translation.
+
+### Updated
+
+- Added missing keys to Polish translation.
+- Added missing key to German translation.
+- Added better translation with flexible word order to Finnish translation.
+
+### Fixed
+
+- Fix instruction in README for using automatically installer script.
+- Bug of duplicated compliments as described in [here](https://forum.magicmirror.builders/topic/2381/compliments-module-stops-cycling-compliments).
+- Fix double message about port when server is starting
+- Corrected Swedish translations for TODAY/TOMORROW/DAYAFTERTOMORROW.
+- Removed unused import from js/electron.js
+- Made calendar.js respect config.timeFormat irrespective of locale setting.
+- Fixed alignment of analog clock when a large calendar is displayed in the same side bar.
+
+## [2.1.1] - 2017-04-01
+
+**Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install`
+
+### Changed
+
+- Add `anytime` group for Compliments module.
+- Compliments module can use remoteFile without default daytime arrays defined.
+- Installer: Use init config.js from config.js.sample.
+- Switched out `rrule` package for `rrule-alt` and fixes in `ical.js` in order to fix calendar issues. ([#565](https://github.com/MichMich/MagicMirror/issues/565))
+- Make mouse events pass through the region fullscreen_above to modules below.
+- Scaled the splash screen down to make it a bit more subtle.
+- Replace HTML tables with markdown tables in README files.
+- Added `DAYAFTERTOMORROW`, `UPDATE_NOTIFICATION` and `UPDATE_NOTIFICATION_MODULE` to Finnish translations.
+- Run `npm test` on Travis automatically.
+- Show the splash screen image even when is reboot or halted.
+- Added some missing translation strings in the sv.json file.
+- Run task jsonlint to check translation files.
+- Restructured Test Suite.
+
+### Added
+
+- Added Docker support (Pull Request [#673](https://github.com/MichMich/MagicMirror/pull/673)).
+- Calendar-specific support for `maximumEntries`, and `maximumNumberOfDays`.
+- Add loaded function to modules, providing an async callback.
+- Made default newsfeed module aware of gesture events from [MMM-Gestures](https://github.com/thobach/MMM-Gestures)
+- 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.
+- Init tests using mocha.
+- Option to use RegExp in Calendar's titleReplace.
+- Hungarian Translation.
+- Icelandic Translation.
+- Add use a script to prevent when is run by SSH session set DISPLAY environment.
+- Enable ability to set configuration file by the environment variable called MM_CONFIG_FILE.
+- Option to give each calendar a different color.
+- Option for colored min-temp and max-temp.
+- Add test e2e helloworld.
+- Add test e2e environment.
+- Add `chai-as-promised` npm module to devDependencies.
+- Basic set of tests for clock module.
+- Run e2e test in Travis.
+- Estonian Translation.
+- Add test for compliments module for parts of day.
+- Korean Translation.
+- Added console warning on startup when deprecated config options are used.
+- Add option to display temperature unit label to the current weather module.
+- Added ability to disable wrapping of news items.
+- Added in the ability to hide events in the calendar module based on simple string filters.
+- Updated Norwegian translation.
+- Added hideLoading option for News Feed module.
+- Added configurable dateFormat to clock module.
+- Added multiple calendar icon support.
+- Added tests for Translations, dev argument, version, dev console.
+- Added test anytime feature compliments module.
+- Added test ipwhitelist configuration directive.
+- Added test for calendar module: default, basic-auth, backward compatibility, fail-basic-auth.
+- Added meta tags to support fullscreen mode on iOS (for server mode)
+- Added `ignoreOldItems` and `ignoreOlderThan` options to the News Feed module
+- Added test for MM_PORT environment variable.
+- Added a configurable Week section to the clock module.
+
+### Fixed
+
+- Update .gitignore to not ignore default modules folder.
+- Remove white flash on boot up.
+- Added `update` in Raspberry Pi installation script.
+- Fix an issue where the analog clock looked scrambled. ([#611](https://github.com/MichMich/MagicMirror/issues/611))
+- If units are set to imperial, the showRainAmount option of weatherforecast will show the correct unit.
+- Module currentWeather: check if temperature received from api is defined.
+- Fix an issue with module hidden status changing to `true` although lock string prevented showing it.
+- Fix newsfeed module bug (removeStartTags)
+- Fix when is set MM_PORT environment variable.
+- Fixed missing animation on `this.show(speed)` when module is alone in a region.
+
+## [2.1.0] - 2016-12-31
+
+**Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install`
+
+### Added
+
+- Finnish translation.
+- Danish translation.
+- Turkish translation.
+- Option to limit access to certain IP addresses based on the value of `ipWhitelist` in the `config.js`, default is access from localhost only (Issue [#456](https://github.com/MichMich/MagicMirror/issues/456)).
+- Added ability to change the point of time when calendar events get relative.
+- Add Splash screen on boot.
+- Add option to show humidity in currentWeather module.
+- 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.
+- 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
+- Add module `updatenotification` to get an update whenever a new version is available. [See documentation](https://github.com/MichMich/MagicMirror/tree/develop/modules/default/updatenotification) for more information.
+- Add the ability to set timezone on the date display in the Clock Module
+- Ability to set date format in calendar module
+- Possibility to use currentweather for the compliments
+- Added option `disabled` for modules.
+- Added option `address` to set bind address.
+- Added option `onlyTemp` for currentweather module to show only current temperature and weather icon.
+- Added option `remoteFile` to compliments module to load compliment array from filesystem.
+- Added option `zoom` to scale the whole mirror display with a given factor.
+- Added option `roundTemp` for currentweather and weatherforecast modules to display temperatures rounded to nearest integer.
+- Added ability set the classes option to compliments module for style and text size of compliments.
+- Added ability to configure electronOptions
+- Calendar module: option to hide private events
+- Add root_path for global vars
+
+### Updated
+
+- Modified translations for Frysk.
+- Modified core English translations.
+- Updated package.json as a result of Snyk security update.
+- Improve object instantiation to prevent reference errors.
+- Improve logger. `Log.log()` now accepts multiple arguments.
+- Remove extensive logging in newsfeed node helper.
+- Calendar times are now uniformly capitalized.
+- Modules are now secure, and Helmet is now used to prevent abuse of the Mirror's API.
+
+### Fixed
+
+- Solve an issue where module margins would appear when the first module of a section was hidden.
+- Solved visual display errors on chrome, if all modules in one of the right sections are hidden.
+- Global and Module default config values are no longer modified when setting config values.
+- Hide a region if all modules in a region are hidden. Prevention unwanted margins.
+- Replaced `electron-prebuilt` package with `electron` in order to fix issues that would happen after 2017.
+- Documentation of alert module
+
+## [2.0.5] - 2016-09-20
+
+### Added
+
+- Added ability to remove tags from the beginning or end of newsfeed items in 'newsfeed.js'.
+- Added ability to define "the day after tomorrow" for calendar events (Definition for German and Dutch already included).
+- Added CII Badge (we are compliant with the CII Best Practices)
+- Add support for doing http basic auth when loading calendars
+- Add the ability to turn off and on the date display in the Clock Module
+
+### Fixed
+
+- Fix typo in installer.
+- Add message to unsupported Pi error to mention that Pi Zeros must use server only mode, as ARMv6 is unsupported. Closes #374.
+- Fix API url for weather API.
+
+### Updated
+
+- Force fullscreen when kioskmode is active.
+- Update the .github templates and information with more modern information.
+- Update the Gruntfile with a more functional StyleLint implementation.
 
 ## [2.0.4] - 2016-08-07
 
 ### Added
+
 - Brazilian Portuguese Translation.
-- Option to enable Kios mode.
+- Option to enable Kiosk mode.
 - Added ability to start the app with Dev Tools.
 - Added ability to turn off the date display in `clock.js` when in analog mode.
 - Greek Translation
 
 ### Fixed
+
 - Prevent `getModules()` selectors from returning duplicate entries.
-- Append endpoints of weather modules with `/` to retreive the correct data. (Issue [#337](https://github.com/MichMich/MagicMirror/issues/337))
-- Corrected grammer in `module.js` from 'suspend' to 'suspended'.
+- Append endpoints of weather modules with `/` to retrieve the correct data. (Issue [#337](https://github.com/MichMich/MagicMirror/issues/337))
+- Corrected grammar in `module.js` from 'suspend' to 'suspended'.
 - Fixed openweathermap.org URL in config sample.
 - Prevent currentweather module from crashing when received data object is incorrect.
 - Fix issue where translation loading prevented the UI start-up when the language was set to 'en'. (Issue [#388](https://github.com/MichMich/MagicMirror/issues/388))
 
 ### Updated
+
 - Updated package.json to fix possible vulnerabilities. (Using Snyk)
 - Updated weathericons
 - Updated default weatherforecast to work with the new icons.
 - More detailed error message in case config file couldn't be loaded.
 
 ## [2.0.3] - 2016-07-12
+
 ### Added
+
 - Add max newsitems parameter to the newsfeed module.
 - Translations for Simplified Chinese, Traditional Chinese and Japanese.
 - Polish Translation
 - Add an analog clock in addition to the digital one.
 
 ### Fixed
+
 - Edit Alert Module to display title & message if they are provided in the notification (Issue [#300](https://github.com/MichMich/MagicMirror/issues/300))
 - Removed 'null' reference from updateModuleContent(). This fixes recent Edge and Internet Explorer browser displays (Issue [#319](https://github.com/MichMich/MagicMirror/issues/319))
 
 ### Changed
+
 - Added default string to calendar titleReplace.
 
 ## [2.0.2] - 2016-06-05
+
 ### Added
+
 - Norwegian Translations (nb and nn)
 - Portuguese Translation
 - Swedish Translation
 
 ### Fixed
+
 - Added reference to Italian Translation.
-- Added the missing NE translation to all languages. [#334](https://github.com/MichMich/MagicMirror/issues/344)
+- Added the missing NE translation to all languages. [#344](https://github.com/MichMich/MagicMirror/issues/344)
 - Added proper User-Agent string to calendar call.
 
 ### Changed
+
 - Add option to use locationID in weather modules.
 
 ## [2.0.1] - 2016-05-18
+
 ### Added
+
 - Changelog
 - Italian Translation
 
 ### Changed
+
 - Improve the installer by fetching the latest Node.js without any 3rd party interferences.
 
 ## [2.0.0] - 2016-05-03
+
 ### Initial release of MagicMirror²
+
 It includes (but is not limited to) the following features:
+
 - Modular system allowing 3rd party plugins.
 - An Node/Electron based application taking away the need for external servers or browsers.
 - A complete development API documentation.
 - Small cute fairies that kiss you while you sleep.
 
 ## [1.0.0] - 2014-02-16
+
 ### Initial release of MagicMirror.
-This was part of the blogpost: http://michaelteeuw.nl/post/83916869600/magic-mirror-part-vi-production-of-the
+
+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)

Gruntfile.js

@@ -1,28 +0,0 @@
-module.exports = function(grunt) {
-	require("time-grunt")(grunt);
-	grunt.initConfig({
-		pkg: grunt.file.readJSON("package.json"),
-		eslint: {
-			options: {
-				configFile: ".eslintrc.json"
-			},
-			target: ["js/*.js", "modules/default/*.js", "serveronly/*.js", "*.js"]
-		},
-		postcss: {
-			lint: {
-				options: {
-					processors: [
-						require("stylelint")({"extends": "stylelint-config-standard", "font-family-name-quotes": "double-where-recommended"}),
-						require("postcss-reporter")({ clearMessages: true })
-					]
-				},
-				dist: {
-					src: "**/**/**/**/**/**/**/**.css"
-				}
-			}
-		}
-	});
-	grunt.loadNpmTasks("grunt-eslint");
-	grunt.loadNpmTasks("grunt-postcss");
-	grunt.registerTask("default", ["eslint", "postcss:lint"]);
-};

LICENSE.md

@@ -1,7 +1,6 @@
-The MIT License (MIT)
-=====================
+# The MIT License (MIT)
 
-Copyright © 2016 Michael Teeuw
+Copyright © 2016-2020 Michael Teeuw
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

README.md

@@ -3,129 +3,42 @@
 <p 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#info=devDependencies"><img src="https://david-dm.org/MichMich/MagicMirror/dev-status.svg" alt="devDependency Status"></a>
-	<a href="https://nodejs.org"><img src="https://img.shields.io/badge/node-v5.10.1-brightgreen.svg" alt="Node Version"></a>
-	<a href="http://choosealicense.com/licenses/mit"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License"></a>
-	<a href="https://travis-ci.org/MichMich/MagicMirror"><img src="https://travis-ci.org/MichMich/MagicMirror.svg" alt="Travis"></a>
-	<a href="https://snyk.io/test/github/MichMich/MagicMirror"><img src="https://snyk.io/test/github/MichMich/MagicMirror/badge.svg" alt="Known Vulnerabilities" data-canonical-src="https://snyk.io/test/github/MichMich/MagicMirror" style="max-width:100%;"></a>
+	<a href="https://bestpractices.coreinfrastructure.org/projects/347"><img src="https://bestpractices.coreinfrastructure.org/projects/347/badge"></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>
 </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](http://michaelteeuw.nl/tagged/magicmirror) with the incredible help of a [growing community of contributors](https://github.com/MichMich/MagicMirror/graphs/contributors).
+**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).
 
-MagicMirror² focuses on a modular plugin system and uses [Electron](http://electron.atom.io/) as an application wrapper. So no more web server or browser installs necessary!
+MagicMirror² focuses on a modular plugin system and uses [Electron](https://www.electronjs.org/) as an application wrapper. So no more web server or browser installs necessary!
 
-## Table Of Contents
+## Documentation
 
-- [Usage](#usage)
-- [Configuration](#configuration)
-- [Modules](#modules)
-- [Known Issues](#known-issues)
-- [community](#community)
-- [Contributing Guidelines](#contributing-guidelines)
+For the full documentation including **[installation instructions](https://docs.magicmirror.builders/getting-started/installation.html)**, please visit our dedicated documentation website: [https://docs.magicmirror.builders](https://docs.magicmirror.builders).
 
-## Usage
+## Links
 
-#### Raspberry Pi Support
-Electron, the app wrapper around MagicMirror², only supports the Raspberry Pi 2 & 3. The Raspberry Pi 1 is currently **not** supported. If you want to run this on a Raspberry Pi 1, use the [server only](#server-only) feature and setup a fullscreen browser yourself.
-
-#### Automatic Installer (Raspberry Pi Only!)
-
-Execute the following command on your Raspberry Pi to install MagicMirror²:
-````
-curl -sL https://raw.githubusercontent.com/MichMich/MagicMirror/master/installers/raspberry.sh | bash
-````
-
-#### Manual Installation
-
-1. Download and install the latest Node.js version.
-2. Clone the repository and check out the beta branch: `git clone https://github.com/MichMich/MagicMirror`
-3. Enter the repository: `cd ~/MagicMirror`
-4. Install and run the app: `npm install && npm start`
-
-**Important:** `npm start` does **not** work via SSH, use `DISPLAY=:0 nohup npm start &` instead. This starts the mirror on the remote display.
-
-**Note:** if you want to debug on Raspberry Pi you can use `npm start dev` which will start the MagicMirror app with Dev Tools enabled.
-
-#### Server Only
-
-In some cases, you want to start the application without an actual app window. In this case, execute the following command from the MagicMirror folder: `node serveronly`. This will start the server, after which you can open the application in your browser of choice.
-
-#### Raspberry Configuration & Auto Start.
-
-The following wiki links are helpful in the configuration of your MagicMirror² operating system:
-- [Configuring the Raspberry Pi](https://github.com/MichMich/MagicMirror/wiki/Configuring-the-Raspberry-Pi)
-- [Auto Starting MagicMirror](https://github.com/MichMich/MagicMirror/wiki/Auto-Starting-MagicMirror)
-
-#### Updating you MagicMirror²
-
-If you want to update your MagicMirror² to the latest version, use your terminal to go to your Magic Mirror folder and type the following command:
-
-````
-git pull
-````
-
-If you changed nothing more than the config or the modules, this should work without any problems.
-Type `git status` to see your changes, if there are any, you can reset them with `git reset --hard`. After that, git pull should be possible.
-
-## Configuration
-
-1. Duplicate `config/config.js.sample` to `config/config.js`.
-2. Modify your required settings.
-
-The following properties can be configured:
-
-
-| **Option** | **Description** |
-| --- | --- |
-| `port` | The port on which the MagicMirror² server will run on. The default value is `8080`. |
-| `kioskmode` | This allows MagicMirror² to run in Kiosk Mode. It protects from other programs popping on top of your screen. The default value is `false`|
-| `language` | The language of the interface. (Note: Not all elements will be localized.) Possible values are `en`, `nl`, `ru`, `fr`, etc., but the default value is `en`. |
-| `timeFormat` | The form of time notation that will be used. Possible values are `12` or `24`. The default is `24`. |
-| `units` | The units that will be used in the default weather modules. Possible values are `metric` or `imperial`. The default is `metric`. |
-| `modules` | An array of active modules. **The array must contain objects. See the next table below for more information.** |
-
-Module configuration:
-
-| **Option** | **Description** |
-| --- | --- |
-| `module` | The name of the module. This can also contain the subfolder. Valid examples include `clock`, `default/calendar` and `custommodules/mymodule`. |
-| `position` | The location of the module in which the module will be loaded. Possible values are `top_ bar`, `top_left`, `top_center`, `top_right`, `upper_third`, `middle_center`, `lower_third`, `bottom_left`, `bottom_center`, `bottom_right`, `bottom_bar`, `fullscreen_above`, and `fullscreen_below`. This field is optional but most modules require this field to set. Check the documentation of the module for more information. Multiple modules with the same position will be ordered based on the order in the configuration file. |
-| `classes` | Additional classes which are passed to the module. The field is optional. |
-| `header` | To display a header text above the module, add the header property. This field is optional. |
-| `config` | An object with the module configuration properties. Check the documentation of the module for more information. This field is optional, unless the module requires extra configuration. |
-
-## Modules
-
-The following modules are installed by default.
-
-- [**Clock**](modules/default/clock)
-- [**Calendar**](modules/default/calendar)
-- [**Current Weather**](modules/default/currentweather)
-- [**Weather Forecast**](modules/default/weatherforecast)
-- [**News Feed**](modules/default/newsfeed)
-- [**Compliments**](modules/default/compliments)
-- [**Hello World**](modules/default/helloworld)
-- [**Alert**](modules/default/alert)
-
-For more available modules, check out out the wiki page: [MagicMirror² Modules](https://github.com/MichMich/MagicMirror/wiki/MagicMirror²-Modules). If you want to build your own modules, check out the [MagicMirror² Module Development Documentation](modules) and don't forget to add it to the wiki and the [forum](https://forum.magicmirror.builders/category/7/showcase)!
-
-## Known issues
-
-- Electron seems to have some issues on certain Raspberry Pi 2's. See [#145](https://github.com/MichMich/MagicMirror/issues/145).
-- MagicMirror² (Electron) sometimes quits without an error after an extended period of use. See [#150](https://github.com/MichMich/MagicMirror/issues/150).
-
-## Community
-
-The community around the MagicMirror² is constantly growing. We even have a [forum](https://forum.magicmirror.builders) now where you can share your ideas, ask questions, help others and get inspired by other builders. We would love to see you there!
+- Website: [https://magicmirror.builders](https://magicmirror.builders)
+- Documentation: [https://docs.magicmirror.builders](https://docs.magicmirror.builders)
+- Forum: [https://forum.magicmirror.builders](https://forum.magicmirror.builders)
+- Discord: [https://discord.gg/J5BAtvx](https://discord.gg/J5BAtvx)
+- Blog: [https://michaelteeuw.nl/tagged/magicmirror](https://michaelteeuw.nl/tagged/magicmirror)
+- Donations: [https://magicmirror.builders/#donate](https://magicmirror.builders/#donate)
 
 ## Contributing Guidelines
 
-Contributions of all kinds are welcome, not only in the form of code but also with regards bug reports and documentation.
+Contributions of all kinds are welcome, not only in the form of code but also with regards bug reports and documentation. For the full contribution guidelines, check out: [https://docs.magicmirror.builders/getting-started/contributing.html](https://docs.magicmirror.builders/getting-started/contributing.html)
 
-Please keep the following in mind:
+## Enjoying MagicMirror? Consider a donation!
 
-- **Bug Reports**:  Make sure you're running the latest version. If the issue(s) still persist: please open a clearly documented issue with a clear title.
-- **Minor Bug Fixes**: Please send a pull request with a clear explanation of the issue or a link to the issue it solves.
-- **Major Bug Fixes**: please discuss your approach in an GitHub issue before you start to alter a big part of the code.
-- **New Features**: please please discuss in a GitHub issue before you start to alter a big part of the code. Without discussion upfront, the pull request will not be accepted / merged.
+MagicMirror² is opensource and free. That doesn't mean we don't need any money.
 
-Thanks for your help in making MagicMirror² better!
+Please consider a donation to help us cover the ongoing costs like webservers and email services.
+If we receive enough donations we might even be able to free up some working hours and spend some extra time improving the MagicMirror² core.
+
+To donate, please follow [this](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=G5D8E9MR5DTD2&source=url) link.
+
+<p align="center">
+	<br>
+	<a href="https://forum.magicmirror.builders/topic/728/magicmirror-is-voted-number-1-in-the-magpi-top-50"><img src="https://magicmirror.builders/img/magpi-best-watermark-custom.png" width="150" alt="MagPi Top 50"></a>
+</p>

clientonly/index.js

@@ -0,0 +1,128 @@
+"use strict";
+
+// Use separate scope to prevent global scope pollution
+(function () {
+	var config = {};
+
+	/**
+	 * Helper function to get server address/hostname from either the commandline or env
+	 */
+	function getServerAddress() {
+		/**
+		 * Get command line parameters
+		 * Assumes that a cmdline parameter is defined with `--key [value]`
+		 *
+		 * @param {string} key key to look for at the command line
+		 * @param {string} defaultValue value if no key is given at the command line
+		 *
+		 * @returns {string} the value of the parameter
+		 */
+		function getCommandLineParameter(key, defaultValue = undefined) {
+			var index = process.argv.indexOf(`--${key}`);
+			var value = index > -1 ? process.argv[index + 1] : undefined;
+			return value !== undefined ? String(value) : defaultValue;
+		}
+
+		// Prefer command line arguments over environment variables
+		["address", "port"].forEach((key) => {
+			config[key] = getCommandLineParameter(key, process.env[key.toUpperCase()]);
+		});
+
+		// determine if "--use-tls"-flag was provided
+		config["tls"] = process.argv.indexOf("--use-tls") > 0;
+	}
+
+	/**
+	 * Gets the config from the specified server url
+	 *
+	 * @param {string} url location where the server is running.
+	 *
+	 * @returns {Promise} the config
+	 */
+	function getServerConfig(url) {
+		// Return new pending promise
+		return new Promise((resolve, reject) => {
+			// Select http or https module, depending on requested url
+			const lib = url.startsWith("https") ? require("https") : require("http");
+			const request = lib.get(url, (response) => {
+				var configData = "";
+
+				// Gather incoming data
+				response.on("data", function (chunk) {
+					configData += chunk;
+				});
+				// Resolve promise at the end of the HTTP/HTTPS stream
+				response.on("end", function () {
+					resolve(JSON.parse(configData));
+				});
+			});
+
+			request.on("error", function (error) {
+				reject(new Error(`Unable to read config from server (${url} (${error.message}`));
+			});
+		});
+	}
+
+	/**
+	 * Print a message to the console in case of errors
+	 *
+	 * @param {string} [message] error message to print
+	 * @param {number} code error code for the exit call
+	 */
+	function fail(message, code = 1) {
+		if (message !== undefined && typeof message === "string") {
+			console.log(message);
+		} else {
+			console.log("Usage: 'node clientonly --address 192.168.1.10 --port 8080 [--use-tls]'");
+		}
+		process.exit(code);
+	}
+
+	getServerAddress();
+
+	(config.address && config.port) || fail();
+	var prefix = config.tls ? "https://" : "http://";
+
+	// Only start the client if a non-local server was provided
+	if (["localhost", "127.0.0.1", "::1", "::ffff:127.0.0.1", undefined].indexOf(config.address) === -1) {
+		getServerConfig(`${prefix}${config.address}:${config.port}/config/`)
+			.then(function (configReturn) {
+				// Pass along the server config via an environment variable
+				var env = Object.create(process.env);
+				var options = { env: env };
+				configReturn.address = config.address;
+				configReturn.port = config.port;
+				configReturn.tls = config.tls;
+				env.config = JSON.stringify(configReturn);
+
+				// Spawn electron application
+				const electron = require("electron");
+				const child = require("child_process").spawn(electron, ["js/electron.js"], options);
+
+				// Pipe all child process output to current stdout
+				child.stdout.on("data", function (buf) {
+					process.stdout.write(`Client: ${buf}`);
+				});
+
+				// Pipe all child process errors to current stderr
+				child.stderr.on("data", function (buf) {
+					process.stderr.write(`Client: ${buf}`);
+				});
+
+				child.on("error", function (err) {
+					process.stdout.write(`Client: ${err}`);
+				});
+
+				child.on("close", (code) => {
+					if (code !== 0) {
+						console.log(`There something wrong. The clientonly is not running code ${code}`);
+					}
+				});
+			})
+			.catch(function (reason) {
+				fail(`Unable to connect to server: (${reason})`);
+			});
+	} else {
+		fail();
+	}
+})();

config/.gitignore

@@ -1,2 +0,0 @@
-*
-!config.js.sample

config/config.js.sample

@@ -1,77 +1,107 @@
 /* Magic Mirror Config Sample
  *
- * By Michael Teeuw http://michaelteeuw.nl
+ * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
+ *
+ * For more information on how you can configure this file
+ * See https://github.com/MichMich/MagicMirror#configuration
+ *
  */
 
 var config = {
+	address: "localhost", 	// Address to listen on, can be:
+							// - "localhost", "127.0.0.1", "::1" to listen on loopback interface
+							// - another specific IPv4/6 to listen on a specific interface
+							// - "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
+					// 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 :
+															// ["127.0.0.1", "::ffff:127.0.0.1", "::1", "::ffff:192.168.1.5"],
+															// or IPv4 range of 192.168.3.0 --> 192.168.3.15 use CIDR format :
+															// ["127.0.0.1", "::ffff:127.0.0.1", "::1", "::ffff:192.168.3.0/28"],
 
-	language: 'en',
+	useHttps: false, 		// Support HTTPS or not, default "false" will use HTTP
+	httpsPrivateKey: "", 	// HTTPS private key path, only require when useHttps is true
+	httpsCertificate: "", 	// HTTPS Certificate path, only require when useHttps is true
+
+	language: "en",
+	logLevel: ["INFO", "LOG", "WARN", "ERROR"], // Add "DEBUG" for even more logging
 	timeFormat: 24,
-	units: 'metric',
+	units: "metric",
+	// serverOnly:  true/false/"local" ,
+	// local for armv6l processors, default
+	//   starts serveronly and then starts chrome browser
+	// false, default for all NON-armv6l devices
+	// true, force serveronly mode, because you want to.. no UI on this device
 
 	modules: [
 		{
-			module: 'alert',
+			module: "alert",
 		},
 		{
-			module: 'clock',
-			position: 'top_left'
+			module: "updatenotification",
+			position: "top_bar"
 		},
 		{
-			module: 'calendar',
-			header: 'US Holidays',
-			position: 'top_left',
+			module: "clock",
+			position: "top_left"
+		},
+		{
+			module: "calendar",
+			header: "US Holidays",
+			position: "top_left",
 			config: {
 				calendars: [
 					{
-						symbol: 'calendar-check-o ',
-						url: 'webcal://www.calendarlabs.com/templates/ical/US-Holidays.ics'
-					}
+						symbol: "calendar-check",
+						url: "webcal://www.calendarlabs.com/ical-calendar/ics/76/US_Holidays.ics"					}
 				]
 			}
 		},
 		{
-			module: 'compliments',
-			position: 'lower_third'
+			module: "compliments",
+			position: "lower_third"
 		},
 		{
-			module: 'currentweather',
-			position: 'top_right',
+			module: "currentweather",
+			position: "top_right",
 			config: {
-				location: 'New York',
-				locationID: '',  //ID from http://www.openweathermap.org
-				appid: 'YOUR_OPENWEATHER_API_KEY'
+				location: "New York",
+				locationID: "5128581", //ID from http://bulk.openweathermap.org/sample/city.list.json.gz; unzip the gz file and find your city
+				appid: "YOUR_OPENWEATHER_API_KEY"
 			}
 		},
 		{
-			module: 'weatherforecast',
-			position: 'top_right',
-			header: 'Weather Forecast',
+			module: "weatherforecast",
+			position: "top_right",
+			header: "Weather Forecast",
 			config: {
-	            location: 'New York',
-				locationID: '5128581',  //ID from http://www.openweathermap.org
-	            appid: 'YOUR_OPENWEATHER_API_KEY'
+				location: "New York",
+				locationID: "5128581", //ID from http://bulk.openweathermap.org/sample/city.list.json.gz; unzip the gz file and find your city
+				appid: "YOUR_OPENWEATHER_API_KEY"
 			}
 		},
 		{
-			module: 'newsfeed',
-			position: 'bottom_bar',
+			module: "newsfeed",
+			position: "bottom_bar",
 			config: {
 				feeds: [
 					{
 						title: "New York Times",
-						url: "http://www.nytimes.com/services/xml/rss/nyt/HomePage.xml"
+						url: "https://rss.nytimes.com/services/xml/rss/nyt/HomePage.xml"
 					}
 				],
 				showSourceTitle: true,
-				showPublishDate: true
+				showPublishDate: true,
+				broadcastNewsFeeds: true,
+				broadcastNewsUpdates: true
 			}
 		},
 	]
-
 };
 
 /*************** DO NOT EDIT THE LINE BELOW ***************/
-if (typeof module !== 'undefined') {module.exports = config;}
+if (typeof module !== "undefined") {module.exports = config;}

css/custom.css

@@ -1,14 +0,0 @@
-/*****************************************************
- * Magic Mirror                                      *
- * Custom CSS                                        *
- *                                                   *
- * By Michael Teeuw http://michaelteeuw.nl           *
- * MIT Licensed.                                     *
- *                                                   *
- * Add any custom CSS below.                         *
- * Changes to this files will be ignored by GIT. *
- *****************************************************/
-
- body {
- 	
- }

css/main.css

@@ -1,10 +1,12 @@
 html {
   cursor: none;
-  overflow:hidden;
+  overflow: hidden;
+  background: #000;
+  user-select: none;
 }
 
-::-webkit-scrollbar { 
-    display: none; 
+::-webkit-scrollbar {
+  display: none;
 }
 
 body {
@@ -94,7 +96,7 @@ body {
 header {
   text-transform: uppercase;
   font-size: 15px;
-  font-family: "Roboto Condensed";
+  font-family: "Roboto Condensed", Arial, Helvetica, sans-serif;
   font-weight: 400;
   border-bottom: 1px solid #666;
   line-height: 15px;
@@ -113,11 +115,22 @@ sup {
  */
 
 .module {
-  margin-top: 30px;
+  margin-bottom: 30px;
 }
 
-.module:first-child {
-  margin-top: 0;
+.region.bottom .module {
+  margin-top: 30px;
+  margin-bottom: 0;
+}
+
+.no-wrap {
+  white-space: nowrap;
+  overflow: hidden;
+  text-overflow: ellipsis;
+}
+
+.pre-line {
+  white-space: pre-line;
 }
 
 /**
@@ -134,10 +147,16 @@ sup {
   left: -60px;
   right: -60px;
   bottom: -60px;
+  pointer-events: none;
+}
+
+.region.fullscreen * {
+  pointer-events: auto;
 }
 
 .region.right {
   right: 0;
+  text-align: right;
 }
 
 .region.top {
@@ -148,6 +167,10 @@ sup {
   margin-bottom: 25px;
 }
 
+.region.bottom .container {
+  margin-top: 25px;
+}
+
 .region.top .container:empty {
   margin-bottom: 0;
 }
@@ -155,10 +178,6 @@ sup {
 .region.top.center,
 .region.bottom.center {
   left: 50%;
-  -moz-transform: translateX(-50%);
-  -o-transform: translateX(-50%);
-  -webkit-transform: translateX(-50%);
-  -ms-transform: translateX(-50%);
   transform: translateX(-50%);
 }
 
@@ -172,10 +191,6 @@ sup {
   bottom: 0;
 }
 
-.region.bottom .container {
-  margin-top: 25px;
-}
-
 .region.bottom .container:empty {
   margin-top: 0;
 }
@@ -195,10 +210,6 @@ sup {
 .region.middle.center {
   width: 100%;
   text-align: center;
-  -moz-transform: translateY(-50%);
-  -o-transform: translateY(-50%);
-  -webkit-transform: translateY(-50%);
-  -ms-transform: translateY(-50%);
   transform: translateY(-50%);
 }
 
@@ -218,10 +229,6 @@ sup {
   text-align: left;
 }
 
-.region.right {
-  text-align: right;
-}
-
 .region table {
   width: 100%;
   border-spacing: 0;

dangerfile.js

@@ -0,0 +1,17 @@
+import { danger, fail, warn } from "danger";
+
+// Check if the CHANGELOG.md file has been edited
+// Fail the build and post a comment reminding submitters to do so if it wasn't changed
+if (!danger.git.modified_files.includes("CHANGELOG.md")) {
+	warn("Please include an updated `CHANGELOG.md` file.<br>This way we can keep track of all the contributions.");
+}
+
+// Check if the PR request is send to the master branch.
+// This should only be done by MichMich.
+if (danger.github.pr.base.ref === "master" && danger.github.pr.user.login !== "MichMich") {
+	// Check if the PR body or title includes the text: #accepted.
+	// If not, the PR will fail.
+	if ((danger.github.pr.body + danger.github.pr.title).includes("#accepted")) {
+		fail("Please send all your pull requests to the `develop` branch.<br>Pull requests on the `master` branch will not be accepted.");
+	}
+}

fonts/LICENSE.txt

@@ -1,202 +0,0 @@
-
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.

fonts/package-lock.json

@@ -0,0 +1,12 @@
+{
+  "name": "magicmirror-fonts",
+  "requires": true,
+  "lockfileVersion": 1,
+  "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=="
+    }
+  }
+}

fonts/package.json

@@ -0,0 +1,15 @@
+{
+	"name": "magicmirror-fonts",
+	"description": "Package for fonts use by MagicMirror Core.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/MichMich/MagicMirror.git"
+	},
+	"license": "MIT",
+	"bugs": {
+		"url": "https://github.com/MichMich/MagicMirror/issues"
+	},
+	"dependencies": {
+		"roboto-fontface": "^0.10.0"
+	}
+}

fonts/roboto.css

@@ -2,94 +2,57 @@
   font-family: Roboto;
   font-style: normal;
   font-weight: 100;
-  src:
-    local("Roboto Thin"),
-    local("Roboto-Thin"),
-    url("Roboto-Thin/Roboto-Thin.woff2") format("woff2"),
-    url("Roboto-Thin/Roboto-Thin.woff") format("woff"),
-    url("Roboto-Thin/Roboto-Thin.ttf") format("truetype");
+  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");
 }
 
 @font-face {
   font-family: "Roboto Condensed";
   font-style: normal;
   font-weight: 300;
-  src:
-    local("Roboto Condensed Light"),
-    local("RobotoCondensed-Light"),
-    url("RobotoCondensed-Light/RobotoCondensed-Light.woff2") format("woff2"),
-    url("RobotoCondensed-Light/RobotoCondensed-Light.woff") format("woff"),
-    url("RobotoCondensed-Light/RobotoCondensed-Light.ttf") format("truetype");
+  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");
 }
 
 @font-face {
   font-family: "Roboto Condensed";
   font-style: normal;
   font-weight: 400;
-  src:
-    local("Roboto Condensed"),
-    local("RobotoCondensed-Regular"),
-    url("RobotoCondensed-Regular/RobotoCondensed-Regular.woff2") format("woff2"),
-    url("RobotoCondensed-Regular/RobotoCondensed-Regular.woff") format("woff"),
-    url("RobotoCondensed-Regular/RobotoCondensed-Regular.ttf") format("truetype");
+  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");
 }
 
 @font-face {
   font-family: "Roboto Condensed";
   font-style: normal;
   font-weight: 700;
-  src:
-    local("Roboto Condensed Bold"),
-    local("RobotoCondensed-Bold"),
-    url("RobotoCondensed-Bold/RobotoCondensed-Bold.woff2") format("woff2"),
-    url("RobotoCondensed-Bold/RobotoCondensed-Bold.woff") format("woff"),
-    url("RobotoCondensed-Bold/RobotoCondensed-Bold.ttf") format("truetype");
+  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");
 }
 
 @font-face {
   font-family: Roboto;
   font-style: normal;
   font-weight: 400;
-  src:
-    local("Roboto"),
-    local("Roboto-Regular"),
-    url("Roboto-Regular/Roboto-Regular.woff2") format("woff2"),
-    url("Roboto-Regular/Roboto-Regular.woff") format("woff"),
-    url("Roboto-Regular/Roboto-Regular.ttf") format("truetype");
+  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");
 }
 
 @font-face {
   font-family: Roboto;
   font-style: normal;
   font-weight: 500;
-  src:
-    local("Roboto Medium"),
-    local("Roboto-Medium"),
-    url("Roboto-Medium/Roboto-Medium.woff2") format("woff2"),
-    url("Roboto-Medium/Roboto-Medium.woff") format("woff"),
-    url("Roboto-Medium/Roboto-Medium.ttf") format("truetype");
+  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");
 }
 
 @font-face {
   font-family: Roboto;
   font-style: normal;
   font-weight: 700;
-  src:
-    local("Roboto Bold"),
-    local("Roboto-Bold"),
-    url("Roboto-Bold/Roboto-Bold.woff2") format("woff2"),
-    url("Roboto-Bold/Roboto-Bold.woff") format("woff"),
-    url("Roboto-Bold/Roboto-Bold.ttf") format("truetype");
+  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");
 }
 
 @font-face {
   font-family: Roboto;
   font-style: normal;
   font-weight: 300;
-  src:
-    local("Roboto Light"),
-    local("Roboto-Light"),
-    url("Roboto-Light/Roboto-Light.woff2") format("woff2"),
-    url("Roboto-Light/Roboto-Light.woff") format("woff"),
-    url("Roboto-Light/Roboto-Light.ttf") format("truetype");
+  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");
 }

index.html

@@ -1,13 +1,23 @@
 <!DOCTYPE html>
 <html>
 <head>
-	<title>Magic Mirror</title>
+	<title>MagicMirror²</title>
 	<meta name="google" content="notranslate" />
 	<meta http-equiv="Content-type" content="text/html; charset=utf-8" />
+
+	<meta name="apple-mobile-web-app-capable" content="yes">
+	<meta name="apple-mobile-web-app-status-bar-style" content="black">
+	<meta name="format-detection" content="telephone=no">
+	<meta name="mobile-web-app-capable" content="yes">
+
 	<link rel="icon" href="data:;base64,iVBORw0KGgo=">
 	<link rel="stylesheet" type="text/css" href="css/main.css">
 	<link rel="stylesheet" type="text/css" href="fonts/roboto.css">
 	<!-- 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#";
+	</script>
 </head>
 <body>
 	<div class="region fullscreen below"><div class="container"></div></div>
@@ -27,9 +37,10 @@
 		<div class="region bottom right"><div class="container"></div></div>
 	</div>
 	<div class="region fullscreen above"><div class="container"></div></div>
-	<script type="text/javascript" src="/socket.io/socket.io.js"></script>
+	<script type="text/javascript" src="socket.io/socket.io.js"></script>
+	<script type="text/javascript" src="vendor/node_modules/nunjucks/browser/nunjucks.min.js"></script>
 	<script type="text/javascript" src="js/defaults.js"></script>
-	<script type="text/javascript" src="config/config.js"></script>
+	<script type="text/javascript" src="#CONFIG_FILE#"></script>
 	<script type="text/javascript" src="vendor/vendor.js"></script>
 	<script type="text/javascript" src="modules/default/defaultmodules.js"></script>
 	<script type="text/javascript" src="js/logger.js"></script>

installers/mm.sh

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

installers/raspberry.sh

@@ -1,118 +0,0 @@
-#!/usr/bin/env bash
-
-# This is an installer script for MagicMirror2. It works well enough
-# that it can detect if you have Node installed, run a binary script
-# and then download and run MagicMirror2.
-
-echo -e "\e[0m"
-echo '$$\      $$\                     $$\           $$\      $$\ $$\                                          $$$$$$\'
-echo '$$$\    $$$ |                    \__|          $$$\    $$$ |\__|                                        $$  __$$\'
-echo '$$$$\  $$$$ | $$$$$$\   $$$$$$\  $$\  $$$$$$$\ $$$$\  $$$$ |$$\  $$$$$$\   $$$$$$\   $$$$$$\   $$$$$$\  \__/  $$ |'
-echo '$$\$$\$$ $$ | \____$$\ $$  __$$\ $$ |$$  _____|$$\$$\$$ $$ |$$ |$$  __$$\ $$  __$$\ $$  __$$\ $$  __$$\  $$$$$$  |'
-echo '$$ \$$$  $$ | $$$$$$$ |$$ /  $$ |$$ |$$ /      $$ \$$$  $$ |$$ |$$ |  \__|$$ |  \__|$$ /  $$ |$$ |  \__|$$  ____/'
-echo '$$ |\$  /$$ |$$  __$$ |$$ |  $$ |$$ |$$ |      $$ |\$  /$$ |$$ |$$ |      $$ |      $$ |  $$ |$$ |      $$ |'
-echo '$$ | \_/ $$ |\$$$$$$$ |\$$$$$$$ |$$ |\$$$$$$$\ $$ | \_/ $$ |$$ |$$ |      $$ |      \$$$$$$  |$$ |      $$$$$$$$\'
-echo '\__|     \__| \_______| \____$$ |\__| \_______|\__|     \__|\__|\__|      \__|       \______/ \__|      \________|'
-echo '                       $$\   $$ |'
-echo '                       \$$$$$$  |'
-echo '                        \______/'
-echo -e "\e[0m"
-
-# Define the tested version of Node.js. 
-NODE_TESTED="v5.1.0"
-
-#Determine which Pi is running.
-ARM=$(uname -m) 
-
-#Check the Raspberry Pi version.
-if [ "$ARM" != "armv7l" ]; then
-	echo -e "\e[91mSorry, your Raspberry Pi is not supported."
-	echo -e "\e[91mPlease run MagicMirror on a Raspberry Pi 2 or 3."
-	exit;
-fi
-
-#define helper methods.
-function version_gt() { test "$(echo "$@" | tr " " "\n" | sort -V | head -n 1)" != "$1"; }
-function command_exists () { type "$1" &> /dev/null ;}
-
-# Installing helper tools
-echo -e "\e[96mInstalling helper tools ...\e[90m"
-sudo apt-get install curl wget git build-essential unzip || exit
-
-# Check if we need to install or upgrade Node.js.
-echo -e "\e[96mCheck current Node installation ...\e[0m"
-NODE_INSTALL=false
-if command_exists node; then
-	echo -e "\e[0mNode currently installed. Checking version number.";
-	NODE_CURRENT=$(node -v)
-	echo -e "\e[0mMinimum Node version: \e[1m$NODE_TESTED\e[0m"
-	echo -e "\e[0mInstalled Node version: \e[1m$NODE_CURRENT\e[0m"
-	if version_gt $NODE_TESTED $NODE_CURRENT; then
-    	echo -e "\e[96mNode should be upgraded.\e[0m"
-    	NODE_INSTALL=true
-
-    	#Check if a node process is currenlty running.
-    	#If so abort installation.
-    	if pgrep "node" > /dev/null; then
-		    echo -e "\e[91mA Node process is currently running. Can't upgrade."
-		    echo "Please quit all Node processes and restart the installer."
-		    exit;
-		fi
-
-    else
-    	echo -e "\e[92mNo Node.js upgrade nessecery.\e[0m"
-	fi
-
-else
-	echo -e "\e[93mNode.js is not installed.\e[0m";
-	NODE_INSTALL=true
-fi
-
-# Install or upgare node if nessecery.
-if $NODE_INSTALL; then
-	
-	echo -e "\e[96mInstalling Node.js ...\e[90m"
-
-	#Fetch the latest version of Node.js from the selected branch
-	#The NODE_STABLE_BRANCH variable will need to be manually adjusted when a new branch is released. (e.g. 7.x)
-	#Only tested (stable) versions are recommended as newer versions could break MagicMirror.
-	
-	NODE_STABLE_BRANCH="6.x"
-	curl -sL https://deb.nodesource.com/setup_$NODE_STABLE_BRANCH | sudo -E bash -
-	sudo apt-get install -y nodejs
-	echo -e "\e[92mNode.js installation Done!\e[0m"
-fi
-
-#Install magic mirror
-cd ~
-if [ -d "$HOME/MagicMirror" ] ; then
-	echo -e "\e[93mIt seems like MagicMirror is already installed."
-	echo -e "To prevent overwriting, the installer will be aborted."
-	echo -e "Please rename the \e[1m~/MagicMirror\e[0m\e[93m folder and try again.\e[0m"
-	echo ""
-	echo -e "If you want to upgrade your installation run \e[1m\e[97mgit pull\e[0m from the ~/MagicMirror directory."
-	echo ""
-	exit;
-fi
-
-echo -e "\e[96mCloning MagicMirror ...\e[90m"
-if git clone https://github.com/MichMich/MagicMirror.git; then 
-	echo -e "\e[92mCloning MagicMirror Done!\e[0m"
-else
-	echo -e "\e[91mUnable to clone MagicMirror."
-	exit;
-fi
-
-cd ~/MagicMirror  || exit
-echo -e "\e[96mInstalling dependencies ...\e[90m"
-if npm install; then 
-	echo -e "\e[92mDependencies installation Done!\e[0m"
-else
-	echo -e "\e[91mUnable to install dependencies!"
-	exit;
-fi
-
-echo " "
-echo -e "\e[92mWe're ready! Run \e[1m\e[97mDISPLAY=:0 npm start\e[0m\e[92m from the ~/MagicMirror directory to start your MagicMirror.\e[0m"
-echo " "
-echo " "

js/app.js

@@ -1,72 +1,123 @@
 /* Magic Mirror
  * The Core App (Server)
  *
- * By Michael Teeuw http://michaelteeuw.nl
+ * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  */
-
 var fs = require("fs");
-var Server = require(__dirname + "/server.js");
-var defaultModules = require(__dirname + "/../modules/default/defaultmodules.js");
 var path = require("path");
+var Log = require(__dirname + "/logger.js");
+var Server = require(__dirname + "/server.js");
+var Utils = require(__dirname + "/utils.js");
+var defaultModules = require(__dirname + "/../modules/default/defaultmodules.js");
+
+// Alias modules mentioned in package.js under _moduleAliases.
+require("module-alias/register");
+
+// Get version number.
+global.version = JSON.parse(fs.readFileSync("package.json", "utf8")).version;
+Log.log("Starting MagicMirror: v" + global.version);
+
+// global absolute root path
+global.root_path = path.resolve(__dirname + "/../");
+
+if (process.env.MM_CONFIG_FILE) {
+	global.configuration_file = process.env.MM_CONFIG_FILE;
+}
+
+// FIXME: Hotfix Pull Request
+// https://github.com/MichMich/MagicMirror/pull/673
+if (process.env.MM_PORT) {
+	global.mmPort = process.env.MM_PORT;
+}
 
 // The next part is here to prevent a major exception when there
 // is no internet connection. This could probable be solved better.
 process.on("uncaughtException", function (err) {
-	console.log("Whoops! There was an uncaught exception...");
-	console.error(err);
-	console.log("MagicMirror will not quit, but it might be a good idea to check why this happened. Maybe no internet connection?");
-	console.log("If you think this really is an issue, please open an issue on GitHub: https://github.com/MichMich/MagicMirror/issues");
+	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("If you think this really is an issue, please open an issue on GitHub: https://github.com/MichMich/MagicMirror/issues");
 });
 
-/* App - The core app.
+/**
+ * The core app.
+ *
+ * @class
  */
-var App = function() {
+var App = function () {
 	var nodeHelpers = [];
 
-	/* loadConfig(callback)
-	 * Loads the config file. combines it with the defaults,
-	 * and runs the callback with the found config as argument.
+	/**
+	 * Loads the config file. Combines it with the defaults,  and runs the
+	 * callback with the found config as argument.
 	 *
-	 * argument callback function - The callback function.
+	 * @param {Function} callback Function to be called after loading the config
 	 */
-
-	var loadConfig = function(callback) {
-		console.log("Loading config ...");
+	var loadConfig = function (callback) {
+		Log.log("Loading config ...");
 		var defaults = require(__dirname + "/defaults.js");
-		var configFilename = path.resolve(__dirname + "/../config/config.js");
+
+		// For this check proposed to TestSuite
+		// https://forum.magicmirror.builders/topic/1456/test-suite-for-magicmirror/8
+		var configFilename = path.resolve(global.root_path + "/config/config.js");
+		if (typeof global.configuration_file !== "undefined") {
+			configFilename = path.resolve(global.configuration_file);
+		}
+
 		try {
 			fs.accessSync(configFilename, fs.F_OK);
 			var c = require(configFilename);
+			checkDeprecatedOptions(c);
 			var config = Object.assign(defaults, c);
 			callback(config);
 		} catch (e) {
-			if (e.code == "ENOENT") {
-				console.error("WARNING! Could not find config file. Please create one. Starting with default configuration.");
-				callback(defaults);
+			if (e.code === "ENOENT") {
+				Log.error(Utils.colors.error("WARNING! Could not find config file. Please create one. Starting with default configuration."));
 			} else if (e instanceof ReferenceError || e instanceof SyntaxError) {
-				console.error("WARNING! Could not validate config file. Please correct syntax errors. Starting with default configuration.");
-				callback(defaults);
+				Log.error(Utils.colors.error("WARNING! Could not validate config file. Starting with default configuration. Please correct syntax errors at or above this line: " + e.stack));
 			} else {
-				console.error("WARNING! Could not load config file. Starting with default configuration. Error found: " + e);
-				callback(defaults);
+				Log.error(Utils.colors.error("WARNING! Could not load config file. Starting with default configuration. Error found: " + e));
 			}
+			callback(defaults);
 		}
 	};
 
-	/* loadModule(module)
+	/**
+	 * Checks the config for deprecated options and throws a warning in the logs
+	 * if it encounters one option from the deprecated.js list
+	 *
+	 * @param {object} userConfig The user config
+	 */
+	var checkDeprecatedOptions = function (userConfig) {
+		var deprecated = require(global.root_path + "/js/deprecated.js");
+		var deprecatedOptions = deprecated.configs;
+
+		var usedDeprecated = [];
+
+		deprecatedOptions.forEach(function (option) {
+			if (userConfig.hasOwnProperty(option)) {
+				usedDeprecated.push(option);
+			}
+		});
+		if (usedDeprecated.length > 0) {
+			Log.warn(Utils.colors.warn("WARNING! Your config is using deprecated options: " + usedDeprecated.join(", ") + ". Check README and CHANGELOG for more up-to-date ways of getting the same functionality."));
+		}
+	};
+
+	/**
 	 * Loads a specific module.
 	 *
-	 * argument module string - The name of the module (including subpath).
+	 * @param {string} module The name of the module (including subpath).
+	 * @param {Function} callback Function to be called after loading
 	 */
-	var loadModule = function(module) {
-
+	var loadModule = function (module, callback) {
 		var elements = module.split("/");
 		var moduleName = elements[elements.length - 1];
-		var moduleFolder =  __dirname + "/../modules/" + module;
+		var moduleFolder = __dirname + "/../modules/" + module;
 
 		if (defaultModules.indexOf(moduleName) !== -1) {
-			moduleFolder =  __dirname + "/../modules/default/" + module;
+			moduleFolder = __dirname + "/../modules/default/" + module;
 		}
 
 		var helperPath = moduleFolder + "/node_helper.js";
@@ -76,75 +127,171 @@ var App = function() {
 			fs.accessSync(helperPath, fs.R_OK);
 		} catch (e) {
 			loadModule = false;
-			console.log("No helper found for module: " + moduleName + ".");
+			Log.log("No helper found for module: " + moduleName + ".");
 		}
 
 		if (loadModule) {
 			var Module = require(helperPath);
 			var m = new Module();
+
+			if (m.requiresVersion) {
+				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 {
+					Log.log("Version is incorrect. Skip module: '" + moduleName + "'");
+					return;
+				}
+			}
+
 			m.setName(moduleName);
 			m.setPath(path.resolve(moduleFolder));
 			nodeHelpers.push(m);
+
+			m.loaded(callback);
+		} else {
+			callback();
 		}
 	};
 
-	/* loadModules(modules)
+	/**
 	 * Loads all modules.
 	 *
-	 * argument module string - The name of the module (including subpath).
+	 * @param {Module[]} modules All modules to be loaded
+	 * @param {Function} callback Function to be called after loading
 	 */
-	var loadModules = function(modules) {
-		console.log("Loading module helpers ...");
+	var loadModules = function (modules, callback) {
+		Log.log("Loading module helpers ...");
 
-		for (var m in modules) {
-			loadModule(modules[m]);
-		}
+		var loadNextModule = function () {
+			if (modules.length > 0) {
+				var nextModule = modules[0];
+				loadModule(nextModule, function () {
+					modules = modules.slice(1);
+					loadNextModule();
+				});
+			} else {
+				// All modules are loaded
+				Log.log("All module helpers loaded.");
+				callback();
+			}
+		};
 
-		console.log("All module helpers loaded.");
+		loadNextModule();
 	};
 
-	/* start(callback)
-	 * This methods starts the core app.
-	 * It loads the config, then it loads all modules.
-	 * When it"s done it executs the callback with the config as argument.
+	/**
+	 * Compare two semantic version numbers and return the difference.
 	 *
-	 * argument callback function - The callback function.
+	 * @param {string} a Version number a.
+	 * @param {string} b Version number b.
+	 *
+	 * @returns {number} A positive number if a is larger than b, a negative
+	 * number if a is smaller and 0 if they are the same
 	 */
-	this.start = function(callback) {
+	function cmpVersions(a, b) {
+		var i, diff;
+		var regExStrip0 = /(\.0+)+$/;
+		var segmentsA = a.replace(regExStrip0, "").split(".");
+		var segmentsB = b.replace(regExStrip0, "").split(".");
+		var l = Math.min(segmentsA.length, segmentsB.length);
 
-		loadConfig(function(c) {
+		for (i = 0; i < l; i++) {
+			diff = parseInt(segmentsA[i], 10) - parseInt(segmentsB[i], 10);
+			if (diff) {
+				return diff;
+			}
+		}
+		return segmentsA.length - segmentsB.length;
+	}
+
+	/**
+	 * Start the core app.
+	 *
+	 * It loads the config, then it loads all modules. When it's done it
+	 * executes the callback with the config as argument.
+	 *
+	 * @param {Function} callback Function to be called after start
+	 */
+	this.start = function (callback) {
+		loadConfig(function (c) {
 			config = c;
 
+			Log.setLogLevel(config.logLevel);
+
 			var modules = [];
 
 			for (var m in config.modules) {
 				var module = config.modules[m];
-				if (modules.indexOf(module.module) === -1) {
+				if (modules.indexOf(module.module) === -1 && !module.disabled) {
 					modules.push(module.module);
 				}
 			}
 
-			loadModules(modules);
+			loadModules(modules, function () {
+				var server = new Server(config, function (app, io) {
+					Log.log("Server started ...");
 
-			var server = new Server(config, function(app, io) {
-				console.log("Server started ...");
+					for (var h in nodeHelpers) {
+						var nodeHelper = nodeHelpers[h];
+						nodeHelper.setExpressApp(app);
+						nodeHelper.setSocketIO(io);
+						nodeHelper.start();
+					}
 
-				for (var h in nodeHelpers) {
-					var nodeHelper = nodeHelpers[h];
-					nodeHelper.setExpressApp(app);
-					nodeHelper.setSocketIO(io);
-					nodeHelper.start();
-				}
-
-				console.log("Sockets connected & modules started ...");
-
-				if (typeof callback === "function") {
-					callback(config);
-				}
+					Log.log("Sockets connected & modules started ...");
 
+					if (typeof callback === "function") {
+						callback(config);
+					}
+				});
 			});
 		});
 	};
+
+	/**
+	 * Stops the core app. This calls each node_helper's STOP() function, if it
+	 * exists.
+	 *
+	 * Added to fix #1056
+	 */
+	this.stop = function () {
+		for (var h in nodeHelpers) {
+			var nodeHelper = nodeHelpers[h];
+			if (typeof nodeHelper.stop === "function") {
+				nodeHelper.stop();
+			}
+		}
+	};
+
+	/**
+	 * Listen for SIGINT signal and call stop() function.
+	 *
+	 * Added to fix #1056
+	 * Note: this is only used if running `server-only`. Otherwise
+	 * this.stop() is called by app.on("before-quit"... in `electron.js`
+	 */
+	process.on("SIGINT", () => {
+		Log.log("[SIGINT] Received. Shutting down server...");
+		setTimeout(() => {
+			process.exit(0);
+		}, 3000); // Force quit after 3 seconds
+		this.stop();
+		process.exit(0);
+	});
+
+	/**
+	 * Listen to SIGTERM signals so we can stop everything when we
+	 * are asked to stop by the OS.
+	 */
+	process.on("SIGTERM", () => {
+		Log.log("[SIGTERM] Received. Shutting down server...");
+		setTimeout(() => {
+			process.exit(0);
+		}, 3000); // Force quit after 3 seconds
+		this.stop();
+		process.exit(0);
+	});
 };
 
-module.exports = new App();
+module.exports = new App();

js/check_config.js

@@ -0,0 +1,74 @@
+/* Magic Mirror
+ *
+ * Check the configuration file for errors
+ *
+ * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com
+ * MIT Licensed.
+ */
+const Linter = require("eslint").Linter;
+const linter = new Linter();
+
+const path = require("path");
+const fs = require("fs");
+
+const rootPath = path.resolve(__dirname + "/../");
+const Log = require(rootPath + "/js/logger.js");
+const Utils = require(rootPath + "/js/utils.js");
+
+/**
+ * Returns a string with path of configuration file.
+ * Check if set by environment variable MM_CONFIG_FILE
+ *
+ * @returns {string} path and filename of the config file
+ */
+function getConfigFile() {
+	// FIXME: This function should be in core. Do you want refactor me ;) ?, be good!
+	let configFileName = path.resolve(rootPath + "/config/config.js");
+	if (process.env.MM_CONFIG_FILE) {
+		configFileName = path.resolve(process.env.MM_CONFIG_FILE);
+	}
+	return configFileName;
+}
+
+/**
+ * Checks the config file using eslint.
+ */
+function checkConfigFile() {
+	const configFileName = getConfigFile();
+
+	// Check if file is present
+	if (fs.existsSync(configFileName) === false) {
+		Log.error(Utils.colors.error("File not found: "), configFileName);
+		throw new Error("No config file present!");
+	}
+
+	// Check permission
+	try {
+		fs.accessSync(configFileName, fs.F_OK);
+	} catch (e) {
+		Log.error(Utils.colors.error(e));
+		throw new Error("No permission to access config file!");
+	}
+
+	// Validate syntax of the configuration file.
+	Log.info(Utils.colors.info("Checking file... "), configFileName);
+
+	// I'm not sure if all ever is utf-8
+	fs.readFile(configFileName, "utf-8", function (err, data) {
+		if (err) {
+			throw err;
+		}
+		const messages = linter.verify(data);
+		if (messages.length === 0) {
+			Log.info(Utils.colors.pass("Your configuration file doesn't contain syntax errors :)"));
+		} else {
+			Log.error(Utils.colors.error("Your configuration file contains syntax errors :("));
+			// In case the there errors show messages and return
+			messages.forEach((error) => {
+				Log.error("Line", error.line, "col", error.column, error.message);
+			});
+		}
+	});
+}
+
+checkConfigFile();

js/class.js

@@ -1,18 +1,25 @@
+/* global Class, xyz */
+
 /* Simple JavaScript Inheritance
- * By John Resig http://ejohn.org/
+ * By John Resig https://johnresig.com/
+ *
+ * Inspired by base2 and Prototype
+ *
  * MIT Licensed.
  */
-
-// Inspired by base2 and Prototype
-(function() {
+(function () {
 	var initializing = false;
-	var fnTest = /xyz/.test(function() {xyz;}) ? /\b_super\b/ : /.*/;
+	var fnTest = /xyz/.test(function () {
+		xyz;
+	})
+		? /\b_super\b/
+		: /.*/;
 
 	// The base Class implementation (does nothing)
-	this.Class = function() {};
+	this.Class = function () {};
 
 	// Create a new Class that inherits from this class
-	Class.extend = function(prop) {
+	Class.extend = function (prop) {
 		var _super = this.prototype;
 
 		// Instantiate a base class (but only create the instance,
@@ -21,31 +28,38 @@
 		var prototype = new this();
 		initializing = false;
 
+		// Make a copy of all prototype properties, to prevent reference issues.
+		for (var p in prototype) {
+			prototype[p] = cloneObject(prototype[p]);
+		}
+
 		// Copy the properties over onto the new prototype
 		for (var 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;
+			prototype[name] =
+				typeof prop[name] === "function" && typeof _super[name] === "function" && fnTest.test(prop[name])
+					? (function (name, fn) {
+							return function () {
+								var tmp = this._super;
 
-		// Add a new ._super() method that is the same method
-		// but on the super-class
-		this._super = _super[name];
+								// Add a new ._super() method that is the same method
+								// but on the super-class
+								this._super = _super[name];
 
-		// The method only need to be bound temporarily, so we
-		// remove it when we're done executing
-		var ret = fn.apply(this, arguments);
-		this._super = tmp;
+								// The method only need to be bound temporarily, so we
+								// remove it when we're done executing
+								var ret = fn.apply(this, arguments);
+								this._super = tmp;
 
-		return ret;
-	};
-        })(name, prop[name]) :
-        prop[name];
+								return ret;
+							};
+					  })(name, prop[name])
+					: prop[name];
 		}
 
-		// The dummy class constructor
+		/**
+		 * The dummy class constructor
+		 */
 		function Class() {
 			// All construction is actually done in the init method
 			if (!initializing && this.init) {
@@ -66,5 +80,31 @@
 	};
 })();
 
+/**
+ * Define the clone method for later use. Helper Method.
+ *
+ * @param {object} obj Object to be cloned
+ *
+ * @returns {object} the cloned object
+ */
+function cloneObject(obj) {
+	if (obj === null || typeof obj !== "object") {
+		return obj;
+	}
+
+	var temp = obj.constructor(); // give temp the original obj's constructor
+	for (var key in obj) {
+		temp[key] = cloneObject(obj[key]);
+
+		if (key === "lockStrings") {
+			Log.log(key);
+		}
+	}
+
+	return temp;
+}
+
 /*************** DO NOT EDIT THE LINE BELOW ***************/
-if (typeof module !== "undefined") {module.exports = Class;}
+if (typeof module !== "undefined") {
+	module.exports = Class;
+}

js/defaults.js

@@ -1,21 +1,35 @@
-/* exported defaults */
+/* global mmPort */
 
 /* Magic Mirror
- * Config Defauls
+ * Config Defaults
  *
- * By Michael Teeuw http://michaelteeuw.nl
+ * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  */
-
+var address = "localhost";
+var port = 8080;
+if (typeof mmPort !== "undefined") {
+	port = mmPort;
+}
 var defaults = {
-	port: 8080,
+	address: address,
+	port: port,
+	basePath: "/",
 	kioskmode: false,
+	electronOptions: {},
+	ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"],
 
 	language: "en",
 	timeFormat: 24,
 	units: "metric",
+	zoom: 1,
+	customCss: "css/custom.css",
 
 	modules: [
+		{
+			module: "updatenotification",
+			position: "top_center"
+		},
 		{
 			module: "helloworld",
 			position: "upper_third",
@@ -54,14 +68,16 @@ var defaults = {
 			config: {
 				text: "www.michaelteeuw.nl"
 			}
-		},
+		}
 	],
 
 	paths: {
 		modules: "modules",
 		vendor: "vendor"
-	},
+	}
 };
 
 /*************** DO NOT EDIT THE LINE BELOW ***************/
-if (typeof module !== "undefined") {module.exports = defaults;}
+if (typeof module !== "undefined") {
+	module.exports = defaults;
+}

js/deprecated.js

@@ -0,0 +1,16 @@
+/* Magic Mirror Deprecated Config Options List
+ *
+ * By Michael Teeuw https://michaelteeuw.nl
+ * MIT Licensed.
+ *
+ * Olex S. original idea this deprecated option
+ */
+
+var deprecated = {
+	configs: ["kioskmode"]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {
+	module.exports = deprecated;
+}

js/electron.js

@@ -1,11 +1,11 @@
 "use strict";
 
-const Server = require(__dirname + "/server.js");
 const electron = require("electron");
-const core = require(__dirname + "/app.js");
+const core = require("./app.js");
+const Log = require("./logger.js");
 
 // Config
-var config = {};
+var config = process.env.config ? JSON.parse(process.env.config) : {};
 // Module to control application life.
 const app = electron.app;
 // Module to create native browser window.
@@ -15,49 +15,91 @@ const BrowserWindow = electron.BrowserWindow;
 // be closed automatically when the JavaScript object is garbage collected.
 let mainWindow;
 
+/**
+ *
+ */
 function createWindow() {
-	// Create the browser window.
+	app.commandLine.appendSwitch("autoplay-policy", "no-user-gesture-required");
+	var electronOptionsDefaults = {
+		width: 800,
+		height: 600,
+		x: 0,
+		y: 0,
+		darkTheme: true,
+		webPreferences: {
+			nodeIntegration: false,
+			zoomFactor: config.zoom
+		},
+		backgroundColor: "#000000"
+	};
+
+	// DEPRECATED: "kioskmode" backwards compatibility, to be removed
+	// settings these options directly instead provides cleaner interface
 	if (config.kioskmode) {
-		mainWindow = new BrowserWindow({width: 800, height: 600, x: 0, y: 0, kiosk:true, darkTheme: true, webPreferences: {nodeIntegration: false}});
+		electronOptionsDefaults.kiosk = true;
 	} else {
-		mainWindow = new BrowserWindow({width: 800, height: 600, x: 0, y: 0, fullscreen: true, autoHideMenuBar: true, darkTheme: true, webPreferences: {nodeIntegration: false}});
+		electronOptionsDefaults.fullscreen = true;
+		electronOptionsDefaults.autoHideMenuBar = true;
 	}
 
+	var electronOptions = Object.assign({}, electronOptionsDefaults, config.electronOptions);
+
+	// Create the browser window.
+	mainWindow = new BrowserWindow(electronOptions);
+
 	// and load the index.html of the app.
-	//mainWindow.loadURL('file://' + __dirname + '../../index.html');
-	mainWindow.loadURL("http://localhost:" + config.port);
+	// If config.address is not defined or is an empty string (listening on all interfaces), connect to localhost
+
+	var prefix;
+	if (config["tls"] !== null && config["tls"]) {
+		prefix = "https://";
+	} else {
+		prefix = "http://";
+	}
+
+	var address = (config.address === void 0) | (config.address === "") ? (config.address = "localhost") : config.address;
+	mainWindow.loadURL(`${prefix}${address}:${config.port}`);
 
 	// Open the DevTools if run with "npm start dev"
-	if(process.argv[2] == "dev"){
+	if (process.argv.includes("dev")) {
 		mainWindow.webContents.openDevTools();
 	}
 
-	// Emitted when the window is closed.
-	mainWindow.on("closed", function() {
-		// Dereference the window object, usually you would store windows
-		// in an array if your app supports multi windows, this is the time
-		// when you should delete the corresponding element.
+	// Set responders for window events.
+	mainWindow.on("closed", function () {
 		mainWindow = null;
 	});
+
+	if (config.kioskmode) {
+		mainWindow.on("blur", function () {
+			mainWindow.focus();
+		});
+
+		mainWindow.on("leave-full-screen", function () {
+			mainWindow.setFullScreen(true);
+		});
+
+		mainWindow.on("resize", function () {
+			setTimeout(function () {
+				mainWindow.reload();
+			}, 1000);
+		});
+	}
 }
 
 // This method will be called when Electron has finished
 // initialization and is ready to create browser windows.
-app.on("ready", function() {
-	console.log("Launching application.");
+app.on("ready", function () {
+	Log.log("Launching application.");
 	createWindow();
 });
 
 // Quit when all windows are closed.
-app.on("window-all-closed", function() {
-	// On OS X it is common for applications and their menu bar
-	// to stay active until the user quits explicitly with Cmd + Q
-	if (process.platform !== "darwin") {
-		app.quit();
-	}
+app.on("window-all-closed", function () {
+	createWindow();
 });
 
-app.on("activate", function() {
+app.on("activate", function () {
 	// On OS X it's common to re-create a window in the app when the
 	// dock icon is clicked and there are no other windows open.
 	if (mainWindow === null) {
@@ -65,8 +107,26 @@ app.on("activate", function() {
 	}
 });
 
-// Start the core application.
-// This starts all node helpers and starts the webserver.
-core.start(function(c) {
-	config = c;
+/* This method will be called when SIGINT is received and will call
+ * each node_helper's stop function if it exists. Added to fix #1056
+ *
+ * Note: this is only used if running Electron. Otherwise
+ * core.stop() is called by process.on("SIGINT"... in `app.js`
+ */
+app.on("before-quit", (event) => {
+	Log.log("Shutting down server...");
+	event.preventDefault();
+	setTimeout(() => {
+		process.exit(0);
+	}, 3000); // Force-quit after 3 seconds.
+	core.stop();
+	process.exit(0);
 });
+
+// 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].indexOf(config.address) > -1) {
+	core.start(function (c) {
+		config = c;
+	});
+}

js/loader.js

@@ -1,14 +1,13 @@
-/* global config, vendor, MM, Log, Module */
+/* global defaultModules, vendor */
+
 /* Magic Mirror
  * Module and File loaders.
  *
- * By Michael Teeuw http://michaelteeuw.nl
+ * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  */
-
-var Loader = (function() {
-
-	/* Create helper valiables */
+var Loader = (function () {
+	/* Create helper variables */
 
 	var loadedModuleFiles = [];
 	var loadedFiles = [];
@@ -16,64 +15,62 @@ var Loader = (function() {
 
 	/* Private Methods */
 
-	/* loadModules()
+	/**
 	 * Loops thru all modules and requests load for every module.
 	 */
-	var loadModules = function() {
-
+	var loadModules = function () {
 		var moduleData = getModuleData();
 
-		var loadNextModule = function() {
+		var loadNextModule = function () {
 			if (moduleData.length > 0) {
 				var nextModule = moduleData[0];
-				loadModule(nextModule, function() {
+				loadModule(nextModule, function () {
 					moduleData = moduleData.slice(1);
 					loadNextModule();
 				});
 			} else {
 				// All modules loaded. Load custom.css
-				// This is done after all the moduels so we can
-				// overwrite all the defined styls.
+				// This is done after all the modules so we can
+				// overwrite all the defined styles.
 
-				loadFile("css/custom.css", function() {
+				loadFile(config.customCss, function () {
 					// custom.css loaded. Start all modules.
 					startModules();
 				});
-
 			}
 		};
 
 		loadNextModule();
 	};
 
-	/* startModules()
+	/**
 	 * Loops thru all modules and requests start for every module.
 	 */
-	var startModules = function() {
+	var startModules = function () {
 		for (var m in moduleObjects) {
 			var module = moduleObjects[m];
 			module.start();
 		}
 
-		// Notifiy core of loded modules.
+		// Notify core of loaded modules.
 		MM.modulesStarted(moduleObjects);
 	};
 
-	/* getAllModules()
+	/**
 	 * Retrieve list of all modules.
 	 *
-	 * return array - module data as configured in config
+	 * @returns {object[]} module data as configured in config
 	 */
-	var getAllModules = function() {
+	var getAllModules = function () {
 		return config.modules;
 	};
 
-	/* getModuleData()
+	/**
 	 * Generate array with module information including module paths.
 	 *
-	 * return array - Module information.
+	 * @returns {object[]} Module information.
 	 */
-	var getModuleData = function() {
+	var getModuleData = function () {
 		var modules = getAllModules();
 		var moduleFiles = [];
 
@@ -83,138 +80,158 @@ var Loader = (function() {
 
 			var elements = module.split("/");
 			var moduleName = elements[elements.length - 1];
-			var moduleFolder =  config.paths.modules + "/" + module;
+			var moduleFolder = config.paths.modules + "/" + module;
 
 			if (defaultModules.indexOf(moduleName) !== -1) {
-				moduleFolder =  config.paths.modules + "/default/" + module;
+				moduleFolder = config.paths.modules + "/default/" + module;
+			}
+
+			if (moduleData.disabled === true) {
+				continue;
 			}
 
 			moduleFiles.push({
 				index: m,
 				identifier: "module_" + m + "_" + module,
 				name: moduleName,
-				path: moduleFolder + "/" ,
+				path: moduleFolder + "/",
 				file: moduleName + ".js",
 				position: moduleData.position,
 				header: moduleData.header,
+				configDeepMerge: typeof moduleData.configDeepMerge === "boolean" ? moduleData.configDeepMerge : false,
 				config: moduleData.config,
-				classes: (typeof moduleData.classes !== "undefined") ? moduleData.classes + " " + module : module
+				classes: typeof moduleData.classes !== "undefined" ? moduleData.classes + " " + module : module
 			});
-
 		}
 
 		return moduleFiles;
 	};
 
-	/* loadModule(module)
-	 * Load modules via ajax request and create module objects.
+	/**
+	 * Load modules via ajax request and create module objects.s
 	 *
-	 * argument callback function - Function called when done.
-	 * argument module object - Information about the module we want to load.
+	 * @param {object} module Information about the module we want to load.
+	 * @param {Function} callback Function called when done.
 	 */
-	var loadModule = function(module, callback) {
+	var loadModule = function (module, callback) {
 		var url = module.path + "/" + module.file;
 
-		var afterLoad = function() {
+		var afterLoad = function () {
 			var moduleObject = Module.create(module.name);
-			bootstrapModule(module, moduleObject, function() {
+			if (moduleObject) {
+				bootstrapModule(module, moduleObject, function () {
+					callback();
+				});
+			} else {
 				callback();
-			});
+			}
 		};
 
 		if (loadedModuleFiles.indexOf(url) !== -1) {
 			afterLoad();
 		} else {
-			loadFile(url, function() {
+			loadFile(url, function () {
 				loadedModuleFiles.push(url);
 				afterLoad();
 			});
 		}
-
 	};
 
-	/* bootstrapModule(module, mObj)
+	/**
 	 * Bootstrap modules by setting the module data and loading the scripts & styles.
 	 *
-	 * argument module object - Information about the module we want to load.
-	 * argument mObj object - Modules instance.
-	 * argument callback function - Function called when done.
+	 * @param {object} module Information about the module we want to load.
+	 * @param {Module} mObj Modules instance.
+	 * @param {Function} callback Function called when done.
 	 */
-	var bootstrapModule = function(module, mObj, callback) {
+	var bootstrapModule = function (module, mObj, callback) {
 		Log.info("Bootstrapping module: " + module.name);
 
 		mObj.setData(module);
 
-		mObj.loadScripts(function() {
+		mObj.loadScripts(function () {
 			Log.log("Scripts loaded for: " + module.name);
-			mObj.loadStyles(function() {
+			mObj.loadStyles(function () {
 				Log.log("Styles loaded for: " + module.name);
-				mObj.loadTranslations(function() {
+				mObj.loadTranslations(function () {
 					Log.log("Translations loaded for: " + module.name);
 					moduleObjects.push(mObj);
 					callback();
 				});
 			});
 		});
-
 	};
 
-	/* loadFile(fileName)
+	/**
 	 * Load a script or stylesheet by adding it to the dom.
 	 *
-	 * argument fileName string - Path of the file we want to load.
-	 * argument callback function - Function called when done.
+	 * @param {string} fileName Path of the file we want to load.
+	 * @param {Function} callback Function called when done.
 	 */
-	var loadFile = function(fileName, callback) {
-
-		var extension =  fileName.slice((Math.max(0, fileName.lastIndexOf(".")) || Infinity) + 1);
+	var loadFile = function (fileName, callback) {
+		var extension = fileName.slice((Math.max(0, fileName.lastIndexOf(".")) || Infinity) + 1);
 
 		switch (extension.toLowerCase()) {
-		case "js":
-			Log.log("Load script: " + fileName);
-			var script = document.createElement("script");
-			script.type = "text/javascript";
-			script.src = fileName;
-			script.onload = function() {
-				if (typeof callback === "function") {callback();}
-			};
-			document.getElementsByTagName("body")[0].appendChild(script);
-			break;
-		case "css":
-			Log.log("Load stylesheet: " + fileName);
-			var stylesheet = document.createElement("link");
-			stylesheet.rel = "stylesheet";
-			stylesheet.type = "text/css";
-			stylesheet.href = fileName;
-			stylesheet.onload = function() {
-				if (typeof callback === "function") {callback();}
-			};
-			document.getElementsByTagName("head")[0].appendChild(stylesheet);
-			break;
-		}
+			case "js":
+				Log.log("Load script: " + fileName);
+				var script = document.createElement("script");
+				script.type = "text/javascript";
+				script.src = fileName;
+				script.onload = function () {
+					if (typeof callback === "function") {
+						callback();
+					}
+				};
+				script.onerror = function () {
+					Log.error("Error on loading script:", fileName);
+					if (typeof callback === "function") {
+						callback();
+					}
+				};
 
+				document.getElementsByTagName("body")[0].appendChild(script);
+				break;
+			case "css":
+				Log.log("Load stylesheet: " + fileName);
+				var stylesheet = document.createElement("link");
+				stylesheet.rel = "stylesheet";
+				stylesheet.type = "text/css";
+				stylesheet.href = fileName;
+				stylesheet.onload = function () {
+					if (typeof callback === "function") {
+						callback();
+					}
+				};
+				stylesheet.onerror = function () {
+					Log.error("Error on loading stylesheet:", fileName);
+					if (typeof callback === "function") {
+						callback();
+					}
+				};
+
+				document.getElementsByTagName("head")[0].appendChild(stylesheet);
+				break;
+		}
 	};
 
 	/* Public Methods */
 	return {
-
-		/* loadModules()
+		/**
 		 * Load all modules as defined in the config.
 		 */
-		loadModules: function() {
+		loadModules: function () {
 			loadModules();
 		},
 
-		/* loadFile()
+		/**
 		 * Load a file (script or stylesheet).
 		 * Prevent double loading and search for files in the vendor folder.
 		 *
-		 * argument fileName string - Path of the file we want to load.
-		 * argument module Module Object - the module that calls the loadFile function.
-		 * argument callback function - Function called when done.
+		 * @param {string} fileName Path of the file we want to load.
+		 * @param {Module} module The module that calls the loadFile function.
+		 * @param {Function} callback Function called when done.
 		 */
-		loadFile: function(fileName, module, callback) {
-
+		loadFile: function (fileName, module, callback) {
 			if (loadedFiles.indexOf(fileName.toLowerCase()) !== -1) {
 				Log.log("File already loaded: " + fileName);
 				callback();
@@ -243,5 +260,4 @@ var Loader = (function() {
 			loadFile(module.file(fileName), callback);
 		}
 	};
-
 })();

js/logger.js

@@ -1,47 +1,50 @@
-/* global console */
-/* exported Log */
-
 /* Magic Mirror
- * Logger
+ * Log
  *
- * By Michael Teeuw http://michaelteeuw.nl
+ * This logger is very simple, but needs to be extended.
+ * This system can eventually be used to push the log messages to an external target.
+ *
+ * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  */
+(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"]
+		});
 
-// This logger is very simple, but needs to be extended.
-// This system can eventually be used to push the log messages to an external target.
+		// Node, CommonJS-like
+		module.exports = factory(root.config);
+	} else {
+		// Browser globals (root is window)
+		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)
+	};
 
-var Log = (function() {
-	return {
-		info: function(message) {
-			console.info(message);
-		},
-		log: function(message) {
-			console.log(message);
-		},
-		error: function(message) {
-			console.error(message);
-		},
-		warn: function(message) {
-			console.warn(message);	
-		},
-		group: function(message) {
-			console.group(message);	
-		},
-		groupCollapsed: function(message) {
-			console.groupCollapsed(message);
-		},
-		groupEnd: function() {
-			console.groupEnd();
-		},
-		time: function(message) {
-			console.time(message);
-		},
-		timeEnd: function(message) {
-			console.timeEnd(message);
-		},
-		timeStamp: function(message) {
-			console.timeStamp(message);
+	logLevel.setLogLevel = function (newLevel) {
+		if (newLevel) {
+			Object.keys(logLevel).forEach(function (key, index) {
+				if (!newLevel.includes(key.toLocaleUpperCase())) {
+					logLevel[key] = function () {};
+				}
+			});
 		}
 	};
-})();
+
+	return logLevel;
+});

js/main.js

@@ -1,292 +1,450 @@
-/* global  Log, Loader, Module, config, defaults */
-/* jshint -W020 */
+/* global Loader, defaults, Translator */
 
 /* Magic Mirror
  * Main System
  *
- * By Michael Teeuw http://michaelteeuw.nl
+ * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  */
-
-var MM = (function() {
-
+var MM = (function () {
 	var modules = [];
 
 	/* Private Methods */
 
-	/* createDomObjects()
-	 * Create dom objects for all modules that
-	 * are configured for a specific position.
+	/**
+	 * Create dom objects for all modules that are configured for a specific position.
 	 */
-	var createDomObjects = function() {
-		for (var m in modules) {
-			var module = modules[m];
+	var createDomObjects = function () {
+		var domCreationPromises = [];
 
-			if (typeof module.data.position === "string") {
-
-				var wrapper = selectWrapper(module.data.position);
-
-				var dom = document.createElement("div");
-				dom.id = module.identifier;
-				dom.className = module.name;
-
-				if (typeof module.data.classes === "string") {
-					dom.className = "module " + dom.className + " " + module.data.classes;
-				}
-
-				dom.opacity = 0;
-				wrapper.appendChild(dom);
-
-				if (typeof module.data.header !== "undefined" && module.data.header !== "") {
-					var moduleHeader = document.createElement("header");
-					moduleHeader.innerHTML = module.data.header;
-					dom.appendChild(moduleHeader);
-				}
-
-				var moduleContent = document.createElement("div");
-				moduleContent.className = "module-content";
-				dom.appendChild(moduleContent);
-
-				updateDom(module, 0);
+		modules.forEach(function (module) {
+			if (typeof module.data.position !== "string") {
+				return;
 			}
-		}
 
-		sendNotification("DOM_OBJECTS_CREATED");
+			var wrapper = selectWrapper(module.data.position);
+
+			var dom = document.createElement("div");
+			dom.id = module.identifier;
+			dom.className = module.name;
+
+			if (typeof module.data.classes === "string") {
+				dom.className = "module " + dom.className + " " + module.data.classes;
+			}
+
+			dom.opacity = 0;
+			wrapper.appendChild(dom);
+
+			var moduleHeader = document.createElement("header");
+			moduleHeader.innerHTML = module.getHeader();
+			moduleHeader.className = "module-header";
+			dom.appendChild(moduleHeader);
+
+			if (typeof module.getHeader() === "undefined" || module.getHeader() !== "") {
+				moduleHeader.style.display = "none;";
+			} else {
+				moduleHeader.style.display = "block;";
+			}
+
+			var moduleContent = document.createElement("div");
+			moduleContent.className = "module-content";
+			dom.appendChild(moduleContent);
+
+			var domCreationPromise = updateDom(module, 0);
+			domCreationPromises.push(domCreationPromise);
+			domCreationPromise
+				.then(function () {
+					sendNotification("MODULE_DOM_CREATED", null, null, module);
+				})
+				.catch(Log.error);
+		});
+
+		updateWrapperStates();
+
+		Promise.all(domCreationPromises).then(function () {
+			sendNotification("DOM_OBJECTS_CREATED");
+		});
 	};
 
-	/* selectWrapper(position)
+	/**
 	 * Select the wrapper dom object for a specific position.
 	 *
-	 * argument position string - The name of the position.
+	 * @param {string} position The name of the position.
+	 *
+	 * @returns {HTMLElement} the wrapper element
 	 */
-	var selectWrapper = function(position) {
-		var classes = position.replace("_"," ");
+	var selectWrapper = function (position) {
+		var classes = position.replace("_", " ");
 		var parentWrapper = document.getElementsByClassName(classes);
 		if (parentWrapper.length > 0) {
-			var wrapper =  parentWrapper[0].getElementsByClassName("container");
+			var wrapper = parentWrapper[0].getElementsByClassName("container");
 			if (wrapper.length > 0) {
 				return wrapper[0];
 			}
 		}
 	};
 
-	/* sendNotification(notification, payload, sender)
+	/**
 	 * Send a notification to all modules.
 	 *
-	 * argument notification string - The identifier of the noitication.
-	 * argument payload mixed - The payload of the notification.
-	 * argument sender Module - The module that sent the notification.
+	 * @param {string} notification The identifier of the notification.
+	 * @param {*} payload The payload of the notification.
+	 * @param {Module} sender The module that sent the notification.
+	 * @param {Module} [sendTo] The (optional) module to send the notification to.
 	 */
-	var sendNotification = function(notification, payload, sender) {
+	var sendNotification = function (notification, payload, sender, sendTo) {
 		for (var m in modules) {
 			var module = modules[m];
-			if (module !== sender) {
+			if (module !== sender && (!sendTo || module === sendTo)) {
 				module.notificationReceived(notification, payload, sender);
 			}
 		}
 	};
 
-	/* updateDom(module, speed)
+	/**
 	 * Update the dom for a specific module.
 	 *
-	 * argument module Module - The module that needs an update.
-	 * argument speed Number - The number of microseconds for the animation. (optional)
+	 * @param {Module} module The module that needs an update.
+	 * @param {number} [speed] The (optional) number of microseconds for the animation.
+	 *
+	 * @returns {Promise} Resolved when the dom is fully updated.
 	 */
-	var updateDom = function(module, speed) {
-		var newContent = module.getDom();
+	var updateDom = function (module, speed) {
+		return new Promise(function (resolve) {
+			var newContentPromise = module.getDom();
+			var newHeader = module.getHeader();
 
-		if (!module.hidden) {
+			if (!(newContentPromise instanceof Promise)) {
+				// convert to a promise if not already one to avoid if/else's everywhere
+				newContentPromise = Promise.resolve(newContentPromise);
+			}
 
-			if (!moduleNeedsUpdate(module, newContent)) {
+			newContentPromise
+				.then(function (newContent) {
+					var updatePromise = updateDomWithContent(module, speed, newHeader, newContent);
+
+					updatePromise.then(resolve).catch(Log.error);
+				})
+				.catch(Log.error);
+		});
+	};
+
+	/**
+	 * Update the dom with the specified content
+	 *
+	 * @param {Module} module The module that needs an update.
+	 * @param {number} [speed] The (optional) number of microseconds for the animation.
+	 * @param {string} newHeader The new header that is generated.
+	 * @param {HTMLElement} newContent The new content that is generated.
+	 *
+	 * @returns {Promise} Resolved when the module dom has been updated.
+	 */
+	var updateDomWithContent = function (module, speed, newHeader, newContent) {
+		return new Promise(function (resolve) {
+			if (module.hidden || !speed) {
+				updateModuleContent(module, newHeader, newContent);
+				resolve();
+				return;
+			}
+
+			if (!moduleNeedsUpdate(module, newHeader, newContent)) {
+				resolve();
 				return;
 			}
 
 			if (!speed) {
-				updateModuleContent(module, newContent);
+				updateModuleContent(module, newHeader, newContent);
+				resolve();
 				return;
 			}
 
-			hideModule(module, speed / 2, function() {
-				updateModuleContent(module, newContent);
+			hideModule(module, speed / 2, function () {
+				updateModuleContent(module, newHeader, newContent);
 				if (!module.hidden) {
 					showModule(module, speed / 2);
 				}
+				resolve();
 			});
+		});
+	};
+
+	/**
+	 * Check if the content has changed.
+	 *
+	 * @param {Module} module The module to check.
+	 * @param {string} newHeader The new header that is generated.
+	 * @param {HTMLElement} newContent The new content that is generated.
+	 *
+	 * @returns {boolean} True if the module need an update, false otherwise
+	 */
+	var moduleNeedsUpdate = function (module, newHeader, newContent) {
+		var moduleWrapper = document.getElementById(module.identifier);
+		if (moduleWrapper === null) {
+			return false;
+		}
+
+		var contentWrapper = moduleWrapper.getElementsByClassName("module-content");
+		var headerWrapper = moduleWrapper.getElementsByClassName("module-header");
+
+		var headerNeedsUpdate = false;
+		var contentNeedsUpdate = false;
+
+		if (headerWrapper.length > 0) {
+			headerNeedsUpdate = newHeader !== headerWrapper[0].innerHTML;
+		}
+
+		var tempContentWrapper = document.createElement("div");
+		tempContentWrapper.appendChild(newContent);
+		contentNeedsUpdate = tempContentWrapper.innerHTML !== contentWrapper[0].innerHTML;
+
+		return headerNeedsUpdate || contentNeedsUpdate;
+	};
+
+	/**
+	 * Update the content of a module on screen.
+	 *
+	 * @param {Module} module The module to check.
+	 * @param {string} newHeader The new header that is generated.
+	 * @param {HTMLElement} newContent The new content that is generated.
+	 */
+	var updateModuleContent = function (module, newHeader, newContent) {
+		var moduleWrapper = document.getElementById(module.identifier);
+		if (moduleWrapper === null) {
+			return;
+		}
+		var headerWrapper = moduleWrapper.getElementsByClassName("module-header");
+		var contentWrapper = moduleWrapper.getElementsByClassName("module-content");
+
+		contentWrapper[0].innerHTML = "";
+		contentWrapper[0].appendChild(newContent);
+
+		headerWrapper[0].innerHTML = newHeader;
+		if (headerWrapper.length > 0 && newHeader) {
+			headerWrapper[0].style.display = "block";
 		} else {
-			updateModuleContent(module, newContent);
+			headerWrapper[0].style.display = "none";
 		}
 	};
 
-	/* moduleNeedsUpdate(module, newContent)
-	 * Check if the content has changed.
-	 *
-	 * argument module Module - The module to check.
-	 * argument newContent Domobject - The new content that is generated.
-	 *
-	 * return bool - Does the module need an update?
-	 */
-	var moduleNeedsUpdate = function(module, newContent) {
-		var moduleWrapper = document.getElementById(module.identifier);
-		var contentWrapper = moduleWrapper.getElementsByClassName("module-content")[0];
-
-		var tempWrapper = document.createElement("div");
-		tempWrapper.appendChild(newContent);
-
-		return tempWrapper.innerHTML !== contentWrapper.innerHTML;
-	};
-
-	/* moduleNeedsUpdate(module, newContent)
-	 * Update the content of a module on screen.
-	 *
-	 * argument module Module - The module to check.
-	 * argument newContent Domobject - The new content that is generated.
-	 */
-	var updateModuleContent = function(module, content) {
-		var moduleWrapper = document.getElementById(module.identifier);
-		var contentWrapper = moduleWrapper.getElementsByClassName("module-content")[0];
-
-		contentWrapper.innerHTML = "";
-		contentWrapper.appendChild(content);
-	};
-
-	/* hideModule(module, speed, callback)
+	/**
 	 * Hide the module.
 	 *
-	 * argument module Module - The module to hide.
-	 * argument speed Number - The speed of the hide animation.
-	 * argument callback function - Called when the animation is done.
+	 * @param {Module} module The module to hide.
+	 * @param {number} speed The speed of the hide animation.
+	 * @param {Function} callback Called when the animation is done.
+	 * @param {object} [options] Optional settings for the hide method.
 	 */
-	var hideModule = function(module, speed, callback) {
+	var hideModule = function (module, speed, callback, options) {
+		options = options || {};
+
+		// set lockString if set in options.
+		if (options.lockString) {
+			// Log.log("Has lockstring: " + options.lockString);
+			if (module.lockStrings.indexOf(options.lockString) === -1) {
+				module.lockStrings.push(options.lockString);
+			}
+		}
+
 		var moduleWrapper = document.getElementById(module.identifier);
 		if (moduleWrapper !== null) {
 			moduleWrapper.style.transition = "opacity " + speed / 1000 + "s";
 			moduleWrapper.style.opacity = 0;
 
 			clearTimeout(module.showHideTimer);
-			module.showHideTimer = setTimeout(function() {
+			module.showHideTimer = setTimeout(function () {
 				// To not take up any space, we just make the position absolute.
-				// since it"s fade out anyway, we can see it lay above or
+				// since it's fade out anyway, we can see it lay above or
 				// below other modules. This works way better than adjusting
 				// the .display property.
-				moduleWrapper.style.position = "absolute";
+				moduleWrapper.style.position = "fixed";
 
-				if (typeof callback === "function") { callback(); }
+				updateWrapperStates();
+
+				if (typeof callback === "function") {
+					callback();
+				}
 			}, speed);
+		} else {
+			// invoke callback even if no content, issue 1308
+			if (typeof callback === "function") {
+				callback();
+			}
 		}
 	};
 
-	/* showModule(module, speed, callback)
+	/**
 	 * Show the module.
 	 *
-	 * argument module Module - The module to show.
-	 * argument speed Number - The speed of the show animation.
-	 * argument callback function - Called when the animation is done.
+	 * @param {Module} module The module to show.
+	 * @param {number} speed The speed of the show animation.
+	 * @param {Function} callback Called when the animation is done.
+	 * @param {object} [options] Optional settings for the show method.
 	 */
-	var showModule = function(module, speed, callback) {
+	var showModule = function (module, speed, callback, options) {
+		options = options || {};
+
+		// remove lockString if set in options.
+		if (options.lockString) {
+			var index = module.lockStrings.indexOf(options.lockString);
+			if (index !== -1) {
+				module.lockStrings.splice(index, 1);
+			}
+		}
+
+		// Check if there are no more lockstrings set, or the force option is set.
+		// Otherwise cancel show action.
+		if (module.lockStrings.length !== 0 && options.force !== true) {
+			Log.log("Will not show " + module.name + ". LockStrings active: " + module.lockStrings.join(","));
+			return;
+		}
+
+		module.hidden = false;
+
+		// If forced show, clean current lockstrings.
+		if (module.lockStrings.length !== 0 && options.force === true) {
+			Log.log("Force show of module: " + module.name);
+			module.lockStrings = [];
+		}
+
 		var moduleWrapper = document.getElementById(module.identifier);
 		if (moduleWrapper !== null) {
 			moduleWrapper.style.transition = "opacity " + speed / 1000 + "s";
-			// Restore the postition. See hideModule() for more info.
+			// Restore the position. See hideModule() for more info.
 			moduleWrapper.style.position = "static";
+
+			updateWrapperStates();
+
+			// Waiting for DOM-changes done in updateWrapperStates before we can start the animation.
+			var dummy = moduleWrapper.parentElement.parentElement.offsetHeight;
 			moduleWrapper.style.opacity = 1;
 
 			clearTimeout(module.showHideTimer);
-			module.showHideTimer = setTimeout(function() {
-				if (typeof callback === "function") { callback(); }
+			module.showHideTimer = setTimeout(function () {
+				if (typeof callback === "function") {
+					callback();
+				}
 			}, speed);
-
+		} else {
+			// invoke callback
+			if (typeof callback === "function") {
+				callback();
+			}
 		}
 	};
 
-	/* loadConfig()
-	 * Loads the core config and combines it with de system defaults.
+	/**
+	 * Checks for all positions if it has visible content.
+	 * If not, if will hide the position to prevent unwanted margins.
+	 * This method should be called by the show and hide methods.
+	 *
+	 * Example:
+	 * If the top_bar only contains the update notification. And no update is available,
+	 * the update notification is hidden. The top bar still occupies space making for
+	 * an ugly top margin. By using this function, the top bar will be hidden if the
+	 * update notification is not visible.
 	 */
-	var loadConfig = function() {
+	var updateWrapperStates = function () {
+		var positions = ["top_bar", "top_left", "top_center", "top_right", "upper_third", "middle_center", "lower_third", "bottom_left", "bottom_center", "bottom_right", "bottom_bar", "fullscreen_above", "fullscreen_below"];
+
+		positions.forEach(function (position) {
+			var wrapper = selectWrapper(position);
+			var moduleWrappers = wrapper.getElementsByClassName("module");
+
+			var showWrapper = false;
+			Array.prototype.forEach.call(moduleWrappers, function (moduleWrapper) {
+				if (moduleWrapper.style.position === "" || moduleWrapper.style.position === "static") {
+					showWrapper = true;
+				}
+			});
+
+			wrapper.style.display = showWrapper ? "block" : "none";
+		});
+	};
+
+	/**
+	 * Loads the core config and combines it with the system defaults.
+	 */
+	var loadConfig = function () {
+		// FIXME: Think about how to pass config around without breaking tests
+		/* eslint-disable */
 		if (typeof config === "undefined") {
 			config = defaults;
 			Log.error("Config file is missing! Please create a config file.");
 			return;
 		}
 
-		config = Object.assign(defaults, config);
+		config = Object.assign({}, defaults, config);
+		/* eslint-enable */
 	};
 
-	/* setSelectionMethodsForModules()
+	/**
 	 * Adds special selectors on a collection of modules.
 	 *
-	 * argument modules array - Array of modules.
+	 * @param {Module[]} modules Array of modules.
 	 */
-	var setSelectionMethodsForModules = function(modules) {
-
-		/* withClass(className)
-		 * filters a collection of modules based on classname(s).
+	var setSelectionMethodsForModules = function (modules) {
+		/**
+		 * Filter modules with the specified classes.
 		 *
-		 * argument className string/array - one or multiple classnames. (array or space devided)
+		 * @param {string|string[]} className one or multiple classnames (array or space divided).
 		 *
-		 * return array - Filtered collection of modules.
+		 * @returns {Module[]} Filtered collection of modules.
 		 */
-		var withClass = function(className) {
+		var withClass = function (className) {
+			return modulesByClass(className, true);
+		};
+
+		/**
+		 * Filter modules without the specified classes.
+		 *
+		 * @param {string|string[]} className one or multiple classnames (array or space divided).
+		 *
+		 * @returns {Module[]} Filtered collection of modules.
+		 */
+		var exceptWithClass = function (className) {
+			return modulesByClass(className, false);
+		};
+
+		/**
+		 * Filters a collection of modules based on classname(s).
+		 *
+		 * @param {string|string[]} className one or multiple classnames (array or space divided).
+		 * @param {boolean} include if the filter should include or exclude the modules with the specific classes.
+		 *
+		 * @returns {Module[]} Filtered collection of modules.
+		 */
+		var modulesByClass = function (className, include) {
 			var searchClasses = className;
 			if (typeof className === "string") {
 				searchClasses = className.split(" ");
 			}
 
-			var newModules = modules.filter(function(module) {
+			var newModules = modules.filter(function (module) {
 				var classes = module.data.classes.toLowerCase().split(" ");
 
 				for (var c in searchClasses) {
 					var searchClass = searchClasses[c];
 					if (classes.indexOf(searchClass.toLowerCase()) !== -1) {
-						return true;
+						return include;
 					}
 				}
 
-				return false;
+				return !include;
 			});
 
 			setSelectionMethodsForModules(newModules);
 			return newModules;
 		};
 
-		/* exceptWithClass(className)
-		 * filters a collection of modules based on classname(s). (NOT)
-		 *
-		 * argument className string/array - one or multiple classnames. (array or space devided)
-		 *
-		 * return array - Filtered collection of modules.
-		 */
-		var exceptWithClass  = function(className) {
-			var searchClasses = className;
-			if (typeof className === "string") {
-				searchClasses = className.split(" ");
-			}
-
-			var newModules = modules.filter(function(module) {
-				var classes = module.data.classes.toLowerCase().split(" ");
-
-				for (var c in searchClasses) {
-					var searchClass = searchClasses[c];
-					if (classes.indexOf(searchClass.toLowerCase()) !== -1) {
-						return false;
-					}
-				}
-
-				return true;
-			});
-
-			setSelectionMethodsForModules(newModules);
-			return newModules;
-		};
-
-		/* exceptModule(module)
+		/**
 		 * Removes a module instance from the collection.
 		 *
-		 * argument module Module object - The module instance to remove from the collection.
+		 * @param {object} module The module instance to remove from the collection.
 		 *
-		 * return array - Filtered collection of modules.
+		 * @returns {Module[]} Filtered collection of modules.
 		 */
-		var exceptModule = function(module) {
-			var newModules = modules.filter(function(mod) {
+		var exceptModule = function (module) {
+			var newModules = modules.filter(function (mod) {
 				return mod.identifier !== module.identifier;
 			});
 
@@ -294,47 +452,55 @@ var MM = (function() {
 			return newModules;
 		};
 
-		/* enumerate(callback)
+		/**
 		 * Walks thru a collection of modules and executes the callback with the module as an argument.
 		 *
-		 * argument callback function - The function to execute with the module as an argument.
+		 * @param {Function} callback The function to execute with the module as an argument.
 		 */
-		var enumerate = function(callback) {
-			modules.map(function(module) {
+		var enumerate = function (callback) {
+			modules.map(function (module) {
 				callback(module);
 			});
 		};
 
-		if (typeof modules.withClass === "undefined") { Object.defineProperty(modules, "withClass",  {value: withClass, enumerable: false}); }
-		if (typeof modules.exceptWithClass === "undefined") { Object.defineProperty(modules, "exceptWithClass",  {value: exceptWithClass, enumerable: false}); }
-		if (typeof modules.exceptModule === "undefined") { Object.defineProperty(modules, "exceptModule",  {value: exceptModule, enumerable: false}); }
-		if (typeof modules.enumerate === "undefined") { Object.defineProperty(modules, "enumerate",  {value: enumerate, enumerable: false}); }
+		if (typeof modules.withClass === "undefined") {
+			Object.defineProperty(modules, "withClass", { value: withClass, enumerable: false });
+		}
+		if (typeof modules.exceptWithClass === "undefined") {
+			Object.defineProperty(modules, "exceptWithClass", { value: exceptWithClass, enumerable: false });
+		}
+		if (typeof modules.exceptModule === "undefined") {
+			Object.defineProperty(modules, "exceptModule", { value: exceptModule, enumerable: false });
+		}
+		if (typeof modules.enumerate === "undefined") {
+			Object.defineProperty(modules, "enumerate", { value: enumerate, enumerable: false });
+		}
 	};
 
 	return {
 		/* Public Methods */
 
-		/* init()
+		/**
 		 * Main init method.
 		 */
-		init: function() {
+		init: function () {
 			Log.info("Initializing MagicMirror.");
 			loadConfig();
+
+			Log.setLogLevel(config.logLevel);
+
 			Translator.loadCoreTranslations(config.language);
 			Loader.loadModules();
 		},
 
-		/* modulesStarted(moduleObjects)
+		/**
 		 * Gets called when all modules are started.
 		 *
-		 * argument moduleObjects array<Module> - All module instances.
+		 * @param {Module[]} moduleObjects All module instances.
 		 */
-		modulesStarted: function(moduleObjects) {
+		modulesStarted: function (moduleObjects) {
 			modules = [];
-			for (var m in moduleObjects) {
-				var module = moduleObjects[m];
-				modules[module.data.index] = module;
-			}
+			moduleObjects.forEach((module) => modules.push(module));
 
 			Log.info("All modules started!");
 			sendNotification("ALL_MODULES_STARTED");
@@ -342,14 +508,14 @@ var MM = (function() {
 			createDomObjects();
 		},
 
-		/* sendNotification(notification, payload, sender)
+		/**
 		 * Send a notification to all modules.
 		 *
-		 * argument notification string - The identifier of the noitication.
-		 * argument payload mixed - The payload of the notification.
-		 * argument sender Module - The module that sent the notification.
+		 * @param {string} notification The identifier of the notification.
+		 * @param {*} payload The payload of the notification.
+		 * @param {Module} sender The module that sent the notification.
 		 */
-		sendNotification: function(notification, payload, sender) {
+		sendNotification: function (notification, payload, sender) {
 			if (arguments.length < 3) {
 				Log.error("sendNotification: Missing arguments.");
 				return;
@@ -369,13 +535,13 @@ var MM = (function() {
 			sendNotification(notification, payload, sender);
 		},
 
-		/* updateDom(module, speed)
+		/**
 		 * Update the dom for a specific module.
 		 *
-		 * argument module Module - The module that needs an update.
-		 * argument speed Number - The number of microseconds for the animation. (optional)
+		 * @param {Module} module The module that needs an update.
+		 * @param {number} [speed] The number of microseconds for the animation.
 		 */
-		updateDom: function(module, speed) {
+		updateDom: function (module, speed) {
 			if (!(module instanceof Module)) {
 				Log.error("updateDom: Sender should be a module.");
 				return;
@@ -385,47 +551,48 @@ var MM = (function() {
 			updateDom(module, speed);
 		},
 
-		/* getModules(module, speed)
+		/**
 		 * Returns a collection of all modules currently active.
 		 *
-		 * return array - A collection of all modules currently active.
+		 * @returns {Module[]} A collection of all modules currently active.
 		 */
-		getModules: function() {
+		getModules: function () {
 			setSelectionMethodsForModules(modules);
 			return modules;
 		},
 
-		/* hideModule(module, speed, callback)
+		/**
 		 * Hide the module.
 		 *
-		 * argument module Module - The module hide.
-		 * argument speed Number - The speed of the hide animation.
-		 * argument callback function - Called when the animation is done.
+		 * @param {Module} module The module to hide.
+		 * @param {number} speed The speed of the hide animation.
+		 * @param {Function} callback Called when the animation is done.
+		 * @param {object} [options] Optional settings for the hide method.
 		 */
-		hideModule: function(module, speed, callback) {
+		hideModule: function (module, speed, callback, options) {
 			module.hidden = true;
-			hideModule(module, speed, callback);
+			hideModule(module, speed, callback, options);
 		},
 
-		/* showModule(module, speed, callback)
+		/**
 		 * Show the module.
 		 *
-		 * argument module Module - The module show.
-		 * argument speed Number - The speed of the show animation.
-		 * argument callback function - Called when the animation is done.
+		 * @param {Module} module The module to show.
+		 * @param {number} speed The speed of the show animation.
+		 * @param {Function} callback Called when the animation is done.
+		 * @param {object} [options] Optional settings for the show method.
 		 */
-		showModule: function(module, speed, callback) {
-			module.hidden = false;
-			showModule(module, speed, callback);
+		showModule: function (module, speed, callback, options) {
+			// do not change module.hidden yet, only if we really show it later
+			showModule(module, speed, callback, options);
 		}
 	};
-
 })();
 
 // Add polyfill for Object.assign.
-if (typeof Object.assign != "function") {
-	(function() {
-		Object.assign = function(target) {
+if (typeof Object.assign !== "function") {
+	(function () {
+		Object.assign = function (target) {
 			"use strict";
 			if (target === undefined || target === null) {
 				throw new TypeError("Cannot convert undefined or null to object");

js/module.js

@@ -1,126 +1,208 @@
-/* global Log, Class, Loader, Class , MM */
-/* exported Module */
+/* global Class, cloneObject, Loader, MMSocket, nunjucks, Translator */
 
 /* Magic Mirror
  * Module Blueprint.
+ * @typedef {Object} Module
  *
- * By Michael Teeuw http://michaelteeuw.nl
+ * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
+ *
  */
-
 var Module = Class.extend({
-
 	/*********************************************************
 	 * All methods (and properties) below can be subclassed. *
 	 *********************************************************/
 
+	// Set the minimum MagicMirror module version for this module.
+	requiresVersion: "2.0.0",
+
 	// Module config defaults.
 	defaults: {},
 
 	// Timer reference used for showHide animation callbacks.
 	showHideTimer: null,
 
-	/* init()
-	 * Is called when the module is instantiated.
+	// Array to store lockStrings. These strings are used to lock
+	// visibility when hiding and showing module.
+	lockStrings: [],
+
+	// Storage of the nunjuck Environment,
+	// This should not be referenced directly.
+	// Use the nunjucksEnvironment() to get it.
+	_nunjucksEnvironment: null,
+
+	/**
+	 * Called when the module is instantiated.
 	 */
-	init: function() {
+	init: function () {
 		//Log.log(this.defaults);
 	},
 
-	/* start()
-	 * Is called when the module is started.
+	/**
+	 * Called when the module is started.
 	 */
-	start: function() {
+	start: function () {
 		Log.info("Starting module: " + this.name);
 	},
 
-	/* getScripts()
+	/**
 	 * Returns a list of scripts the module requires to be loaded.
 	 *
-	 * return Array<String> - An array with filenames.
+	 * @returns {string[]} An array with filenames.
 	 */
-	getScripts: function() {
+	getScripts: function () {
 		return [];
 	},
 
-	/* getStyles()
+	/**
 	 * Returns a list of stylesheets the module requires to be loaded.
 	 *
-	 * return Array<String> - An array with filenames.
+	 * @returns {string[]} An array with filenames.
 	 */
-	getStyles: function() {
+	getStyles: function () {
 		return [];
 	},
 
-	/* getTranslations()
+	/**
 	 * Returns a map of translation files the module requires to be loaded.
 	 *
-	 * return Map<String, String> - A map with langKeys and filenames.
+	 * return Map<String, String> -
+	 *
+	 * @returns {*} A map with langKeys and filenames.
 	 */
-	getTranslations: function() {
+	getTranslations: function () {
 		return false;
 	},
 
-	/* getDom()
-	 * This method generates the dom which needs to be displayed. This method is called by the Magic Mirror core.
-	 * This method needs to be subclassed if the module wants to display info on the mirror.
+	/**
+	 * Generates the dom which needs to be displayed. This method is called by the Magic Mirror core.
+	 * This method can to be subclassed if the module wants to display info on the mirror.
+	 * Alternatively, the getTemplate method could be subclassed.
 	 *
-	 * return domobject - The dom to display.
+	 * @returns {HTMLElement|Promise} The dom or a promise with the dom to display.
 	 */
-	getDom: function() {
-		var nameWrapper = document.createElement("div");
-		var name = document.createTextNode(this.name);
-		nameWrapper.appendChild(name);
+	getDom: function () {
+		var self = this;
+		return new Promise(function (resolve) {
+			var div = document.createElement("div");
+			var template = self.getTemplate();
+			var templateData = self.getTemplateData();
 
-		var identifierWrapper = document.createElement("div");
-		var identifier = document.createTextNode(this.identifier);
-		identifierWrapper.appendChild(identifier);
-		identifierWrapper.className = "small dimmed";
+			// Check to see if we need to render a template string or a file.
+			if (/^.*((\.html)|(\.njk))$/.test(template)) {
+				// the template is a filename
+				self.nunjucksEnvironment().render(template, templateData, function (err, res) {
+					if (err) {
+						Log.error(err);
+					}
 
-		var div = document.createElement("div");
-		div.appendChild(nameWrapper);
-		div.appendChild(identifierWrapper);
+					div.innerHTML = res;
 
-		return div;
+					resolve(div);
+				});
+			} else {
+				// the template is a template string.
+				div.innerHTML = self.nunjucksEnvironment().renderString(template, templateData);
+
+				resolve(div);
+			}
+		});
 	},
 
-	/* notificationReceived(notification, payload, sender)
-	 * This method is called when a notification arrives.
-	 * This method is called by the Magic Mirror core.
+	/**
+	 * 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 needs to be subclassed if the module wants to display modified headers on the mirror.
 	 *
-	 * argument notification string - The identifier of the noitication.
-	 * argument payload mixed - The payload of the notification.
-	 * argument sender Module - The module that sent the notification.
+	 * @returns {string} The header to display above the header.
 	 */
-	notificationReceived: function(notification, payload, sender) {
+	getHeader: function () {
+		return this.data.header;
+	},
+
+	/**
+	 * Returns the template for the module which is used by the default getDom implementation.
+	 * This method needs to be subclassed if the module wants to use a template.
+	 * It can either return a template sting, or a template filename.
+	 * If the string ends with '.html' it's considered a file from within the module's folder.
+	 *
+	 * @returns {string} The template string of filename.
+	 */
+	getTemplate: function () {
+		return '<div class="normal">' + this.name + '</div><div class="small dimmed">' + this.identifier + "</div>";
+	},
+
+	/**
+	 * Returns the data to be used in the template.
+	 * This method needs to be subclassed if the module wants to use a custom data.
+	 *
+	 * @returns {object} The data for the template
+	 */
+	getTemplateData: function () {
+		return {};
+	},
+
+	/**
+	 * Called by the Magic Mirror core when a notification arrives.
+	 *
+	 * @param {string} notification The identifier of the notification.
+	 * @param {*} payload The payload of the notification.
+	 * @param {Module} sender The module that sent the notification.
+	 */
+	notificationReceived: function (notification, payload, sender) {
 		if (sender) {
-			Log.log(this.name + " received a module notification: " + notification + " from sender: " + sender.name);
+			// Log.log(this.name + " received a module notification: " + notification + " from sender: " + sender.name);
 		} else {
-			Log.log(this.name + " received a system notification: " + notification);
+			// Log.log(this.name + " received a system notification: " + notification);
 		}
 	},
 
-	/* socketNotificationReceived(notification, payload)
-	 * This method is called when a socket notification arrives.
+	/**
+	 * Returns the nunjucks environment for the current module.
+	 * The environment is checked in the _nunjucksEnvironment instance variable.
 	 *
-	 * argument notification string - The identifier of the noitication.
-	 * argument payload mixed - The payload of the notification.
+	 * @returns {object} The Nunjucks Environment
 	 */
-	socketNotificationReceived: function(notification, payload) {
+	nunjucksEnvironment: function () {
+		if (this._nunjucksEnvironment !== null) {
+			return this._nunjucksEnvironment;
+		}
+
+		var self = this;
+
+		this._nunjucksEnvironment = new nunjucks.Environment(new nunjucks.WebLoader(this.file(""), { async: true }), {
+			trimBlocks: true,
+			lstripBlocks: true
+		});
+
+		this._nunjucksEnvironment.addFilter("translate", function (str, variables) {
+			return self.translate(str, variables);
+		});
+
+		return this._nunjucksEnvironment;
+	},
+
+	/**
+	 * Called when a socket notification arrives.
+	 *
+	 * @param {string} notification The identifier of the notification.
+	 * @param {*} payload The payload of the notification.
+	 */
+	socketNotificationReceived: function (notification, payload) {
 		Log.log(this.name + " received a socket notification: " + notification + " - Payload: " + payload);
 	},
 
-	/* suspend()
-	 * This method is called when a module is hidden.
+	/*
+	 * Called when the module is hidden.
 	 */
-	suspend: function() {
+	suspend: function () {
 		Log.log(this.name + " is suspended.");
 	},
 
-	/* resume()
-	 * This method is called when a module is shown.
+	/*
+	 * Called when the module is shown.
 	 */
-	resume: function() {
+	resume: function () {
 		Log.log(this.name + " is resumed.");
 	},
 
@@ -128,118 +210,117 @@ var Module = Class.extend({
 	 * The methods below don"t need subclassing. *
 	 *********************************************/
 
-	/* setData(data)
+	/**
 	 * Set the module data.
 	 *
-	 * argument data obejct - Module data.
+	 * @param {Module} data The module data
 	 */
-	setData: function(data) {
+	setData: function (data) {
 		this.data = data;
 		this.name = data.name;
 		this.identifier = data.identifier;
 		this.hidden = false;
 
-		this.setConfig(data.config);
+		this.setConfig(data.config, data.configDeepMerge);
 	},
 
-	/* setConfig(config)
+	/**
 	 * Set the module config and combine it with the module defaults.
 	 *
-	 * argument config obejct - Module config.
+	 * @param {object} config The combined module config.
+	 * @param {boolean} deep Merge module config in deep.
 	 */
-	setConfig: function(config) {
-		this.config = Object.assign(this.defaults, config);
+	setConfig: function (config, deep) {
+		this.config = deep ? configMerge({}, this.defaults, config) : Object.assign({}, this.defaults, config);
 	},
 
-	/* socket()
-	 * Returns a socket object. If it doesn"t exist, it"s created.
+	/**
+	 * Returns a socket object. If it doesn't exist, it's created.
 	 * It also registers the notification callback.
+	 *
+	 * @returns {MMSocket} a socket object
 	 */
-	socket: function() {
+	socket: function () {
 		if (typeof this._socket === "undefined") {
-			this._socket = this._socket = new MMSocket(this.name);
+			this._socket = new MMSocket(this.name);
 		}
 
 		var self = this;
-		this._socket.setNotificationCallback(function(notification, payload) {
+		this._socket.setNotificationCallback(function (notification, payload) {
 			self.socketNotificationReceived(notification, payload);
 		});
 
 		return this._socket;
 	},
 
-	/* file(file)
+	/**
 	 * Retrieve the path to a module file.
 	 *
-	 * argument file string - Filename.
-	 *
-	 * return string - File path.
+	 * @param {string} file Filename
+	 * @returns {string} the file path
 	 */
-	file: function(file) {
-		return this.data.path + "/" + file;
+	file: function (file) {
+		return (this.data.path + "/" + file).replace("//", "/");
 	},
 
-	/* loadStyles()
+	/**
 	 * Load all required stylesheets by requesting the MM object to load the files.
 	 *
-	 * argument callback function - Function called when done.
+	 * @param {Function} callback Function called when done.
 	 */
-	loadStyles: function(callback) {
-		var self = this;
-		var styles = this.getStyles();
+	loadStyles: function (callback) {
+		this.loadDependencies("getStyles", callback);
+	},
 
-		var loadNextStyle = function() {
-			if (styles.length > 0) {
-				var nextStyle = styles[0];
-				Loader.loadFile(nextStyle, self, function() {
-					styles = styles.slice(1);
-					loadNextStyle();
+	/**
+	 * Load all required scripts by requesting the MM object to load the files.
+	 *
+	 * @param {Function} callback Function called when done.
+	 */
+	loadScripts: function (callback) {
+		this.loadDependencies("getScripts", callback);
+	},
+
+	/**
+	 * Helper method to load all dependencies.
+	 *
+	 * @param {string} funcName Function name to call to get scripts or styles.
+	 * @param {Function} callback Function called when done.
+	 */
+	loadDependencies: function (funcName, callback) {
+		var self = this;
+		var dependencies = this[funcName]();
+
+		var loadNextDependency = function () {
+			if (dependencies.length > 0) {
+				var nextDependency = dependencies[0];
+				Loader.loadFile(nextDependency, self, function () {
+					dependencies = dependencies.slice(1);
+					loadNextDependency();
 				});
 			} else {
 				callback();
 			}
 		};
 
-		loadNextStyle();
+		loadNextDependency();
 	},
 
-	/* loadScripts()
-	 * Load all required scripts by requesting the MM object to load the files.
+	/**
+	 * Load all translations.
 	 *
-	 * argument callback function - Function called when done.
+	 * @param {Function} callback Function called when done.
 	 */
-	loadScripts: function(callback) {
-		var self = this;
-		var scripts = this.getScripts();
-
-		var loadNextScript = function() {
-			if (scripts.length > 0) {
-				var nextScript = scripts[0];
-				Loader.loadFile(nextScript, self, function() {
-					scripts = scripts.slice(1);
-					loadNextScript();
-				});
-			} else {
-				callback();
-			}
-		};
-
-		loadNextScript();
-	},
-
-	/* loadScripts()
-	 * Load all required scripts by requesting the MM object to load the files.
-	 *
-	 * argument callback function - Function called when done.
-	 */
-	loadTranslations: function(callback) {
+	loadTranslations: function (callback) {
 		var self = this;
 		var translations = this.getTranslations();
 		var lang = config.language.toLowerCase();
 
 		// The variable `first` will contain the first
 		// defined translation after the following line.
-		for (var first in translations) {break;}
+		for (var first in translations) {
+			break;
+		}
 
 		if (translations) {
 			var translationFile = translations[lang] || undefined;
@@ -248,7 +329,7 @@ var Module = Class.extend({
 			// If a translation file is set, load it and then also load the fallback translation file.
 			// Otherwise only load the fallback translation file.
 			if (translationFile !== undefined && translationFile !== translationsFallbackFile) {
-				Translator.load(self, translationFile, false, function() {
+				Translator.load(self, translationFile, false, function () {
 					Translator.load(self, translationsFallbackFile, true, callback);
 				});
 			} else {
@@ -259,89 +340,159 @@ var Module = Class.extend({
 		}
 	},
 
- 	/* translate(key, defaultValue)
- 	 * Request the translation for a given key.
- 	 *
- 	 * argument key string - The key of the string to translage
-	 * argument defaultValue string - The default value if no translation was found. (Optional)
- 	 */
-	translate: function(key, defaultValue) {
-		return Translator.translate(this, key) || defaultValue || "";
+	/**
+	 * Request the translation for a given key with optional variables and default value.
+	 *
+	 * @param {string} key The key of the string to translate
+	 * @param {string|object} [defaultValueOrVariables] The default value or variables for translating.
+	 * @param {string} [defaultValue] The default value with variables.
+	 * @returns {string} the translated key
+	 */
+	translate: function (key, defaultValueOrVariables, defaultValue) {
+		if (typeof defaultValueOrVariables === "object") {
+			return Translator.translate(this, key, defaultValueOrVariables) || defaultValue || "";
+		}
+		return Translator.translate(this, key) || defaultValueOrVariables || "";
 	},
 
-	/* updateDom(speed)
+	/**
 	 * Request an (animated) update of the module.
 	 *
-	 * argument speed Number - The speed of the animation. (Optional)
+	 * @param {number} [speed] The speed of the animation.
 	 */
-	updateDom: function(speed) {
+	updateDom: function (speed) {
 		MM.updateDom(this, speed);
 	},
 
-	/* sendNotification(notification, payload)
+	/**
 	 * Send a notification to all modules.
 	 *
-	 * argument notification string - The identifier of the noitication.
-	 * argument payload mixed - The payload of the notification.
+	 * @param {string} notification The identifier of the notification.
+	 * @param {*} payload The payload of the notification.
 	 */
-	sendNotification: function(notification, payload) {
+	sendNotification: function (notification, payload) {
 		MM.sendNotification(notification, payload, this);
 	},
 
-	/* sendSocketNotification(notification, payload)
+	/**
 	 * Send a socket notification to the node helper.
 	 *
-	 * argument notification string - The identifier of the noitication.
-	 * argument payload mixed - The payload of the notification.
+	 * @param {string} notification The identifier of the notification.
+	 * @param {*} payload The payload of the notification.
 	 */
-	sendSocketNotification: function(notification, payload) {
+	sendSocketNotification: function (notification, payload) {
 		this.socket().sendNotification(notification, payload);
 	},
 
-	/* hideModule(module, speed, callback)
+	/**
 	 * Hide this module.
 	 *
-	 * argument speed Number - The speed of the hide animation.
-	 * argument callback function - Called when the animation is done.
+	 * @param {number} speed The speed of the hide animation.
+	 * @param {Function} callback Called when the animation is done.
+	 * @param {object} [options] Optional settings for the hide method.
 	 */
-	hide: function(speed, callback) {
-		callback = callback || function() {};
+	hide: function (speed, callback, options) {
+		if (typeof callback === "object") {
+			options = callback;
+			callback = function () {};
+		}
+
+		callback = callback || function () {};
+		options = options || {};
 
 		var self = this;
-		MM.hideModule(self, speed, function() {
-			self.suspend();
-			callback();
-		});
+		MM.hideModule(
+			self,
+			speed,
+			function () {
+				self.suspend();
+				callback();
+			},
+			options
+		);
 	},
 
-	/* showModule(module, speed, callback)
+	/**
 	 * Show this module.
 	 *
-	 * argument speed Number - The speed of the show animation.
-	 * argument callback function - Called when the animation is done.
+	 * @param {number} speed The speed of the show animation.
+	 * @param {Function} callback Called when the animation is done.
+	 * @param {object} [options] Optional settings for the show method.
 	 */
-	show: function(speed, callback) {
-		this.resume();
-		MM.showModule(this, speed, callback);
+	show: function (speed, callback, options) {
+		if (typeof callback === "object") {
+			options = callback;
+			callback = function () {};
+		}
+
+		callback = callback || function () {};
+		options = options || {};
+
+		var self = this;
+		MM.showModule(
+			this,
+			speed,
+			function () {
+				self.resume();
+				callback();
+			},
+			options
+		);
 	}
 });
 
+/**
+ * Merging MagicMirror (or other) default/config script by @bugsounet
+ * Merge 2 objects or/with array
+ *
+ * Usage:
+ * -------
+ * this.config = configMerge({}, this.defaults, this.config)
+ * -------
+ * arg1: initial object
+ * arg2: config model
+ * arg3: config to merge
+ * -------
+ * why using it ?
+ * Object.assign() function don't to all job
+ * it don't merge all thing in deep
+ * -> object in object and array is not merging
+ * -------
+ *
+ * Todo: idea of Mich determinate what do you want to merge or not
+ *
+ * @param {object} result the initial object
+ * @returns {object} the merged config
+ */
+function configMerge(result) {
+	var stack = Array.prototype.slice.call(arguments, 1);
+	var item;
+	var key;
+	while (stack.length) {
+		item = stack.shift();
+		for (key in item) {
+			if (item.hasOwnProperty(key)) {
+				if (typeof result[key] === "object" && result[key] && Object.prototype.toString.call(result[key]) !== "[object Array]") {
+					if (typeof item[key] === "object" && item[key] !== null) {
+						result[key] = configMerge({}, result[key], item[key]);
+					} else {
+						result[key] = item[key];
+					}
+				} else {
+					result[key] = item[key];
+				}
+			}
+		}
+	}
+	return result;
+}
+
 Module.definitions = {};
 
-Module.create = function(name) {
-
-	//Define the clone method for later use.
-	function cloneObject(obj) {
-		if (obj === null || typeof obj !== "object") {
-			return obj;
-		}
-
-		var temp = obj.constructor(); // give temp the original obj"s constructor
-		for (var key in obj) {
-			temp[key] = cloneObject(obj[key]);
-		}
-
-		return temp;
+Module.create = function (name) {
+	// Make sure module definition is available.
+	if (!Module.definitions[name]) {
+		return;
 	}
 
 	var moduleDefinition = Module.definitions[name];
@@ -351,10 +502,42 @@ Module.create = function(name) {
 	var ModuleClass = Module.extend(clonedDefinition);
 
 	return new ModuleClass();
-
 };
 
-Module.register = function(name, moduleDefinition) {
+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("Version is ok!");
+		} else {
+			Log.warn("Version is incorrect. Skip module: '" + name + "'");
+			return;
+		}
+	}
 	Log.log("Module registered: " + name);
 	Module.definitions[name] = moduleDefinition;
 };
+
+/**
+ * Compare two semantic version numbers and return the difference.
+ *
+ * @param {string} a Version number a.
+ * @param {string} b Version number b.
+ * @returns {number} A positive number if a is larger than b, a negative
+ * number if a is smaller and 0 if they are the same
+ */
+function cmpVersions(a, b) {
+	var i, diff;
+	var regExStrip0 = /(\.0+)+$/;
+	var segmentsA = a.replace(regExStrip0, "").split(".");
+	var segmentsB = b.replace(regExStrip0, "").split(".");
+	var l = Math.min(segmentsA.length, segmentsB.length);
+
+	for (i = 0; i < l; i++) {
+		diff = parseInt(segmentsA[i], 10) - parseInt(segmentsB[i], 10);
+		if (diff) {
+			return diff;
+		}
+	}
+	return segmentsA.length - segmentsB.length;
+}

js/node_helper.js

@@ -0,0 +1,126 @@
+/* Magic Mirror
+ * Node Helper Superclass
+ *
+ * By Michael Teeuw https://michaelteeuw.nl
+ * MIT Licensed.
+ */
+const Class = require("./class.js");
+const Log = require("./logger.js");
+const express = require("express");
+
+var NodeHelper = Class.extend({
+	init: function () {
+		Log.log("Initializing new module helper ...");
+	},
+
+	loaded: function (callback) {
+		Log.log("Module helper loaded: " + this.name);
+		callback();
+	},
+
+	start: function () {
+		Log.log("Starting module helper: " + this.name);
+	},
+
+	/* stop()
+	 * Called when the MagicMirror server receives a `SIGINT`
+	 * Close any open connections, stop any sub-processes and
+	 * gracefully exit the module.
+	 *
+	 */
+	stop: function () {
+		Log.log("Stopping module helper: " + this.name);
+	},
+
+	/* socketNotificationReceived(notification, payload)
+	 * This method is called when a socket notification arrives.
+	 *
+	 * argument notification string - The identifier of the notification.
+	 * argument payload mixed - The payload of the notification.
+	 */
+	socketNotificationReceived: function (notification, payload) {
+		Log.log(this.name + " received a socket notification: " + notification + " - Payload: " + payload);
+	},
+
+	/* setName(name)
+	 * Set the module name.
+	 *
+	 * argument name string - Module name.
+	 */
+	setName: function (name) {
+		this.name = name;
+	},
+
+	/* setPath(path)
+	 * Set the module path.
+	 *
+	 * argument path string - Module path.
+	 */
+	setPath: function (path) {
+		this.path = path;
+	},
+
+	/* sendSocketNotification(notification, payload)
+	 * Send a socket notification to the node helper.
+	 *
+	 * argument notification string - The identifier of the notification.
+	 * argument payload mixed - The payload of the notification.
+	 */
+	sendSocketNotification: function (notification, payload) {
+		this.io.of(this.name).emit(notification, payload);
+	},
+
+	/* setExpressApp(app)
+	 * Sets the express app object for this module.
+	 * This allows you to host files from the created webserver.
+	 *
+	 * argument app Express app - The Express app object.
+	 */
+	setExpressApp: function (app) {
+		this.expressApp = app;
+
+		var publicPath = this.path + "/public";
+		app.use("/" + this.name, express.static(publicPath));
+	},
+
+	/* setSocketIO(io)
+	 * Sets the socket io object for this module.
+	 * Binds message receiver.
+	 *
+	 * argument io Socket.io - The Socket io object.
+	 */
+	setSocketIO: function (io) {
+		var self = this;
+		self.io = io;
+
+		Log.log("Connecting socket for: " + this.name);
+		var namespace = this.name;
+		io.of(namespace).on("connection", function (socket) {
+			// add a catch all event.
+			var onevent = socket.onevent;
+			socket.onevent = function (packet) {
+				var args = packet.data || [];
+				onevent.call(this, packet); // original call
+				packet.data = ["*"].concat(args);
+				onevent.call(this, packet); // additional call to catch-all
+			};
+
+			// register catch all.
+			socket.on("*", function (notification, payload) {
+				if (notification !== "*") {
+					//Log.log('received message in namespace: ' + namespace);
+					self.socketNotificationReceived(notification, payload);
+				}
+			});
+		});
+	}
+});
+
+NodeHelper.create = function (moduleDefinition) {
+	return NodeHelper.extend(moduleDefinition);
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {
+	module.exports = NodeHelper;
+}

js/server.js

@@ -1,30 +1,83 @@
 /* Magic Mirror
  * Server
  *
- * By Michael Teeuw http://michaelteeuw.nl
+ * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  */
-
 var express = require("express");
 var app = require("express")();
-var server = require("http").Server(app);
-var io = require("socket.io")(server);
 var path = require("path");
+var ipfilter = require("express-ipfilter").IpFilter;
+var fs = require("fs");
+var helmet = require("helmet");
 
-var Server = function(config, callback) {
-	console.log("Starting server op port " + config.port + " ... ");
+var Log = require("./logger.js");
+var Utils = require("./utils.js");
+
+var Server = function (config, callback) {
+	var port = config.port;
+	if (process.env.MM_PORT) {
+		port = process.env.MM_PORT;
+	}
+
+	var server = null;
+	if (config.useHttps) {
+		var options = {
+			key: fs.readFileSync(config.httpsPrivateKey),
+			cert: fs.readFileSync(config.httpsCertificate)
+		};
+		server = require("https").Server(options, app);
+	} else {
+		server = require("http").Server(app);
+	}
+	var io = require("socket.io")(server);
+
+	Log.log("Starting server on port " + port + " ... ");
+
+	server.listen(port, config.address ? config.address : "localhost");
+
+	if (config.ipWhitelist instanceof Array && config.ipWhitelist.length === 0) {
+		Log.warn(Utils.colors.warn("You're using a full whitelist configuration to allow for all IPs"));
+	}
+
+	app.use(function (req, res, next) {
+		var result = ipfilter(config.ipWhitelist, { mode: config.ipWhitelist.length === 0 ? "deny" : "allow", log: false })(req, res, function (err) {
+			if (err === undefined) {
+				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 }));
 
-	server.listen(config.port);
 	app.use("/js", express.static(__dirname));
-	app.use("/config", express.static(path.resolve(__dirname + "/../config")));
-	app.use("/css", express.static(path.resolve(__dirname + "/../css")));
-	app.use("/fonts", express.static(path.resolve(__dirname + "/../fonts")));
-	app.use("/modules", express.static(path.resolve(__dirname + "/../modules")));
-	app.use("/vendor", express.static(path.resolve(__dirname + "/../vendor")));
-	app.use("/translations", express.static(path.resolve(__dirname + "/../translations")));
+	var directories = ["/config", "/css", "/fonts", "/modules", "/vendor", "/translations", "/tests/configs"];
+	var directory;
+	for (var i in directories) {
+		directory = directories[i];
+		app.use(directory, express.static(path.resolve(global.root_path + directory)));
+	}
 
-	app.get("/", function(req, res) {
-		res.sendFile(path.resolve(__dirname + "/../index.html"));
+	app.get("/version", function (req, res) {
+		res.send(global.version);
+	});
+
+	app.get("/config", function (req, res) {
+		res.send(config);
+	});
+
+	app.get("/", function (req, res) {
+		var html = fs.readFileSync(path.resolve(global.root_path + "/index.html"), { encoding: "utf8" });
+		html = html.replace("#VERSION#", global.version);
+
+		var configFile = "config/config.js";
+		if (typeof global.configuration_file !== "undefined") {
+			configFile = global.configuration_file;
+		}
+		html = html.replace("#CONFIG_FILE#", configFile);
+
+		res.send(html);
 	});
 
 	if (typeof callback === "function") {

js/socket.js

@@ -1,35 +0,0 @@
-/* exported Log */
-
-/* Magic Mirror
- * Socket Connection
- *
- * By Michael Teeuw http://michaelteeuw.nl
- * MIT Licensed.
- */
-
-var MMSocket = function(moduleName) {
-
-	var self = this;
-
-	if (typeof moduleName !== "string") {
-		throw new Error("Please set the module name for the MMSocket.");
-	}
-
-	self.moduleName = moduleName;
-
-	self.socket = io("http://localhost:8080");
-	self.socket.on("notification", function(data) {
-		MM.sendNotification(data.notification, data.payload, Socket);
-	});
-
-	return {
-		sendMessage: function(notification, payload, sender) {
-			Log.log("Send socket message: " + notification);
-			self.socket.emit("notification", {
-				notification: notification,
-				sender: sender,
-				payload: payload
-			});
-		}
-	};
-};