Merge pull request #932 from oclif/mdonnalley/configurable-theme

feat: allow theme file to be configurable

src/config/config.ts

@@ -402,15 +402,26 @@ export class Config implements IConfig {
   }
 
   public async loadThemes(): Promise<{
-    file: string
+    file: string | undefined
     theme: Theme | undefined
   }> {
-    const file = resolve(this.configDir, 'theme.json')
-    const themes = await safeReadJson<Record<string, string>>(file)
-    const theme = themes ? parseTheme(themes) : undefined
+    const defaultThemeFile = this.pjson.oclif.theme
+      ? resolve(this.root, this.pjson.oclif.theme)
+      : this.pjson.oclif.theme
+    const userThemeFile = resolve(this.configDir, 'theme.json')
+
+    const [defaultTheme, userTheme] = await Promise.all([
+      defaultThemeFile ? await safeReadJson<Record<string, string>>(defaultThemeFile) : undefined,
+      await safeReadJson<Record<string, string>>(userThemeFile),
+    ])
+
+    // Merge the default theme with the user theme, giving the user theme precedence.
+    const merged = {...defaultTheme, ...userTheme}
     return {
-      file,
-      theme,
+      // Point to the user file if it exists, otherwise use the default file.
+      // This doesn't really serve a purpose to anyone but removing it would be a breaking change.
+      file: userTheme ? userThemeFile : defaultThemeFile,
+      theme: Object.keys(merged).length > 0 ? parseTheme(merged) : undefined,
     }
   }
 

src/help/command.ts

@@ -161,7 +161,7 @@ export class CommandHelp extends HelpFormatter {
         }
       }
 
-      label = labels.join(colorize(this.config?.theme?.flagSeparator, flag.char ? ', ' : '  '))
+      label = labels.join(flag.char ? colorize(this.config?.theme?.flagSeparator, ', ') : '  ')
     }
 
     if (flag.type === 'option') {
@@ -175,7 +175,7 @@ export class CommandHelp extends HelpFormatter {
       label += `=${value}`
     }
 
-    return label
+    return colorize(this.config.theme?.flag, label)
   }
 
   protected flags(flags: Array<Command.Flag.Any>): [string, string | undefined][] | undefined {
@@ -184,7 +184,7 @@ export class CommandHelp extends HelpFormatter {
     const noChar = flags.reduce((previous, current) => previous && current.char === undefined, true)
 
     return flags.map((flag) => {
-      let left = colorize(this.config?.theme?.flag, this.flagHelpLabel(flag))
+      let left = this.flagHelpLabel(flag)
 
       if (noChar) left = left.replace('    ', '')
 

src/interfaces/pjson.ts

@@ -43,15 +43,11 @@ export namespace PJSON {
         identifier?: string
         sign?: string
       }
-      windows?: {
-        homepage?: string
-        keypath?: string
-        name?: string
-      }
       plugins?: string[]
       repositoryPrefix?: string
       schema?: number
       state?: 'beta' | 'deprecated' | string
+      theme?: string
       topicSeparator?: ' ' | ':'
       topics?: {
         [k: string]: {
@@ -72,6 +68,11 @@ export namespace PJSON {
         }
         s3: S3
       }
+      windows?: {
+        homepage?: string
+        keypath?: string
+        name?: string
+      }
     }
     version: string
   }