getClassOrder() — tailwindcss Function Reference

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

Function typescript CompilerEngine ModuleResolution calls 1 called by 1

Entity Profile

CompilerEngine→ ModuleResolution→ getClassOrder() — tailwindcss Function Reference

Dependency Diagram

graph TD
  253719f6_2c20_17e4_dfba_451682b655dd["getClassOrder()"]
  cebe77e1_f0f2_aeee_417e_2192f5790344["buildDesignSystem()"]
  cebe77e1_f0f2_aeee_417e_2192f5790344 -->|calls| 253719f6_2c20_17e4_dfba_451682b655dd
  cbdeac33_581c_3396_0f10_877935a68176["compileCandidates()"]
  253719f6_2c20_17e4_dfba_451682b655dd -->|calls| cbdeac33_581c_3396_0f10_877935a68176
  style 253719f6_2c20_17e4_dfba_451682b655dd fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/tailwindcss/src/sort.ts lines 4–30

export function getClassOrder(design: DesignSystem, classes: string[]): [string, bigint | null][] {
  // Generate a sorted AST
  let { astNodes, nodeSorting } = compileCandidates(Array.from(classes), design)

  // Map class names to their order in the AST
  // `null` indicates a non-Tailwind class
  let sorted = new Map<string, bigint | null>(classes.map((className) => [className, null]))

  // Assign each class a unique, sorted number
  let idx = 0n

  for (let node of astNodes) {
    let candidate = nodeSorting.get(node)?.candidate
    if (!candidate) continue

    // When multiple rules match a candidate
    // always take the position of the first one
    sorted.set(candidate, sorted.get(candidate) ?? idx++)
  }

  // Pair classes with their assigned sorting number
  return classes.map((className) => [
    //
    className,
    sorted.get(className) ?? null,
  ])
}