add walk variants util

Author: RobinMalfait

packages/@tailwindcss-upgrade/src/codemods/template/migrate-arbitrary-value-to-bare-value.ts

@@ -2,7 +2,6 @@ import {
   parseCandidate,
   type Candidate,
   type NamedUtilityValue,
-  type Variant,
 } from '../../../../tailwindcss/src/candidate'
 import type { Config } from '../../../../tailwindcss/src/compat/plugin-api'
 import type { DesignSystem } from '../../../../tailwindcss/src/design-system'
@@ -11,6 +10,7 @@ import {
   isValidSpacingMultiplier,
 } from '../../../../tailwindcss/src/utils/infer-data-type'
 import { segment } from '../../../../tailwindcss/src/utils/segment'
+import { walkVariants } from '../../utils/walk-variants'
 import { printCandidate } from './candidates'
 import { computeUtilitySignature } from './signatures'
 
@@ -40,7 +40,7 @@ export function migrateArbitraryValueToBareValue(
       }
     }
 
-    for (let variant of variants(clone)) {
+    for (let [variant] of walkVariants(clone)) {
       // Convert `data-[selected]` to `data-selected`
       if (
         variant.kind === 'functional' &&
@@ -108,19 +108,6 @@ export function migrateArbitraryValueToBareValue(
   return rawCandidate
 }
 
-function* variants(candidate: Candidate) {
-  function* inner(variant: Variant): Iterable<Variant> {
-    yield variant
-    if (variant.kind === 'compound') {
-      yield* inner(variant.variant)
-    }
-  }
-
-  for (let variant of candidate.variants) {
-    yield* inner(variant)
-  }
-}
-
 // Convert functional utilities with arbitrary values to bare values if we can.
 // We know that bare values can only be:
 //

packages/@tailwindcss-upgrade/src/codemods/template/migrate-arbitrary-variants.ts

@@ -1,9 +1,9 @@
-import type { Candidate, Variant } from '../../../../tailwindcss/src/candidate'
 import type { Config } from '../../../../tailwindcss/src/compat/plugin-api'
 import type { DesignSystem } from '../../../../tailwindcss/src/design-system'
 import { DefaultMap } from '../../../../tailwindcss/src/utils/default-map'
 import { memcpy } from '../../utils/memcpy'
 import type { Writable } from '../../utils/types'
+import { walkVariants } from '../../utils/walk-variants'
 import { printCandidate, printVariant } from './candidates'
 import { computeVariantSignature } from './signatures'
 
@@ -38,7 +38,7 @@ export function migrateArbitraryVariants(
     // DesignSystem are cached, we can't mutate them directly.
     let candidate = structuredClone(readonlyCandidate) as Writable<typeof readonlyCandidate>
 
-    for (let variant of variants(candidate)) {
+    for (let [variant] of walkVariants(candidate)) {
       if (variant.kind === 'compound') continue
 
       let targetString = printVariant(variant)
@@ -60,16 +60,3 @@ export function migrateArbitraryVariants(
 
   return rawCandidate
 }
-
-function* variants(candidate: Candidate) {
-  function* inner(variant: Variant): Iterable<Variant> {
-    yield variant
-    if (variant.kind === 'compound') {
-      yield* inner(variant.variant)
-    }
-  }
-
-  for (let variant of candidate.variants) {
-    yield* inner(variant)
-  }
-}

packages/@tailwindcss-upgrade/src/codemods/template/migrate-modernize-arbitrary-values.ts

@@ -1,10 +1,11 @@
 import SelectorParser from 'postcss-selector-parser'
-import { parseCandidate, type Candidate, type Variant } from '../../../../tailwindcss/src/candidate'
+import { parseCandidate, type Variant } from '../../../../tailwindcss/src/candidate'
 import type { Config } from '../../../../tailwindcss/src/compat/plugin-api'
 import type { DesignSystem } from '../../../../tailwindcss/src/design-system'
 import { isPositiveInteger } from '../../../../tailwindcss/src/utils/infer-data-type'
 import * as ValueParser from '../../../../tailwindcss/src/value-parser'
 import { memcpy } from '../../utils/memcpy'
+import { walkVariants } from '../../utils/walk-variants'
 import { printCandidate } from './candidates'
 
 export function migrateModernizeArbitraryValues(
@@ -16,7 +17,7 @@ export function migrateModernizeArbitraryValues(
     let clone = structuredClone(candidate)
     let changed = false
 
-    for (let [variant, parent] of variants(clone)) {
+    for (let [variant, parent] of walkVariants(clone)) {
       // Forward modifier from the root to the compound variant
       if (
         variant.kind === 'compound' &&
@@ -480,20 +481,3 @@ export function migrateModernizeArbitraryValues(
 
   return rawCandidate
 }
-
-function* variants(candidate: Candidate) {
-  function* inner(
-    variant: Variant,
-    parent: Extract<Variant, { kind: 'compound' }> | null = null,
-  ): Iterable<[Variant, Extract<Variant, { kind: 'compound' }> | null]> {
-    yield [variant, parent]
-
-    if (variant.kind === 'compound') {
-      yield* inner(variant.variant, variant)
-    }
-  }
-
-  for (let variant of candidate.variants) {
-    yield* inner(variant, null)
-  }
-}

packages/@tailwindcss-upgrade/src/codemods/template/migrate-theme-to-var.ts

@@ -1,16 +1,12 @@
-import {
-  parseCandidate,
-  type Candidate,
-  type CandidateModifier,
-  type Variant,
-} from '../../../../tailwindcss/src/candidate'
+import { parseCandidate, type CandidateModifier } from '../../../../tailwindcss/src/candidate'
 import { keyPathToCssProperty } from '../../../../tailwindcss/src/compat/apply-config-to-theme'
 import type { Config } from '../../../../tailwindcss/src/compat/plugin-api'
 import type { DesignSystem } from '../../../../tailwindcss/src/design-system'
 import { isValidSpacingMultiplier } from '../../../../tailwindcss/src/utils/infer-data-type'
 import { segment } from '../../../../tailwindcss/src/utils/segment'
 import { toKeyPath } from '../../../../tailwindcss/src/utils/to-key-path'
 import * as ValueParser from '../../../../tailwindcss/src/value-parser'
+import { walkVariants } from '../../utils/walk-variants'
 import { printCandidate } from './candidates'
 
 export const enum Convert {
@@ -59,7 +55,7 @@ export function migrateThemeToVar(
     }
 
     // Handle variants
-    for (let variant of variants(clone)) {
+    for (let [variant] of walkVariants(clone)) {
       if (variant.kind === 'arbitrary') {
         let [newValue] = convert(variant.selector, Convert.MigrateThemeOnly)
         if (newValue !== variant.selector) {
@@ -332,16 +328,3 @@ function eventuallyUnquote(value: string) {
 
   return unquoted
 }
-
-function* variants(candidate: Candidate) {
-  function* inner(variant: Variant): Iterable<Variant> {
-    yield variant
-    if (variant.kind === 'compound') {
-      yield* inner(variant.variant)
-    }
-  }
-
-  for (let variant of candidate.variants) {
-    yield* inner(variant)
-  }
-}

packages/@tailwindcss-upgrade/src/utils/walk-variants.ts

@@ -0,0 +1,18 @@
+import type { Candidate, Variant } from '../../../tailwindcss/src/candidate'
+
+export function* walkVariants(candidate: Candidate) {
+  function* inner(
+    variant: Variant,
+    parent: Extract<Variant, { kind: 'compound' }> | null = null,
+  ): Iterable<[Variant, Extract<Variant, { kind: 'compound' }> | null]> {
+    yield [variant, parent]
+
+    if (variant.kind === 'compound') {
+      yield* inner(variant.variant, variant)
+    }
+  }
+
+  for (let variant of candidate.variants) {
+    yield* inner(variant, null)
+  }
+}