Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

remove all useless header comments #3363

Merged
merged 4 commits into from
Jan 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
5 changes: 1 addition & 4 deletions config/config.js.sample
Original file line number Diff line number Diff line change
@@ -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
Expand Down
8 changes: 3 additions & 5 deletions css/custom.css.sample
Original file line number Diff line number Diff line change
@@ -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: */
Expand All @@ -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;
}
7 changes: 0 additions & 7 deletions js/animateCSS.js
Original file line number Diff line number Diff line change
@@ -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
Expand Down
7 changes: 0 additions & 7 deletions js/app.js
Original file line number Diff line number Diff line change
@@ -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");

Expand Down
7 changes: 0 additions & 7 deletions js/check_config.js
Original file line number Diff line number Diff line change
@@ -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");
Expand Down
6 changes: 0 additions & 6 deletions js/defaults.js
Original file line number Diff line number Diff line change
@@ -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") {
Expand Down
8 changes: 0 additions & 8 deletions js/deprecated.js
Original file line number Diff line number Diff line change
@@ -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"]
};
6 changes: 0 additions & 6 deletions js/loader.js
Original file line number Diff line number Diff line change
@@ -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 */
Expand Down
10 changes: 1 addition & 9 deletions js/logger.js
Original file line number Diff line number Diff line change
@@ -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.
khassel marked this conversation as resolved.
Show resolved Hide resolved
*
* 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) {
Expand Down
6 changes: 0 additions & 6 deletions js/main.js
Original file line number Diff line number Diff line change
@@ -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 = [];

Expand Down
6 changes: 1 addition & 5 deletions js/module.js
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
/* global Class, cloneObject, Loader, MMSocket, nunjucks, Translator */

/* MagicMirror²
* Module Blueprint.
khassel marked this conversation as resolved.
Show resolved Hide resolved
/* Module Blueprint.
* @typedef {Object} Module
*
* By Michael Teeuw https://michaelteeuw.nl
* MIT Licensed.
*/
const Module = Class.extend({

Expand Down
6 changes: 0 additions & 6 deletions js/node_helper.js
Original file line number Diff line number Diff line change
@@ -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");
Expand Down
6 changes: 0 additions & 6 deletions js/server.js
Original file line number Diff line number Diff line change
@@ -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");
Expand Down
6 changes: 0 additions & 6 deletions js/socketclient.js
Original file line number Diff line number Diff line change
@@ -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.");
Expand Down
6 changes: 0 additions & 6 deletions js/translator.js
Original file line number Diff line number Diff line change
@@ -1,11 +1,5 @@
/* global translations */

/* MagicMirror²
* Translator (l10n)
*
* By Christopher Fenner https://github.com/CFenner
* MIT Licensed.
*/
const Translator = (function () {

/**
Expand Down
5 changes: 0 additions & 5 deletions js/utils.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
/* MagicMirror²
* Utils
*
* MIT Licensed.
*/
const execSync = require("node:child_process").execSync;
const Log = require("logger");
const si = require("systeminformation");
Expand Down
6 changes: 0 additions & 6 deletions modules/default/alert/alert.js
Original file line number Diff line number Diff line change
@@ -1,11 +1,5 @@
/* global NotificationFx */

/* MagicMirror²
* Module: alert
*
* By Paul-Vincent Roll https://paulvincentroll.com/
* MIT Licensed.
*/
Module.register("alert", {
alerts: {},

Expand Down
6 changes: 0 additions & 6 deletions modules/default/calendar/calendar.js
Original file line number Diff line number Diff line change
@@ -1,11 +1,5 @@
/* global CalendarUtils */

/* MagicMirror²
* Module: Calendar
*
* By Michael Teeuw https://michaelteeuw.nl
* MIT Licensed.
*/
Module.register("calendar", {
// Define module defaults
defaults: {
Expand Down
7 changes: 0 additions & 7 deletions modules/default/calendar/calendarfetcher.js
Original file line number Diff line number Diff line change
@@ -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");
Expand Down
7 changes: 0 additions & 7 deletions modules/default/calendar/calendarfetcherutils.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
/* MagicMirror²
* Calendar Fetcher Util Methods
*
* By Michael Teeuw https://michaelteeuw.nl
* MIT Licensed.
*/

/**
* @external Moment
*/
Expand Down
6 changes: 0 additions & 6 deletions modules/default/calendar/calendarutils.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
/* MagicMirror²
* Calendar Util Methods
*
* By Rejas
* MIT Licensed.
*/
const CalendarUtils = {

/**
Expand Down
3 changes: 0 additions & 3 deletions modules/default/calendar/debug.js
Original file line number Diff line number Diff line change
@@ -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");
Expand Down
6 changes: 0 additions & 6 deletions modules/default/calendar/node_helper.js
Original file line number Diff line number Diff line change
@@ -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");
Expand Down
6 changes: 0 additions & 6 deletions modules/default/clock/clock.js
Original file line number Diff line number Diff line change
@@ -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: {
Expand Down
6 changes: 0 additions & 6 deletions modules/default/compliments/compliments.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
/* MagicMirror²
* Module: Compliments
*
* By Michael Teeuw https://michaelteeuw.nl
* MIT Licensed.
*/
Module.register("compliments", {
// Module config defaults.
defaults: {
Expand Down
5 changes: 1 addition & 4 deletions modules/default/defaultmodules.js
Original file line number Diff line number Diff line change
@@ -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.
*
khassel marked this conversation as resolved.
Show resolved Hide resolved
* By Michael Teeuw https://michaelteeuw.nl
* MIT Licensed.
*/
const defaultModules = ["alert", "calendar", "clock", "compliments", "helloworld", "newsfeed", "updatenotification", "weather"];

Expand Down
6 changes: 0 additions & 6 deletions modules/default/helloworld/helloworld.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
/* MagicMirror²
* Module: HelloWorld
*
* By Michael Teeuw https://michaelteeuw.nl
* MIT Licensed.
*/
Module.register("helloworld", {
// Default module config.
defaults: {
Expand Down
6 changes: 0 additions & 6 deletions modules/default/newsfeed/newsfeed.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
/* MagicMirror²
* Module: NewsFeed
*
* By Michael Teeuw https://michaelteeuw.nl
* MIT Licensed.
*/
Module.register("newsfeed", {
// Default module config.
defaults: {
Expand Down
7 changes: 0 additions & 7 deletions modules/default/newsfeed/newsfeedfetcher.js
Original file line number Diff line number Diff line change
@@ -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");
Expand Down
7 changes: 0 additions & 7 deletions modules/default/newsfeed/node_helper.js
Original file line number Diff line number Diff line change
@@ -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");
Expand Down
6 changes: 0 additions & 6 deletions modules/default/updatenotification/updatenotification.js
Original file line number Diff line number Diff line change
@@ -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
Expand Down
8 changes: 1 addition & 7 deletions modules/default/weather/providers/envcanada.js
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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/
*
Expand Down
Loading
Loading