update docs [skip publish]

Author: chenasraf

Diff for: src/types.ts

@@ -11,17 +11,55 @@ export type FileResponseFn<T> = (fullPath: string, basedir: string, basename: st
 export type FileResponse<T> = T | FileResponseFn<T>
 
 export interface ScaffoldConfig {
-  /** The name supplied for the output templates */
+  /**
+   * Name to be passed to the generated files. `{{name}}` and `{{Name}}` inside contents and file names will be replaced
+   * accordingly.
+   */
   name: string
-  /** Template input files/dirs/glob patterns to use as template input. These will be copied to the output directory. */
+
+  /**
+   * Template files to use as input. You may provide multiple files, each of which can be a relative or absolute path,
+   * or a glob pattern for multiple file matching easily. (default: current working directory)
+   */
   templates: string[]
-  /** Output directory to put scaffolded files in. */
+
+  /** Path to output to. If `createSubFolder` is `true`, the subfolder will be created inside this path. */
   output: FileResponse<string>
+
+  /**
+   * Create subfolder with the input name (default: `false`)
+   */
   createSubFolder?: boolean
+
+  /**
+   * Add custom data to the templates. By default, only your app name is included as `{{name}}` and `{{Name}}`.
+   */
   data?: Record<string, string>
+
+  /**
+   * Enable to override output files, even if they already exist. (default: `false`)
+   *
+   * You may supply a function to this option, which can take the arguments `(fullPath, baseDir, baseName)` and returns
+   * a string, to return a dynamic path for each file.
+   */
   overwrite?: FileResponse<boolean>
+
+  /** Suppress output logs (Same as `verbose: 0` or `verbose: LogLevel.None`) */
   quiet?: boolean
+
+  /**
+   * Determine amount of logs to display.
+   *
+   * The values are: `0 (none) | 1 (debug) | 2 (info) | 3 (warn) | 4 (error)`. The provided level will display messages
+   * of the same level or higher. (default: `2 (info)`)
+   * @see LogLevel
+   */
   verbose?: LogLevel
+
+  /**
+   * Don't emit files. This is good for testing your scaffolds and making sure they don't fail, without having to write
+   * actual file contents or create directories. (default: `false`)
+   */
   dryRun?: boolean
 }
 export interface ScaffoldCmdConfig {
@@ -32,5 +70,6 @@ export interface ScaffoldCmdConfig {
   data?: Record<string, string>
   overwrite: boolean
   quiet: boolean
+  verbose: LogLevel
   dryRun: boolean
 }