tailwindcss Architecture Docs
Home / Function/ migrateAutomaticVarInjection() — tailwindcss Function Reference

migrateAutomaticVarInjection() — tailwindcss Function Reference

Architecture documentation for the migrateAutomaticVarInjection() function in migrate-automatic-var-injection.ts from the tailwindcss codebase.

Function typescript MigrationSuite TemplateMigration calls 6

Entity Profile

Dependency Diagram

graph TD
  39857840_c6e7_0594_122a_445c1ca9d108["migrateAutomaticVarInjection()"]
  53cf41fe_5903_d247_3bb3_38414ba7d631["parseCandidate()"]
  39857840_c6e7_0594_122a_445c1ca9d108 -->|calls| 53cf41fe_5903_d247_3bb3_38414ba7d631
  6aa3d960_a2f2_03a4_9eb3_642a5598b141["cloneCandidate()"]
  39857840_c6e7_0594_122a_445c1ca9d108 -->|calls| 6aa3d960_a2f2_03a4_9eb3_642a5598b141
  dd118980_144b_59fb_67e2_653ea68e26ea["isAutomaticVarInjectionException()"]
  39857840_c6e7_0594_122a_445c1ca9d108 -->|calls| dd118980_144b_59fb_67e2_653ea68e26ea
  5a669ddb_c6e4_576f_e97a_a8046c2834d8["injectVar()"]
  39857840_c6e7_0594_122a_445c1ca9d108 -->|calls| 5a669ddb_c6e4_576f_e97a_a8046c2834d8
  4c50d4c9_d654_3056_42e2_ba6a553be1b2["injectVarIntoVariant()"]
  39857840_c6e7_0594_122a_445c1ca9d108 -->|calls| 4c50d4c9_d654_3056_42e2_ba6a553be1b2
  ec55634f_f6e4_3b8b_1267_0b251c4dade1["printCandidate()"]
  39857840_c6e7_0594_122a_445c1ca9d108 -->|calls| ec55634f_f6e4_3b8b_1267_0b251c4dade1
  style 39857840_c6e7_0594_122a_445c1ca9d108 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/@tailwindcss-upgrade/src/codemods/template/migrate-automatic-var-injection.ts lines 8–74

export function migrateAutomaticVarInjection(
  designSystem: DesignSystem,
  _userConfig: Config | null,
  rawCandidate: string,
): string {
  for (let readonlyCandidate of designSystem.parseCandidate(rawCandidate)) {
    // The below logic makes extended use of mutation. Since candidates in the
    // DesignSystem are cached, we can't mutate them directly.
    let candidate = cloneCandidate(readonlyCandidate) as Writable<Candidate>

    let didChange = false

    // Add `var(…)` in modifier position, e.g.:
    //
    // `bg-red-500/[--my-opacity]` => `bg-red-500/[var(--my-opacity)]`
    if (
      'modifier' in candidate &&
      candidate.modifier?.kind === 'arbitrary' &&
      !isAutomaticVarInjectionException(designSystem, candidate, candidate.modifier.value)
    ) {
      let { value, didChange: modifierDidChange } = injectVar(candidate.modifier.value)
      candidate.modifier.value = value
      didChange ||= modifierDidChange
    }

    // Add `var(…)` to all variants, e.g.:
    //
    // `supports-[--test]:flex'` => `supports-[var(--test)]:flex`
    for (let variant of candidate.variants) {
      let didChangeVariant = injectVarIntoVariant(designSystem, variant)
      if (didChangeVariant) {
        didChange = true
      }
    }

    // Add `var(…)` to arbitrary candidates, e.g.:
    //
    // `[color:--my-color]` => `[color:var(--my-color)]`
    if (
      candidate.kind === 'arbitrary' &&
      !isAutomaticVarInjectionException(designSystem, candidate, candidate.value)
    ) {
      let { value, didChange: valueDidChange } = injectVar(candidate.value)
      candidate.value = value
      didChange ||= valueDidChange
    }

    // Add `var(…)` to arbitrary values for functional candidates, e.g.:
    //
    // `bg-[--my-color]` => `bg-[var(--my-color)]`
    if (
      candidate.kind === 'functional' &&
      candidate.value &&
      candidate.value.kind === 'arbitrary' &&
      !isAutomaticVarInjectionException(designSystem, candidate, candidate.value.value)
    ) {
      let { value, didChange: valueDidChange } = injectVar(candidate.value.value)
      candidate.value.value = value
      didChange ||= valueDidChange
    }

    if (didChange) {
      return designSystem.printCandidate(candidate)
    }
  }
  return rawCandidate
}

Domain

Subdomains

Calls

Source

Frequently Asked Questions

What does migrateAutomaticVarInjection() do?
migrateAutomaticVarInjection() is a function in the tailwindcss codebase.
What does migrateAutomaticVarInjection() call?
migrateAutomaticVarInjection() calls 6 function(s): cloneCandidate, injectVar, injectVarIntoVariant, isAutomaticVarInjectionException, parseCandidate, printCandidate.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free