feat: export HelpOptions in Interfaces

oclif · Sep 16, 2020 · 4351759 · 4351759
1 parent 10d3de9
commit 4351759
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git a/src/help/index.ts b/src/help/index.ts
@@ -20,12 +20,6 @@ const {
 
 const ROOT_INDEX_CMD_ID = ''
 
-export interface HelpOptions {
-  all?: boolean;
-  maxWidth: number;
-  stripAnsi?: boolean;
-}
-
 function getHelpSubject(args: string[]): string | undefined {
   for (const arg of args) {
     if (arg === '--') return
@@ -36,14 +30,14 @@ function getHelpSubject(args: string[]): string | undefined {
 }
 
 export abstract class HelpBase {
-  constructor(config: Interfaces.Config, opts: Partial<HelpOptions> = {}) {
+  constructor(config: Interfaces.Config, opts: Partial<Interfaces.HelpOptions> = {}) {
     this.config = config
     this.opts = {maxWidth: stdtermwidth, ...opts}
   }
 
   protected config: Interfaces.Config
 
-  protected opts: HelpOptions
+  protected opts: Interfaces.HelpOptions
 
   /**
    * Show help, used in multi-command CLIs
@@ -95,7 +89,7 @@ export class Help extends HelpBase {
     return topics
   }
 
-  constructor(config: Interfaces.Config, opts: Partial<HelpOptions> = {}) {
+  constructor(config: Interfaces.Config, opts: Partial<Interfaces.HelpOptions> = {}) {
     super(config, opts)
     this.render = template(this)
   }

diff --git a/src/interfaces/help.ts b/src/interfaces/help.ts
@@ -0,0 +1,5 @@
+export interface HelpOptions {
+  all?: boolean;
+  maxWidth: number;
+  stripAnsi?: boolean;
+}
diff --git a/src/interfaces/index.ts b/src/interfaces/index.ts
@@ -1,5 +1,6 @@
 export {Config, ArchTypes, PlatformTypes, LoadOptions} from './config'
 export {Command} from './command'
+export {HelpOptions} from './help'
 export {Hook, HookKeyOrOptions, Hooks} from './hooks'
 export {Manifest} from './manifest'
 export {PJSON} from './pjson'