remove all useless header comments (#3363)

see #3358 used command: `find ./ -type f -exec perl -i -0pe 's/\/\*\s*magicmirror.*?\*\/\s*//si' {} \;` This is a first draft, I think we should preserve some of the comments.
MagicMirrorOrg · Jan 24, 2024 · 27f3c86 · 27f3c86
1 parent b0161fe
commit 27f3c86
Show file tree

Hide file tree

Showing 108 changed files with 30 additions and 623 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -34,6 +34,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
@@ -1,7 +1,4 @@
-/* MagicMirror² Config Sample
- *
- * By Michael Teeuw https://michaelteeuw.nl
- * MIT Licensed.
+/* Config Sample
  *
  * For more information on how you can configure this file
  * see https://docs.magicmirror.builders/configuration/introduction.html

diff --git a/css/custom.css.sample b/css/custom.css.sample
@@ -1,10 +1,8 @@
-/* MagicMirror² Custom CSS Sample
+/* 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: */
@@ -18,14 +16,14 @@
 
   --font-primary: "Roboto Condensed";
   --font-secondary: "Roboto";
-  
+
   --font-size: 20px;
   --font-size-small: 0.75rem;
 
   --gap-body-top: 60px;
   --gap-body-right: 60px;
   --gap-body-bottom: 60px;
   --gap-body-left: 60px;
-  
+
   --gap-modules: 30px;
 }
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -1,12 +1,4 @@
-/* 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.
- */
+// 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/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
@@ -1,11 +1,7 @@
 /* global Class, cloneObject, Loader, MMSocket, nunjucks, Translator */
 
-/* MagicMirror²
- * Module Blueprint.
+/* 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -1,9 +1,3 @@
-/* MagicMirror²
- * Calendar Util Methods
- *
- * By Rejas
- * MIT Licensed.
- */
 const CalendarUtils = {
 
 	/**

diff --git 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/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
@@ -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
@@ -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
@@ -1,8 +1,5 @@
-/* MagicMirror² Default Modules List
+/* 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"];
 

diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -1,10 +1,6 @@
 /* global WeatherProvider, WeatherObject, WeatherUtils */
 
-/* MagicMirror²
- * Module: Weather
- * Provider: Environment Canada (EC)
- *
- * This class is a provider for Environment Canada MSC Datamart
+/* 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:
@@ -27,8 +23,6 @@
  * 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/
  *