Skip to content

Commit d9f9f41

Browse files
Add spell check (#3544)
I felt like adding a spell checker, but it's okay if you find it superfluous. At least then we could fix the found spell issues. What is still missing is an automatic integration so that the spell checker does not have to be called manually. Would it perhaps make sense to always do it before a release?
1 parent ea3a323 commit d9f9f41

17 files changed

+1439
-147
lines changed

CHANGELOG.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ _This release is scheduled to be released on 2024-10-01._
1111

1212
### Added
1313

14+
- [core] Add spelling check (cspell): `npm run test:spelling` and handle spelling issues
15+
1416
### Removed
1517

1618
- [core] removed installer only files (#3492)
@@ -59,7 +61,7 @@ Thanks to: @btoconnor, @bugsounet, @JasonStieber, @khassel, @kleinmantara and @W
5961

6062
### Fixed
6163

62-
- [core] Fixed crash possibility if `module: <name>` is not defined and on `postion: <positon>` mistake (#3445)
64+
- [core] Fixed crash possibility if `module: <name>` is not defined and on `position: <position>` mistake (#3445)
6365
- [weather] Fixed precipitationProbability in forecast for provider openmeteo (#3446)
6466
- [weather] Fixed type=daily for provider openmeteo having no data when running after 23:00 (#3449)
6567
- [weather] Fixed type=daily for provider openmeteo showing nightly icons in forecast when current time is "nightly" (#3458)
@@ -98,7 +100,7 @@ For more info, please read the following post: [A New Chapter for MagicMirror: T
98100

99101
### Fixed
100102

101-
- Correct apibase of weathergov weatherprovider to match documentation (#2926)
103+
- Correct apiBase of weathergov weatherProvider to match documentation (#2926)
102104
- Worked around several issues in the RRULE library that were causing deleted calender events to still show, some
103105
initial and recurring events to not show, and some event times to be off an hour. (#3291)
104106
- Skip changelog requirement when running tests for dependency updates (#3320)
@@ -164,8 +166,8 @@ This release also marks the latest release by Michael Teeuw. For more info, plea
164166
- Fix issue template (#3167)
165167
- Fix #3256 filter out bad results from rrule.between
166168
- Fix calendar events sometimes not respecting deleted events (#3250)
167-
- Fix electron loadurl locally on Windows when address "0.0.0.0" (#2550)
168-
- Fix updatanotification (update_helper.js): catch error if response is not an JSON format (check PM2)
169+
- Fix electron loadURL locally on Windows when address "0.0.0.0" (#2550)
170+
- Fix updatenotification (update_helper.js): catch error if response is not an JSON format (check PM2)
169171
- Fix missing typeof in calendar module
170172
- Fix style issues after prettier update
171173
- Fix calendar test (#3291) by moving "Exdate check" from e2e to electron to run on a Thursday
@@ -423,7 +425,7 @@ Special thanks to the following contributors: @eouia, @khassel, @kolbyjack, @Kri
423425

424426
### Added
425427

426-
- Added a new config option `httpHeaders` used by helmet (see https://helmetjs.github.io/). You can now set own httpHeaders which will override the defaults in `js/defauls.js` which is useful e.g. if you want to embed MagicMirror into annother website (solves #2847).
428+
- Added a new config option `httpHeaders` used by helmet (see https://helmetjs.github.io/). You can now set own httpHeaders which will override the defaults in `js/defaults.js` which is useful e.g. if you want to embed MagicMirror into another website (solves #2847).
427429
- Show endDate for calendar events when dateHeader is enabled and showEnd is set to true (#2192).
428430
- Added the notification emitting from the weather module on information updated.
429431
- Use recommended file extension for YAML files (#2864).
@@ -472,7 +474,7 @@ Special thanks to the following contributors: @10bias, @CFenner, @JHWelch, @k1rd
472474
- Fix minor console output issue for loading translations (#2814).
473475
- Don't adjust startDate for full day events if endDate is in the past.
474476
- Fix windspeed conversion error in openweathermap provider. (#2812)
475-
- Fix conflicting parms turning off showEnd for full day events. (#2629)
477+
- Fix conflicting parameter turning off showEnd for full day events. (#2629)
476478
- Fix regression, calendar.maximumEntries not used to filter calendar level entries (#2868)
477479

478480
## [2.18.0] - 2022-01-01
@@ -504,7 +506,7 @@ Special thanks to the following contributors: @AmpioRosso, @eouia, @fewieden, @j
504506
### Fixed
505507

506508
- Fixed wrong file `kr.json` to `ko.json`. Use language code 'ko' instead of 'kr' for Korean language.
507-
- Fixed `feels_like` data from openweathermaps current weather being ignored (#2678).
509+
- Fixed `feels_like` data from openweathermap's current weather being ignored (#2678).
508510
- Fixed chaotic newsfeed display after network connection loss thanks to @jalibu (#2638).
509511
- Fixed incorrect time zone correction of recurring full day events (#2632 and #2634).
510512
- Fixed e2e tests by increasing testTimeout.
@@ -541,7 +543,7 @@ Special thanks to the following contributors: @apiontek, @eouia, @jupadin, @khas
541543
- Updated github templates.
542544
- Actually test all js and css files when lint script is run.
543545
- Updated jsdocs and print warnings during testing too.
544-
- Updated weathergov provider to try fetching not just current, but also foreacst, when API URLs available.
546+
- Updated weathergov provider to try fetching not just current, but also forecast, when API URLs available.
545547
- Refactored clock layout.
546548
- Refactored methods from weather-providers into weatherobject (isDaytime, updateSunTime).
547549
- Use of `logger.js` in jest tests.
@@ -891,7 +893,7 @@ Special thanks to @sdetweil for all his great contributions!
891893
### Updated
892894

893895
- Updated lower bound of `lodash` and `helmet` dependencies for security patches.
894-
- Updated compliments.js to handle newline in text, as textfields to not interpolate contents.
896+
- Updated compliments.js to handle newline in text, as text fields to not interpolate contents.
895897
- Updated raspberry.sh installer script to handle new platform issues, split node/npm, pm2, and screen saver changes.
896898
- Improve handling for armv6l devices, where electron support has gone away, add optional serveronly config option.
897899
- Improved run-start.sh to handle for serveronly mode, by choice, or when electron not available.
@@ -1112,7 +1114,7 @@ A huge, huge, huge thanks to user @fewieden for all his hard work on the new `we
11121114
- Fixed close dates to be absolute, if no configured in the config.js - module Calendar
11131115
- Fixed the updatenotification module message about new commits in the repository, so they can be correctly localized in singular and plural form.
11141116
- Fix for weatherforecast rainfall rounding [#1374](https://github.com/MagicMirrorOrg/MagicMirror/issues/1374)
1115-
- Fix calendar parsing issue for Midori on RasperryPi Zero w, related to issue #694.
1117+
- Fix calendar parsing issue for Midori on Raspberry Pi Zero w, related to issue #694.
11161118
- Fix weather city ID link in sample config
11171119
- Fixed issue with clientonly not updating with IP address and port provided on command line.
11181120

@@ -1167,7 +1169,7 @@ A huge, huge, huge thanks to user @fewieden for all his hard work on the new `we
11671169
- Fixed weatherforecast to use dt_txt field instead of dt to handle timezones better
11681170
- 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/MagicMirrorOrg/MagicMirror/issues/1282)
11691171
- `clientonly/*.js` is now linted, and one linting error is fixed
1170-
- Fix issue #1196 by changing underscore to hyphen in locale id, in align with momentjs.
1172+
- Fix issue #1196 by changing underscore to hyphen in locale id, in align with moment.js.
11711173
- Fixed issue where heat index and wind chill were reporting incorrect values in Kelvin. [#1263](https://github.com/MagicMirrorOrg/MagicMirror/issues/1263)
11721174

11731175
### Updated
@@ -1192,7 +1194,7 @@ A huge, huge, huge thanks to user @fewieden for all his hard work on the new `we
11921194
- Implement Danger.js to notify contributors when CHANGELOG.md is missing in PR.
11931195
- Allow scrolling in full page article view of default newsfeed module with gesture events from [MMM-Gestures](https://github.com/thobach/MMM-Gestures)
11941196
- Changed 'compliments.js' - Updated DOM if remote compliments are loaded instead of waiting one updateInterval to show custom compliments
1195-
- Automated unit tests utils, deprecated, translator, cloneObject(lockstrings)
1197+
- Automated unit tests utils, deprecated, translator, cloneObject(lockStrings)
11961198
- Automated integration tests translations
11971199
- Add advanced filtering to the excludedEvents configuration of the default calendar module
11981200
- New currentweather module config option: `showFeelsLike`: Shows how it actually feels like. (wind chill or heat index)
@@ -1296,7 +1298,7 @@ A huge, huge, huge thanks to user @fewieden for all his hard work on the new `we
12961298
### Fixed
12971299

12981300
- Fixed issue with incorrect alignment of analog clock when displayed in the center column of the MM.
1299-
- Fixed ipWhitelist behaviour to make empty whitelist ([]) allow any and all hosts access to the MM.
1301+
- Fixed ipWhitelist behavior to make empty whitelist ([]) allow any and all hosts access to the MM.
13001302
- Fixed issue with calendar module where 'excludedEvents' count towards 'maximumEntries'.
13011303
- Fixed issue with calendar module where global configuration of maximumEntries was not overridden by calendar specific config (see module doc).
13021304
- Fixed issue where `this.file(filename)` returns a path with two hashes.
@@ -1401,7 +1403,7 @@ A huge, huge, huge thanks to user @fewieden for all his hard work on the new `we
14011403
- Added multiple calendar icon support.
14021404
- Added tests for Translations, dev argument, version, dev console.
14031405
- Added test anytime feature compliments module.
1404-
- Added test ipwhitelist configuration directive.
1406+
- Added test ipWhitelist configuration directive.
14051407
- Added test for calendar module: default, basic-auth, backward compatibility, fail-basic-auth.
14061408
- Added meta tags to support fullscreen mode on iOS (for server mode)
14071409
- Added `ignoreOldItems` and `ignoreOlderThan` options to the News Feed module

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ For the full contribution guidelines, check out: [https://docs.magicmirror.build
4141

4242
## Enjoying MagicMirror? Consider a donation!
4343

44-
MagicMirror² is opensource and free. That doesn't mean we don't need any money.
44+
MagicMirror² is Open Source and free. That doesn't mean we don't need any money.
4545

4646
Please consider a donation to help us cover the ongoing costs like webservers and email services.
4747
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.

cspell.config.json

Lines changed: 226 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,226 @@
1+
{
2+
"version": "0.2",
3+
"language": "en",
4+
"words": [
5+
"aarch",
6+
"Alvinger",
7+
"Ampio",
8+
"andrezibaia",
9+
"angeldeejay",
10+
"apiontek",
11+
"armv",
12+
"ashishtank",
13+
"autoplay",
14+
"beada",
15+
"Binney",
16+
"bluemanos",
17+
"bnitkin",
18+
"bokmål",
19+
"Brasileiro",
20+
"Brento",
21+
"browserwindow",
22+
"bryanzzhu",
23+
"btoconnor",
24+
"bugsounet",
25+
"buxxi",
26+
"byday",
27+
"calendarfetcherutils",
28+
"calendarutils",
29+
"chamakura",
30+
"cjbrunner",
31+
"clientonly",
32+
"clockfaces",
33+
"cmdline",
34+
"codac",
35+
"Crazylegstoo",
36+
"crazyscot",
37+
"Creepin",
38+
"currentweather",
39+
"customregions",
40+
"Cymraeg",
41+
"dariom",
42+
"darksky",
43+
"dateheader",
44+
"dateheaders",
45+
"davide",
46+
"DAYAFTERTOMORROW",
47+
"DAYBEFOREYESTERDAY",
48+
"defaultmodules",
49+
"dgoth",
50+
"DTEND",
51+
"Duffman",
52+
"earlman",
53+
"easyas",
54+
"eddiehung",
55+
"Edgardos",
56+
"Ekristoffe",
57+
"envcanada",
58+
"envsub",
59+
"envsubst",
60+
"eouia",
61+
"exdate",
62+
"expectedheaders",
63+
"ezeholz",
64+
"Faizan",
65+
"feedme",
66+
"feelslike",
67+
"Fenner",
68+
"fewieden",
69+
"fixuppm",
70+
"flopp",
71+
"fontawesome",
72+
"fontface",
73+
"forecastweather",
74+
"fortawesome",
75+
"frameguard",
76+
"Frysk",
77+
"fulldate",
78+
"fullday",
79+
"fullscreen",
80+
"Gevoelstemperatuur",
81+
"ghsas",
82+
"grenagit",
83+
"Hirschberger",
84+
"hourlyweather",
85+
"Hwind",
86+
"ical",
87+
"illimarkangur",
88+
"Ingan",
89+
"ipfilter",
90+
"ismarslomic",
91+
"jakemulley",
92+
"jakobsarwary",
93+
"jalibu",
94+
"jetson",
95+
"jkriegshauser",
96+
"jsdocs",
97+
"jsonlint",
98+
"jupadin",
99+
"kaennchenstruggle",
100+
"kenzal",
101+
"Keyport",
102+
"khassel",
103+
"Kingdon",
104+
"kioskmode",
105+
"klaernie",
106+
"kleinmantara",
107+
"Kmph",
108+
"Knapoc",
109+
"Koepke",
110+
"kolbyjack",
111+
"krekos",
112+
"Kristjan",
113+
"krukle",
114+
"larryare",
115+
"letsencrypt",
116+
"Lightspeed",
117+
"locationforecast",
118+
"lockstring",
119+
"lstrip",
120+
"Luciella",
121+
"luxon",
122+
"lxsession",
123+
"magicmirror",
124+
"martingron",
125+
"marvai",
126+
"mastermerge",
127+
"Meteo",
128+
"michaelteeuw",
129+
"michmich",
130+
"Midori",
131+
"mirontoli",
132+
"MISSINGLANG",
133+
"MMPM",
134+
"modernizr",
135+
"modulename",
136+
"multiday",
137+
"Mystara",
138+
"Ñandú",
139+
"nathannaveen",
140+
"naveensrinivasan",
141+
"ndom",
142+
"Nerfzooka",
143+
"NEWSFEED",
144+
"newsitems",
145+
"nfogal",
146+
"njwilliams",
147+
"Norsk",
148+
"nunjuck",
149+
"odroid",
150+
"oemel",
151+
"onecall",
152+
"onevent",
153+
"openmeteo",
154+
"openweathermap",
155+
"oraclesean",
156+
"oscarb",
157+
"philnagel",
158+
"Português",
159+
"PRECIP",
160+
"Problema",
161+
"psieg",
162+
"radokristof",
163+
"rajniszp",
164+
"Reis",
165+
"rejas",
166+
"Resig",
167+
"roboto",
168+
"rohitdharavath",
169+
"Rosso",
170+
"rrule",
171+
"sdetweil",
172+
"sendheaders",
173+
"serveronly",
174+
"SMHI",
175+
"Snille",
176+
"socketclient",
177+
"socketio",
178+
"spectron",
179+
"Starinvest",
180+
"sthuber",
181+
"Stieber",
182+
"stylelintrc",
183+
"subclassing",
184+
"sunaction",
185+
"suncalc",
186+
"suntimes",
187+
"systeminformation",
188+
"tada",
189+
"taglist",
190+
"Teeuw",
191+
"thomasrockhu",
192+
"tomzt",
193+
"ukmetoffice",
194+
"ukmetofficedatahub",
195+
"unitless",
196+
"unparseable",
197+
"updatenotification",
198+
"Vaice",
199+
"veeck",
200+
"VEVENT",
201+
"vgtu",
202+
"Voelt",
203+
"vppencilsharpener",
204+
"Wallys",
205+
"Weatherbit",
206+
"WEATHERDATA",
207+
"Weatherflow",
208+
"weatherforecast",
209+
"weathergov",
210+
"weathericons",
211+
"weatherobject",
212+
"weatherutils",
213+
"windspeed",
214+
"Woolridge",
215+
"worktree",
216+
"xlarge",
217+
"xrandr",
218+
"xsmall",
219+
"xwindows",
220+
"xxxe",
221+
"Ybbet",
222+
"yearmatchgroup"
223+
],
224+
"ignorePaths": ["node_modules/**", "modules/**", "vendor/node_modules/**", "translations/**", "tests/mocks/**", "tests/e2e/modules/clock_es_spec.js", "fonts/roboto.css"],
225+
"dictionaries": ["node"]
226+
}

js/check_config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ function checkConfigFile () {
7070
Log.info("Checking modules structure configuration... ");
7171

7272
const position_list = Utils.getModulePositions();
73-
// Make Ajv schema confguration of modules config
73+
// Make Ajv schema configuration of modules config
7474
// only scan "module" and "position"
7575
const schema = {
7676
type: "object",

0 commit comments

Comments
 (0)