Merge pull request #1968 from MichMich/develop

Release 2.11.0

Author: MichMich

.eslintrc.json

@@ -7,6 +7,7 @@
 		"curly": "error",
 		"camelcase": ["error", {"properties": "never"}],
         "no-multiple-empty-lines": ["error", { "max": 1, "maxEOF": 1 }],
+		"no-multi-spaces": "error",
 		"no-trailing-spaces": ["error", {"ignoreComments": false }],
 		"no-irregular-whitespace": ["error"]
 	},

.github/ISSUE_TEMPLATE.md

@@ -1,15 +1,28 @@
-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](https://forum.magicmirror.builders/category/15/bug-hunt)
+
+## I'm having troubles installing or configuring MagicMirror
 Problems installing or configuring your MagicMirror? Check out: [https://forum.magicmirror.builders/category/10/troubleshooting](https://forum.magicmirror.builders/category/10/troubleshooting)
 
+## I found a bug in the MagicMirror installer
+If you are facing an issue or found a bug while trying to install MagicMirror via the installer please report it in the respective GitHub repository:
+[https://github.com/sdetweil/MagicMirror_scripts](https://github.com/sdetweil/MagicMirror_scripts)
+
+## I found a bug in the MagicMirror Docker image
+If you are facing an issue or found a bug while running MagicMirror inside a Docker container please create an issue in the GitHub repository of the MagicMirror Docker image:
+[https://github.com/bastilimbach/docker-MagicMirror](https://github.com/bastilimbach/docker-MagicMirror)
+
+---
+
+## I found a bug in MagicMirror
+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 0.12.13 or later.
+**Node Version**: Make sure it's version 8 or later.
 
-**MagicMirror Version**: Now that the versions have split, tell us if you are using the PHP version (v1) or the newer JavaScript version (v2).
+**MagicMirror Version**: Please let us 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.
 

.travis.yml

@@ -1,21 +1,24 @@
 dist: trusty
 language: node_js
 node_js:
- - "10"
+  - 10
+  - lts/*
+  - node
 before_install:
   - npm i -g npm
 before_script:
- - yarn danger ci
- - npm install grunt-cli -g
- - "export DISPLAY=:99.0"
- - "sh -e /etc/init.d/xvfb start"
- - sleep 5
+  - yarn danger ci
+  - npm install grunt-cli -g
+  - "export DISPLAY=:99.0"
+  - "export ELECTRON_DISABLE_SANDBOX=1"
+  - "sh -e /etc/init.d/xvfb start"
+  - sleep 5
 script:
-- npm run test:e2e
-- npm run test:unit
-- grunt
+  - npm run test:lint
+  - npm run test:e2e
+  - npm run test:unit
 after_script:
- - npm list
+  - npm list
 cache:
- directories:
-  - node_modules
+  directories:
+    - node_modules

CHANGELOG.md

@@ -3,7 +3,54 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-❤️ **Donate:** Enjoying MagicMirror²? [Please consider a donation!](https://magicmirror.builders/donate) With your help we can continue to improve the MagicMirror² core.
+❤️ **Donate:** Enjoying MagicMirror²? [Please consider a donation!](https://magicmirror.builders/donate) With your help we can continue to improve the MagicMirror²
+
+## [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
+
+### 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.
 
 ## [2.10.1] - 2020-01-10
 
@@ -12,6 +59,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [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
@@ -32,9 +81,9 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - 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
+- 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
 
@@ -541,7 +590,7 @@ A huge, huge, huge thanks to user @fewieden for all his hard work on the new `we
 - 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 abilty set the classes option to compliments module for style and text size of compliments.
+- 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

Gruntfile.js

@@ -1,10 +1,10 @@
 module.exports = function(grunt) {
 	require("time-grunt")(grunt);
+	var fix = (grunt.option("env") || "lint") === "lint";
 	grunt.initConfig({
-		pkg: grunt.file.readJSON("package.json"),
 		eslint: {
 			options: {
-				fix: "true",
+				fix: fix,
 				configFile: ".eslintrc.json"
 			},
 			target: [
@@ -20,13 +20,13 @@ module.exports = function(grunt) {
 				"!modules/default/alert/classie.js",
 				"config/*",
 				"translations/translations.js",
-				"vendor/vendor.js",
-				"modules/node_modules/node_helper/index.js"
+				"vendor/vendor.js"
 			]
 		},
 		stylelint: {
 			simple: {
 				options: {
+					fix: fix,
 					configFile: ".stylelintrc.json"
 				},
 				src: [
@@ -44,7 +44,6 @@ module.exports = function(grunt) {
 					"package.json",
 					".eslintrc.json",
 					".stylelintrc.json",
-					"installers/pm2_MagicMirror.json",
 					"translations/*.json",
 					"modules/default/*/translations/*.json",
 					"vendor/package.json"
@@ -77,7 +76,8 @@ module.exports = function(grunt) {
 						"MD018": false,
 						"MD012": false,
 						"MD026": false,
-						"MD038": false
+						"MD038": false,
+						"MD047": false
 					}
 				},
 				src: [
@@ -101,5 +101,6 @@ module.exports = function(grunt) {
 	grunt.loadNpmTasks("grunt-jsonlint");
 	grunt.loadNpmTasks("grunt-yamllint");
 	grunt.loadNpmTasks("grunt-markdownlint");
+
 	grunt.registerTask("default", ["eslint", "stylelint", "jsonlint", "markdownlint", "yamllint"]);
 };

clientonly/index.js

@@ -1,5 +1,3 @@
-/* jshint esversion: 6 */
-
 "use strict";
 
 // Use separate scope to prevent global scope pollution

config/config.js.sample

@@ -3,7 +3,7 @@
  * By Michael Teeuw http://michaelteeuw.nl
  * MIT Licensed.
  *
- * For more information how you can configurate this file
+ * For more information on how you can configure this file
  * See https://github.com/MichMich/MagicMirror#configuration
  *
  */
@@ -12,24 +12,28 @@ 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, is "localhost"
+	                      // - "0.0.0.0", "::" to listen on any interface
+	                      // Default, when address config is left out or empty, is "localhost"
 	port: 8080,
 	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"],
 
+	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",
 	timeFormat: 24,
 	units: "metric",
 	// serverOnly:  true/false/"local" ,
-			     // local for armv6l processors, default 
+			     // 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",
@@ -63,7 +67,7 @@ var config = {
 			position: "top_right",
 			config: {
 				location: "New York",
-				locationID: "",  //ID from http://bulk.openweathermap.org/sample/city.list.json.gz; unzip the gz file and find your city
+				locationID: "", //ID from http://bulk.openweathermap.org/sample/city.list.json.gz; unzip the gz file and find your city
 				appid: "YOUR_OPENWEATHER_API_KEY"
 			}
 		},
@@ -73,7 +77,7 @@ var config = {
 			header: "Weather Forecast",
 			config: {
 				location: "New York",
-				locationID: "5128581",  //ID from http://bulk.openweathermap.org/sample/city.list.json.gz; unzip the gz file and find your city
+				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"
 			}
 		},

index.html

@@ -37,7 +37,7 @@
 		<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_FILE#"></script>