feat(help): color refactor

BREAKING CHANGE: option/command/namespace groups are now `MetadataGroup`
ionic-team · Apr 17, 2019 · 5938429 · 5938429
1 parent cc1d2af
commit 5938429
Show file tree

Hide file tree

Showing 55 changed files with 249 additions and 264 deletions.
diff --git a/packages/@ionic/cli-framework/src/definitions.ts b/packages/@ionic/cli-framework/src/definitions.ts
@@ -32,6 +32,15 @@ export interface LinkFootnote {
 
 export type Footnote = TextFootnote | LinkFootnote;
 
+export const enum MetadataGroup {
+  ADVANCED = 'advanced',
+  BETA = 'beta',
+  DEPRECATED = 'deprecated',
+  EXPERIMENTAL = 'experimental',
+  HIDDEN = 'hidden',
+  PAID = 'paid',
+}
+
 export interface Metadata {
   name: string;
   summary: string;

diff --git a/packages/@ionic/cli-framework/src/lib/__tests__/help.ts b/packages/@ionic/cli-framework/src/lib/__tests__/help.ts
@@ -1,5 +1,6 @@
 import { Command, CommandMap, CommandMapDefault, Namespace, NamespaceMap } from '../command';
-import { CommandGroup, NamespaceGroup, OptionGroup, CommandStringHelpFormatter, NamespaceStringHelpFormatter, NamespaceSchemaHelpFormatter } from '../help';
+import { CommandStringHelpFormatter, NamespaceStringHelpFormatter, NamespaceSchemaHelpFormatter } from '../help';
+import { MetadataGroup } from '../../definitions';
 import { stripAnsi } from '../../utils/format';
 
 class MyNamespace extends Namespace {
@@ -30,7 +31,7 @@ class NamespaceWithDefault extends Namespace {
     return {
       name: 'defns',
       summary: 'the defns namespace',
-      groups: [NamespaceGroup.Beta],
+      groups: [MetadataGroup.BETA],
     };
   }
 
@@ -72,7 +73,7 @@ class DefaultCommand extends Command {
     return {
       name: 'def',
       summary: 'the default command',
-      groups: [CommandGroup.Beta],
+      groups: [MetadataGroup.BETA],
     };
   }
 
@@ -98,7 +99,7 @@ class BarCommand extends Command {
       ],
       options: [
         { name: 'opt1', summary: 'opt1 summary', aliases: ['o'], spec: { value: 'optvalue' } },
-        { name: 'opt2', summary: 'opt2 summary', groups: [OptionGroup.Advanced] },
+        { name: 'opt2', summary: 'opt2 summary', groups: [MetadataGroup.ADVANCED] },
         { name: 'opt3', summary: 'opt3 summary', type: Boolean },
       ],
       exampleCommands: ['', 'input1 input2', '--opt1 --opt2'],

diff --git a/packages/@ionic/cli-framework/src/lib/colors.ts b/packages/@ionic/cli-framework/src/lib/colors.ts
@@ -1,10 +1,22 @@
 import chalk from 'chalk';
 import * as lodash from 'lodash';
 
+import { MetadataGroup } from '../definitions';
+
 import { LoggerLevel } from './logger';
 
 export type ColorFunction = (...text: string[]) => string;
 export type LoggerColors = { [L in LoggerLevel]: ColorFunction; };
+export type HelpGroupColors = { [G in Exclude<MetadataGroup, MetadataGroup.HIDDEN | MetadataGroup.ADVANCED>]: ColorFunction; };
+
+export interface HelpColors {
+  /**
+   * Used to color the section titles in help output.
+   */
+  title: ColorFunction;
+
+  group: HelpGroupColors;
+}
 
 export interface Colors {
   /**
@@ -38,12 +50,14 @@ export interface Colors {
   ancillary: ColorFunction;
 
   log: LoggerColors;
+
+  help: HelpColors;
 }
 
 export const DEFAULT_COLORS: Colors = Object.freeze({
   strong: chalk.bold,
   weak: chalk.dim,
-  input: chalk.green,
+  input: chalk.cyan,
   success: chalk.green,
   failure: chalk.red,
   ancillary: chalk.cyan,
@@ -53,6 +67,15 @@ export const DEFAULT_COLORS: Colors = Object.freeze({
     WARN: chalk.yellow,
     ERROR: chalk.red,
   }),
+  help: Object.freeze({
+    title: chalk.bold,
+    group: Object.freeze({
+      [MetadataGroup.DEPRECATED]: chalk.yellow,
+      [MetadataGroup.BETA]: chalk.magenta,
+      [MetadataGroup.EXPERIMENTAL]: chalk.red,
+      [MetadataGroup.PAID]: chalk.green,
+    }),
+  }),
 });
 
 export const NO_COLORS: Colors = Object.freeze({
@@ -68,4 +91,13 @@ export const NO_COLORS: Colors = Object.freeze({
     WARN: lodash.identity,
     ERROR: lodash.identity,
   }),
+  help: Object.freeze({
+    title: lodash.identity,
+    group: Object.freeze({
+      [MetadataGroup.DEPRECATED]: lodash.identity,
+      [MetadataGroup.BETA]: lodash.identity,
+      [MetadataGroup.EXPERIMENTAL]: lodash.identity,
+      [MetadataGroup.PAID]: lodash.identity,
+    }),
+  }),
 });