refactor(typescript): packages/rspack/src/logging/runtime

packages/rspack/src/logging/createConsoleLogger.ts

@@ -8,44 +8,37 @@
  * https://github.com/webpack/webpack/blob/main/LICENSE
  */
 
-// @ts-nocheck
+import type { FilterItemTypes, FilterTypes } from "../config";
+import { LogType, type LogTypeEnum } from "./Logger";
 
-const { LogType } = require("./Logger");
+export type FilterFunction = (ident: string) => boolean;
 
-/** @typedef {import("./Logger").LogTypeEnum} LogTypeEnum */
-
-/** @typedef {function(string): boolean} FilterFunction */
-
-/**
- * @typedef {Object} LoggerConsole
- * @property {function(): void} clear
- * @property {function(): void} trace
- * @property {(...args: any[]) => void} info
- * @property {(...args: any[]) => void} log
- * @property {(...args: any[]) => void} warn
- * @property {(...args: any[]) => void} error
- * @property {(...args: any[]) => void=} debug
- * @property {(...args: any[]) => void=} group
- * @property {(...args: any[]) => void=} groupCollapsed
- * @property {(...args: any[]) => void=} groupEnd
- * @property {(...args: any[]) => void=} status
- * @property {(...args: any[]) => void=} profile
- * @property {(...args: any[]) => void=} profileEnd
- * @property {(...args: any[]) => void=} logTime
- */
+export type LoggerConsole = {
+	clear: () => void;
+	trace: () => void;
+	info: (...args: any[]) => void;
+	log: (...args: any[]) => void;
+	warn: (...args: any[]) => void;
+	error: (...args: any[]) => void;
+	debug?: (...args: any[]) => void;
+	group?: (...args: any[]) => void;
+	groupCollapsed?: (...args: any[]) => void;
+	groupEnd?: (...args: any[]) => void;
+	status?: (...args: any[]) => void;
+	profile?: (...args: any[]) => void;
+	profileEnd?: (...args: any[]) => void;
+	logTime?: (...args: any[]) => void;
+};
 
-/**
- * @typedef {Object} LoggerOptions
- * @property {false|true|"none"|"error"|"warn"|"info"|"log"|"verbose"} level loglevel
- * @property {FilterTypes|boolean} debug filter for debug logging
- * @property {LoggerConsole} console the console to log to
- */
+export type LoggerOptions = {
+	level: "none" | "error" | "warn" | "info" | "log" | "verbose" | boolean;
+	debug: FilterTypes | boolean;
+	console: LoggerConsole;
+};
 
-/**
- * @param {FilterItemTypes} item an input item
- * @returns {FilterFunction} filter function
- */
-const filterToFunction = item => {
+const filterToFunction = (
+	item: FilterItemTypes
+): FilterFunction | undefined => {
 	if (typeof item === "string") {
 		const regExp = new RegExp(
 			`[\\\\/]${item.replace(
@@ -67,9 +60,6 @@ const filterToFunction = item => {
 	}
 };
 
-/**
- * @enum {number}
- */
 const LogLevel = {
 	none: 6,
 	false: 6,
@@ -81,25 +71,18 @@ const LogLevel = {
 	verbose: 1
 };
 
-/**
- * @param {LoggerOptions} options options object
- * @returns {function(string, LogTypeEnum, any[]): void} logging function
- */
-export = ({ level = "info", debug = false, console }: any) => {
+const createConsoleLogger = ({
+	level = "info",
+	debug = false,
+	console
+}: LoggerOptions) => {
 	const debugFilters =
 		typeof debug === "boolean"
 			? [() => debug]
-			: /** @type {FilterItemTypes[]} */ [].concat(debug).map(filterToFunction);
-	/** @type {number} */
+			: ([] as FilterItemTypes[]).concat(debug).map(filterToFunction);
 	const loglevel = LogLevel[`${level}`] || 0;
 
-	/**
-	 * @param {string} name name of the logger
-	 * @param {LogTypeEnum} type type of the log entry
-	 * @param {any[]} args arguments of the log entry
-	 * @returns {void}
-	 */
-	const logger = (name, type, args) => {
+	const logger = (name: string, type: LogTypeEnum, args: any[]): void => {
 		const labeledArgs = () => {
 			if (Array.isArray(args)) {
 				if (args.length > 0 && typeof args[0] === "string") {
@@ -109,7 +92,7 @@ export = ({ level = "info", debug = false, console }: any) => {
 			}
 			return [];
 		};
-		const debug = debugFilters.some(f => f(name));
+		const debug = debugFilters.some(f => f!(name));
 		switch (type) {
 			case LogType.debug:
 				if (!debug) return;
@@ -215,3 +198,5 @@ export = ({ level = "info", debug = false, console }: any) => {
 	};
 	return logger;
 };
+
+export { createConsoleLogger };

packages/rspack/src/logging/runtime.ts

@@ -9,41 +9,28 @@
  */
 
 const SyncBailHook = require("tapable/lib/SyncBailHook");
-const { Logger } = require("./Logger");
-const createConsoleLogger = require("./createConsoleLogger");
+import { Logger } from "./Logger";
+import { type LoggerOptions, createConsoleLogger } from "./createConsoleLogger";
 
-/** @type {createConsoleLogger.LoggerOptions} */
-const currentDefaultLoggerOptions = {
+const currentDefaultLoggerOptions: LoggerOptions = {
 	level: "info",
 	debug: false,
 	console
 };
 let currentDefaultLogger = createConsoleLogger(currentDefaultLoggerOptions);
 
-/**
- * @param {string} name name of the logger
- * @returns {Logger} a logger
- */
-// @ts-expect-error
-export const getLogger = name => {
+export const getLogger = (name: string): Logger => {
 	return new Logger(
-		// @ts-expect-error
 		(type, args) => {
 			if (exports.hooks.log.call(name, type, args) === undefined) {
 				currentDefaultLogger(name, type, args);
 			}
 		},
-		// @ts-expect-error
 		childName => exports.getLogger(`${name}/${childName}`)
 	);
 };
 
-/**
- * @param {createConsoleLogger.LoggerOptions} options new options, merge with old options
- * @returns {void}
- */
-// @ts-expect-error
-export const configureDefaultLogger = options => {
+export const configureDefaultLogger = (options: LoggerOptions): void => {
 	Object.assign(currentDefaultLoggerOptions, options);
 	currentDefaultLogger = createConsoleLogger(currentDefaultLoggerOptions);
 };

packages/rspack/src/node/NodeEnvironmentPlugin.ts

@@ -13,7 +13,10 @@ import fs from "graceful-fs";
 
 import type { Compiler } from "..";
 import type { InfrastructureLogging } from "../config";
-import createConsoleLogger from "../logging/createConsoleLogger";
+import {
+	type LoggerConsole,
+	createConsoleLogger
+} from "../logging/createConsoleLogger";
 import NodeWatchFileSystem from "./NodeWatchFileSystem";
 import nodeConsole from "./nodeConsole";
 
@@ -35,11 +38,11 @@ export default class NodeEnvironmentPlugin {
 			debug: infrastructureLogging.debug || false,
 			console:
 				infrastructureLogging.console ||
-				nodeConsole({
+				(nodeConsole({
 					colors: infrastructureLogging.colors,
 					appendOnly: infrastructureLogging.appendOnly,
 					stream: infrastructureLogging.stream
-				})
+				}) as LoggerConsole)
 		});
 		compiler.inputFileSystem = new CachedInputFileSystem(fs, 60000);
 		const inputFileSystem = compiler.inputFileSystem;