Add switch --no-table-formatting to 'rush list'

sachinjoseph · sachinjoseph · commit a6f2b34b487d · 2020-05-03T17:27:13.000-07:00
diff --git a/apps/rush-lib/src/cli/actions/ListAction.ts b/apps/rush-lib/src/cli/actions/ListAction.ts
@@ -4,7 +4,6 @@ import { CommandLineFlagParameter } from '@rushstack/ts-command-line';
 import { RushConfigurationProject } from '../../api/RushConfigurationProject';
 import * as Table from 'cli-table';
 
-
 export interface IJsonEntry {
   name: string;
   version: string;
@@ -21,6 +20,7 @@ export class ListAction extends BaseRushAction {
   private _path: CommandLineFlagParameter;
   private _fullPath: CommandLineFlagParameter;
   private _jsonFlag: CommandLineFlagParameter;
+  private _notTableFormatting: CommandLineFlagParameter;
 
   public constructor(parser: RushCommandLineParser) {
     super({
@@ -63,6 +63,11 @@ export class ListAction extends BaseRushAction {
       parameterLongName: '--json',
       description: 'If this flag is specified, output will be in JSON format.'
     });
+
+    this._notTableFormatting = this.defineFlagParameter({
+      parameterLongName: '--no-table-formatting',
+      description: 'If this flag is specified, then the output table will not have headers or border characters making it easier to parse (for example, using grep).'
+    });
   }
 
   protected async run(): Promise<void> {
@@ -117,8 +122,16 @@ export class ListAction extends BaseRushAction {
     if (this._fullPath.value) {
       tableHeader.push('Full Path');
     }
+
     const table: Table = new Table({
-      head: tableHeader
+      head: this._notTableFormatting.value ? [] : tableHeader,
+      chars: this._notTableFormatting.value ? {
+        'top': '', 'top-mid': '', 'top-left': '', 'top-right': '',
+        'bottom': '', 'bottom-mid': '', 'bottom-left': '', 'bottom-right': '',
+        'left': '', 'left-mid': '', 'mid': '', 'mid-mid': '',
+        'right': '', 'right-mid': '', 'middle': ' '
+      } : {},
+      style: this._notTableFormatting ? { 'padding-left': 0, 'padding-right': 0 } : {}
     });
 
     allPackages.forEach((config: RushConfigurationProject, name: string) => {
diff --git a/apps/rush-lib/src/cli/test/__snapshots__/CommandLineHelp.test.ts.snap b/apps/rush-lib/src/cli/test/__snapshots__/CommandLineHelp.test.ts.snap
@@ -362,20 +362,25 @@ Optional arguments:
 `;
 
 exports[`CommandLineHelp prints the help for each action: list 1`] = `
-"usage: rush list [-h] [-v] [-p] [-f] [--json]
+"usage: rush list [-h] [-v] [-p] [-f] [--json] [--no-table-formatting]
 
 List package names, and optionally version (--version) and path (--path) or 
 full path (--full-path), for projects in the current rush config.
 
 Optional arguments:
-  -h, --help       Show this help message and exit.
-  -v, --version    If this flag is specified, the project version will be 
-                   displayed in a column along with the package name.
-  -p, --path       If this flag is specified, the project path will be 
-                   displayed in a column along with the package name.
-  -f, --full-path  If this flag is specified, the project full path will be 
-                   displayed in a column along with the package name.
-  --json           If this flag is specified, output will be in JSON format.
+  -h, --help            Show this help message and exit.
+  -v, --version         If this flag is specified, the project version will 
+                        be displayed in a column along with the package name.
+  -p, --path            If this flag is specified, the project path will be 
+                        displayed in a column along with the package name.
+  -f, --full-path       If this flag is specified, the project full path will 
+                        be displayed in a column along with the package name.
+  --json                If this flag is specified, output will be in JSON 
+                        format.
+  --no-table-formatting
+                        If this flag is specified, then the output table will 
+                        not have headers or border characters making it 
+                        easier to parse.
 "
 `;
 
