relative() — tailwindcss Function Reference

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

Function typescript CommandLineInterface Renderer

Entity Profile

CommandLineInterface→ Renderer→ relative() — tailwindcss Function Reference

Dependency Diagram

graph TD
  30e992a1_3fd4_9946_9330_7675678f843d["relative()"]
  cc1a3f06_4b21_684c_487a_f342bd18d772["renderer.ts"]
  30e992a1_3fd4_9946_9330_7675678f843d -->|defined in| cc1a3f06_4b21_684c_487a_f342bd18d772
  style 30e992a1_3fd4_9946_9330_7675678f843d fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/@tailwindcss-cli/src/utils/renderer.ts lines 23–38

export function relative(
  to: string,
  from = process.cwd(),
  { preferAbsoluteIfShorter = true } = {},
) {
  let result = path.relative(from, to)
  if (!result.startsWith('..')) {
    result = `.${path.sep}${result}`
  }

  if (preferAbsoluteIfShorter && result.length > to.length) {
    return to
  }

  return result
}