Skip to content

Commit abe5c08

Browse files
MichMichMichMich
authored
Release 2.23.0 (#3078)
## [2.23.0] - 2023-04-04 Thanks to: @angeldeejay, @buxxi, @CarJem, @dariom, @DaveChild, @dWoolridge, @grenagit, @Hirschberger, @KristjanESPERANTO, @MagMar94, @naveensrinivasan, @nfogal, @psieg, @rajniszp, @retroflex, @SkySails and @tomzt. Special thanks to @khassel, @rejas and @sdetweil for taking over most (if not all) of the work on this release as project collaborators. This version would not be there without their effort. Thank you guys! You are awesome! ### Added - Added increments for hourly forecasts in weather module (#2996) - Added tests for hourly weather forecast - Added possibility to ignore MagicMirror repo in updatenotification module - Added Pirate Weather as new weather provider (#3005) - Added possibility to use your own templates in Alert module - Added error message if `<modulename>.js` file is missing in module folder to get a hint in the logs (#2403) - Added possibility to use environment variables in `config.js` (#1756) - Added option `pastDaysCount` to default calendar module to control of how many days past events should be displayed - Added thai language to alert module - Added option `sendNotifications` in clock module (#3056) ### Removed - Removed darksky weather provider - Removed unneeded (and unwanted) '.' after the year in calendar repeatingCountTitle (#2896) ### Updated - Use develop as target branch for dependabot - Update issue template, contributing doc and sample config - The weather modules clearly separates precipitation amount and probability (risk of rain/snow) - This requires all providers that only supports probability to change the config from `showPrecipitationAmount` to `showPrecipitationProbability`. - Update tests for weather and calendar module - Changed updatenotification module for MagicMirror repo only: Send only notifications for `master` if there is a tag on a newer commit - Update dates in Calendar widgets every minute - Cleanup jest coverage for patches - Update `stylelint` dependencies, switch to `stylelint-config-standard` and handle `stylelint` issues, update `main.css` matching new rules - Update Eslint config, add new rule and handle issue - Convert lots of callbacks to async/await - Revise require imports (#3071 and #3072) ### Fixed - Fix wrong day labels in envcanada forecast (#2987) - Fix for missing default class name prefix for customEvents in calendar - Fix electron flashing white screen on startup (#1919) - Fix weathergov provider hourly forecast (#3008) - Fix message display with HTML code into alert module (#2828) - Fix typo in french translation - Yr wind direction is no longer inverted - Fix async node_helper stopping electron start (#2487) - The wind direction arrow now points in the direction the wind is flowing, not into the wind (#3019) - Fix precipitation css styles and rounding value - Fix wrong vertical alignment of calendar title column when wrapEvents is true (#3053) - Fix empty news feed stopping the reload forever - Fix e2e tests (failed after async changes) by running calendar and newsfeed tests last - Lint: Use template literals instead of string concatenation - Fix default alert module to render HTML for title and message - Fix Open-Meteo wind speed units
1 parent f14e956 commit abe5c08

File tree

162 files changed

+6642
-3042
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

162 files changed

+6642
-3042
lines changed

‎.eslintrc.json

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
22
"extends": ["eslint:recommended", "plugin:prettier/recommended", "plugin:jsdoc/recommended"],
3-
"plugins": ["prettier", "jsdoc", "jest"],
3+
"plugins": ["prettier", "import", "jsdoc", "jest"],
44
"env": {
55
"browser": true,
6-
"es6": true,
6+
"es2022": true,
77
"jest/globals": true,
88
"node": true
99
},
@@ -16,16 +16,18 @@
1616
},
1717
"parserOptions": {
1818
"sourceType": "module",
19-
"ecmaVersion": 2020,
19+
"ecmaVersion": 2022,
2020
"ecmaFeatures": {
2121
"globalReturn": true
2222
}
2323
},
2424
"rules": {
25-
"prettier/prettier": "error",
2625
"eqeqeq": "error",
26+
"import/order": "error",
2727
"no-prototype-builtins": "off",
28+
"no-throw-literal": "error",
2829
"no-unused-vars": "off",
29-
"no-useless-return": "error"
30+
"no-useless-return": "error",
31+
"prefer-template": "error"
3032
}
3133
}

‎.github/CONTRIBUTING.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ We hold our code to standard, and these standards are documented below.
66

77
## Linters
88

9-
If you wish to run our linters, use `npm run lint` without any arguments.
9+
We use prettier for automatic linting of all our files: `npm run lint:prettier`.
1010

1111
### JavaScript: Run ESLint
1212

@@ -18,7 +18,7 @@ To run ESLint, use `npm run lint:js`.
1818

1919
### CSS: Run StyleLint
2020

21-
We use [StyleLint](https://stylelint.io) to lint our CSS. Our configuration is in our .stylelintrc file.
21+
We use [StyleLint](https://stylelint.io) to lint our CSS. Our configuration is in our `.stylelintrc` file.
2222

2323
To run StyleLint, use `npm run lint:css`.
2424

@@ -28,7 +28,8 @@ We use [Jest](https://jestjs.io) for JavaScript testing.
2828

2929
To run all tests, use `npm run test`.
3030

31-
The specific test commands are defined in `package.json`. So you can also run the specific tests with other commands, e.g. `npm run test:unit` or `npx jest tests/e2e/env_spec.js`.
31+
The specific test commands are defined in `package.json`.
32+
So you can also run the specific tests with other commands, e.g. `npm run test:unit` or `npx jest tests/e2e/env_spec.js`.
3233

3334
## Submitting Issues
3435

‎.github/ISSUE_TEMPLATE.md ‎.github/ISSUE_TEMPLATE/custom.md

File renamed without changes.

‎.github/codecov.yaml

+4
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,7 @@ coverage:
44
default:
55
# advanced settings
66
informational: true
7+
patch:
8+
default:
9+
threshold: 0%
10+
target: 0

‎.github/dependabot.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@ updates:
44
directory: "/"
55
schedule:
66
interval: "weekly"
7+
target-branch: "develop"

‎.github/workflows/automated-tests.yaml

+3-3
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,14 @@ jobs:
2020
matrix:
2121
node-version: [14.x, 16.x, 18.x]
2222
steps:
23-
- name: Checkout code
23+
- name: "Checkout code"
2424
uses: actions/checkout@v3
25-
- name: Use Node.js ${{ matrix.node-version }}
25+
- name: "Use Node.js ${{ matrix.node-version }}"
2626
uses: actions/setup-node@v3
2727
with:
2828
node-version: ${{ matrix.node-version }}
2929
cache: "npm"
30-
- name: Install dependencies and run tests
30+
- name: "Install dependencies and run tests"
3131
run: |
3232
Xvfb :99 -screen 0 1024x768x16 &
3333
export DISPLAY=:99

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,16 @@ jobs:
1717
runs-on: ubuntu-latest
1818
timeout-minutes: 30
1919
steps:
20-
- name: Checkout code
20+
- name: "Checkout code"
2121
uses: actions/checkout@v3
22-
- name: Install dependencies and run coverage
22+
- name: "Install dependencies and run coverage"
2323
run: |
2424
Xvfb :99 -screen 0 1024x768x16 &
2525
export DISPLAY=:99
2626
npm ci
2727
touch css/custom.css
2828
npm run test:coverage
29-
- name: Upload coverage results to codecov
29+
- name: "Upload coverage results to codecov"
3030
uses: codecov/codecov-action@v3
3131
with:
3232
files: ./coverage/lcov.info

‎.github/workflows/depsreview.yaml

+7-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
name: "Dependency Review"
1+
# This workflow scans your pull requests for dependency changes, and will raise an error if any vulnerabilities or invalid licenses are being introduced.
2+
# For more information see: https://github.com/actions/dependency-review-action
3+
4+
name: "Review Dependencies"
5+
26
on: [pull_request]
37

48
permissions:
@@ -8,7 +12,7 @@ jobs:
812
dependency-review:
913
runs-on: ubuntu-latest
1014
steps:
11-
- name: "Checkout Repository"
15+
- name: "Checkout code"
1216
uses: actions/checkout@v3
1317
- name: "Dependency Review"
14-
uses: actions/dependency-review-action@v2
18+
uses: actions/dependency-review-action@v3

‎.github/workflows/enforce-changelog.yaml

-19
This file was deleted.

‎.github/workflows/enforce-pullrequest-rules.yaml

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# This workflow enforces on every pull request:
2+
# - the update of our CHANGELOG.md file, see: https://github.com/dangoslen/changelog-enforcer
3+
# - that the PR is not based against master, taken from https://github.com/oppia/oppia-android/pull/2832/files
4+
5+
name: "Enforce Pull-Request Rules"
6+
7+
on:
8+
pull_request:
9+
types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled]
10+
11+
jobs:
12+
check:
13+
runs-on: ubuntu-latest
14+
timeout-minutes: 10
15+
steps:
16+
- name: "Enforce changelog"
17+
uses: dangoslen/changelog-enforcer@v3
18+
with:
19+
changeLogPath: "CHANGELOG.md"
20+
skipLabels: "Skip Changelog"
21+
- name: "Enforce develop branch"
22+
if: ${{ github.base_ref == 'master' && !contains(github.event.pull_request.labels.*.name, 'mastermerge') }}
23+
run: |
24+
echo "This PR is based against the master branch and not a release or hotfix."
25+
echo "Please don't do this. Switch the branch to 'develop'."
26+
exit 1
27+
env:
28+
BASE_BRANCH: ${{ github.base_ref }}

‎.stylelintrc.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"extends": ["stylelint-prettier/recommended"],
2+
"extends": ["stylelint-config-standard"],
33
"plugins": ["stylelint-prettier"],
44
"rules": {
55
"prettier/prettier": true

‎CHANGELOG.md

+62-2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,64 @@ This project adheres to [Semantic Versioning](https://semver.org/).
55

66
❤️ **Donate:** Enjoying MagicMirror²? [Please consider a donation!](https://magicmirror.builders/donate) With your help we can continue to improve the MagicMirror².
77

8+
## [2.23.0] - 2023-04-04
9+
10+
Thanks to: @angeldeejay, @buxxi, @CarJem, @dariom, @DaveChild, @dWoolridge, @grenagit, @Hirschberger, @KristjanESPERANTO, @MagMar94, @naveensrinivasan, @nfogal, @psieg, @rajniszp, @retroflex, @SkySails and @tomzt.
11+
12+
Special thanks to @khassel, @rejas and @sdetweil for taking over most (if not all) of the work on this release as project collaborators. This version would not be there without their effort. Thank you guys! You are awesome!
13+
14+
### Added
15+
16+
- Added increments for hourly forecasts in weather module (#2996)
17+
- Added tests for hourly weather forecast
18+
- Added possibility to ignore MagicMirror repo in updatenotification module
19+
- Added Pirate Weather as new weather provider (#3005)
20+
- Added possibility to use your own templates in Alert module
21+
- Added error message if `<modulename>.js` file is missing in module folder to get a hint in the logs (#2403)
22+
- Added possibility to use environment variables in `config.js` (#1756)
23+
- Added option `pastDaysCount` to default calendar module to control of how many days past events should be displayed
24+
- Added thai language to alert module
25+
- Added option `sendNotifications` in clock module (#3056)
26+
27+
### Removed
28+
29+
- Removed darksky weather provider
30+
- Removed unneeded (and unwanted) '.' after the year in calendar repeatingCountTitle (#2896)
31+
32+
### Updated
33+
34+
- Use develop as target branch for dependabot
35+
- Update issue template, contributing doc and sample config
36+
- The weather modules clearly separates precipitation amount and probability (risk of rain/snow)
37+
- This requires all providers that only supports probability to change the config from `showPrecipitationAmount` to `showPrecipitationProbability`.
38+
- Update tests for weather and calendar module
39+
- Changed updatenotification module for MagicMirror repo only: Send only notifications for `master` if there is a tag on a newer commit
40+
- Update dates in Calendar widgets every minute
41+
- Cleanup jest coverage for patches
42+
- Update `stylelint` dependencies, switch to `stylelint-config-standard` and handle `stylelint` issues, update `main.css` matching new rules
43+
- Update Eslint config, add new rule and handle issue
44+
- Convert lots of callbacks to async/await
45+
- Revise require imports (#3071 and #3072)
46+
47+
### Fixed
48+
49+
- Fix wrong day labels in envcanada forecast (#2987)
50+
- Fix for missing default class name prefix for customEvents in calendar
51+
- Fix electron flashing white screen on startup (#1919)
52+
- Fix weathergov provider hourly forecast (#3008)
53+
- Fix message display with HTML code into alert module (#2828)
54+
- Fix typo in french translation
55+
- Yr wind direction is no longer inverted
56+
- Fix async node_helper stopping electron start (#2487)
57+
- The wind direction arrow now points in the direction the wind is flowing, not into the wind (#3019)
58+
- Fix precipitation css styles and rounding value
59+
- Fix wrong vertical alignment of calendar title column when wrapEvents is true (#3053)
60+
- Fix empty news feed stopping the reload forever
61+
- Fix e2e tests (failed after async changes) by running calendar and newsfeed tests last
62+
- Lint: Use template literals instead of string concatenation
63+
- Fix default alert module to render HTML for title and message
64+
- Fix Open-Meteo wind speed units
65+
866
## [2.22.0] - 2023-01-01
967

1068
Thanks to: @angeldeejay, @buxxi, @dariom, @dWoolridge, @KristjanESPERANTO, @MagMar94, @naveensrinivasan, @retroflex, @SkySails and @Tom.
@@ -13,20 +71,22 @@ Special thanks to @khassel, @rejas and @sdetweil for taking over most (if not al
1371

1472
### Added
1573

74+
- Added new calendar options for colored entries and improved styling (#3033)
1675
- Added test for remoteFile option in compliments module
1776
- Added hourlyWeather functionality to Weather.gov weather provider
18-
- Removed weatherEndpoint definition from weathergov.js (not used)
1977
- Added css class names "today" and "tomorrow" for default calendar
2078
- Added Collaboration.md
2179
- Added new github action for dependency review (#2862)
2280
- Added a WeatherProvider for Open-Meteo
2381
- Added Yr as a weather provider
2482
- Added config options "ignoreXOriginHeader" and "ignoreContentSecurityPolicy"
2583
- Added thai language
84+
- Added workflow rule to make sure PRs are based against develop
2685

2786
### Removed
2887

2988
- Removed usage of internal fetch function of node until it is more stable
89+
- Removed weatherEndpoint definition from weathergov.js (not used)
3090

3191
### Updated
3292

@@ -40,7 +100,7 @@ Special thanks to @khassel, @rejas and @sdetweil for taking over most (if not al
40100
- Reworked how weatherproviders handle units (#2849)
41101
- Use unix() method for parsing times, fix suntimes on the way (#2950)
42102
- Refactor conversion functions into utils class (#2958)
43-
- The `cors`-method in `server.js` now supports sending and recieving HTTP headers
103+
- The `cors`-method in `server.js` now supports sending and receiving HTTP headers
44104
- Replace `&hellip;` by `…`
45105
- Cleanup compliments module
46106
- Updated dependencies including electron to v22 (#2903)

‎Collaboration.md

+6
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,14 @@ This document describes how collaborators of this repository should work togethe
55
- never merge your own PR's
66
- never merge without someone having approved (approving and merging from same person is allowed)
77
- wait for all approvals requested (or the author decides something different in the comments)
8+
- never merge to `master`, except for releases (because of update notification)
9+
- merges to master should be tagged with the "mastermerge" label so that the test runs through
810

911
## Issues
1012

1113
- "real" Issues are closed if the problem is solved and the fix is released
1214
- unrelated Issues (e.g. related to a foreign module) are closed immediately with a comment to open an issue in the module repository or to discuss this further in the forum or discord
15+
16+
## Releases
17+
18+
- are done by @MichMich only

‎config/config.js.sample

+8-9
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,21 @@
66
* For more information on how you can configure this file
77
* see https://docs.magicmirror.builders/configuration/introduction.html
88
* and https://docs.magicmirror.builders/modules/configuration.html
9+
*
10+
* You can use environment variables using a `config.js.template` file instead of `config.js`
11+
* which will be converted to `config.js` while starting. For more information
12+
* see https://docs.magicmirror.builders/configuration/introduction.html#enviromnent-variables
913
*/
1014
let config = {
11-
address: "localhost", // Address to listen on, can be:
15+
address: "localhost", // Address to listen on, can be:
1216
// - "localhost", "127.0.0.1", "::1" to listen on loopback interface
1317
// - another specific IPv4/6 to listen on a specific interface
1418
// - "0.0.0.0", "::" to listen on any interface
1519
// Default, when address config is left out or empty, is "localhost"
1620
port: 8080,
17-
basePath: "/", // The URL path where MagicMirror² is hosted. If you are using a Reverse proxy
18-
// you must set the sub path here. basePath must end with a /
19-
ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"], // Set [] to allow all IP addresses
21+
basePath: "/", // The URL path where MagicMirror² is hosted. If you are using a Reverse proxy
22+
// you must set the sub path here. basePath must end with a /
23+
ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"], // Set [] to allow all IP addresses
2024
// or add a specific IPv4 of 192.168.1.5 :
2125
// ["127.0.0.1", "::ffff:127.0.0.1", "::1", "::ffff:192.168.1.5"],
2226
// or IPv4 range of 192.168.3.0 --> 192.168.3.15 use CIDR format :
@@ -31,11 +35,6 @@ let config = {
3135
logLevel: ["INFO", "LOG", "WARN", "ERROR"], // Add "DEBUG" for even more logging
3236
timeFormat: 24,
3337
units: "metric",
34-
// serverOnly: true/false/"local" ,
35-
// local for armv6l processors, default
36-
// starts serveronly and then starts chrome browser
37-
// false, default for all NON-armv6l devices
38-
// true, force serveronly mode, because you want to.. no UI on this device
3938

4039
modules: [
4140
{

‎css/main.css

+1-8
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,18 @@
33
--color-text-dimmed: #666;
44
--color-text-bright: #fff;
55
--color-background: #000;
6-
76
--font-primary: "Roboto Condensed";
87
--font-secondary: "Roboto";
9-
108
--font-size: 20px;
119
--font-size-xsmall: 0.75rem;
1210
--font-size-small: 1rem;
1311
--font-size-medium: 1.5rem;
1412
--font-size-large: 3.25rem;
1513
--font-size-xlarge: 3.75rem;
16-
1714
--gap-body-top: 60px;
1815
--gap-body-right: 60px;
1916
--gap-body-bottom: 60px;
2017
--gap-body-left: 60px;
21-
2218
--gap-modules: 30px;
2319
}
2420

@@ -175,10 +171,7 @@ sup {
175171

176172
.region.fullscreen {
177173
position: absolute;
178-
top: calc(-1 * var(--gap-body-top));
179-
left: calc(-1 * var(--gap-body-left));
180-
right: calc(-1 * var(--gap-body-right));
181-
bottom: calc(-1 * var(--gap-body-bottom));
174+
inset: calc(-1 * var(--gap-body-top)) calc(-1 * var(--gap-body-right)) calc(-1 * var(--gap-body-bottom)) calc(-1 * var(--gap-body-left));
182175
pointer-events: none;
183176
}
184177

‎jest.config.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ module.exports = async () => {
22
return {
33
verbose: true,
44
testTimeout: 20000,
5-
testSequencer: "<rootDir>/tests/configs/test_sequencer.js",
5+
testSequencer: "<rootDir>/tests/utils/test_sequencer.js",
66
projects: [
77
{
88
displayName: "unit",
@@ -25,7 +25,7 @@ module.exports = async () => {
2525
testPathIgnorePatterns: ["<rootDir>/tests/e2e/helpers/", "<rootDir>/tests/e2e/mocks"]
2626
}
2727
],
28-
collectCoverageFrom: ["./clientonly/**/*.js", "./js/**/*.js", "./modules/**/*.js", "./serveronly/**/*.js"],
28+
collectCoverageFrom: ["./clientonly/**/*.js", "./js/**/*.js", "./modules/default/**/*.js", "./serveronly/**/*.js"],
2929
coverageReporters: ["lcov", "text"],
3030
coverageProvider: "v8"
3131
};

0 commit comments

Comments
 (0)