Add ability to filter logs via CLI option or environment variable (#5035

)

* Support basic log filtering

* Negative and intersected filters

* More filtering

* Handle nested properties and edge cases

* Add exports condition

* Sort CLI flags

* Describe --filterLogs option

* Formatting

* Add documentation and ES build

* Fix link

build-plugins/copy-types.ts

@@ -2,15 +2,19 @@ import { readFile } from 'node:fs/promises';
 import { resolve } from 'node:path';
 import type { Plugin } from 'rollup';
 
-function copyRollupType(fileName: string): Plugin {
+function copyRollupType(
+	fileName: string,
+	inputFile = 'src/rollup/types.d.ts',
+	rollupImportPath?: string
+): Plugin {
 	return {
 		async generateBundle(_options, _bundle, isWrite) {
 			if (isWrite) {
-				this.emitFile({
-					fileName,
-					source: await readFile(resolve('src/rollup/types.d.ts'), 'utf8'),
-					type: 'asset'
-				});
+				let source = await readFile(resolve(inputFile), 'utf8');
+				if (rollupImportPath) {
+					source = source.replace(rollupImportPath, './rollup');
+				}
+				this.emitFile({ fileName, source, type: 'asset' });
 			}
 		},
 		name: 'copy-rollup-type'
@@ -24,20 +28,11 @@ export function copyBrowserTypes(): Plugin {
 export function copyNodeTypes(): Plugin[] {
 	return [
 		copyRollupType('rollup.d.ts'),
-		{
-			async generateBundle(_options, _bundle, isWrite) {
-				if (isWrite) {
-					this.emitFile({
-						fileName: 'loadConfigFile.d.ts',
-						source: (await readFile(resolve('cli/run/loadConfigFileType.d.ts'), 'utf8')).replace(
-							'../../src/rollup/types',
-							'./rollup'
-						),
-						type: 'asset'
-					});
-				}
-			},
-			name: 'copy-loadConfigFile-type'
-		}
+		copyRollupType(
+			'loadConfigFile.d.ts',
+			'cli/run/loadConfigFileType.d.ts',
+			'../../src/rollup/types'
+		),
+		copyRollupType('getLogFilter.d.ts', 'src/utils/getLogFilterType.d.ts', '../rollup/types')
 	];
 }

cli/help.md

@@ -38,6 +38,7 @@ Basic options:
 --no-externalImportAssertions Omit import assertions in "es" output
 --no-externalLiveBindings   Do not generate code to support live bindings
 --failAfterWarnings         Exit with an error if the build produced warnings
+--filterLogs <filter>       Filter log messages
 --footer <text>             Code to insert at end of bundle (outside wrapper)
 --no-freeze                 Do not freeze namespace objects
 --generatedCode <preset>    Which code features to use (es5/es2015)

cli/run/batchWarnings.ts

@@ -1,6 +1,8 @@
 import { blue, cyan } from 'colorette';
 import type { RollupLog } from '../../src/rollup/types';
 import { bold, gray, yellow } from '../../src/utils/colors';
+import { ensureArray } from '../../src/utils/ensureArray';
+import { getLogFilter } from '../../src/utils/getLogFilter';
 import { getNewArray, getOrCreate } from '../../src/utils/getOrCreate';
 import { LOGLEVEL_DEBUG, LOGLEVEL_WARN } from '../../src/utils/logging';
 import { printQuotedStringList } from '../../src/utils/printStringList';
@@ -18,7 +20,9 @@ import {
 import { stderr } from '../logging';
 import type { BatchWarnings } from './loadConfigFileType';
 
-export default function batchWarnings(silent: boolean): BatchWarnings {
+export default function batchWarnings(command: Record<string, any>): BatchWarnings {
+	const silent = !!command.silent;
+	const logFilter = generateLogFilter(command);
 	let count = 0;
 	const deferredWarnings = new Map<keyof typeof deferredHandlers, RollupLog[]>();
 	let warningOccurred = false;
@@ -61,6 +65,7 @@ export default function batchWarnings(silent: boolean): BatchWarnings {
 		},
 
 		log(level, log) {
+			if (!logFilter(log)) return;
 			switch (level) {
 				case LOGLEVEL_WARN: {
 					return add(log);
@@ -327,3 +332,11 @@ function showTruncatedWarnings(warnings: readonly RollupLog[]): void {
 		stderr(`\n...and ${nestedByModule.length - displayedByModule.length} other files`);
 	}
 }
+
+function generateLogFilter(command: Record<string, any>) {
+	const filters = ensureArray(command.filterLogs).flatMap(filter => String(filter).split(','));
+	if (process.env.ROLLUP_FILTER_LOGS) {
+		filters.push(...process.env.ROLLUP_FILTER_LOGS.split(','));
+	}
+	return getLogFilter(filters);
+}

cli/run/loadConfigFile.ts

@@ -29,7 +29,7 @@ export const loadConfigFile: LoadConfigFile = async (
 		getDefaultFromCjs(await getConfigFileExport(fileName, commandOptions, watchMode)),
 		commandOptions
 	);
-	const warnings = batchWarnings(commandOptions.silent);
+	const warnings = batchWarnings(commandOptions);
 	try {
 		const normalizedConfigs: MergedRollupOptions[] = [];
 		for (const config of configs) {
@@ -92,9 +92,10 @@ function getDefaultFromCjs(namespace: GenericConfigObject): unknown {
 
 async function loadTranspiledConfigFile(
 	fileName: string,
-	{ bundleConfigAsCjs, configPlugin, silent }: Record<string, unknown>
+	commandOptions: Record<string, unknown>
 ): Promise<unknown> {
-	const warnings = batchWarnings(!!silent);
+	const { bundleConfigAsCjs, configPlugin, silent } = commandOptions;
+	const warnings = batchWarnings(commandOptions);
 	const inputOptions = {
 		external: (id: string) =>
 			(id[0] !== '.' && !isAbsolute(id)) || id.slice(-5, id.length) === '.json',

cli/run/loadConfigFromCommand.ts

@@ -7,17 +7,17 @@ import type { BatchWarnings } from './loadConfigFileType';
 import { stdinName } from './stdin';
 
 export default async function loadConfigFromCommand(
-	command: Record<string, unknown>,
+	commandOptions: Record<string, unknown>,
 	watchMode: boolean
 ): Promise<{
 	options: MergedRollupOptions[];
 	warnings: BatchWarnings;
 }> {
-	const warnings = batchWarnings(!!command.silent);
-	if (!command.input && (command.stdin || !process.stdin.isTTY)) {
-		command.input = stdinName;
+	const warnings = batchWarnings(commandOptions);
+	if (!commandOptions.input && (commandOptions.stdin || !process.stdin.isTTY)) {
+		commandOptions.input = stdinName;
 	}
-	const options = await mergeOptions({ input: [] }, watchMode, command, warnings.log);
-	await addCommandPluginsToInputOptions(options, command);
+	const options = await mergeOptions({ input: [] }, watchMode, commandOptions, warnings.log);
+	await addCommandPluginsToInputOptions(options, commandOptions);
 	return { options: [options], warnings };
 }