add lint rules for console.log and fix postcss-browser-comments (#1482)

Author: romainmenke

.github/bin/detect-executable-files/to-github-annotations.mjs

@@ -33,8 +33,10 @@ if (!fileNames || !fileNames.length) {
 }
 
 if (!process.env.GITHUB_ACTIONS) {
+	// eslint-disable-next-line no-console
 	console.log('Unexpected executables:');
 	fileNames.forEach((f) => {
+		// eslint-disable-next-line no-console
 		console.log(`chmod a-x ${f}`);
 	});
 	process.exit(1);
@@ -51,6 +53,7 @@ fileNames.forEach((f) => {
 		},
 	);
 
+	// eslint-disable-next-line no-console
 	console.log(annotation);
 });
 

.github/bin/format-package-json.mjs

@@ -251,6 +251,7 @@ const formatted = {};
 Object.assign(formatted, packageJSONInfo);
 
 if (process.env.GITHUB_ACTIONS && JSON.stringify(formatted, null, '\t') !== packageJSONInfoCopy) {
+	// eslint-disable-next-line no-console
 	console.error(`::error file=${path.relative(process.env.GITHUB_WORKSPACE, path.resolve('./package.json'))},line=1,col=1::package.json has an incorrect field order. Run "npm run lint" to resolve.`);
 	process.exit(1);
 }

.github/bin/license/check-license.mjs

@@ -139,6 +139,7 @@ const allFiles = (await getFiles('./')).filter((file) => {
 }
 
 if (logEntries.length > 0) {
+	// eslint-disable-next-line no-console
 	console.log(logEntries.join('\n'));
 	process.exit(1);
 }

.github/bin/list-workspaces/list-workspaces.mjs

@@ -73,7 +73,8 @@ export async function listWorkspaces() {
 		});
 
 		return result;
-	} catch(err) {
+	} catch (err) {
+		// eslint-disable-next-line no-console
 		console.error(err);
 		throw new Error('failed to get the list of workspaces');
 	}

.github/bin/modified-workspaces/modified-workspaces.mjs

@@ -61,6 +61,7 @@ export async function listModifiedWorkspaces() {
 
 		for (const internalDependency of internalDependencies) {
 			if (modifiedFile.startsWith(internalDependency)) {
+				// eslint-disable-next-line no-console
 				console.error('modified a private dependency', modifiedFile);
 				// this file can influence anything
 				// anything or everything might have changed
@@ -82,6 +83,7 @@ export async function listModifiedWorkspaces() {
 		}
 
 		if (isNonWorkspaceFile) {
+			// eslint-disable-next-line no-console
 			console.error('modifiedFile outside of workspaces', modifiedFile);
 			// files outside of workspaces include "package-lock.json", rollup config, ...
 			// anything or everything might have changed

.github/bin/new-plugin.mjs

@@ -6,16 +6,19 @@ const pluginName = process.argv.slice(2).join(' ');
 // Plugin name checks
 {
 	if (!pluginName) {
+		// eslint-disable-next-line no-console
 		console.warn('A plugin name must be provided:\n  new-plugin <human readable name>\n  new-plugin Cascade Layers');
 		process.exit(1);
 	}
 
 	if (pluginName.startsWith('postcss-')) {
+		// eslint-disable-next-line no-console
 		console.warn('Plugin name cannot start with "postcss-", it is added by this scripts.');
 		process.exit(1);
 	}
 
 	if (pluginName.includes('/')) {
+		// eslint-disable-next-line no-console
 		console.warn('Plugin name cannot contain "/"');
 		process.exit(1);
 	}
@@ -29,13 +32,15 @@ const exportName = 'postcss' + pluginName.replace(/\s+/g, '');
 const basePluginDir = './plugins/postcss-base-plugin';
 const pluginDir = './plugins/' + pluginSlug;
 
+// eslint-disable-next-line no-console
 console.log(`- Creating new plugin ${pluginName}`);
 
 // Copy base plugin
 {
 	await fs.rm(pluginDir, { recursive: true, force: true });
 	await fs.cp(basePluginDir, pluginDir, { recursive: true });
 
+	// eslint-disable-next-line no-console
 	console.log('- Copied base plugin to', pluginDir);
 }
 
@@ -44,6 +49,7 @@ console.log(`- Creating new plugin ${pluginName}`);
 	await fs.rm(path.join(pluginDir, 'dist'), { recursive: true, force: true });
 	await fs.rm(path.join(pluginDir, 'node_modules'), { recursive: true, force: true });
 
+	// eslint-disable-next-line no-console
 	console.log('- Cleaned up files and directories not required in a new plugin');
 }
 
@@ -65,6 +71,7 @@ console.log(`- Creating new plugin ${pluginName}`);
 `,
 	);
 
+	// eslint-disable-next-line no-console
 	console.log('- Relabeled references to base plugin');
 }
 
@@ -85,21 +92,23 @@ console.log(`- Creating new plugin ${pluginName}`);
 
 	await fs.writeFile(path.join(pluginDir, 'package.json'), JSON.stringify(packageInfo, null, '\t'));
 
+	// eslint-disable-next-line no-console
 	console.log('- Updated "package.json"');
 }
 
+// eslint-disable-next-line no-console
 console.log('\nDone! 🎉');
 
 // Next steps
 {
-	console.log('\nYour next steps:');
-	console.log('- Run : "npm install" from the root directory');
-	console.log(`- Run : "cd plugins/${pluginSlug}"`);
-	console.log('- Run : "npm run docs" to generate documentation');
-	console.log('- Run : "npm run build" to build your plugin');
-	console.log('- Run : "npm run test" to test your plugin');
-	console.log('- Run : "npm run test:rewrite-expects" to update test expects');
-	console.log('\nChange "blue" to "purple" in "src/index.ts" and see how it affects the test outcome');
+	console.log('\nYour next steps:'); // eslint-disable-line no-console
+	console.log('- Run : "npm install" from the root directory'); // eslint-disable-line no-console
+	console.log(`- Run : "cd plugins/${pluginSlug}"`); // eslint-disable-line no-console
+	console.log('- Run : "npm run docs" to generate documentation'); // eslint-disable-line no-console
+	console.log('- Run : "npm run build" to build your plugin'); // eslint-disable-line no-console
+	console.log('- Run : "npm run test" to test your plugin'); // eslint-disable-line no-console
+	console.log('- Run : "npm run test:rewrite-expects" to update test expects'); // eslint-disable-line no-console
+	console.log('\nChange "blue" to "purple" in "src/index.ts" and see how it affects the test outcome'); // eslint-disable-line no-console
 }
 
 // Helpers

.github/bin/release-plan/add-to-changelog.mjs

@@ -3,13 +3,15 @@ export function addUpdatedPackagesToChangelog(workspace, changelog, changeLogAdd
 		// Find the heading for the unreleased changes.
 		const unreleasedSectionStart = changelog.indexOf('Unreleased');
 		if (unreleasedSectionStart === -1) {
+			// eslint-disable-next-line no-console
 			console.log('Unable to update the Changelog for ' + workspace.name);
 			return changelog;
 		}
 
 		// Find the start of the section content for the unreleased changes.
 		const unreleasedSectionContent = changelog.indexOf('\n', unreleasedSectionStart) + 1;
 		if (unreleasedSectionContent === 0) {
+			// eslint-disable-next-line no-console
 			console.log('Unable to update the Changelog for ' + workspace.name);
 			return changelog;
 		}
@@ -23,13 +25,15 @@ export function addUpdatedPackagesToChangelog(workspace, changelog, changeLogAdd
 		// Search backward from the next section to find the line for the last unreleased change.
 		const listEnd = changelog.lastIndexOf('- ', nextSectionStart);
 		if (listEnd < unreleasedSectionContent) {
+			// eslint-disable-next-line no-console
 			console.log('Unable to update the Changelog for ' + workspace.name);
 			return changelog;
 		}
 
 		// Get the start of the next line after the last change.
 		const nextLine = changelog.indexOf('\n', listEnd) + 1;
 		if (nextLine === 0) {
+			// eslint-disable-next-line no-console
 			console.log('Unable to update the Changelog for ' + workspace.name);
 			return changelog;
 		}

.github/bin/release-plan/discord-announce.mjs

@@ -65,16 +65,19 @@ export async function discordAnnounceDryRun() {
 
 	const discordArgument = process.argv.slice(2).find(arg => arg.includes('--discord='));
 	if (!discordArgument) {
+		// eslint-disable-next-line no-console
 		console.log('Discord announce webhook URL: not set');
 		return;
 	}
 
 	const [, webHookUrl] = discordArgument.split('=');
 
 	if (!webHookUrl) {
+		// eslint-disable-next-line no-console
 		console.log('Discord announce webhook URL: not set');
 		return;
 	}
 
+	// eslint-disable-next-line no-console
 	console.log(`Discord announce webhook URL: ${webHookUrl}`);
 }

.github/bin/release-plan/prepare-current-release-plan.mjs

@@ -49,6 +49,7 @@ export async function prepareCurrentReleasePlan() {
 			} else if (changelog.includes('Unreleased (major)')) {
 				increment = 'major';
 			} else {
+				// eslint-disable-next-line no-console
 				console.warn('Invalid CHANGELOG.md in', workspace.name);
 				notReleasableNow.set(workspace.name, workspace);
 				continue WORKSPACES_LOOP;
@@ -61,6 +62,7 @@ export async function prepareCurrentReleasePlan() {
 					notReleasableNow.set(workspace.name, workspace);
 				}
 
+				// eslint-disable-next-line no-console
 				console.warn('Current npm user does not have write access for', workspace.name);
 				continue WORKSPACES_LOOP;
 			}
@@ -92,23 +94,30 @@ export async function prepareCurrentReleasePlan() {
 	}
 
 	if (needsRelease.size === 0) {
+		// eslint-disable-next-line no-console
 		console.log('Nothing to release');
 		process.exit(0);
 	}
 
 	if (maybeNextPlan.size) {
+		// eslint-disable-next-line no-console
 		console.log('Excluded:');
 		for (const workspace of maybeNextPlan.values()) {
+			// eslint-disable-next-line no-console
 			console.log(`  - ${workspace.name}`);
 		}
+		// eslint-disable-next-line no-console
 		console.log(''); // empty line
 	}
 
 	if (needsRelease.size) {
+		// eslint-disable-next-line no-console
 		console.log('Release plan:');
 		for (const workspace of needsRelease.values()) {
+			// eslint-disable-next-line no-console
 			console.log(`  - ${workspace.name} (${workspace.increment})`);
 		}
+		// eslint-disable-next-line no-console
 		console.log(''); // empty line
 	}
 

.github/bin/release-plan/prepare-next-release-plan.mjs

@@ -6,6 +6,7 @@ export async function prepareNextReleasePlan(needsRelease, notReleasableNow) {
 	// Downstream dependents
 	let didChangeDownstreamPackages = false;
 
+	// eslint-disable-next-line no-console
 	console.log('\nPreparing next plan');
 
 	for (const workspace of notReleasableNow.values()) {

.github/bin/release-plan/release-plan.mjs

@@ -25,6 +25,7 @@ if (process.argv.slice(2).includes('--dry-run')) {
 }
 
 for (const workspace of needsRelease.values()) {
+	// eslint-disable-next-line no-console
 	console.log(`Releasing : ${workspace.name}`);
 	// Increment the version
 	workspace.newVersion = await npmVersion(workspace.increment, workspace.path);
@@ -86,21 +87,26 @@ for (const workspace of needsRelease.values()) {
 
 const didChangeDownstreamPackages = await prepareNextReleasePlan(needsRelease, notReleasableNow);
 
+// eslint-disable-next-line no-console
 console.log('\nUpdating lock file');
 await npmInstall();
 
 if (didChangeDownstreamPackages) {
 	await commitAfterDependencyUpdates();
 }
 
+// eslint-disable-next-line no-console
 console.log('\nDone 🎉');
 
 if (didChangeDownstreamPackages || maybeNextPlan.size > 0) {
+	// eslint-disable-next-line no-console
 	console.log('\nNotes:'); // empty line
 	if (didChangeDownstreamPackages) {
+		// eslint-disable-next-line no-console
 		console.log('  - updated "package.json" files of downstream packages.');
 	}
 	if (maybeNextPlan.size) {
+		// eslint-disable-next-line no-console
 		console.log('  - some packages were excluded from this plan. A next plan of releases might be available now.');
 	}
 }

.github/bin/release-plan/run-and-print-debug-on-fail.mjs

@@ -2,8 +2,10 @@ export async function runAndPrintDebugOnFail(runningJob, prelude, helpMessage) {
 	try {
 		await runningJob;
 	} catch (e) {
+		// eslint-disable-next-line no-console
 		console.error(e);
 
+		// eslint-disable-next-line no-console
 		console.log(`-----------\n\n${prelude.trim()}\n\n${helpMessage.trim()}`);
 
 		process.exit(1);

cli/csstools-cli/src/cli.ts

@@ -266,6 +266,7 @@ async function main(): Promise<void> {
 				'  @csstools/csstools-cli postcss-preset-env',
 			];
 
+			// eslint-disable-next-line no-console
 			console.warn(allHelp.join('\n'));
 		}
 	}

eslint.config.mjs

@@ -39,6 +39,7 @@ export default [
 		},
 
 		rules: {
+			'no-console': ['error'],
 			quotes: ['error', 'single'],
 			'comma-dangle': ['error', 'always-multiline'],
 			semi: ['error', 'always'],
@@ -75,6 +76,7 @@ export default [
 		},
 
 		rules: {
+			'no-console': ['error'],
 			'no-unused-vars': ['error', { 'caughtErrorsIgnorePattern': '_' }],
 			'no-constant-condition': 'off',
 		},
@@ -93,6 +95,7 @@ export default [
 			},
 		},
 		rules: {
+			'no-console': ['error'],
 			'no-shadow': 'off',
 			'@typescript-eslint/no-shadow': 'error',
 

experimental/css-has-pseudo/dist/browser-global.js.map

@@ -1,3 +1,4 @@
 export default function cssHasPseudo() {
+	// eslint-disable-next-line no-console
 	console.log('"@csstools/css-has-pseudo-experimental" is no longer supported. Please use "css-has-pseudo" instead.');
 }

experimental/css-has-pseudo/dist/browser.cjs.map

@@ -95,7 +95,7 @@ export function parseArguments(args: Array<string>, allowedPluginOpts: Array<str
 			default:
 				if (arg.indexOf('-') === 0) {
 					// Stryker disable next-line all
-					console.warn(`[error] unknown argument : ${arg}\n`);
+					console.warn(`[error] unknown argument : ${arg}\n`); // eslint-disable-line no-console
 					// Stryker disable next-line all
 					helpLogger();
 					return SignalValue.InvalidArguments;
@@ -123,7 +123,7 @@ export function parseArguments(args: Array<string>, allowedPluginOpts: Array<str
 
 	if (parsedArgs.inputs.length > 1 && parsedArgs.output) {
 		// Stryker disable next-line all
-		console.warn('[error] omit "--output" when processing multiple inputs\n');
+		console.warn('[error] omit "--output" when processing multiple inputs\n'); // eslint-disable-line no-console
 		// Stryker disable next-line all
 		helpLogger();
 		return SignalValue.InvalidArguments;
@@ -148,7 +148,7 @@ export function parseArguments(args: Array<string>, allowedPluginOpts: Array<str
 			parsedPluginOpts = JSON.parse(pluginOpts) as Record<string, unknown>;
 		} catch {
 			// Stryker disable next-line all
-			console.warn('[error] plugin options must be valid JSON\n');
+			console.warn('[error] plugin options must be valid JSON\n'); // eslint-disable-line no-console
 			// Stryker disable next-line all
 			helpLogger();
 			return SignalValue.InvalidArguments;
@@ -161,7 +161,7 @@ export function parseArguments(args: Array<string>, allowedPluginOpts: Array<str
 			parsedArgs.pluginOptions[key] = value;
 		} else {
 			// Stryker disable next-line all
-			console.warn(`[error] unknown plugin option: ${key}\n`);
+			console.warn(`[error] unknown plugin option: ${key}\n`); // eslint-disable-line no-console
 			// Stryker disable next-line all
 			helpLogger();
 			return SignalValue.InvalidArguments;

experimental/css-has-pseudo/dist/browser.mjs.map

@@ -38,6 +38,7 @@ export function helpTextLogger(command: string, name: string, description: strin
 	}
 
 	return (): void => {
+		// eslint-disable-next-line no-console
 		console.warn(allHelp.join('\n'));
 	};
 }