feat: export OclifError & PrettyPrintableError in Interfaces (#44)

src/errors/errors/cli.ts

@@ -6,16 +6,11 @@ import Indent = require('indent-string')
 import * as Wrap from 'wrap-ansi'
 
 import {config} from '../config'
-import {PrettyPrintableError} from './pretty-print'
+import {PrettyPrintableError, OclifError} from '../../interfaces/errors'
 
 /**
  * properties specific to internal oclif error handling
  */
-export interface OclifError {
-  oclif: {
-    exit?: number | false;
-  };
-}
 
 export function addOclifExitCode(error: Record<string, any>, options?: { exit?: number | false }): OclifError {
   if (!('oclif' in error)) {

src/errors/errors/exit.ts

@@ -1,4 +1,5 @@
-import {CLIError, OclifError} from './cli'
+import {CLIError} from './cli'
+import {OclifError} from '../../interfaces'
 
 export class ExitError extends CLIError implements OclifError {
   oclif!: { exit: number }

src/errors/errors/pretty-print.ts

@@ -1,30 +1,9 @@
 import * as wrap from 'wrap-ansi'
 import indent = require('indent-string')
+
 import * as screen from '../screen'
 import {config} from '../config'
-
-export interface PrettyPrintableError {
-  /**
-   * messsage to display related to the error
-   */
-  message?: string;
-
-  /**
-   * a unique error code for this error class
-   */
-  code?: string;
-
-  /**
-   * a url to find out more information related to this error
-   * or fixing the error
-   */
-  ref?: string;
-
-  /**
-   * a suggestion that may be useful or provide additional context
-   */
-  suggestions?: string[];
-}
+import {PrettyPrintableError} from '../../interfaces/errors'
 
 // These exist for backwards compatibility with CLIError
 type CLIErrorDisplayOptions = { name?: string; bang?: string }

src/errors/handle.ts

@@ -1,10 +1,11 @@
 /* eslint-disable no-process-exit */
 /* eslint-disable unicorn/no-process-exit */
 import {config} from './config'
-import prettyPrint, {PrettyPrintableError} from './errors/pretty-print'
+import prettyPrint from './errors/pretty-print'
 import {ExitError} from '.'
 import clean = require('clean-stack')
-import {OclifError, CLIError} from './errors/cli'
+import {CLIError} from './errors/cli'
+import {OclifError, PrettyPrintableError} from '../interfaces'
 
 export const handle = (err: Error & Partial<PrettyPrintableError> & Partial<OclifError>) => {
   try {

src/errors/index.ts

@@ -7,9 +7,10 @@ export {Logger} from './logger'
 export {config} from './config'
 
 import {config} from './config'
-import {CLIError, addOclifExitCode, OclifError} from './errors/cli'
+import {CLIError, addOclifExitCode} from './errors/cli'
 import {ExitError} from './errors/exit'
-import prettyPrint, {PrettyPrintableError, applyPrettyPrintOptions} from './errors/pretty-print'
+import prettyPrint, {applyPrettyPrintOptions} from './errors/pretty-print'
+import {OclifError, PrettyPrintableError} from '../interfaces'
 
 export {PrettyPrintableError}
 

src/interfaces/errors.ts

@@ -0,0 +1,28 @@
+export interface OclifError {
+  oclif: {
+    exit?: number | false;
+  };
+}
+
+export interface PrettyPrintableError {
+  /**
+   * messsage to display related to the error
+   */
+  message?: string;
+
+  /**
+   * a unique error code for this error class
+   */
+  code?: string;
+
+  /**
+   * a url to find out more information related to this error
+   * or fixing the error
+   */
+  ref?: string;
+
+  /**
+   * a suggestion that may be useful or provide additional context
+   */
+  suggestions?: string[];
+}

src/interfaces/index.ts

@@ -1,5 +1,6 @@
 export {Config, ArchTypes, PlatformTypes, LoadOptions} from './config'
 export {Command} from './command'
+export {OclifError, PrettyPrintableError} from './errors'
 export {Hook, HookKeyOrOptions, Hooks} from './hooks'
 export {Manifest} from './manifest'
 export {PJSON} from './pjson'

test/errors/error.test.ts

@@ -1,6 +1,6 @@
 import {expect, fancy} from 'fancy-test'
 import {error} from '../../src/errors'
-import {PrettyPrintableError} from '../../src/errors/errors/pretty-print'
+import {PrettyPrintableError} from '../../src/interfaces/errors'
 
 describe('error', () => {
   fancy

test/errors/pretty-print.test.ts

@@ -1,5 +1,6 @@
 import {expect, fancy} from 'fancy-test'
-import prettyPrint, {PrettyPrintableError} from '../../src/errors/errors/pretty-print'
+import prettyPrint from '../../src/errors/errors/pretty-print'
+import {PrettyPrintableError} from '../../src/interfaces/errors'
 import {CLIError} from '../../src/errors'
 import {config} from '../../src/errors/config'
 const stripAnsi = require('strip-ansi')