Replace prettier by stylistic to lint JavaScript (#3303)

In the latest versions of ESLint, more and more formatting rules were removed or declared deprecated. These rules have been integrated into the new Stylistic package (https://eslint.style/guide/why) and expanded. Stylistic acts as a better formatter for JavaScript as Prettier. With this PR there are many changes that make the code more uniform, but it may be difficult to review due to the large amount. Even if I have no worries about the changes, perhaps this would be something for the release after next. Let me know what you think.
2025-08-21 12:55:22 +00:00 · 2023-12-25 08:17:11 +01:00
parent 4e7b68a69d
commit 0b70274a1a
64 changed files with 954 additions and 942 deletions
--- a/modules/default/calendar/calendar.js
+++ b/modules/default/calendar/calendar.js
@@ -75,17 +75,17 @@ Module.register("calendar", {
 	requiresVersion: "2.1.0",

 	// Define required scripts.
-	getStyles: function () {
+	getStyles () {
 		return ["calendar.css", "font-awesome.css"];
 	},

 	// Define required scripts.
-	getScripts: function () {
+	getScripts () {
 		return ["calendarutils.js", "moment.js"];
 	},

 	// Define required translations.
-	getTranslations: function () {
+	getTranslations () {
 		// The translations for the default modules are defined in the core translation files.
 		// Therefore we can just return false. Otherwise we should have returned a dictionary.
 		// If you're trying to build your own module including translations, check out the documentation.
@@ -93,7 +93,7 @@ Module.register("calendar", {
 	},

 	// Override start method.
-	start: function () {
+	start () {
 		Log.info(`Starting module: ${this.name}`);

 		if (this.config.colored) {
@@ -169,7 +169,7 @@ Module.register("calendar", {
 	},

 	// Override socket notification handler.
-	socketNotificationReceived: function (notification, payload) {
+	socketNotificationReceived (notification, payload) {
 		if (notification === "FETCH_CALENDAR") {
 			this.sendSocketNotification(notification, { url: payload.url, id: this.identifier });
 		}
@@ -210,7 +210,7 @@ Module.register("calendar", {
 	},

 	// Override dom generator.
-	getDom: function () {
+	getDom () {
 		const ONE_SECOND = 1000; // 1,000 milliseconds
 		const ONE_MINUTE = ONE_SECOND * 60;
 		const ONE_HOUR = ONE_MINUTE * 60;
@@ -552,7 +552,7 @@ Module.register("calendar", {
 	 * @param {string} url The calendar url
 	 * @returns {boolean} True if the calendar config contains the url, False otherwise
 	 */
-	hasCalendarURL: function (url) {
+	hasCalendarURL (url) {
 		for (const calendar of this.config.calendars) {
 			if (calendar.url === url) {
 				return true;
@@ -567,7 +567,7 @@ Module.register("calendar", {
 	 * @param {boolean} limitNumberOfEntries Whether to filter returned events for display.
 	 * @returns {object[]} Array with events.
 	 */
-	createEventList: function (limitNumberOfEntries) {
+	createEventList (limitNumberOfEntries) {
 		const ONE_SECOND = 1000; // 1,000 milliseconds
 		const ONE_MINUTE = ONE_SECOND * 60;
 		const ONE_HOUR = ONE_MINUTE * 60;
@@ -617,7 +617,12 @@ Module.register("calendar", {
 				const maxCount = Math.ceil((event.endDate - 1 - moment(event.startDate, "x").endOf("day").format("x")) / ONE_DAY) + 1;
 				if (this.config.sliceMultiDayEvents && maxCount > 1) {
 					const splitEvents = [];
-					let midnight = moment(event.startDate, "x").clone().startOf("day").add(1, "day").format("x");
+					let midnight
+						= moment(event.startDate, "x")
+							.clone()
+							.startOf("day")
+							.add(1, "day")
+							.format("x");
 					let count = 1;
 					while (event.endDate > midnight) {
 						const thisEvent = JSON.parse(JSON.stringify(event)); // clone object
@@ -686,7 +691,7 @@ Module.register("calendar", {
 		return events.slice(0, this.config.maximumEntries);
 	},

-	listContainsEvent: function (eventList, event) {
+	listContainsEvent (eventList, event) {
 		for (const evt of eventList) {
 			if (evt.title === event.title && parseInt(evt.startDate) === parseInt(event.startDate) && parseInt(evt.endDate) === parseInt(event.endDate)) {
 				return true;
@@ -701,7 +706,7 @@ Module.register("calendar", {
 	 * @param {object} auth The authentication method and credentials
 	 * @param {object} calendarConfig The config of the specific calendar
 	 */
-	addCalendar: function (url, auth, calendarConfig) {
+	addCalendar (url, auth, calendarConfig) {
 		this.sendSocketNotification("ADD_CALENDAR", {
 			id: this.identifier,
 			url: url,
@@ -724,7 +729,7 @@ Module.register("calendar", {
 	 * @param {object} event Event to look for.
 	 * @returns {string[]} The symbols
 	 */
-	symbolsForEvent: function (event) {
+	symbolsForEvent (event) {
 		let symbols = this.getCalendarPropertyAsArray(event.url, "symbol", this.config.defaultSymbol);

 		if (event.recurringEvent === true && this.hasCalendarProperty(event.url, "recurringSymbol")) {
@@ -751,7 +756,7 @@ Module.register("calendar", {
 		return symbols;
 	},

-	mergeUnique: function (arr1, arr2) {
+	mergeUnique (arr1, arr2) {
 		return arr1.concat(
 			arr2.filter(function (item) {
 				return arr1.indexOf(item) === -1;
@@ -764,7 +769,7 @@ Module.register("calendar", {
 	 * @param {string} url The calendar url
 	 * @returns {string} The class to be used for the symbols of the calendar
 	 */
-	symbolClassForUrl: function (url) {
+	symbolClassForUrl (url) {
 		return this.getCalendarProperty(url, "symbolClass", "");
 	},

@@ -773,7 +778,7 @@ Module.register("calendar", {
 	 * @param {string} url The calendar url
 	 * @returns {string} The class to be used for the title of the calendar
 	 */
-	titleClassForUrl: function (url) {
+	titleClassForUrl (url) {
 		return this.getCalendarProperty(url, "titleClass", "");
 	},

@@ -782,7 +787,7 @@ Module.register("calendar", {
 	 * @param {string} url The calendar url
 	 * @returns {string} The class to be used for the time of the calendar
 	 */
-	timeClassForUrl: function (url) {
+	timeClassForUrl (url) {
 		return this.getCalendarProperty(url, "timeClass", "");
 	},

@@ -791,7 +796,7 @@ Module.register("calendar", {
 	 * @param {string} url The calendar url
 	 * @returns {string} The name of the calendar
 	 */
-	calendarNameForUrl: function (url) {
+	calendarNameForUrl (url) {
 		return this.getCalendarProperty(url, "name", "");
 	},

@@ -801,7 +806,7 @@ Module.register("calendar", {
 	 * @param {boolean} isBg Determines if we fetch the bgColor or not
 	 * @returns {string} The color
 	 */
-	colorForUrl: function (url, isBg) {
+	colorForUrl (url, isBg) {
 		return this.getCalendarProperty(url, isBg ? "bgColor" : "color", "#fff");
 	},

@@ -810,7 +815,7 @@ Module.register("calendar", {
 	 * @param {string} url The calendar url
 	 * @returns {string} The title
 	 */
-	countTitleForUrl: function (url) {
+	countTitleForUrl (url) {
 		return this.getCalendarProperty(url, "repeatingCountTitle", this.config.defaultRepeatingCountTitle);
 	},

@@ -819,7 +824,7 @@ Module.register("calendar", {
 	 * @param {string} url The calendar url
 	 * @returns {number} The maximum entry count
 	 */
-	maximumEntriesForUrl: function (url) {
+	maximumEntriesForUrl (url) {
 		return this.getCalendarProperty(url, "maximumEntries", this.config.maximumEntries);
 	},

@@ -828,7 +833,7 @@ Module.register("calendar", {
 	 * @param {string} url The calendar url
 	 * @returns {number} The maximum past days count
 	 */
-	maximumPastDaysForUrl: function (url) {
+	maximumPastDaysForUrl (url) {
 		return this.getCalendarProperty(url, "pastDaysCount", this.config.pastDaysCount);
 	},

@@ -839,7 +844,7 @@ Module.register("calendar", {
 	 * @param {string} defaultValue The value if the property is not found
 	 * @returns {*} The property
 	 */
-	getCalendarProperty: function (url, property, defaultValue) {
+	getCalendarProperty (url, property, defaultValue) {
 		for (const calendar of this.config.calendars) {
 			if (calendar.url === url && calendar.hasOwnProperty(property)) {
 				return calendar[property];
@@ -849,7 +854,7 @@ Module.register("calendar", {
 		return defaultValue;
 	},

-	getCalendarPropertyAsArray: function (url, property, defaultValue) {
+	getCalendarPropertyAsArray (url, property, defaultValue) {
 		let p = this.getCalendarProperty(url, property, defaultValue);
 		if (property === "symbol" || property === "recurringSymbol" || property === "fullDaySymbol") {
 			const className = this.getCalendarProperty(url, "symbolClassName", this.config.defaultSymbolClassName);
@@ -860,7 +865,7 @@ Module.register("calendar", {
 		return p;
 	},

-	hasCalendarProperty: function (url, property) {
+	hasCalendarProperty (url, property) {
 		return !!this.getCalendarProperty(url, property, undefined);
 	},

@@ -868,7 +873,7 @@ Module.register("calendar", {
 	 * Broadcasts the events to all other modules for reuse.
 	 * The all events available in one array, sorted on startdate.
 	 */
-	broadcastEvents: function () {
+	broadcastEvents () {
 		const eventList = this.createEventList(false);
 		for (const event of eventList) {
 			event.symbol = this.symbolsForEvent(event);
@@ -888,7 +893,7 @@ Module.register("calendar", {
 	 * and it's allow to refresh The DOM every minute with animation speed too
 	 * (because updateDom is not set in CALENDAR_EVENTS for this case)
 	 */
-	selfUpdate: function () {
+	selfUpdate () {
 		const ONE_MINUTE = 60 * 1000;
 		setTimeout(
 			() => {
--- a/modules/default/calendar/calendarfetcherutils.js
+++ b/modules/default/calendar/calendarfetcherutils.js
@@ -15,6 +15,7 @@ const zoneTable = require(path.join(__dirname, "windowsZones.json"));
 const Log = require("../../../js/logger");

 const CalendarFetcherUtils = {
+
 	/**
 	 * Calculate the time correction, either dst/std or full day in cases where
 	 * utc time is day before plus offset
@@ -22,7 +23,7 @@ const CalendarFetcherUtils = {
 	 * @param {Date} date the date on which this event happens
 	 * @returns {number} the necessary adjustment in hours
 	 */
-	calculateTimezoneAdjustment: function (event, date) {
+	calculateTimezoneAdjustment (event, date) {
 		let adjustHours = 0;
 		// if a timezone was specified
 		if (!event.start.tz) {
@@ -123,7 +124,7 @@ const CalendarFetcherUtils = {
 	 * @param {object} config The configuration object
 	 * @returns {string[]} the filtered events
 	 */
-	filterEvents: function (data, config) {
+	filterEvents (data, config) {
 		const newEvents = [];

 		// limitFunction doesn't do much limiting, see comment re: the dates
@@ -142,7 +143,12 @@ const CalendarFetcherUtils = {
 			Log.debug("Processing entry...");
 			const now = new Date();
 			const today = moment().startOf("day").toDate();
-			const future = moment().startOf("day").add(config.maximumNumberOfDays, "days").subtract(1, "seconds").toDate(); // Subtract 1 second so that events that start on the middle of the night will not repeat.
+			const future
+				= moment()
+					.startOf("day")
+					.add(config.maximumNumberOfDays, "days")
+					.subtract(1, "seconds") // Subtract 1 second so that events that start on the middle of the night will not repeat.
+					.toDate();
 			let past = today;

 			if (config.includePastEvents) {
@@ -521,7 +527,7 @@ const CalendarFetcherUtils = {
 	 * @param {string} msTZName the timezone name to lookup
 	 * @returns {string|null} the iana name or null of none is found
 	 */
-	getIanaTZFromMS: function (msTZName) {
+	getIanaTZFromMS (msTZName) {
 		// Get hash entry
 		const he = zoneTable[msTZName];
 		// If found return iana name, else null
@@ -533,7 +539,7 @@ const CalendarFetcherUtils = {
 	 * @param {object} event The event object to check.
 	 * @returns {string} The title of the event, or "Event" if no title is found.
 	 */
-	getTitleFromEvent: function (event) {
+	getTitleFromEvent (event) {
 		let title = "Event";
 		if (event.summary) {
 			title = typeof event.summary.val !== "undefined" ? event.summary.val : event.summary;
@@ -549,7 +555,7 @@ const CalendarFetcherUtils = {
 	 * @param {object} event The event object to check.
 	 * @returns {boolean} True if the event is a fullday event, false otherwise
 	 */
-	isFullDayEvent: function (event) {
+	isFullDayEvent (event) {
 		if (event.start.length === 8 || event.start.dateOnly || event.datetype === "date") {
 			return true;
 		}
@@ -572,7 +578,7 @@ const CalendarFetcherUtils = {
 	 * @param {string} filter The time to subtract from the end date to determine if an event should be shown
 	 * @returns {boolean} True if the event should be filtered out, false otherwise
 	 */
-	timeFilterApplies: function (now, endDate, filter) {
+	timeFilterApplies (now, endDate, filter) {
 		if (filter) {
 			const until = filter.split(" "),
 				value = parseInt(until[0]),
@@ -593,7 +599,7 @@ const CalendarFetcherUtils = {
 	 * @param {string} regexFlags flags that should be applied to the regex
 	 * @returns {boolean} True if the title should be filtered out, false otherwise
 	 */
-	titleFilterApplies: function (title, filter, useRegex, regexFlags) {
+	titleFilterApplies (title, filter, useRegex, regexFlags) {
 		if (useRegex) {
 			let regexFilter = filter;
 			// Assume if leading slash, there is also trailing slash
--- a/modules/default/calendar/calendarutils.js
+++ b/modules/default/calendar/calendarutils.js
@@ -5,12 +5,13 @@
 * MIT Licensed.
 */
 const CalendarUtils = {
+
 	/**
 	 * Capitalize the first letter of a string
 	 * @param {string} string The string to capitalize
 	 * @returns {string} The capitalized string
 	 */
-	capFirst: function (string) {
+	capFirst (string) {
 		return string.charAt(0).toUpperCase() + string.slice(1);
 	},

@@ -21,7 +22,7 @@ const CalendarUtils = {
 	 * @param {number} timeFormat Specifies either 12 or 24-hour time format
 	 * @returns {moment.LocaleSpecification} formatted time
 	 */
-	getLocaleSpecification: function (timeFormat) {
+	getLocaleSpecification (timeFormat) {
 		switch (timeFormat) {
 			case 12: {
 				return { longDateFormat: { LT: "h:mm A" } };
@@ -43,7 +44,7 @@ const CalendarUtils = {
 	 * @param {number} maxTitleLines The max number of vertical lines before cutting event title
 	 * @returns {string} The shortened string
 	 */
-	shorten: function (string, maxLength, wrapEvents, maxTitleLines) {
+	shorten (string, maxLength, wrapEvents, maxTitleLines) {
 		if (typeof string !== "string") {
 			return "";
 		}
@@ -98,7 +99,7 @@ const CalendarUtils = {
 	 *                    yearmatchgroup: {number,optional} match group for year element
 	 * @returns {string} The transformed title.
 	 */
-	titleTransform: function (title, titleReplace) {
+	titleTransform (title, titleReplace) {
 		let transformedTitle = title;
 		for (let tr in titleReplace) {
 			let transform = titleReplace[tr];
--- a/modules/default/calendar/node_helper.js
+++ b/modules/default/calendar/node_helper.js
@@ -10,13 +10,13 @@ const CalendarFetcher = require("./calendarfetcher");

 module.exports = NodeHelper.create({
 	// Override start method.
-	start: function () {
+	start () {
 		Log.log(`Starting node helper for: ${this.name}`);
 		this.fetchers = [];
 	},

 	// Override socketNotificationReceived method.
-	socketNotificationReceived: function (notification, payload) {
+	socketNotificationReceived (notification, payload) {
 		if (notification === "ADD_CALENDAR") {
 			this.createFetcher(payload.url, payload.fetchInterval, payload.excludedEvents, payload.maximumEntries, payload.maximumNumberOfDays, payload.auth, payload.broadcastPastEvents, payload.selfSignedCert, payload.id);
 		} else if (notification === "FETCH_CALENDAR") {
@@ -43,7 +43,7 @@ module.exports = NodeHelper.create({
 	 * @param {boolean} selfSignedCert If true, the server certificate is not verified against the list of supplied CAs.
 	 * @param {string} identifier ID of the module
 	 */
-	createFetcher: function (url, fetchInterval, excludedEvents, maximumEntries, maximumNumberOfDays, auth, broadcastPastEvents, selfSignedCert, identifier) {
+	createFetcher (url, fetchInterval, excludedEvents, maximumEntries, maximumNumberOfDays, auth, broadcastPastEvents, selfSignedCert, identifier) {
 		try {
 			new URL(url);
 		} catch (error) {
@@ -85,7 +85,7 @@ module.exports = NodeHelper.create({
 	 * @param {object} fetcher the fetcher associated with the calendar
 	 * @param {string} identifier the identifier of the calendar
 	 */
-	broadcastEvents: function (fetcher, identifier) {
+	broadcastEvents (fetcher, identifier) {
 		this.sendSocketNotification("CALENDAR_EVENTS", {
 			id: identifier,
 			url: fetcher.url(),