From 300f154c4f4296b8ecdbbbc4ef7fc625bb21b382 Mon Sep 17 00:00:00 2001 From: Karsten Hassel Date: Thu, 18 Jan 2024 21:03:11 +0100 Subject: [PATCH 1/4] remove all header comments including magicmirror with `find ./ -type f -exec perl -i -0pe 's/\/\*\s*magicmirror.*?\*\/\s*//si' {} \;` --- CHANGELOG.md | 2 + config/config.js.sample | 13 ------- css/custom.css.sample | 9 ----- js/animateCSS.js | 7 ---- js/app.js | 7 ---- js/check_config.js | 7 ---- js/defaults.js | 6 --- js/deprecated.js | 8 ---- js/loader.js | 6 --- js/logger.js | 9 ----- js/main.js | 6 --- js/module.js | 7 ---- js/node_helper.js | 6 --- js/server.js | 6 --- js/socketclient.js | 6 --- js/translator.js | 6 --- js/utils.js | 5 --- modules/default/alert/alert.js | 6 --- modules/default/calendar/calendar.js | 6 --- modules/default/calendar/calendarfetcher.js | 7 ---- .../default/calendar/calendarfetcherutils.js | 7 ---- modules/default/calendar/calendarutils.js | 6 --- modules/default/calendar/node_helper.js | 6 --- modules/default/clock/clock.js | 6 --- modules/default/compliments/compliments.js | 6 --- modules/default/defaultmodules.js | 6 --- modules/default/helloworld/helloworld.js | 6 --- modules/default/newsfeed/newsfeed.js | 6 --- modules/default/newsfeed/newsfeedfetcher.js | 7 ---- modules/default/newsfeed/node_helper.js | 7 ---- .../updatenotification/updatenotification.js | 6 --- .../default/weather/providers/envcanada.js | 34 ---------------- .../default/weather/providers/openmeteo.js | 10 ----- .../weather/providers/openweathermap.js | 8 ---- .../weather/providers/pirateweather.js | 10 ----- modules/default/weather/providers/smhi.js | 10 ----- .../default/weather/providers/ukmetoffice.js | 8 ---- .../weather/providers/ukmetofficedatahub.js | 39 ------------------- .../default/weather/providers/weatherbit.js | 10 ----- .../default/weather/providers/weatherflow.js | 11 ------ .../default/weather/providers/weathergov.js | 13 ------- modules/default/weather/providers/yr.js | 11 ------ modules/default/weather/weather.js | 6 --- modules/default/weather/weatherobject.js | 12 ------ modules/default/weather/weatherprovider.js | 8 ---- modules/default/weather/weatherutils.js | 6 --- tests/configs/default.js | 5 --- tests/configs/empty_ipWhiteList.js | 5 --- tests/configs/modules/alert/default.js | 5 --- .../configs/modules/calendar/auth-default.js | 5 --- tests/configs/modules/calendar/bad_rrule.js | 5 --- tests/configs/modules/calendar/basic-auth.js | 5 --- .../configs/modules/calendar/changed-port.js | 5 --- tests/configs/modules/calendar/custom.js | 5 --- tests/configs/modules/calendar/default.js | 5 --- tests/configs/modules/calendar/exdate.js | 11 ------ .../modules/calendar/fail-basic-auth.js | 7 ---- .../modules/calendar/old-basic-auth.js | 5 --- tests/configs/modules/calendar/recurring.js | 5 --- .../calendar/show-duplicates-in-calendar.js | 5 --- tests/configs/modules/clock/clock_12hr.js | 5 --- tests/configs/modules/clock/clock_24hr.js | 5 --- tests/configs/modules/clock/clock_analog.js | 4 -- .../clock/clock_displaySeconds_false.js | 5 --- .../modules/clock/clock_showDateAnalog.js | 5 --- .../modules/clock/clock_showPeriodUpper.js | 5 --- .../modules/clock/clock_showSunMoon.js | 5 --- tests/configs/modules/clock/clock_showTime.js | 5 --- tests/configs/modules/clock/clock_showWeek.js | 5 --- tests/configs/modules/clock/es/clock_12hr.js | 5 --- tests/configs/modules/clock/es/clock_24hr.js | 5 --- .../modules/clock/es/clock_showPeriodUpper.js | 5 --- .../modules/clock/es/clock_showWeek.js | 6 --- .../compliments/compliments_animateCSS.js | 6 --- ...ompliments_animateCSS_fallbackToDefault.js | 7 ---- ...iments_animateCSS_invertedAnimationName.js | 6 --- .../compliments/compliments_anytime.js | 5 --- .../modules/compliments/compliments_date.js | 5 --- .../compliments/compliments_only_anytime.js | 5 --- .../compliments/compliments_parts_day.js | 5 --- .../modules/compliments/compliments_remote.js | 5 --- tests/configs/modules/display.js | 5 --- .../configs/modules/helloworld/helloworld.js | 5 --- .../modules/helloworld/helloworld_default.js | 5 --- tests/configs/modules/newsfeed/default.js | 5 --- .../configs/modules/newsfeed/ignore_items.js | 4 -- .../configs/modules/newsfeed/incorrect_url.js | 4 -- .../modules/newsfeed/prohibited_words.js | 4 -- tests/configs/modules/positions.js | 5 --- .../weather/currentweather_compliments.js | 5 --- .../modules/weather/currentweather_default.js | 5 --- .../modules/weather/currentweather_options.js | 5 --- .../modules/weather/currentweather_units.js | 5 --- .../weather/forecastweather_absolute.js | 5 --- .../weather/forecastweather_default.js | 5 --- .../weather/forecastweather_options.js | 5 --- .../modules/weather/forecastweather_units.js | 5 --- .../modules/weather/hourlyweather_default.js | 5 --- .../modules/weather/hourlyweather_options.js | 5 --- .../hourlyweather_showPrecipitation.js | 5 --- tests/configs/noIpWhiteList.js | 5 --- tests/configs/port_8090.js | 5 --- tests/configs/port_variable.js.template | 5 --- tests/configs/without_modules.js | 5 --- translations/translations.js | 7 ---- vendor/vendor.js | 6 --- 106 files changed, 2 insertions(+), 710 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5de50d3462..b4f37142c0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -31,6 +31,8 @@ _This release is scheduled to be released on 2024-04-01._ ### Deleted +- Unneeded file headers (#3358) + ## [2.26.0] - 01-01-2024 Thanks to: @bnitkin, @bugsounet, @dependabot, @jkriegshauser, @kaennchenstruggle, @KristjanESPERANTO and @Ybbet. diff --git a/config/config.js.sample b/config/config.js.sample index 06ff3a5d93..edab06fae5 100644 --- a/config/config.js.sample +++ b/config/config.js.sample @@ -1,16 +1,3 @@ -/* MagicMirror² Config Sample - * - * By Michael Teeuw https://michaelteeuw.nl - * MIT Licensed. - * - * For more information on how you can configure this file - * see https://docs.magicmirror.builders/configuration/introduction.html - * and https://docs.magicmirror.builders/modules/configuration.html - * - * You can use environment variables using a `config.js.template` file instead of `config.js` - * which will be converted to `config.js` while starting. For more information - * see https://docs.magicmirror.builders/configuration/introduction.html#enviromnent-variables - */ let config = { address: "localhost", // Address to listen on, can be: // - "localhost", "127.0.0.1", "::1" to listen on loopback interface diff --git a/css/custom.css.sample b/css/custom.css.sample index 48cc17a0af..4adb57aae3 100644 --- a/css/custom.css.sample +++ b/css/custom.css.sample @@ -1,12 +1,3 @@ -/* MagicMirror² Custom CSS Sample - * - * Change color and fonts here. - * - * Beware that properties cannot be unitless, so for example write '--gap-body: 0px;' instead of just '--gap-body: 0;' - * - * MIT Licensed. - */ - /* Uncomment and adjust accordingly if you want to import another font from the google-fonts-api: */ /* @import url('https://fonts.googleapis.com/css2?family=Poppins:wght@100;300;400;700&display=swap'); */ diff --git a/js/animateCSS.js b/js/animateCSS.js index b4db77b9ab..057d53c72d 100644 --- a/js/animateCSS.js +++ b/js/animateCSS.js @@ -1,10 +1,3 @@ -/* MagicMirror² - * AnimateCSS System from https://animate.style/ - * by @bugsounet - * for Michael Teeuw https://michaelteeuw.nl - * MIT Licensed. - */ - /* enumeration of animations in Array **/ const AnimateCSSIn = [ // Attention seekers diff --git a/js/app.js b/js/app.js index 05212f2e11..ec8f42f3dd 100644 --- a/js/app.js +++ b/js/app.js @@ -1,10 +1,3 @@ -/* MagicMirror² - * The Core App (Server) - * - * By Michael Teeuw https://michaelteeuw.nl - * MIT Licensed. - */ - // Alias modules mentioned in package.js under _moduleAliases. require("module-alias/register"); diff --git a/js/check_config.js b/js/check_config.js index d190f22a75..ec5ebcae66 100644 --- a/js/check_config.js +++ b/js/check_config.js @@ -1,10 +1,3 @@ -/* MagicMirror² - * - * Check the configuration file for errors - * - * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com - * MIT Licensed. - */ const path = require("node:path"); const fs = require("node:fs"); const colors = require("ansis"); diff --git a/js/defaults.js b/js/defaults.js index ce49bf5bee..c4efa77e95 100644 --- a/js/defaults.js +++ b/js/defaults.js @@ -1,11 +1,5 @@ /* global mmPort */ -/* MagicMirror² - * Config Defaults - * - * By Michael Teeuw https://michaelteeuw.nl - * MIT Licensed. - */ const address = "localhost"; let port = 8080; if (typeof mmPort !== "undefined") { diff --git a/js/deprecated.js b/js/deprecated.js index e2c70322ac..b0aca56ca0 100644 --- a/js/deprecated.js +++ b/js/deprecated.js @@ -1,11 +1,3 @@ -/* MagicMirror² Deprecated Config Options List - * - * By Michael Teeuw https://michaelteeuw.nl - * MIT Licensed. - * - * Olex S. original idea this deprecated option - */ - module.exports = { configs: ["kioskmode"] }; diff --git a/js/loader.js b/js/loader.js index b4b32f4f3c..0d59858c77 100644 --- a/js/loader.js +++ b/js/loader.js @@ -1,11 +1,5 @@ /* global defaultModules, vendor */ -/* MagicMirror² - * Module and File loaders. - * - * By Michael Teeuw https://michaelteeuw.nl - * MIT Licensed. - */ const Loader = (function () { /* Create helper variables */ diff --git a/js/logger.js b/js/logger.js index da295bb990..7af4a0f7d8 100644 --- a/js/logger.js +++ b/js/logger.js @@ -1,12 +1,3 @@ -/* MagicMirror² - * Log - * - * 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") { if (process.env.JEST_WORKER_ID === undefined) { diff --git a/js/main.js b/js/main.js index 7bda7ababa..43ec02ad87 100644 --- a/js/main.js +++ b/js/main.js @@ -1,11 +1,5 @@ /* global Loader, defaults, Translator, addAnimateCSS, removeAnimateCSS, AnimateCSSIn, AnimateCSSOut */ -/* MagicMirror² - * Main System - * - * By Michael Teeuw https://michaelteeuw.nl - * MIT Licensed. - */ const MM = (function () { let modules = []; diff --git a/js/module.js b/js/module.js index d9d40ac50b..ef9c55fbc7 100644 --- a/js/module.js +++ b/js/module.js @@ -1,12 +1,5 @@ /* global Class, cloneObject, Loader, MMSocket, nunjucks, Translator */ -/* MagicMirror² - * Module Blueprint. - * @typedef {Object} Module - * - * By Michael Teeuw https://michaelteeuw.nl - * MIT Licensed. - */ const Module = Class.extend({ /********************************************************* diff --git a/js/node_helper.js b/js/node_helper.js index dee0beeb3a..42da0efcff 100644 --- a/js/node_helper.js +++ b/js/node_helper.js @@ -1,9 +1,3 @@ -/* MagicMirror² - * Node Helper Superclass - * - * By Michael Teeuw https://michaelteeuw.nl - * MIT Licensed. - */ const express = require("express"); const Log = require("logger"); const Class = require("./class"); diff --git a/js/server.js b/js/server.js index 03de57ebef..bfa0f911d7 100644 --- a/js/server.js +++ b/js/server.js @@ -1,9 +1,3 @@ -/* MagicMirror² - * Server - * - * By Michael Teeuw https://michaelteeuw.nl - * MIT Licensed. - */ const fs = require("node:fs"); const http = require("node:http"); const https = require("node:https"); diff --git a/js/socketclient.js b/js/socketclient.js index a8d2e4b592..d8408e9e93 100644 --- a/js/socketclient.js +++ b/js/socketclient.js @@ -1,11 +1,5 @@ /* global io */ -/* MagicMirror² - * TODO add description - * - * By Michael Teeuw https://michaelteeuw.nl - * MIT Licensed. - */ const MMSocket = function (moduleName) { if (typeof moduleName !== "string") { throw new Error("Please set the module name for the MMSocket."); diff --git a/js/translator.js b/js/translator.js index d329ffd076..e742eb9c3b 100644 --- a/js/translator.js +++ b/js/translator.js @@ -1,11 +1,5 @@ /* global translations */ -/* MagicMirror² - * Translator (l10n) - * - * By Christopher Fenner https://github.com/CFenner - * MIT Licensed. - */ const Translator = (function () { /** diff --git a/js/utils.js b/js/utils.js index 395feceff9..ba80004bb3 100644 --- a/js/utils.js +++ b/js/utils.js @@ -1,8 +1,3 @@ -/* MagicMirror² - * Utils - * - * MIT Licensed. - */ const execSync = require("node:child_process").execSync; const Log = require("logger"); const si = require("systeminformation"); diff --git a/modules/default/alert/alert.js b/modules/default/alert/alert.js index da26292372..a436a74c7b 100644 --- a/modules/default/alert/alert.js +++ b/modules/default/alert/alert.js @@ -1,11 +1,5 @@ /* global NotificationFx */ -/* MagicMirror² - * Module: alert - * - * By Paul-Vincent Roll https://paulvincentroll.com/ - * MIT Licensed. - */ Module.register("alert", { alerts: {}, diff --git a/modules/default/calendar/calendar.js b/modules/default/calendar/calendar.js index bfb49af78e..fe08a883af 100644 --- a/modules/default/calendar/calendar.js +++ b/modules/default/calendar/calendar.js @@ -1,11 +1,5 @@ /* global CalendarUtils */ -/* MagicMirror² - * Module: Calendar - * - * By Michael Teeuw https://michaelteeuw.nl - * MIT Licensed. - */ Module.register("calendar", { // Define module defaults defaults: { diff --git a/modules/default/calendar/calendarfetcher.js b/modules/default/calendar/calendarfetcher.js index 2ba4e12ea6..824c7c5b4f 100644 --- a/modules/default/calendar/calendarfetcher.js +++ b/modules/default/calendar/calendarfetcher.js @@ -1,10 +1,3 @@ -/* MagicMirror² - * Node Helper: Calendar - CalendarFetcher - * - * By Michael Teeuw https://michaelteeuw.nl - * MIT Licensed. - */ - const https = require("node:https"); const ical = require("node-ical"); const Log = require("logger"); diff --git a/modules/default/calendar/calendarfetcherutils.js b/modules/default/calendar/calendarfetcherutils.js index 7a0b8b4053..c2067296cd 100644 --- a/modules/default/calendar/calendarfetcherutils.js +++ b/modules/default/calendar/calendarfetcherutils.js @@ -1,10 +1,3 @@ -/* MagicMirror² - * Calendar Fetcher Util Methods - * - * By Michael Teeuw https://michaelteeuw.nl - * MIT Licensed. - */ - /** * @external Moment */ diff --git a/modules/default/calendar/calendarutils.js b/modules/default/calendar/calendarutils.js index 68aef52154..5cbc8d6824 100644 --- a/modules/default/calendar/calendarutils.js +++ b/modules/default/calendar/calendarutils.js @@ -1,9 +1,3 @@ -/* MagicMirror² - * Calendar Util Methods - * - * By Rejas - * MIT Licensed. - */ const CalendarUtils = { /** diff --git a/modules/default/calendar/node_helper.js b/modules/default/calendar/node_helper.js index c0d46ae468..e485926099 100644 --- a/modules/default/calendar/node_helper.js +++ b/modules/default/calendar/node_helper.js @@ -1,9 +1,3 @@ -/* MagicMirror² - * Node Helper: Calendar - * - * By Michael Teeuw https://michaelteeuw.nl - * MIT Licensed. - */ const NodeHelper = require("node_helper"); const Log = require("logger"); const CalendarFetcher = require("./calendarfetcher"); diff --git a/modules/default/clock/clock.js b/modules/default/clock/clock.js index 549026eaef..3796a2c359 100644 --- a/modules/default/clock/clock.js +++ b/modules/default/clock/clock.js @@ -1,11 +1,5 @@ /* global SunCalc, formatTime */ -/* MagicMirror² - * Module: Clock - * - * By Michael Teeuw https://michaelteeuw.nl - * MIT Licensed. - */ Module.register("clock", { // Module config defaults. defaults: { diff --git a/modules/default/compliments/compliments.js b/modules/default/compliments/compliments.js index 374cd54f76..10e54afd40 100644 --- a/modules/default/compliments/compliments.js +++ b/modules/default/compliments/compliments.js @@ -1,9 +1,3 @@ -/* MagicMirror² - * Module: Compliments - * - * By Michael Teeuw https://michaelteeuw.nl - * MIT Licensed. - */ Module.register("compliments", { // Module config defaults. defaults: { diff --git a/modules/default/defaultmodules.js b/modules/default/defaultmodules.js index c74e94a45c..6c39367ad7 100644 --- a/modules/default/defaultmodules.js +++ b/modules/default/defaultmodules.js @@ -1,9 +1,3 @@ -/* MagicMirror² Default Modules List - * Modules listed below can be loaded without the 'default/' prefix. Omitting the default folder name. - * - * By Michael Teeuw https://michaelteeuw.nl - * MIT Licensed. - */ const defaultModules = ["alert", "calendar", "clock", "compliments", "helloworld", "newsfeed", "updatenotification", "weather"]; /*************** DO NOT EDIT THE LINE BELOW ***************/ diff --git a/modules/default/helloworld/helloworld.js b/modules/default/helloworld/helloworld.js index 6adb382e07..53fbd80c03 100644 --- a/modules/default/helloworld/helloworld.js +++ b/modules/default/helloworld/helloworld.js @@ -1,9 +1,3 @@ -/* MagicMirror² - * Module: HelloWorld - * - * By Michael Teeuw https://michaelteeuw.nl - * MIT Licensed. - */ Module.register("helloworld", { // Default module config. defaults: { diff --git a/modules/default/newsfeed/newsfeed.js b/modules/default/newsfeed/newsfeed.js index 329c04bb33..c66f8990d8 100644 --- a/modules/default/newsfeed/newsfeed.js +++ b/modules/default/newsfeed/newsfeed.js @@ -1,9 +1,3 @@ -/* MagicMirror² - * Module: NewsFeed - * - * By Michael Teeuw https://michaelteeuw.nl - * MIT Licensed. - */ Module.register("newsfeed", { // Default module config. defaults: { diff --git a/modules/default/newsfeed/newsfeedfetcher.js b/modules/default/newsfeed/newsfeedfetcher.js index ea1c7712fd..ea181b60b4 100644 --- a/modules/default/newsfeed/newsfeedfetcher.js +++ b/modules/default/newsfeed/newsfeedfetcher.js @@ -1,10 +1,3 @@ -/* MagicMirror² - * Node Helper: Newsfeed - NewsfeedFetcher - * - * By Michael Teeuw https://michaelteeuw.nl - * MIT Licensed. - */ - const crypto = require("node:crypto"); const stream = require("node:stream"); const FeedMe = require("feedme"); diff --git a/modules/default/newsfeed/node_helper.js b/modules/default/newsfeed/node_helper.js index 2110fde406..c8cdaa0c37 100644 --- a/modules/default/newsfeed/node_helper.js +++ b/modules/default/newsfeed/node_helper.js @@ -1,10 +1,3 @@ -/* MagicMirror² - * Node Helper: Newsfeed - * - * By Michael Teeuw https://michaelteeuw.nl - * MIT Licensed. - */ - const NodeHelper = require("node_helper"); const Log = require("logger"); const NewsfeedFetcher = require("./newsfeedfetcher"); diff --git a/modules/default/updatenotification/updatenotification.js b/modules/default/updatenotification/updatenotification.js index eb5528e114..6de5f6a252 100644 --- a/modules/default/updatenotification/updatenotification.js +++ b/modules/default/updatenotification/updatenotification.js @@ -1,9 +1,3 @@ -/* MagicMirror² - * Module: UpdateNotification - * - * By Michael Teeuw https://michaelteeuw.nl - * MIT Licensed. - */ Module.register("updatenotification", { defaults: { updateInterval: 10 * 60 * 1000, // every 10 minutes diff --git a/modules/default/weather/providers/envcanada.js b/modules/default/weather/providers/envcanada.js index 934c5831d4..77624453c0 100644 --- a/modules/default/weather/providers/envcanada.js +++ b/modules/default/weather/providers/envcanada.js @@ -1,39 +1,5 @@ /* global WeatherProvider, WeatherObject, WeatherUtils */ -/* MagicMirror² - * Module: Weather - * Provider: Environment Canada (EC) - * - * This class is a provider for Environment Canada MSC Datamart - * Note that this is only for Canadian locations and does not require an API key (access is anonymous) - * - * EC Documentation at following links: - * https://dd.weather.gc.ca/citypage_weather/schema/ - * https://eccc-msc.github.io/open-data/msc-datamart/readme_en/ - * - * This module supports Canadian locations only and requires 2 additional config parameters: - * - * siteCode - the city/town unique identifier for which weather is to be displayed. Format is 's0000000'. - * - * provCode - the 2-character province code for the selected city/town. - * - * Example: for Toronto, Ontario, the following parameters would be used - * - * siteCode: 's0000458', - * provCode: 'ON' - * - * To determine the siteCode and provCode values for a Canadian city/town, look at the Environment Canada document - * at https://dd.weather.gc.ca/citypage_weather/docs/site_list_en.csv (or site_list_fr.csv). There you will find a table - * with locations you can search under column B (English Names), with the corresponding siteCode under - * column A (Codes) and provCode under column C (Province). - * - * Original by Kevin Godin - * - * License to use Environment Canada (EC) data is detailed here: - * https://eccc-msc.github.io/open-data/licence/readme_en/ - * - */ - WeatherProvider.register("envcanada", { // Set the name of the provider for debugging and alerting purposes (eg. provide eye-catcher) providerName: "Environment Canada", diff --git a/modules/default/weather/providers/openmeteo.js b/modules/default/weather/providers/openmeteo.js index b80601a12e..780eed7d9d 100644 --- a/modules/default/weather/providers/openmeteo.js +++ b/modules/default/weather/providers/openmeteo.js @@ -1,15 +1,5 @@ /* global WeatherProvider, WeatherObject */ -/* MagicMirror² - * Module: Weather - * Provider: Open-Meteo - * - * By Andrés Vanegas - * MIT Licensed - * - * This class is a provider for Open-Meteo, based on Andrew Pometti's class - * for Weatherbit. - */ // https://www.bigdatacloud.com/docs/api/free-reverse-geocode-to-city-api const GEOCODE_BASE = "https://api.bigdatacloud.net/data/reverse-geocode-client"; const OPEN_METEO_BASE = "https://api.open-meteo.com/v1"; diff --git a/modules/default/weather/providers/openweathermap.js b/modules/default/weather/providers/openweathermap.js index c389b7fd97..77c991d321 100644 --- a/modules/default/weather/providers/openweathermap.js +++ b/modules/default/weather/providers/openweathermap.js @@ -1,13 +1,5 @@ /* global WeatherProvider, WeatherObject */ -/* MagicMirror² - * Module: Weather - * - * By Michael Teeuw https://michaelteeuw.nl - * MIT Licensed. - * - * This class is the blueprint for a weather provider. - */ WeatherProvider.register("openweathermap", { // Set the name of the provider. // This isn't strictly necessary, since it will fallback to the provider identifier diff --git a/modules/default/weather/providers/pirateweather.js b/modules/default/weather/providers/pirateweather.js index 46106cfc3e..cb8b8eda60 100644 --- a/modules/default/weather/providers/pirateweather.js +++ b/modules/default/weather/providers/pirateweather.js @@ -1,15 +1,5 @@ /* global WeatherProvider, WeatherObject */ -/* MagicMirror² - * Module: Weather - * Provider: Pirate Weather - * - * Written by Nicholas Hubbard https://github.com/nhubbard for formerly Dark Sky Provider - * Modified by Karsten Hassel for Pirate Weather - * MIT Licensed - * - * This class is a provider for Pirate Weather, it is a replacement for Dark Sky (same api). - */ WeatherProvider.register("pirateweather", { // Set the name of the provider. // Not strictly required, but helps for debugging. diff --git a/modules/default/weather/providers/smhi.js b/modules/default/weather/providers/smhi.js index d1641b4214..05df75772a 100644 --- a/modules/default/weather/providers/smhi.js +++ b/modules/default/weather/providers/smhi.js @@ -1,15 +1,5 @@ /* global WeatherProvider, WeatherObject */ -/* MagicMirror² - * Module: Weather - * Provider: SMHI - * - * By BuXXi https://github.com/buxxi - * MIT Licensed - * - * This class is a provider for SMHI (Sweden only). Metric system is the only - * supported unit. - */ WeatherProvider.register("smhi", { providerName: "SMHI", diff --git a/modules/default/weather/providers/ukmetoffice.js b/modules/default/weather/providers/ukmetoffice.js index e4e020b371..66a5d01a9b 100644 --- a/modules/default/weather/providers/ukmetoffice.js +++ b/modules/default/weather/providers/ukmetoffice.js @@ -1,13 +1,5 @@ /* global WeatherProvider, WeatherObject, WeatherUtils */ -/* MagicMirror² - * Module: Weather - * - * By Malcolm Oakes https://github.com/maloakes - * MIT Licensed. - * - * This class is a provider for UK Met Office Datapoint. - */ WeatherProvider.register("ukmetoffice", { // Set the name of the provider. // This isn't strictly necessary, since it will fallback to the provider identifier diff --git a/modules/default/weather/providers/ukmetofficedatahub.js b/modules/default/weather/providers/ukmetofficedatahub.js index 225e7b4660..d8ead57bdd 100644 --- a/modules/default/weather/providers/ukmetofficedatahub.js +++ b/modules/default/weather/providers/ukmetofficedatahub.js @@ -1,44 +1,5 @@ /* global WeatherProvider, WeatherObject */ -/* MagicMirror² - * Module: Weather - * - * By Malcolm Oakes https://github.com/maloakes - * Existing Met Office provider edited for new MetOffice Data Hub by CreepinJesus http://github.com/XBCreepinJesus - * MIT Licensed. - * - * This class is a provider for UK Met Office Data Hub (the replacement for their Data Point services). - * For more information on Data Hub, see https://www.metoffice.gov.uk/services/data/datapoint/notifications/weather-datahub - * Data available: - * Hourly data for next 2 days ("hourly") - https://www.metoffice.gov.uk/binaries/content/assets/metofficegovuk/pdf/data/global-spot-data-hourly.pdf - * 3-hourly data for the next 7 days ("3hourly") - https://www.metoffice.gov.uk/binaries/content/assets/metofficegovuk/pdf/data/global-spot-data-3-hourly.pdf - * Daily data for the next 7 days ("daily") - https://www.metoffice.gov.uk/binaries/content/assets/metofficegovuk/pdf/data/global-spot-data-daily.pdf - * - * NOTES - * This provider requires longitude/latitude coordinates, rather than a location ID (as with the previous Met Office provider) - * Provide the following in your config.js file: - * weatherProvider: "ukmetofficedatahub", - * apiBase: "https://api-metoffice.apiconnect.ibmcloud.com/metoffice/production/v0/forecasts/point/", - * apiKey: "[YOUR API KEY]", - * apiSecret: "[YOUR API SECRET]", - * lat: [LATITUDE (DECIMAL)], - * lon: [LONGITUDE (DECIMAL)] - * - * At time of writing, free accounts are limited to 360 requests a day per service (hourly, 3hourly, daily); take this in mind when - * setting your update intervals. For reference, 360 requests per day is once every 4 minutes. - * - * Pay attention to the units of the supplied data from the Met Office - it is given in SI/metric units where applicable: - * - Temperatures are in degrees Celsius (°C) - * - Wind speeds are in metres per second (m/s) - * - Wind direction given in degrees (°) - * - Pressures are in Pascals (Pa) - * - Distances are in metres (m) - * - Probabilities and humidity are given as percentages (%) - * - Precipitation is measured in millimetres (mm) with rates per hour (mm/h) - * - * See the PDFs linked above for more information on the data their corresponding units. - */ - WeatherProvider.register("ukmetofficedatahub", { // Set the name of the provider. providerName: "UK Met Office (DataHub)", diff --git a/modules/default/weather/providers/weatherbit.js b/modules/default/weather/providers/weatherbit.js index 5bde8003bb..a600e75de7 100644 --- a/modules/default/weather/providers/weatherbit.js +++ b/modules/default/weather/providers/weatherbit.js @@ -1,15 +1,5 @@ /* global WeatherProvider, WeatherObject */ -/* MagicMirror² - * Module: Weather - * Provider: Weatherbit - * - * By Andrew Pometti - * MIT Licensed - * - * This class is a provider for Weatherbit, based on Nicholas Hubbard's class - * for Dark Sky & Vince Peri's class for Weather.gov. - */ WeatherProvider.register("weatherbit", { // Set the name of the provider. // Not strictly required, but helps for debugging. diff --git a/modules/default/weather/providers/weatherflow.js b/modules/default/weather/providers/weatherflow.js index 9e15be82d8..4b17734e55 100644 --- a/modules/default/weather/providers/weatherflow.js +++ b/modules/default/weather/providers/weatherflow.js @@ -1,16 +1,5 @@ /* global WeatherProvider, WeatherObject, WeatherUtils */ -/* MagicMirror² - * Module: Weather - * Provider: Weatherflow - * - * By Tobias Dreyem https://github.com/10bias - * MIT Licensed - * - * This class is a provider for Weatherflow. - * Note that the Weatherflow API does not provide snowfall. - */ - WeatherProvider.register("weatherflow", { // Set the name of the provider. // Not strictly required, but helps for debugging diff --git a/modules/default/weather/providers/weathergov.js b/modules/default/weather/providers/weathergov.js index f66101468b..f97920c8e0 100644 --- a/modules/default/weather/providers/weathergov.js +++ b/modules/default/weather/providers/weathergov.js @@ -1,18 +1,5 @@ /* global WeatherProvider, WeatherObject, WeatherUtils */ -/* MagicMirror² - * Module: Weather - * Provider: weather.gov - * https://weather-gov.github.io/api/general-faqs - * - * Original by Vince Peri - * MIT Licensed. - * - * This class is a provider for weather.gov. - * Note that this is only for US locations (lat and lon) and does not require an API key - * Since it is free, there are some items missing - like sunrise, sunset - */ - WeatherProvider.register("weathergov", { // Set the name of the provider. // This isn't strictly necessary, since it will fallback to the provider identifier diff --git a/modules/default/weather/providers/yr.js b/modules/default/weather/providers/yr.js index 0c6701bfab..df2f4a8aff 100644 --- a/modules/default/weather/providers/yr.js +++ b/modules/default/weather/providers/yr.js @@ -1,16 +1,5 @@ /* global WeatherProvider, WeatherObject */ -/* MagicMirror² - * Module: Weather - * Provider: Yr.no - * - * By Magnus Marthinsen - * MIT Licensed - * - * This class is a provider for Yr.no, a norwegian weather service. - * - * Terms of service: https://developer.yr.no/doc/TermsOfService/ - */ WeatherProvider.register("yr", { providerName: "Yr", diff --git a/modules/default/weather/weather.js b/modules/default/weather/weather.js index 15e6cfc51b..f4149652df 100644 --- a/modules/default/weather/weather.js +++ b/modules/default/weather/weather.js @@ -1,11 +1,5 @@ /* global WeatherProvider, WeatherUtils, formatTime */ -/* MagicMirror² - * Module: Weather - * - * By Michael Teeuw https://michaelteeuw.nl - * MIT Licensed. - */ Module.register("weather", { // Default module config. defaults: { diff --git a/modules/default/weather/weatherobject.js b/modules/default/weather/weatherobject.js index 33c9e669bf..5d6801ce13 100644 --- a/modules/default/weather/weatherobject.js +++ b/modules/default/weather/weatherobject.js @@ -1,17 +1,5 @@ /* global SunCalc, WeatherUtils */ -/* MagicMirror² - * Module: Weather - * - * By Michael Teeuw https://michaelteeuw.nl - * MIT Licensed. - * - * This class is the blueprint for a day which includes weather information. - * - * Currently this is focused on the information which is necessary for the current weather. - * As soon as we start implementing the forecast, mode properties will be added. - */ - /** * @external Moment */ diff --git a/modules/default/weather/weatherprovider.js b/modules/default/weather/weatherprovider.js index b85e1a9924..f0dbeb8f7f 100644 --- a/modules/default/weather/weatherprovider.js +++ b/modules/default/weather/weatherprovider.js @@ -1,13 +1,5 @@ /* global Class, performWebRequest, OverrideWrapper */ -/* MagicMirror² - * Module: Weather - * - * By Michael Teeuw https://michaelteeuw.nl - * MIT Licensed. - * - * This class is the blueprint for a weather provider. - */ const WeatherProvider = Class.extend({ // Weather Provider Properties providerName: null, diff --git a/modules/default/weather/weatherutils.js b/modules/default/weather/weatherutils.js index e0c5709e0f..e75baf20f7 100644 --- a/modules/default/weather/weatherutils.js +++ b/modules/default/weather/weatherutils.js @@ -1,9 +1,3 @@ -/* MagicMirror² - * Weather Util Methods - * - * By Rejas - * MIT Licensed. - */ const WeatherUtils = { /** diff --git a/tests/configs/default.js b/tests/configs/default.js index 509dfd9860..ba6652068c 100644 --- a/tests/configs/default.js +++ b/tests/configs/default.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test default config for modules - * - * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com - * MIT Licensed. - */ exports.configFactory = (options) => { return Object.assign( { diff --git a/tests/configs/empty_ipWhiteList.js b/tests/configs/empty_ipWhiteList.js index 5288112d08..8fdfc0e42d 100644 --- a/tests/configs/empty_ipWhiteList.js +++ b/tests/configs/empty_ipWhiteList.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config sample ipWhitelist - * - * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com - * MIT Licensed. - */ let config = require(`${process.cwd()}/tests/configs/default.js`).configFactory({ ipWhitelist: [], port: 8282 diff --git a/tests/configs/modules/alert/default.js b/tests/configs/modules/alert/default.js index 45ffefe5b2..ea77b574be 100644 --- a/tests/configs/modules/alert/default.js +++ b/tests/configs/modules/alert/default.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config sample module alert - * - * By rejas - * MIT Licensed. - */ let config = { modules: [ { diff --git a/tests/configs/modules/calendar/auth-default.js b/tests/configs/modules/calendar/auth-default.js index 0b2491612f..99ce3922b0 100644 --- a/tests/configs/modules/calendar/auth-default.js +++ b/tests/configs/modules/calendar/auth-default.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config default calendar with auth by default - * - * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com - * MIT Licensed. - */ let config = { timeFormat: 12, diff --git a/tests/configs/modules/calendar/bad_rrule.js b/tests/configs/modules/calendar/bad_rrule.js index 5a89b5e616..3810794384 100644 --- a/tests/configs/modules/calendar/bad_rrule.js +++ b/tests/configs/modules/calendar/bad_rrule.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test ics with out of date event causing bad return from rrule.between - * - * By Sam Detweiler - * MIT Licensed. - */ let config = { timeFormat: 12, logLevel: ["INFO", "LOG", "WARN", "ERROR", "DEBUG"], diff --git a/tests/configs/modules/calendar/basic-auth.js b/tests/configs/modules/calendar/basic-auth.js index 5cbebceb2f..f322f573d7 100644 --- a/tests/configs/modules/calendar/basic-auth.js +++ b/tests/configs/modules/calendar/basic-auth.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config default calendar - * - * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com - * MIT Licensed. - */ let config = { timeFormat: 12, diff --git a/tests/configs/modules/calendar/changed-port.js b/tests/configs/modules/calendar/changed-port.js index 5027726115..15bf920739 100644 --- a/tests/configs/modules/calendar/changed-port.js +++ b/tests/configs/modules/calendar/changed-port.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config default calendar with auth by default - * - * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com - * MIT Licensed. - */ let config = { timeFormat: 12, diff --git a/tests/configs/modules/calendar/custom.js b/tests/configs/modules/calendar/custom.js index 4153da0460..4c6deb7838 100644 --- a/tests/configs/modules/calendar/custom.js +++ b/tests/configs/modules/calendar/custom.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config custom calendar - * - * By Rejas - * MIT Licensed. - */ let config = { timeFormat: 12, diff --git a/tests/configs/modules/calendar/default.js b/tests/configs/modules/calendar/default.js index 2dee121203..67c943d3c9 100644 --- a/tests/configs/modules/calendar/default.js +++ b/tests/configs/modules/calendar/default.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config default calendar - * - * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com - * MIT Licensed. - */ let config = { timeFormat: 12, diff --git a/tests/configs/modules/calendar/exdate.js b/tests/configs/modules/calendar/exdate.js index 574b24fef8..dab9692b64 100644 --- a/tests/configs/modules/calendar/exdate.js +++ b/tests/configs/modules/calendar/exdate.js @@ -1,14 +1,3 @@ -/* MagicMirror² Test calendar exdate - * - * By jkriegshauser - * MIT Licensed. - * - * NOTE: calendar_test_exdate.ics has exdate entries for the next 20 years, but without some - * way to set a debug date for tests, this test may become flaky on specific days (i.e. could - * not test easily on leap-years, the BYDAY specified in exdate, etc.) or when the 20 years - * elapses if this project is still in active development ;) - * See issue #3250 - */ let config = { timeFormat: 12, diff --git a/tests/configs/modules/calendar/fail-basic-auth.js b/tests/configs/modules/calendar/fail-basic-auth.js index e0b3ff15ae..2a58d623d6 100644 --- a/tests/configs/modules/calendar/fail-basic-auth.js +++ b/tests/configs/modules/calendar/fail-basic-auth.js @@ -1,10 +1,3 @@ -/* MagicMirror² Test calendar calendar - * - * This configuration is a wrong authentication - * - * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com - * MIT Licensed. - */ let config = { timeFormat: 12, diff --git a/tests/configs/modules/calendar/old-basic-auth.js b/tests/configs/modules/calendar/old-basic-auth.js index 01805e5c8c..08dc407316 100644 --- a/tests/configs/modules/calendar/old-basic-auth.js +++ b/tests/configs/modules/calendar/old-basic-auth.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config default calendar - * with authentication old config - * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com - * MIT Licensed. - */ let config = { timeFormat: 12, diff --git a/tests/configs/modules/calendar/recurring.js b/tests/configs/modules/calendar/recurring.js index d05cce6c9b..fe1d36629e 100644 --- a/tests/configs/modules/calendar/recurring.js +++ b/tests/configs/modules/calendar/recurring.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config custom calendar - * - * By Rejas - * MIT Licensed. - */ let config = { timeFormat: 12, diff --git a/tests/configs/modules/calendar/show-duplicates-in-calendar.js b/tests/configs/modules/calendar/show-duplicates-in-calendar.js index 89fb8eb93e..c4a1c95811 100644 --- a/tests/configs/modules/calendar/show-duplicates-in-calendar.js +++ b/tests/configs/modules/calendar/show-duplicates-in-calendar.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config for multiple calendar events having the same name and start date/time - * - * By Paranoid93 https://github.com/Paranoid93/ - * MIT Licensed. - */ let config = { timeFormat: 12, diff --git a/tests/configs/modules/clock/clock_12hr.js b/tests/configs/modules/clock/clock_12hr.js index 18170e7c9c..4a7318f58d 100644 --- a/tests/configs/modules/clock/clock_12hr.js +++ b/tests/configs/modules/clock/clock_12hr.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config for default clock module - * - * By Sergey Morozov - * MIT Licensed. - */ let config = { timeFormat: 12, diff --git a/tests/configs/modules/clock/clock_24hr.js b/tests/configs/modules/clock/clock_24hr.js index f9bd451436..f75287eb04 100644 --- a/tests/configs/modules/clock/clock_24hr.js +++ b/tests/configs/modules/clock/clock_24hr.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config for default clock module - * - * By Sergey Morozov - * MIT Licensed. - */ let config = { modules: [ { diff --git a/tests/configs/modules/clock/clock_analog.js b/tests/configs/modules/clock/clock_analog.js index d303c3f995..98331ee389 100644 --- a/tests/configs/modules/clock/clock_analog.js +++ b/tests/configs/modules/clock/clock_analog.js @@ -1,7 +1,3 @@ -/* MagicMirror² Test config for analog clock face - * - * MIT Licensed. - */ let config = { modules: [ { diff --git a/tests/configs/modules/clock/clock_displaySeconds_false.js b/tests/configs/modules/clock/clock_displaySeconds_false.js index cf33332090..181e8c6085 100644 --- a/tests/configs/modules/clock/clock_displaySeconds_false.js +++ b/tests/configs/modules/clock/clock_displaySeconds_false.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config for default clock module - * - * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com - * MIT Licensed. - */ let config = { timeFormat: 12, diff --git a/tests/configs/modules/clock/clock_showDateAnalog.js b/tests/configs/modules/clock/clock_showDateAnalog.js index e5f5c49b7d..772261c187 100644 --- a/tests/configs/modules/clock/clock_showDateAnalog.js +++ b/tests/configs/modules/clock/clock_showDateAnalog.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config for default clock module - * - * By Johan Hammar - * MIT Licensed. - */ let config = { timeFormat: 12, diff --git a/tests/configs/modules/clock/clock_showPeriodUpper.js b/tests/configs/modules/clock/clock_showPeriodUpper.js index 3dd8b5c52f..78a1f315ef 100644 --- a/tests/configs/modules/clock/clock_showPeriodUpper.js +++ b/tests/configs/modules/clock/clock_showPeriodUpper.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config for default clock module - * - * By Sergey Morozov - * MIT Licensed. - */ let config = { timeFormat: 12, diff --git a/tests/configs/modules/clock/clock_showSunMoon.js b/tests/configs/modules/clock/clock_showSunMoon.js index 025e054d1d..c5766aa255 100644 --- a/tests/configs/modules/clock/clock_showSunMoon.js +++ b/tests/configs/modules/clock/clock_showSunMoon.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config for default clock module - * - * By Johan Hammar - * MIT Licensed. - */ let config = { timeFormat: 12, diff --git a/tests/configs/modules/clock/clock_showTime.js b/tests/configs/modules/clock/clock_showTime.js index 17ea4590d1..5e68951e2f 100644 --- a/tests/configs/modules/clock/clock_showTime.js +++ b/tests/configs/modules/clock/clock_showTime.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config for default clock module - * - * By Johan Hammar - * MIT Licensed. - */ let config = { timeFormat: 12, diff --git a/tests/configs/modules/clock/clock_showWeek.js b/tests/configs/modules/clock/clock_showWeek.js index 71377e0bc5..7af4740655 100644 --- a/tests/configs/modules/clock/clock_showWeek.js +++ b/tests/configs/modules/clock/clock_showWeek.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config for default clock module - * - * By Johan Hammar - * MIT Licensed. - */ let config = { timeFormat: 12, diff --git a/tests/configs/modules/clock/es/clock_12hr.js b/tests/configs/modules/clock/es/clock_12hr.js index 44444c06e4..66d380f8bf 100644 --- a/tests/configs/modules/clock/es/clock_12hr.js +++ b/tests/configs/modules/clock/es/clock_12hr.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config for default clock module - * - * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com - * MIT Licensed. - */ let config = { language: "es", timeFormat: 12, diff --git a/tests/configs/modules/clock/es/clock_24hr.js b/tests/configs/modules/clock/es/clock_24hr.js index 66b5304d17..752c5fd054 100644 --- a/tests/configs/modules/clock/es/clock_24hr.js +++ b/tests/configs/modules/clock/es/clock_24hr.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config for default clock module - * - * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com - * MIT Licensed. - */ let config = { language: "es", diff --git a/tests/configs/modules/clock/es/clock_showPeriodUpper.js b/tests/configs/modules/clock/es/clock_showPeriodUpper.js index 5e1fbb4be2..76f5fd0433 100644 --- a/tests/configs/modules/clock/es/clock_showPeriodUpper.js +++ b/tests/configs/modules/clock/es/clock_showPeriodUpper.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config for default clock module - * - * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com - * MIT Licensed. - */ let config = { language: "es", timeFormat: 12, diff --git a/tests/configs/modules/clock/es/clock_showWeek.js b/tests/configs/modules/clock/es/clock_showWeek.js index 73635c0ec0..c43eccdaef 100644 --- a/tests/configs/modules/clock/es/clock_showWeek.js +++ b/tests/configs/modules/clock/es/clock_showWeek.js @@ -1,9 +1,3 @@ -/* MagicMirror² Test config for default clock module - * Language es for showWeek feature - * - * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com - * MIT Licensed. - */ let config = { language: "es", timeFormat: 12, diff --git a/tests/configs/modules/compliments/compliments_animateCSS.js b/tests/configs/modules/compliments/compliments_animateCSS.js index 24e2736073..1e3d3d2f9d 100644 --- a/tests/configs/modules/compliments/compliments_animateCSS.js +++ b/tests/configs/modules/compliments/compliments_animateCSS.js @@ -1,9 +1,3 @@ -/* MagicMirror² Test config sample for AnimateCSS integration with compliments module - * - * By bugsounet https://github.com/bugsounet - * 09/2023 - * MIT Licensed. - */ let config = { modules: [ { diff --git a/tests/configs/modules/compliments/compliments_animateCSS_fallbackToDefault.js b/tests/configs/modules/compliments/compliments_animateCSS_fallbackToDefault.js index 89c0694466..48f41cbfeb 100644 --- a/tests/configs/modules/compliments/compliments_animateCSS_fallbackToDefault.js +++ b/tests/configs/modules/compliments/compliments_animateCSS_fallbackToDefault.js @@ -1,10 +1,3 @@ -/* MagicMirror² Test config sample for AnimateCSS integration with compliments module - * --> if animation name is not an AnimateCSS animation - * --> must fallback to default (no animation) - * By bugsounet https://github.com/bugsounet - * 09/2023 - * MIT Licensed. - */ let config = { modules: [ { diff --git a/tests/configs/modules/compliments/compliments_animateCSS_invertedAnimationName.js b/tests/configs/modules/compliments/compliments_animateCSS_invertedAnimationName.js index eb4af0ca1b..310210bfc1 100644 --- a/tests/configs/modules/compliments/compliments_animateCSS_invertedAnimationName.js +++ b/tests/configs/modules/compliments/compliments_animateCSS_invertedAnimationName.js @@ -1,9 +1,3 @@ -/* MagicMirror² Test config sample for AnimateCSS integration with compliments module - * --> inversed name animation : in for out and vice versa (must return no animation) - * By bugsounet https://github.com/bugsounet - * 09/2023 - * MIT Licensed. - */ let config = { modules: [ { diff --git a/tests/configs/modules/compliments/compliments_anytime.js b/tests/configs/modules/compliments/compliments_anytime.js index 89253d9140..102b59ca8e 100644 --- a/tests/configs/modules/compliments/compliments_anytime.js +++ b/tests/configs/modules/compliments/compliments_anytime.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config compliments with anytime type - * - * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com - * MIT Licensed. - */ let config = { timeFormat: 12, diff --git a/tests/configs/modules/compliments/compliments_date.js b/tests/configs/modules/compliments/compliments_date.js index 2d9018b1d6..f1822f6a1c 100644 --- a/tests/configs/modules/compliments/compliments_date.js +++ b/tests/configs/modules/compliments/compliments_date.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config compliments with date type - * - * By Rejas - * MIT Licensed. - */ let config = { timeFormat: 12, diff --git a/tests/configs/modules/compliments/compliments_only_anytime.js b/tests/configs/modules/compliments/compliments_only_anytime.js index f1da683a94..8714bebd7e 100644 --- a/tests/configs/modules/compliments/compliments_only_anytime.js +++ b/tests/configs/modules/compliments/compliments_only_anytime.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config compliments with anytime type - * - * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com - * MIT Licensed. - */ let config = { timeFormat: 12, diff --git a/tests/configs/modules/compliments/compliments_parts_day.js b/tests/configs/modules/compliments/compliments_parts_day.js index ff34803a5b..f5a2bb7f42 100644 --- a/tests/configs/modules/compliments/compliments_parts_day.js +++ b/tests/configs/modules/compliments/compliments_parts_day.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config for default compliments - * - * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com - * MIT Licensed. - */ let config = { timeFormat: 12, diff --git a/tests/configs/modules/compliments/compliments_remote.js b/tests/configs/modules/compliments/compliments_remote.js index 4658929682..5d8543e1c8 100644 --- a/tests/configs/modules/compliments/compliments_remote.js +++ b/tests/configs/modules/compliments/compliments_remote.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config compliments with remote file - * - * By Rejas - * MIT Licensed. - */ let config = { modules: [ { diff --git a/tests/configs/modules/display.js b/tests/configs/modules/display.js index a416607743..c66e586a7b 100644 --- a/tests/configs/modules/display.js +++ b/tests/configs/modules/display.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config for display setters module using the helloworld module - * - * By Rejas - * MIT Licensed. - */ let config = { modules: [ { diff --git a/tests/configs/modules/helloworld/helloworld.js b/tests/configs/modules/helloworld/helloworld.js index 7225662127..d9aa0cb442 100644 --- a/tests/configs/modules/helloworld/helloworld.js +++ b/tests/configs/modules/helloworld/helloworld.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config sample module hello world - * - * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com - * MIT Licensed. - */ let config = { modules: [ { diff --git a/tests/configs/modules/helloworld/helloworld_default.js b/tests/configs/modules/helloworld/helloworld_default.js index 06e6fe8dda..b0b35c7e48 100644 --- a/tests/configs/modules/helloworld/helloworld_default.js +++ b/tests/configs/modules/helloworld/helloworld_default.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config sample module hello world default config - * - * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com - * MIT Licensed. - */ let config = { modules: [ { diff --git a/tests/configs/modules/newsfeed/default.js b/tests/configs/modules/newsfeed/default.js index 34a7587fb0..0023c4c386 100644 --- a/tests/configs/modules/newsfeed/default.js +++ b/tests/configs/modules/newsfeed/default.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config newsfeed module - * - * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com - * MIT Licensed. - */ let config = { timeFormat: 12, diff --git a/tests/configs/modules/newsfeed/ignore_items.js b/tests/configs/modules/newsfeed/ignore_items.js index fd104ba414..425ef78398 100644 --- a/tests/configs/modules/newsfeed/ignore_items.js +++ b/tests/configs/modules/newsfeed/ignore_items.js @@ -1,7 +1,3 @@ -/* MagicMirror² Test config newsfeed module - * - * MIT Licensed. - */ let config = { timeFormat: 12, diff --git a/tests/configs/modules/newsfeed/incorrect_url.js b/tests/configs/modules/newsfeed/incorrect_url.js index f9d75b09a3..565da18997 100644 --- a/tests/configs/modules/newsfeed/incorrect_url.js +++ b/tests/configs/modules/newsfeed/incorrect_url.js @@ -1,7 +1,3 @@ -/* MagicMirror² Test config newsfeed module - * - * MIT Licensed. - */ let config = { timeFormat: 12, diff --git a/tests/configs/modules/newsfeed/prohibited_words.js b/tests/configs/modules/newsfeed/prohibited_words.js index 4ff6aec0fa..143fcf903c 100644 --- a/tests/configs/modules/newsfeed/prohibited_words.js +++ b/tests/configs/modules/newsfeed/prohibited_words.js @@ -1,7 +1,3 @@ -/* MagicMirror² Test config newsfeed module - * - * MIT Licensed. - */ let config = { timeFormat: 12, diff --git a/tests/configs/modules/positions.js b/tests/configs/modules/positions.js index a40bfab959..e9e0d07a76 100644 --- a/tests/configs/modules/positions.js +++ b/tests/configs/modules/positions.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config for position setters module using the helloworld module - * - * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com - * MIT Licensed. - */ let config = { modules: // Using exotic content. This is why don't accept go to JSON configuration file diff --git a/tests/configs/modules/weather/currentweather_compliments.js b/tests/configs/modules/weather/currentweather_compliments.js index 4af544663f..25303fd3cb 100644 --- a/tests/configs/modules/weather/currentweather_compliments.js +++ b/tests/configs/modules/weather/currentweather_compliments.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config current weather compliments - * - * By rejas https://github.com/rejas - * MIT Licensed. - */ let config = { modules: [ { diff --git a/tests/configs/modules/weather/currentweather_default.js b/tests/configs/modules/weather/currentweather_default.js index e2ef16b764..cd02cdecc5 100644 --- a/tests/configs/modules/weather/currentweather_default.js +++ b/tests/configs/modules/weather/currentweather_default.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config default weather - * - * By fewieden https://github.com/fewieden - * MIT Licensed. - */ let config = { timeFormat: 12, diff --git a/tests/configs/modules/weather/currentweather_options.js b/tests/configs/modules/weather/currentweather_options.js index 2dd9216327..5ad748e480 100644 --- a/tests/configs/modules/weather/currentweather_options.js +++ b/tests/configs/modules/weather/currentweather_options.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config default weather - * - * By fewieden https://github.com/fewieden - * MIT Licensed. - */ let config = { modules: [ { diff --git a/tests/configs/modules/weather/currentweather_units.js b/tests/configs/modules/weather/currentweather_units.js index ac007314a5..a51bb58ab7 100644 --- a/tests/configs/modules/weather/currentweather_units.js +++ b/tests/configs/modules/weather/currentweather_units.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config default weather - * - * By fewieden https://github.com/fewieden - * MIT Licensed. - */ let config = { units: "imperial", diff --git a/tests/configs/modules/weather/forecastweather_absolute.js b/tests/configs/modules/weather/forecastweather_absolute.js index 9972383b4e..a2640d3025 100644 --- a/tests/configs/modules/weather/forecastweather_absolute.js +++ b/tests/configs/modules/weather/forecastweather_absolute.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config default weather - * - * By fewieden https://github.com/fewieden - * MIT Licensed. - */ let config = { timeFormat: 12, diff --git a/tests/configs/modules/weather/forecastweather_default.js b/tests/configs/modules/weather/forecastweather_default.js index 6f535b39c3..4cddef62fa 100644 --- a/tests/configs/modules/weather/forecastweather_default.js +++ b/tests/configs/modules/weather/forecastweather_default.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config default weather - * - * By fewieden https://github.com/fewieden - * MIT Licensed. - */ let config = { timeFormat: 12, diff --git a/tests/configs/modules/weather/forecastweather_options.js b/tests/configs/modules/weather/forecastweather_options.js index 23cda84f67..0eea8292ed 100644 --- a/tests/configs/modules/weather/forecastweather_options.js +++ b/tests/configs/modules/weather/forecastweather_options.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config default weather - * - * By fewieden https://github.com/fewieden - * MIT Licensed. - */ let config = { timeFormat: 12, diff --git a/tests/configs/modules/weather/forecastweather_units.js b/tests/configs/modules/weather/forecastweather_units.js index 22a9820a1e..8ac58a43b0 100644 --- a/tests/configs/modules/weather/forecastweather_units.js +++ b/tests/configs/modules/weather/forecastweather_units.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config default weather - * - * By rejas - * MIT Licensed. - */ let config = { units: "imperial", diff --git a/tests/configs/modules/weather/hourlyweather_default.js b/tests/configs/modules/weather/hourlyweather_default.js index aca5ced8f8..8e46b44cab 100644 --- a/tests/configs/modules/weather/hourlyweather_default.js +++ b/tests/configs/modules/weather/hourlyweather_default.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config hourly weather - * - * By rejas https://github.com/rejas - * MIT Licensed. - */ let config = { timeFormat: 12, diff --git a/tests/configs/modules/weather/hourlyweather_options.js b/tests/configs/modules/weather/hourlyweather_options.js index 0d73311768..b37fd7b9f1 100644 --- a/tests/configs/modules/weather/hourlyweather_options.js +++ b/tests/configs/modules/weather/hourlyweather_options.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config hourly weather options - * - * By rejas https://github.com/rejas - * MIT Licensed. - */ let config = { timeFormat: 12, diff --git a/tests/configs/modules/weather/hourlyweather_showPrecipitation.js b/tests/configs/modules/weather/hourlyweather_showPrecipitation.js index 4ba579e1d3..0e79858f16 100644 --- a/tests/configs/modules/weather/hourlyweather_showPrecipitation.js +++ b/tests/configs/modules/weather/hourlyweather_showPrecipitation.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config hourly weather - * - * By rejas https://github.com/rejas - * MIT Licensed. - */ let config = { timeFormat: 12, diff --git a/tests/configs/noIpWhiteList.js b/tests/configs/noIpWhiteList.js index 09e74061a2..57eaa91215 100644 --- a/tests/configs/noIpWhiteList.js +++ b/tests/configs/noIpWhiteList.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config sample ipWhitelist - * - * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com - * MIT Licensed. - */ let config = require(`${process.cwd()}/tests/configs/default.js`).configFactory({ ipWhitelist: ["x.x.x.x"], port: 8181 diff --git a/tests/configs/port_8090.js b/tests/configs/port_8090.js index 25d4bce224..4019be8e89 100644 --- a/tests/configs/port_8090.js +++ b/tests/configs/port_8090.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test config sample environment set port 8090 - * - * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com - * MIT Licensed. - */ let config = require(`${process.cwd()}/tests/configs/default.js`).configFactory({ port: 8090 }); diff --git a/tests/configs/port_variable.js.template b/tests/configs/port_variable.js.template index 0a0d58bb9a..e44aa5ac90 100644 --- a/tests/configs/port_variable.js.template +++ b/tests/configs/port_variable.js.template @@ -1,8 +1,3 @@ -/* MagicMirror² Test config sample environment set port 8090 - * - * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com - * MIT Licensed. - */ let config = require(`${process.cwd()}/tests/configs/default.js`).configFactory({ port: ${MM_PORT} }); diff --git a/tests/configs/without_modules.js b/tests/configs/without_modules.js index 51ce02f6e0..abe8fbc42e 100644 --- a/tests/configs/without_modules.js +++ b/tests/configs/without_modules.js @@ -1,8 +1,3 @@ -/* MagicMirror² Test default config for modules - * - * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com - * MIT Licensed. - */ let config = { ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1", "::ffff:192.168.10.1"] }; diff --git a/translations/translations.js b/translations/translations.js index f3b2d2c14a..69d1591dfa 100644 --- a/translations/translations.js +++ b/translations/translations.js @@ -1,10 +1,3 @@ -/* MagicMirror² - * Translation Definition - * - * By Michael Teeuw https://michaelteeuw.nl - * MIT Licensed. - */ - let translations = { en: "translations/en.json", // English nl: "translations/nl.json", // Dutch diff --git a/vendor/vendor.js b/vendor/vendor.js index 7d7a2a8ee8..b2d912d4de 100644 --- a/vendor/vendor.js +++ b/vendor/vendor.js @@ -1,9 +1,3 @@ -/* MagicMirror² - * Vendor File Definition - * - * By Michael Teeuw https://michaelteeuw.nl - * MIT Licensed. - */ const vendor = { "moment.js": "node_modules/moment/min/moment-with-locales.js", "moment-timezone.js": "node_modules/moment-timezone/builds/moment-timezone-with-data.js", From 2a8913974a5397a4cfa4a3ff8f1c166305aba7f4 Mon Sep 17 00:00:00 2001 From: Karsten Hassel Date: Thu, 18 Jan 2024 23:30:40 +0100 Subject: [PATCH 2/4] add back useful informations --- config/config.js.sample | 10 ++++++ css/custom.css.sample | 11 +++++-- .../default/weather/providers/envcanada.js | 28 ++++++++++++++++ .../weather/providers/ukmetofficedatahub.js | 32 +++++++++++++++++++ .../default/weather/providers/weathergov.js | 8 +++++ tests/configs/modules/calendar/exdate.js | 6 ++++ 6 files changed, 93 insertions(+), 2 deletions(-) diff --git a/config/config.js.sample b/config/config.js.sample index edab06fae5..688f627286 100644 --- a/config/config.js.sample +++ b/config/config.js.sample @@ -1,3 +1,13 @@ +/* Config Sample + * + * For more information on how you can configure this file + * see https://docs.magicmirror.builders/configuration/introduction.html + * and https://docs.magicmirror.builders/modules/configuration.html + * + * You can use environment variables using a `config.js.template` file instead of `config.js` + * which will be converted to `config.js` while starting. For more information + * see https://docs.magicmirror.builders/configuration/introduction.html#enviromnent-variables + */ let config = { address: "localhost", // Address to listen on, can be: // - "localhost", "127.0.0.1", "::1" to listen on loopback interface diff --git a/css/custom.css.sample b/css/custom.css.sample index 4adb57aae3..29590206a7 100644 --- a/css/custom.css.sample +++ b/css/custom.css.sample @@ -1,3 +1,10 @@ +/* Custom CSS Sample + * + * Change color and fonts here. + * + * Beware that properties cannot be unitless, so for example write '--gap-body: 0px;' instead of just '--gap-body: 0;' + */ + /* Uncomment and adjust accordingly if you want to import another font from the google-fonts-api: */ /* @import url('https://fonts.googleapis.com/css2?family=Poppins:wght@100;300;400;700&display=swap'); */ @@ -9,7 +16,7 @@ --font-primary: "Roboto Condensed"; --font-secondary: "Roboto"; - + --font-size: 20px; --font-size-small: 0.75rem; @@ -17,6 +24,6 @@ --gap-body-right: 60px; --gap-body-bottom: 60px; --gap-body-left: 60px; - + --gap-modules: 30px; } diff --git a/modules/default/weather/providers/envcanada.js b/modules/default/weather/providers/envcanada.js index 77624453c0..7372e17689 100644 --- a/modules/default/weather/providers/envcanada.js +++ b/modules/default/weather/providers/envcanada.js @@ -1,5 +1,33 @@ /* global WeatherProvider, WeatherObject, WeatherUtils */ +/* This class is a provider for Environment Canada MSC Datamart + * Note that this is only for Canadian locations and does not require an API key (access is anonymous) + * + * EC Documentation at following links: + * https://dd.weather.gc.ca/citypage_weather/schema/ + * https://eccc-msc.github.io/open-data/msc-datamart/readme_en/ + * + * This module supports Canadian locations only and requires 2 additional config parameters: + * + * siteCode - the city/town unique identifier for which weather is to be displayed. Format is 's0000000'. + * + * provCode - the 2-character province code for the selected city/town. + * + * Example: for Toronto, Ontario, the following parameters would be used + * + * siteCode: 's0000458', + * provCode: 'ON' + * + * To determine the siteCode and provCode values for a Canadian city/town, look at the Environment Canada document + * at https://dd.weather.gc.ca/citypage_weather/docs/site_list_en.csv (or site_list_fr.csv). There you will find a table + * with locations you can search under column B (English Names), with the corresponding siteCode under + * column A (Codes) and provCode under column C (Province). + * + * License to use Environment Canada (EC) data is detailed here: + * https://eccc-msc.github.io/open-data/licence/readme_en/ + * + */ + WeatherProvider.register("envcanada", { // Set the name of the provider for debugging and alerting purposes (eg. provide eye-catcher) providerName: "Environment Canada", diff --git a/modules/default/weather/providers/ukmetofficedatahub.js b/modules/default/weather/providers/ukmetofficedatahub.js index d8ead57bdd..1ca4da5c01 100644 --- a/modules/default/weather/providers/ukmetofficedatahub.js +++ b/modules/default/weather/providers/ukmetofficedatahub.js @@ -1,5 +1,37 @@ /* global WeatherProvider, WeatherObject */ +/* This class is a provider for UK Met Office Data Hub (the replacement for their Data Point services). + * For more information on Data Hub, see https://www.metoffice.gov.uk/services/data/datapoint/notifications/weather-datahub + * Data available: + * Hourly data for next 2 days ("hourly") - https://www.metoffice.gov.uk/binaries/content/assets/metofficegovuk/pdf/data/global-spot-data-hourly.pdf + * 3-hourly data for the next 7 days ("3hourly") - https://www.metoffice.gov.uk/binaries/content/assets/metofficegovuk/pdf/data/global-spot-data-3-hourly.pdf + * Daily data for the next 7 days ("daily") - https://www.metoffice.gov.uk/binaries/content/assets/metofficegovuk/pdf/data/global-spot-data-daily.pdf + * + * NOTES + * This provider requires longitude/latitude coordinates, rather than a location ID (as with the previous Met Office provider) + * Provide the following in your config.js file: + * weatherProvider: "ukmetofficedatahub", + * apiBase: "https://api-metoffice.apiconnect.ibmcloud.com/metoffice/production/v0/forecasts/point/", + * apiKey: "[YOUR API KEY]", + * apiSecret: "[YOUR API SECRET]", + * lat: [LATITUDE (DECIMAL)], + * lon: [LONGITUDE (DECIMAL)] + * + * At time of writing, free accounts are limited to 360 requests a day per service (hourly, 3hourly, daily); take this in mind when + * setting your update intervals. For reference, 360 requests per day is once every 4 minutes. + * + * Pay attention to the units of the supplied data from the Met Office - it is given in SI/metric units where applicable: + * - Temperatures are in degrees Celsius (°C) + * - Wind speeds are in metres per second (m/s) + * - Wind direction given in degrees (°) + * - Pressures are in Pascals (Pa) + * - Distances are in metres (m) + * - Probabilities and humidity are given as percentages (%) + * - Precipitation is measured in millimetres (mm) with rates per hour (mm/h) + * + * See the PDFs linked above for more information on the data their corresponding units. + */ + WeatherProvider.register("ukmetofficedatahub", { // Set the name of the provider. providerName: "UK Met Office (DataHub)", diff --git a/modules/default/weather/providers/weathergov.js b/modules/default/weather/providers/weathergov.js index f97920c8e0..661f36af59 100644 --- a/modules/default/weather/providers/weathergov.js +++ b/modules/default/weather/providers/weathergov.js @@ -1,5 +1,13 @@ /* global WeatherProvider, WeatherObject, WeatherUtils */ +/* Provider: weather.gov + * https://weather-gov.github.io/api/general-faqs + * + * This class is a provider for weather.gov. + * Note that this is only for US locations (lat and lon) and does not require an API key + * Since it is free, there are some items missing - like sunrise, sunset + */ + WeatherProvider.register("weathergov", { // Set the name of the provider. // This isn't strictly necessary, since it will fallback to the provider identifier diff --git a/tests/configs/modules/calendar/exdate.js b/tests/configs/modules/calendar/exdate.js index dab9692b64..bb52561aa0 100644 --- a/tests/configs/modules/calendar/exdate.js +++ b/tests/configs/modules/calendar/exdate.js @@ -1,3 +1,9 @@ +/* NOTE: calendar_test_exdate.ics has exdate entries for the next 20 years, but without some + * way to set a debug date for tests, this test may become flaky on specific days (i.e. could + * not test easily on leap-years, the BYDAY specified in exdate, etc.) or when the 20 years + * elapses if this project is still in active development ;) + * See issue #3250 + */ let config = { timeFormat: 12, From b1d340f42b931ef727274dc7f01735cf2ddad551 Mon Sep 17 00:00:00 2001 From: Karsten Hassel Date: Thu, 18 Jan 2024 23:38:42 +0100 Subject: [PATCH 3/4] remove other findings --- js/class.js | 7 ------- modules/default/alert/notificationFx.js | 13 ------------- modules/default/calendar/debug.js | 3 --- tests/e2e/animateCSS_spec.js | 7 ------- 4 files changed, 30 deletions(-) diff --git a/js/class.js b/js/class.js index c3a0ab22eb..f00dff943e 100644 --- a/js/class.js +++ b/js/class.js @@ -1,12 +1,5 @@ /* global Class, xyz */ -/* Simple JavaScript Inheritance - * By John Resig https://johnresig.com/ - * - * Inspired by base2 and Prototype - * - * MIT Licensed. - */ (function () { let initializing = false; const fnTest = (/xyz/).test(function () { diff --git a/modules/default/alert/notificationFx.js b/modules/default/alert/notificationFx.js index fcf7f3456b..e8bc53a609 100644 --- a/modules/default/alert/notificationFx.js +++ b/modules/default/alert/notificationFx.js @@ -1,16 +1,3 @@ -/** - * Based on work by - * - * notificationFx.js v1.0.0 - * https://tympanus.net/codrops/ - * - * Licensed under the MIT license. - * https://opensource.org/licenses/mit-license.php - * - * Copyright 2014, Codrops - * https://tympanus.net/codrops/ - * @param {object} window The window object - */ (function (window) { /** diff --git a/modules/default/calendar/debug.js b/modules/default/calendar/debug.js index 5e19e13134..71ed2f4abd 100644 --- a/modules/default/calendar/debug.js +++ b/modules/default/calendar/debug.js @@ -1,9 +1,6 @@ /* CalendarFetcher Tester * use this script with `node debug.js` to test the fetcher without the need * of starting the MagicMirror² core. Adjust the values below to your desire. - * - * By Michael Teeuw https://michaelteeuw.nl - * MIT Licensed. */ // Alias modules mentioned in package.js under _moduleAliases. require("module-alias/register"); diff --git a/tests/e2e/animateCSS_spec.js b/tests/e2e/animateCSS_spec.js index 3cb3aca607..d7fcb52e44 100644 --- a/tests/e2e/animateCSS_spec.js +++ b/tests/e2e/animateCSS_spec.js @@ -1,10 +1,3 @@ -/* AnimateCSS integration Test with compliments module - * - * By bugsounet https://github.com/bugsounet - * and helped by khassel - * 09/2023 - * MIT Licensed. - */ const helpers = require("./helpers/global-setup"); describe("AnimateCSS integration Test", () => { From 571bb1b6b8763faeda839d72cb112546e9321e42 Mon Sep 17 00:00:00 2001 From: Karsten Hassel Date: Wed, 24 Jan 2024 21:33:28 +0100 Subject: [PATCH 4/4] changes requested by @rejas --- js/class.js | 7 +++++++ js/logger.js | 1 + js/module.js | 3 +++ modules/default/alert/notificationFx.js | 13 +++++++++++++ modules/default/defaultmodules.js | 3 +++ modules/default/weather/providers/openmeteo.js | 4 ++++ modules/default/weather/providers/openweathermap.js | 3 +++ modules/default/weather/providers/pirateweather.js | 3 +++ modules/default/weather/providers/smhi.js | 4 ++++ modules/default/weather/providers/ukmetoffice.js | 3 +++ modules/default/weather/providers/weatherbit.js | 3 +++ modules/default/weather/providers/weatherflow.js | 3 +++ modules/default/weather/providers/yr.js | 3 +++ modules/default/weather/weatherprovider.js | 1 + 14 files changed, 54 insertions(+) diff --git a/js/class.js b/js/class.js index f00dff943e..c3a0ab22eb 100644 --- a/js/class.js +++ b/js/class.js @@ -1,5 +1,12 @@ /* global Class, xyz */ +/* Simple JavaScript Inheritance + * By John Resig https://johnresig.com/ + * + * Inspired by base2 and Prototype + * + * MIT Licensed. + */ (function () { let initializing = false; const fnTest = (/xyz/).test(function () { diff --git a/js/logger.js b/js/logger.js index 7af4a0f7d8..0c254082c4 100644 --- a/js/logger.js +++ b/js/logger.js @@ -1,3 +1,4 @@ +// This logger is very simple, but needs to be extended. (function (root, factory) { if (typeof exports === "object") { if (process.env.JEST_WORKER_ID === undefined) { diff --git a/js/module.js b/js/module.js index ef9c55fbc7..71451763d0 100644 --- a/js/module.js +++ b/js/module.js @@ -1,5 +1,8 @@ /* global Class, cloneObject, Loader, MMSocket, nunjucks, Translator */ +/* Module Blueprint. + * @typedef {Object} Module + */ const Module = Class.extend({ /********************************************************* diff --git a/modules/default/alert/notificationFx.js b/modules/default/alert/notificationFx.js index e8bc53a609..fcf7f3456b 100644 --- a/modules/default/alert/notificationFx.js +++ b/modules/default/alert/notificationFx.js @@ -1,3 +1,16 @@ +/** + * Based on work by + * + * notificationFx.js v1.0.0 + * https://tympanus.net/codrops/ + * + * Licensed under the MIT license. + * https://opensource.org/licenses/mit-license.php + * + * Copyright 2014, Codrops + * https://tympanus.net/codrops/ + * @param {object} window The window object + */ (function (window) { /** diff --git a/modules/default/defaultmodules.js b/modules/default/defaultmodules.js index 6c39367ad7..e28413ff7b 100644 --- a/modules/default/defaultmodules.js +++ b/modules/default/defaultmodules.js @@ -1,3 +1,6 @@ +/* Default Modules List + * Modules listed below can be loaded without the 'default/' prefix. Omitting the default folder name. + */ const defaultModules = ["alert", "calendar", "clock", "compliments", "helloworld", "newsfeed", "updatenotification", "weather"]; /*************** DO NOT EDIT THE LINE BELOW ***************/ diff --git a/modules/default/weather/providers/openmeteo.js b/modules/default/weather/providers/openmeteo.js index 780eed7d9d..5c4b232200 100644 --- a/modules/default/weather/providers/openmeteo.js +++ b/modules/default/weather/providers/openmeteo.js @@ -1,5 +1,9 @@ /* global WeatherProvider, WeatherObject */ +/* This class is a provider for Open-Meteo, + * see https://open-meteo.com/ + */ + // https://www.bigdatacloud.com/docs/api/free-reverse-geocode-to-city-api const GEOCODE_BASE = "https://api.bigdatacloud.net/data/reverse-geocode-client"; const OPEN_METEO_BASE = "https://api.open-meteo.com/v1"; diff --git a/modules/default/weather/providers/openweathermap.js b/modules/default/weather/providers/openweathermap.js index 77c991d321..0999c83f0a 100644 --- a/modules/default/weather/providers/openweathermap.js +++ b/modules/default/weather/providers/openweathermap.js @@ -1,5 +1,8 @@ /* global WeatherProvider, WeatherObject */ +/* This class is a provider for Openweathermap, + * see https://openweathermap.org/ + */ WeatherProvider.register("openweathermap", { // Set the name of the provider. // This isn't strictly necessary, since it will fallback to the provider identifier diff --git a/modules/default/weather/providers/pirateweather.js b/modules/default/weather/providers/pirateweather.js index cb8b8eda60..dd20ccf47d 100644 --- a/modules/default/weather/providers/pirateweather.js +++ b/modules/default/weather/providers/pirateweather.js @@ -1,5 +1,8 @@ /* global WeatherProvider, WeatherObject */ +/* This class is a provider for Pirate Weather, it is a replacement for Dark Sky (same api), + * see http://pirateweather.net/en/latest/ + */ WeatherProvider.register("pirateweather", { // Set the name of the provider. // Not strictly required, but helps for debugging. diff --git a/modules/default/weather/providers/smhi.js b/modules/default/weather/providers/smhi.js index 05df75772a..d7dcdf1b6f 100644 --- a/modules/default/weather/providers/smhi.js +++ b/modules/default/weather/providers/smhi.js @@ -1,5 +1,9 @@ /* global WeatherProvider, WeatherObject */ +/* This class is a provider for SMHI (Sweden only). + * Metric system is the only supported unit, + * see https://www.smhi.se/ + */ WeatherProvider.register("smhi", { providerName: "SMHI", diff --git a/modules/default/weather/providers/ukmetoffice.js b/modules/default/weather/providers/ukmetoffice.js index 66a5d01a9b..c2db4cda37 100644 --- a/modules/default/weather/providers/ukmetoffice.js +++ b/modules/default/weather/providers/ukmetoffice.js @@ -1,5 +1,8 @@ /* global WeatherProvider, WeatherObject, WeatherUtils */ +/* This class is a provider for UK Met Office Datapoint, + * see https://www.metoffice.gov.uk/ + */ WeatherProvider.register("ukmetoffice", { // Set the name of the provider. // This isn't strictly necessary, since it will fallback to the provider identifier diff --git a/modules/default/weather/providers/weatherbit.js b/modules/default/weather/providers/weatherbit.js index a600e75de7..7c01f5d6be 100644 --- a/modules/default/weather/providers/weatherbit.js +++ b/modules/default/weather/providers/weatherbit.js @@ -1,5 +1,8 @@ /* global WeatherProvider, WeatherObject */ +/* This class is a provider for Weatherbit, + * see https://www.weatherbit.io/ + */ WeatherProvider.register("weatherbit", { // Set the name of the provider. // Not strictly required, but helps for debugging. diff --git a/modules/default/weather/providers/weatherflow.js b/modules/default/weather/providers/weatherflow.js index 4b17734e55..54066d7b40 100644 --- a/modules/default/weather/providers/weatherflow.js +++ b/modules/default/weather/providers/weatherflow.js @@ -1,5 +1,8 @@ /* global WeatherProvider, WeatherObject, WeatherUtils */ +/* This class is a provider for Weatherflow. + * Note that the Weatherflow API does not provide snowfall. + */ WeatherProvider.register("weatherflow", { // Set the name of the provider. // Not strictly required, but helps for debugging diff --git a/modules/default/weather/providers/yr.js b/modules/default/weather/providers/yr.js index df2f4a8aff..35493a1653 100644 --- a/modules/default/weather/providers/yr.js +++ b/modules/default/weather/providers/yr.js @@ -1,5 +1,8 @@ /* global WeatherProvider, WeatherObject */ +/* This class is a provider for Yr.no, a norwegian weather service. + * Terms of service: https://developer.yr.no/doc/TermsOfService/ + */ WeatherProvider.register("yr", { providerName: "Yr", diff --git a/modules/default/weather/weatherprovider.js b/modules/default/weather/weatherprovider.js index f0dbeb8f7f..3646441094 100644 --- a/modules/default/weather/weatherprovider.js +++ b/modules/default/weather/weatherprovider.js @@ -1,5 +1,6 @@ /* global Class, performWebRequest, OverrideWrapper */ +// This class is the blueprint for a weather provider. const WeatherProvider = Class.extend({ // Weather Provider Properties providerName: null,