Add Logging API (#5026)

* Add onLog to input options in JavaScript API * Clean up tests * Test string logging * Test type fixes * Add basic this.log support without position * Add positions to logs in "transform" hook * Separate level from logs * Display logs in CLI * Unify log handling to use onLog * Introduce constants for log levels * Replace RollupWarning with RollupLog type * Replace warn with log in AST context * Allow to turn logs into errors in default handler * Add onLog plugin hook * Clean up * Add log levels * Ensure "silent" also silences logs * Do not augment onLog errors, only allow pos in transform via types * Fix test * Add docs * Fix anchors * Rename errors to logs * Clarify that onLog option can be used for logging * Start work on eixsting logs * Use logging API for experimental features * Improve coverage * Allow logs to be functions * Finalise docs * Refine docs
rollup · Jun 11, 2023 · 23c111c · 23c111c
1 parent de2d6ff
commit 23c111c
Show file tree

Hide file tree

Showing 189 changed files with 3,234 additions and 1,716 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -144,6 +144,7 @@ module.exports = {
 		'unicorn/prefer-math-trunc': 'off',
 		'unicorn/prefer-number-properties': 'off',
 		'unicorn/prefer-string-replace-all': 'off',
-		'unicorn/prefer-top-level-await': 'off'
+		'unicorn/prefer-top-level-await': 'off',
+		'unicorn/prevent-abbreviations': ['error', { replacements: { dir: false } }]
 	}
 };
diff --git a/browser/src/error.ts b/browser/src/error.ts
@@ -1,4 +1,4 @@
-import { error, errorNoFileSystemInBrowser } from '../../src/utils/error';
+import { error, logNoFileSystemInBrowser } from '../../src/utils/logs';
 
 export const throwNoFileSystem = (method: string) => (): never =>
-	error(errorNoFileSystemInBrowser(method));
+	error(logNoFileSystemInBrowser(method));
diff --git a/cli/help.md b/cli/help.md
@@ -51,6 +51,7 @@ Basic options:
 --inlineDynamicImports      Create single bundle when using dynamic imports
 --no-interop                Do not include interop block
 --intro <text>              Code to insert at top of bundle (inside wrapper)
+--logLevel <level>          Which kind of logs to display
 --no-makeAbsoluteExternalsRelative Prevent normalization of external imports
 --maxParallelFileOps <value> How many files to read in parallel
 --minifyInternalExports     Force or disable minification of internal exports

diff --git a/cli/run/batchWarnings.ts b/cli/run/batchWarnings.ts
@@ -1,6 +1,8 @@
-import type { RollupWarning } from '../../src/rollup/types';
+import { blue, cyan } from 'colorette';
+import type { RollupLog } from '../../src/rollup/types';
 import { bold, gray, yellow } from '../../src/utils/colors';
 import { getNewArray, getOrCreate } from '../../src/utils/getOrCreate';
+import { LOGLEVEL_DEBUG, LOGLEVEL_WARN } from '../../src/utils/logging';
 import { printQuotedStringList } from '../../src/utils/printStringList';
 import relativeId from '../../src/utils/relativeId';
 import { getRollupUrl } from '../../src/utils/url';
@@ -16,44 +18,35 @@ import {
 import { stderr } from '../logging';
 import type { BatchWarnings } from './loadConfigFileType';
 
-export default function batchWarnings(): BatchWarnings {
+export default function batchWarnings(silent: boolean): BatchWarnings {
 	let count = 0;
-	const deferredWarnings = new Map<keyof typeof deferredHandlers, RollupWarning[]>();
+	const deferredWarnings = new Map<keyof typeof deferredHandlers, RollupLog[]>();
 	let warningOccurred = false;
 
-	return {
-		add(warning: RollupWarning) {
-			count += 1;
-			warningOccurred = true;
-
-			if (warning.code! in deferredHandlers) {
-				getOrCreate(deferredWarnings, warning.code!, getNewArray).push(warning);
-			} else if (warning.code! in immediateHandlers) {
-				immediateHandlers[warning.code!](warning);
-			} else {
-				title(warning.message);
-
-				if (warning.url) info(warning.url);
-
-				const id = warning.loc?.file || warning.id;
-				if (id) {
-					const loc = warning.loc
-						? `${relativeId(id)} (${warning.loc.line}:${warning.loc.column})`
-						: relativeId(id);
-
-					stderr(bold(relativeId(loc)));
-				}
+	const add = (warning: RollupLog) => {
+		count += 1;
+		warningOccurred = true;
+
+		if (silent) return;
+		if (warning.code! in deferredHandlers) {
+			getOrCreate(deferredWarnings, warning.code!, getNewArray).push(warning);
+		} else if (warning.code! in immediateHandlers) {
+			immediateHandlers[warning.code!](warning);
+		} else {
+			title(warning.message);
+			defaultBody(warning);
+		}
+	};
 
-				if (warning.frame) info(warning.frame);
-			}
-		},
+	return {
+		add,
 
 		get count() {
 			return count;
 		},
 
 		flush() {
-			if (count === 0) return;
+			if (count === 0 || silent) return;
 
 			const codes = [...deferredWarnings.keys()].sort(
 				(a, b) => deferredWarnings.get(b)!.length - deferredWarnings.get(a)!.length
@@ -67,14 +60,35 @@ export default function batchWarnings(): BatchWarnings {
 			count = 0;
 		},
 
+		log(level, log) {
+			switch (level) {
+				case LOGLEVEL_WARN: {
+					return add(log);
+				}
+				case LOGLEVEL_DEBUG: {
+					if (!silent) {
+						stderr(bold(blue(log.message)));
+						defaultBody(log);
+					}
+					return;
+				}
+				default: {
+					if (!silent) {
+						stderr(bold(cyan(log.message)));
+						defaultBody(log);
+					}
+				}
+			}
+		},
+
 		get warningOccurred() {
 			return warningOccurred;
 		}
 	};
 }
 
 const immediateHandlers: {
-	[code: string]: (warning: RollupWarning) => void;
+	[code: string]: (warning: RollupLog) => void;
 } = {
 	MISSING_NODE_BUILTINS(warning) {
 		title(`Missing shims for Node.js built-ins`);
@@ -93,7 +107,7 @@ const immediateHandlers: {
 };
 
 const deferredHandlers: {
-	[code: string]: (warnings: RollupWarning[]) => void;
+	[code: string]: (warnings: RollupLog[]) => void;
 } = {
 	CIRCULAR_DEPENDENCY(warnings) {
 		title(`Circular dependenc${warnings.length > 1 ? 'ies' : 'y'}`);
@@ -249,6 +263,21 @@ const deferredHandlers: {
 	}
 };
 
+function defaultBody(log: RollupLog): void {
+	if (log.url) {
+		info(getRollupUrl(log.url));
+	}
+
+	const id = log.loc?.file || log.id;
+	if (id) {
+		const loc = log.loc ? `${relativeId(id)} (${log.loc.line}:${log.loc.column})` : relativeId(id);
+
+		stderr(bold(relativeId(loc)));
+	}
+
+	if (log.frame) info(log.frame);
+}
+
 function title(string_: string): void {
 	stderr(bold(yellow(`(!) ${string_}`)));
 }
@@ -281,7 +310,7 @@ function nest<T extends Record<string, any>>(array: readonly T[], property: stri
 	return nested;
 }
 
-function showTruncatedWarnings(warnings: readonly RollupWarning[]): void {
+function showTruncatedWarnings(warnings: readonly RollupLog[]): void {
 	const nestedByModule = nest(warnings, 'id');
 
 	const displayedByModule = nestedByModule.length > 5 ? nestedByModule.slice(0, 3) : nestedByModule;

diff --git a/cli/run/build.ts b/cli/run/build.ts
@@ -3,7 +3,7 @@ import ms from 'pretty-ms';
 import { rollup } from '../../src/node-entry';
 import type { MergedRollupOptions } from '../../src/rollup/types';
 import { bold, cyan, green } from '../../src/utils/colors';
-import { errorOnlyInlineSourcemapsForStdout } from '../../src/utils/error';
+import { logOnlyInlineSourcemapsForStdout } from '../../src/utils/logs';
 import relativeId from '../../src/utils/relativeId';
 import { handleError, stderr } from '../logging';
 import type { BatchWarnings } from './loadConfigFileType';
@@ -34,7 +34,7 @@ export default async function build(
 	if (useStdout) {
 		const output = outputOptions[0];
 		if (output.sourcemap && output.sourcemap !== 'inline') {
-			handleError(errorOnlyInlineSourcemapsForStdout());
+			handleError(logOnlyInlineSourcemapsForStdout());
 		}
 		const { output: outputs } = await bundle.generate(output);
 		for (const file of outputs) {

diff --git a/cli/run/getConfigPath.ts b/cli/run/getConfigPath.ts
@@ -1,7 +1,7 @@
 import { readdir } from 'node:fs/promises';
 import { resolve } from 'node:path';
 import { cwd } from 'node:process';
-import { errorMissingExternalConfig } from '../../src/utils/error';
+import { logMissingExternalConfig } from '../../src/utils/logs';
 import { handleError } from '../logging';
 
 const DEFAULT_CONFIG_BASE = 'rollup.config';
@@ -21,7 +21,7 @@ export async function getConfigPath(commandConfig: string | true): Promise<strin
 				return require.resolve(packageName, { paths: [cwd()] });
 			} catch (error: any) {
 				if (error.code === 'MODULE_NOT_FOUND') {
-					handleError(errorMissingExternalConfig(commandConfig));
+					handleError(logMissingExternalConfig(commandConfig));
 				}
 				throw error;
 			}

diff --git a/cli/run/index.ts b/cli/run/index.ts
@@ -1,6 +1,6 @@
 import { env } from 'node:process';
 import type { MergedRollupOptions } from '../../src/rollup/types';
-import { errorDuplicateImportOptions, errorFailAfterWarnings } from '../../src/utils/error';
+import { logDuplicateImportOptions, logFailAfterWarnings } from '../../src/utils/logs';
 import { isWatchEnabled } from '../../src/utils/options/mergeOptions';
 import { getAliasName } from '../../src/utils/relativeId';
 import { loadFsEvents } from '../../src/watch/fsevents-importer';
@@ -15,7 +15,7 @@ export default async function runRollup(command: Record<string, any>): Promise<v
 	let inputSource;
 	if (command._.length > 0) {
 		if (command.input) {
-			handleError(errorDuplicateImportOptions());
+			handleError(logDuplicateImportOptions());
 		}
 		inputSource = command._;
 	} else if (typeof command.input === 'string') {
@@ -65,7 +65,7 @@ export default async function runRollup(command: Record<string, any>): Promise<v
 				}
 				if (command.failAfterWarnings && warnings.warningOccurred) {
 					warnings.flush();
-					handleError(errorFailAfterWarnings());
+					handleError(logFailAfterWarnings());
 				}
 			} catch (error: any) {
 				warnings.flush();
@@ -82,8 +82,8 @@ async function getConfigs(
 ): Promise<{ options: MergedRollupOptions[]; warnings: BatchWarnings }> {
 	if (command.config) {
 		const configFile = await getConfigPath(command.config);
-		const { options, warnings } = await loadConfigFile(configFile, command);
+		const { options, warnings } = await loadConfigFile(configFile, command, false);
 		return { options, warnings };
 	}
-	return await loadConfigFromCommand(command);
+	return await loadConfigFromCommand(command, false);
 }
diff --git a/cli/run/loadConfigFile.ts b/cli/run/loadConfigFile.ts
@@ -7,11 +7,11 @@ import type { MergedRollupOptions } from '../../src/rollup/types';
 import { bold } from '../../src/utils/colors';
 import {
 	error,
-	errorCannotBundleConfigAsEsm,
-	errorCannotLoadConfigAsCjs,
-	errorCannotLoadConfigAsEsm,
-	errorMissingConfig
-} from '../../src/utils/error';
+	logCannotBundleConfigAsEsm,
+	logCannotLoadConfigAsCjs,
+	logCannotLoadConfigAsEsm,
+	logMissingConfig
+} from '../../src/utils/logs';
 import { mergeOptions } from '../../src/utils/options/mergeOptions';
 import type { GenericConfigObject } from '../../src/utils/options/options';
 import relativeId from '../../src/utils/relativeId';
@@ -20,16 +20,20 @@ import batchWarnings from './batchWarnings';
 import { addCommandPluginsToInputOptions, addPluginsFromCommandOption } from './commandPlugins';
 import type { LoadConfigFile } from './loadConfigFileType';
 
-export const loadConfigFile: LoadConfigFile = async (fileName, commandOptions = {}) => {
+export const loadConfigFile: LoadConfigFile = async (
+	fileName,
+	commandOptions = {},
+	watchMode = false
+) => {
 	const configs = await getConfigList(
-		getDefaultFromCjs(await getConfigFileExport(fileName, commandOptions)),
+		getDefaultFromCjs(await getConfigFileExport(fileName, commandOptions, watchMode)),
 		commandOptions
 	);
-	const warnings = batchWarnings();
+	const warnings = batchWarnings(commandOptions.silent);
 	try {
 		const normalizedConfigs: MergedRollupOptions[] = [];
 		for (const config of configs) {
-			const options = await mergeOptions(config, commandOptions, warnings.add);
+			const options = await mergeOptions(config, watchMode, commandOptions, warnings.log);
 			await addCommandPluginsToInputOptions(options, commandOptions);
 			normalizedConfigs.push(options);
 		}
@@ -40,13 +44,17 @@ export const loadConfigFile: LoadConfigFile = async (fileName, commandOptions =
 	}
 };
 
-async function getConfigFileExport(fileName: string, commandOptions: Record<string, unknown>) {
+async function getConfigFileExport(
+	fileName: string,
+	commandOptions: Record<string, unknown>,
+	watchMode: boolean
+) {
 	if (commandOptions.configPlugin || commandOptions.bundleConfigAsCjs) {
 		try {
 			return await loadTranspiledConfigFile(fileName, commandOptions);
 		} catch (error_: any) {
 			if (error_.message.includes('not defined in ES module scope')) {
-				return error(errorCannotBundleConfigAsEsm(error_));
+				return error(logCannotBundleConfigAsEsm(error_));
 			}
 			throw error_;
 		}
@@ -60,17 +68,17 @@ async function getConfigFileExport(fileName: string, commandOptions: Record<stri
 	process.on('warning', handleWarning);
 	try {
 		const fileUrl = pathToFileURL(fileName);
-		if (process.env.ROLLUP_WATCH) {
+		if (watchMode) {
 			// We are adding the current date to allow reloads in watch mode
 			fileUrl.search = `?${Date.now()}`;
 		}
 		return (await import(fileUrl.href)).default;
 	} catch (error_: any) {
 		if (cannotLoadEsm) {
-			return error(errorCannotLoadConfigAsCjs(error_));
+			return error(logCannotLoadConfigAsCjs(error_));
 		}
 		if (error_.message.includes('not defined in ES module scope')) {
-			return error(errorCannotLoadConfigAsEsm(error_));
+			return error(logCannotLoadConfigAsEsm(error_));
 		}
 		throw error_;
 	} finally {
@@ -86,7 +94,7 @@ async function loadTranspiledConfigFile(
 	fileName: string,
 	{ bundleConfigAsCjs, configPlugin, silent }: Record<string, unknown>
 ): Promise<unknown> {
-	const warnings = batchWarnings();
+	const warnings = batchWarnings(!!silent);
 	const inputOptions = {
 		external: (id: string) =>
 			(id[0] !== '.' && !isAbsolute(id)) || id.slice(-5, id.length) === '.json',
@@ -97,10 +105,6 @@ async function loadTranspiledConfigFile(
 	};
 	await addPluginsFromCommandOption(configPlugin, inputOptions);
 	const bundle = await rollup.rollup(inputOptions);
-	if (!silent && warnings.count > 0) {
-		stderr(bold(`loaded ${relativeId(fileName)} with warnings`));
-		warnings.flush();
-	}
 	const {
 		output: [{ code }]
 	} = await bundle.generate({
@@ -120,6 +124,10 @@ async function loadTranspiledConfigFile(
 			}
 		]
 	});
+	if (!silent && warnings.count > 0) {
+		stderr(bold(`loaded ${relativeId(fileName)} with warnings`));
+		warnings.flush();
+	}
 	return loadConfigFromWrittenFile(
 		join(dirname(fileName), `rollup.config-${Date.now()}.${bundleConfigAsCjs ? 'cjs' : 'mjs'}`),
 		code
@@ -144,7 +152,7 @@ async function getConfigList(configFileExport: any, commandOptions: any): Promis
 		? configFileExport(commandOptions)
 		: configFileExport);
 	if (Object.keys(config).length === 0) {
-		return error(errorMissingConfig());
+		return error(logMissingConfig());
 	}
 	return Array.isArray(config) ? config : [config];
 }
diff --git a/cli/run/loadConfigFileType.d.ts b/cli/run/loadConfigFileType.d.ts
@@ -1,17 +1,19 @@
-import type { MergedRollupOptions, RollupWarning } from '../../src/rollup/types';
+import type { LogHandler, MergedRollupOptions, RollupLog } from '../../src/rollup/types';
 
 export interface BatchWarnings {
-	add: (warning: RollupWarning) => void;
+	add: (warning: RollupLog) => void;
 	readonly count: number;
 	flush: () => void;
+	log: LogHandler;
 	readonly warningOccurred: boolean;
 }
 
 export type LoadConfigFile = typeof loadConfigFile;
 
 export function loadConfigFile(
 	fileName: string,
-	commandOptions: any
+	commandOptions: any,
+	watchMode?: boolean
 ): Promise<{
 	options: MergedRollupOptions[];
 	warnings: BatchWarnings;