args() — tailwindcss Function Reference

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

Function typescript UpgradeToolkit TemplateAnalysis calls 1

Entity Profile

UpgradeToolkit→ TemplateAnalysis→ args() — tailwindcss Function Reference

Dependency Diagram

graph TD
  7b2613af_eca0_b063_a0e3_ffec30cb1a12["args()"]
  2dcceaf3_4383_df7d_023d_fa36fab3c61a["args.ts"]
  7b2613af_eca0_b063_a0e3_ffec30cb1a12 -->|defined in| 2dcceaf3_4383_df7d_023d_fa36fab3c61a
  e4ebe550_4073_0060_f01d_0255e2847876["convert()"]
  7b2613af_eca0_b063_a0e3_ffec30cb1a12 -->|calls| e4ebe550_4073_0060_f01d_0255e2847876
  style 7b2613af_eca0_b063_a0e3_ffec30cb1a12 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/@tailwindcss-upgrade/src/utils/args.ts lines 69–101

export function args<const T extends Arg>(options: T, argv = process.argv.slice(2)): Result<T> {
  let parsed = parse(argv)

  let result: { _: string[]; [key: string]: unknown } = {
    _: parsed._,
  }

  for (let [
    flag,
    { type, alias, default: defaultValue = type === 'boolean' ? false : null },
  ] of Object.entries(options)) {
    // Start with the default value
    result[flag] = defaultValue

    // Try to find the `alias`, and map it to long form `flag`
    if (alias) {
      let key = alias.slice(1)
      if (parsed[key] !== undefined) {
        result[flag] = convert(parsed[key], type)
      }
    }

    // Try to find the long form `flag`
    {
      let key = flag.slice(2)
      if (parsed[key] !== undefined) {
        result[flag] = convert(parsed[key], type)
      }
    }
  }

  return result as Result<T>
}