Merge pull request #2672 from MichMich/develop

Release 2.17.0

Author: MichMich

.eslintrc.json

@@ -25,6 +25,7 @@
 		"prettier/prettier": "error",
 		"eqeqeq": "error",
 		"no-prototype-builtins": "off",
-		"no-unused-vars": "off"
+		"no-unused-vars": "off",
+		"no-useless-return": "error"
 	}
 }

.github/CONTRIBUTING.md

@@ -18,7 +18,7 @@ To run ESLint, use `npm run lint:js`.
 
 We use [StyleLint](https://stylelint.io) to lint our CSS. Our configuration is in our .stylelintrc file.
 
-To run StyleLint, use `npm run lint:style`.
+To run StyleLint, use `npm run lint:css`.
 
 ### Submitting Issues
 
@@ -32,9 +32,9 @@ When submitting a new issue, please supply the following information:
 
 **Platform**: Place your platform here... give us your web browser/Electron version _and_ your hardware (Raspberry Pi 2/3/4, Windows, Mac, Linux, System V UNIX).
 
-**Node Version**: Make sure it's version 10 or later.
+**Node Version**: Make sure it's version 12 or later (recommended is 14).
 
-**MagicMirror Version**: Now that the versions have split, tell us if you are using the PHP version (v1) or the newer JavaScript version (v2).
+**MagicMirror Version**: Please let us know which version of MagicMirror you are running. It can be found in the `package.json` file.
 
 **Description**: Provide a detailed description about the issue and include specific details to help us understand the problem. Adding screenshots will help describing the problem.
 

.github/FUNDING.yml

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

.github/ISSUE_TEMPLATE.md

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

.github/PULL_REQUEST_TEMPLATE.md

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

.github/header.psd

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

.github/workflows/automated-tests.yml

@@ -4,22 +4,26 @@ name: "Run Codecov Tests"
 
 on:
   push:
-    branches: [ master, develop ]
+    branches: [master, develop]
   pull_request:
-    branches: [ master, develop ]
+    branches: [master, develop]
 
 jobs:
   run-and-upload-coverage-report:
     runs-on: ubuntu-latest
     timeout-minutes: 30
     steps:
-      - uses: actions/checkout@v2
-      - run: |
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Install dependencies and run coverage
+        run: |
           Xvfb :99 -screen 0 1024x768x16 &
           export DISPLAY=:99
           npm ci
+          touch css/custom.css
           npm run test:coverage
-      - uses: codecov/codecov-action@v1
+      - name: Upload coverage results to codecov
+        uses: codecov/codecov-action@v1
         with:
           file: ./coverage/lcov.info
           fail_ci_if_error: true

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

@@ -4,15 +4,17 @@ name: "Enforce Changelog"
 
 on:
   pull_request:
-      types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled]
+    types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled]
 
 jobs:
   check:
     runs-on: ubuntu-latest
     timeout-minutes: 10
     steps:
-    - uses: actions/checkout@v2
-    - uses: dangoslen/[email protected]
-      with:
-        changeLogPath: 'CHANGELOG.md'
-        skipLabels: 'Skip Changelog'
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Enforce changelog️
+        uses: dangoslen/[email protected]
+        with:
+          changeLogPath: "CHANGELOG.md"
+          skipLabels: "Skip Changelog"