help() — tailwindcss Function Reference

Architecture documentation for the help() function in index.ts from the tailwindcss codebase.

Function typescript CommandLineInterface Renderer calls 5

Entity Profile

CommandLineInterface→ Renderer→ help() — tailwindcss Function Reference

Dependency Diagram

graph TD
  b3812df1_363e_a468_d814_9f5366025963["help()"]
  dedd6830_c180_a2b0_01d1_b5874e938eb8["index.ts"]
  b3812df1_363e_a468_d814_9f5366025963 -->|defined in| dedd6830_c180_a2b0_01d1_b5874e938eb8
  67ba9693_4314_1af0_b958_6866171fbded["println()"]
  b3812df1_363e_a468_d814_9f5366025963 -->|calls| 67ba9693_4314_1af0_b958_6866171fbded
  e596cbd7_5ac3_bb1f_974c_17f3c797c49f["header()"]
  b3812df1_363e_a468_d814_9f5366025963 -->|calls| e596cbd7_5ac3_bb1f_974c_17f3c797c49f
  013ade5d_a705_2dda_2ed9_20a4f95c3a49["wordWrap()"]
  b3812df1_363e_a468_d814_9f5366025963 -->|calls| 013ade5d_a705_2dda_2ed9_20a4f95c3a49
  7517bd35_5b87_fa68_a4ac_7d202b4cf436["indent()"]
  b3812df1_363e_a468_d814_9f5366025963 -->|calls| 7517bd35_5b87_fa68_a4ac_7d202b4cf436
  91fd8834_d180_b2df_65bf_c35d13dac7a7["highlight()"]
  b3812df1_363e_a468_d814_9f5366025963 -->|calls| 91fd8834_d180_b2df_65bf_c35d13dac7a7
  style b3812df1_363e_a468_d814_9f5366025963 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/@tailwindcss-cli/src/commands/help/index.ts lines 5–174

export function help({
  invalid,
  usage,
  options,
}: {
  invalid?: string
  usage?: string[]
  options?: Arg
}) {
  // Available terminal width
  let width = process.stdout.columns

  // Render header
  println(header())

  // Render the invalid command
  if (invalid) {
    println()
    println(`${pc.dim('Invalid command:')} ${invalid}`)
  }

  // Render usage
  if (usage && usage.length > 0) {
    println()
    println(pc.dim('Usage:'))
    for (let [idx, example] of usage.entries()) {
      // Split the usage example into the command and its options. This allows
      // us to wrap the options based on the available width of the terminal.
      let command = example.slice(0, example.indexOf('['))
      let options = example.slice(example.indexOf('['))

      // Make the options dimmed, to make them stand out less than the command
      // itself.
      options = options.replace(/\[.*?\]/g, (option) => pc.dim(option))

      // The space between the command and the options.
      let space = 1

      // Wrap the options based on the available width of the terminal.
      let lines = wordWrap(options, width - UI.indent - command.length - space)

      // Print an empty line between the usage examples if we need to split due
      // to width constraints. This ensures that the usage examples are visually
      // separated.
      //
      // E.g.: when enough space is available
      //
      // ```
      //   Usage:
      //     tailwindcss build [--input input.css] [--output output.css] [--watch] [options...]
      //     tailwindcss other [--watch] [options...]
      // ```
      //
      // E.g.: when not enough space is available
      //
      // ```
      //   Usage:
      //     tailwindcss build [--input input.css] [--output output.css]
      //                       [--watch] [options...]
      //
      //     tailwindcss other [--watch] [options...]
      // ```
      if (lines.length > 1 && idx !== 0) {
        println()
      }

      // Print the usage examples based on available width of the terminal.
      //
      // E.g.: when enough space is available
      //
      // ```
      //   Usage:
      //     tailwindcss [--input input.css] [--output output.css] [--watch] [options...]
      // ```
      //
      // E.g.: when not enough space is available
      //
      // ```
      //   Usage:
      //     tailwindcss [--input input.css] [--output output.css]
      //                 [--watch] [options...]