fix(eslint-bulk): change clean command to prune and update --help

Author: kevin-y-ang

eslint/eslint-bulk/README.md

@@ -13,17 +13,17 @@ Supply the files as the main argument. The "files" argument is a glob pattern th
 rules as the "eslint" command.
 
 ```bash
-  eslint-bulk suppress path/to/file1 path/to/file2 path/to/directory --rule rule1 --rule rule2
+  eslint-bulk suppress --rule rule1 --rule rule2 path/to/file1 path/to/file2 path/to/directory
 ```
 
-## eslint-bulk clean
+## eslint-bulk prune
 
 Use this command to automatically delete unused suppression entries for the given files in the
 corresponding .eslint-bulk-suppressions.json file(s). Supply the files as the main argument. The
 "files" argument is a glob pattern that follows the same rules as the "eslint" command.
 
 ```bash
-  eslint-bulk clean path/to/file1 path/to/file2 path/to/directory
+  eslint-bulk prune path/to/file1 path/to/file2 path/to/directory
 ```
 
 # Links

eslint/eslint-bulk/bin/eslint-bulk

@@ -142,14 +142,14 @@ argument. The "files" argument is a glob pattern that follows the same rules as
 eslint-bulk suppress path/to/file1 path/to/file2 path/to/directory --rule rule1 --rule rule2
 ```
 
-## eslint-bulk cleanup
+## eslint-bulk prune
 
 Use this command to automatically delete unused suppression entries for the given files in the
 corresponding .eslint-bulk-suppressions.json file(s). Supply the files as the main argument. The
 "files" argument is a glob pattern thatfollows the same rules as the "eslint" command.
 
 ```bash
-eslint-bulk cleanup path/to/file1 path/to/file2 path/to/directory
+eslint-bulk prune path/to/file1 path/to/file2 path/to/directory
 ```
 
 # Links

eslint/eslint-patch/README.md

@@ -246,12 +246,12 @@ export function shouldBulkSuppress(params: {
 }
 
 export function onFinish(params: { filename: string }): void {
-  if (process.env.ESLINT_BULK_CLEAN === 'true') {
-    BulkSuppressionsCleanUp(params);
+  if (process.env.ESLINT_BULK_PRUNE === 'true') {
+    BulkSuppressionsPrune(params);
   }
 }
 
-export function BulkSuppressionsCleanUp(params: { filename: string }): void {
+export function BulkSuppressionsPrune(params: { filename: string }): void {
   const { filename: fileAbsolutePath } = params;
   const suppressionsJson = readSuppressionsJson(fileAbsolutePath);
   const newSuppressionsJson = {

eslint/eslint-patch/src/eslint-bulk-suppressions/bulk-suppressions-patch.ts

@@ -3,13 +3,13 @@
 
 import { ExecException, exec } from 'child_process';
 import { getEslintCli } from './utils/get-eslint-cli';
-import { printCleanHelp } from './utils/print-help';
+import { printPruneHelp } from './utils/print-help';
 
-export function clean() {
+export function prune() {
   const args = process.argv.slice(3);
 
   if (args.includes('--help') || args.includes('-h')) {
-    printCleanHelp();
+    printPruneHelp();
     process.exit(0);
   }
 
@@ -32,7 +32,7 @@ export function clean() {
   const eslintCLI = getEslintCli(process.cwd());
 
   const env = Object.assign({}, process.env);
-  env.ESLINT_BULK_CLEAN = 'true';
+  env.ESLINT_BULK_PRUNE = 'true';
 
   exec(
     `${eslintCLI} ${parsedArgs.files.join(' ')} --format=json`,
@@ -52,7 +52,7 @@ export function clean() {
       }
 
       console.log(
-        `@rushstack/eslint-bulk: Successfully cleaned up .eslint-bulk-suppressions.json at ${process.cwd()} for ${
+        `@rushstack/eslint-bulk: Successfully pruned unused suppressions in .eslint-bulk-suppressions.json at ${process.cwd()} for ${
           parsedArgs.files
         }`
       );

eslint/eslint-patch/src/eslint-bulk-suppressions/cli/clean.ts renamed to eslint/eslint-patch/src/eslint-bulk-suppressions/cli/prune.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 
-import { clean } from './clean';
+import { prune } from './prune';
 import { suppress } from './suppress';
 import { isCorrectCwd } from './utils/is-correct-cwd';
 import { printHelp } from './utils/print-help';
@@ -20,8 +20,8 @@ const subcommand = process.argv[2];
 
 if (subcommand === 'suppress') {
   suppress();
-} else if (subcommand === 'clean') {
-  clean();
+} else if (subcommand === 'prune') {
+  prune();
 } else {
   throw new Error('@rushstack/eslint-bulk: Unknown subcommand: ' + subcommand);
 }

eslint/eslint-patch/src/eslint-bulk-suppressions/cli/start.ts

@@ -3,14 +3,14 @@
 
 import { wrapWordsToLines } from './wrap-words-to-lines';
 
-export function printCleanHelp() {
-  const help = `Usage: eslint-bulk suppress [options] <files...>
+export function printPruneHelp() {
+  const help = `Usage: eslint-bulk prune [options] <path...>
 
 This command is a thin wrapper around ESLint that communicates with @rushstack/eslint-patch to delete all unused suppression entries in the local .eslint-bulk-suppressions.json file that correspond to the target files given as arguments.
 
 Argument:
-  <files...>
-    Glob patterns for files to suppress, same as eslint files argument. Should be relative to the project root.`;
+  <path...>
+    Glob patterns for paths to suppress, same as eslint files argument. Should be relative to the project root.`;
 
   const wrapped = wrapWordsToLines(help);
   for (const line of wrapped) {
@@ -19,16 +19,27 @@ Argument:
 }
 
 export function printHelp() {
-  const help = `Usage: eslint-bulk <command> [options] <files...>
+  const help = `eslint-bulk <command>
 
-This command is a thin wrapper around ESLint that communicates with @rushstack/eslint-patch to suppress or clean up unused suppressions in the local .eslint-bulk-suppressions.json file.
+Usage:
+
+eslint-bulk suppress --rule NAME1 [--rule NAME2...] PATH1 [PATH2...]
+eslint-bulk suppress --all PATH1 [PATH2...]
+eslint-bulk suppress --help
+
+eslint-bulk prune PATH1 [PATH2...]
+eslint-bulk prune --help
+
+eslint-bulk --help
+
+This command line tool is a thin wrapper around ESLint that communicates with @rushstack/eslint-patch to suppress or prune unused suppressions in the local .eslint-bulk-suppressions.json file.
 
 Commands:
-  suppress
-    Please run "eslint-bulk suppress --help" to learn how to use this command.
+  eslint-bulk suppress [options] <path...>
+    Please run "eslint-bulk suppress --help" to learn more.
 
-  clean
-    Please run "eslint-bulk clean --help" to learn how to use this command.
+  eslint-bulk prune <path...>
+    Please run "eslint-bulk prune --help" to learn how to use this command.
 `;
 
   const wrapped = wrapWordsToLines(help);
@@ -38,20 +49,20 @@ Commands:
 }
 
 export function printSuppressHelp() {
-  const help = `Usage: eslint-bulk suppress [options] <files...>
+  const help = `Usage: eslint-bulk suppress [options] <path...>
 
 This command is a thin wrapper around ESLint that communicates with @rushstack/eslint-patch to either generate a new .eslint-bulk-suppressions.json file or add suppression entries to the existing file. Specify the files and rules you want to suppress.
 
 Argument:
-  <files...>
-    Glob patterns for files to suppress, same as eslint files argument. Should be relative to the project root.
+  <path...>
+    Glob patterns for paths to suppress, same as eslint files argument. Should be relative to the project root.
 
 Options:
   -h, -H, --help
     Display this help message.
 
   -R, --rule
-    The full name of the ESLint rule you want to bulk-suppress. Specify multiple rules with --rule rule1 --rule rule2.
+    The full name of the ESLint rule you want to bulk-suppress. Specify multiple rules with --rule NAME1 --rule NAME2.
 
   -A, --all
     Bulk-suppress all rules in the specified file patterns.`;