chore: add jsdocs to Configuration type

src/interfaces/pjson.ts

@@ -117,16 +117,46 @@ export type S3 = {
 }
 
 export type Configuration = {
+  /**
+   * Flags in addition to --help that should trigger help output.
+   */
   additionalHelpFlags?: string[]
+  /**
+   * Flags in addition to --version that should trigger version output.
+   */
   additionalVersionFlags?: string[]
+  /**
+   * Plugin aliases.
+   */
   aliases?: {[name: string]: null | string}
+  /**
+   * The name of the executable.
+   */
   bin?: string
+  /**
+   * Aliases for the executable.
+   */
   binAliases?: string[]
   commands?: string | CommandDiscovery
+  /**
+   * Your CLI's description. Overrides the description in the package.json.
+   */
   description?: string | undefined
+  /**
+   * Plugins to load when in development mode.
+   */
   devPlugins?: string[]
+  /**
+   * The directory name to use when determining the cache, config, and data directories.
+   */
   dirname?: string
+  /**
+   * Example plugin to use in @oclif/plugin-plugin's help output.
+   */
   examplePlugin?: string
+  /**
+   * Customize the exit codes for the CLI.
+   */
   exitCodes?: {
     default?: number
     failedFlagParsing?: number
@@ -136,24 +166,73 @@ export type Configuration = {
     requiredArgs?: number
     unexpectedArgs?: number
   }
+  /**
+   * Enable flexible taxonomy for commands.
+   */
   flexibleTaxonomy?: boolean
+  /**
+   * The location of your custom help class.
+   */
   helpClass?: string | HelpLocationOptions
+  /**
+   * Options for the help output.
+   */
   helpOptions?: HelpOptions
+  /**
+   * Register hooks to run at various points in the CLI lifecycle.
+   */
   hooks?: {[name: string]: string | string[] | HookOptions | HookOptions[]}
+  /**
+   * Plugins that can be installed just-in-time.
+   */
   jitPlugins?: Record<string, string>
   macos?: {
     identifier?: string
     sign?: string
   }
+  /**
+   * Use a private or alternate npm registry.
+   */
   npmRegistry?: string
+  /**
+   * Script to run during postinstall on windows.
+   */
   nsisCustomization?: string
+  /**
+   * Plugin prefix to use when working with plugins with @oclif/plugin-plugins.
+   *
+   * Defaults to `plugin-`.
+   */
   pluginPrefix?: string
+  /**
+   * Plugins to load.
+   */
   plugins?: string[]
+  /**
+   * Template string used to build links to source code in CLI's README (when using `oclif readme`).
+   */
   repositoryPrefix?: string
   schema?: number
+  /**
+   * State of your CLI
+   *
+   * - `beta` - will show message to user that command or CLI is in beta
+   * - `deprecated` - will show message to user that command or CLI is deprecated
+   */
   state?: 'beta' | 'deprecated' | string
+  /**
+   * The theme to ship with the CLI.
+   *
+   * Can be a path to a JSON file or a Theme object.
+   */
   theme?: string | Theme
+  /**
+   * Separator to use for your CLI. Can be `:` or ` `.
+   */
   topicSeparator?: ' ' | ':'
+  /**
+   * Customize the topics in the CLI.
+   */
   topics?: {
     [k: string]: {
       description?: string
@@ -174,12 +253,12 @@ export type Configuration = {
     s3: S3
   }
   'warn-if-update-available'?: {
-    authorization: string
-    message: string
-    registry: string
-    timeoutInDays: number
-    frequency: number
-    frequencyUnit: 'days' | 'hours' | 'minutes' | 'seconds' | 'milliseconds'
+    authorization?: string
+    message?: string
+    registry?: string
+    timeoutInDays?: number
+    frequency?: number
+    frequencyUnit?: 'days' | 'hours' | 'minutes' | 'seconds' | 'milliseconds'
   }
   windows?: {
     homepage?: string