migrate-simple-legacy-classes.ts — tailwindcss Source File

Source Code

import type { Config } from '../../../../tailwindcss/src/compat/plugin-api'
import type { DesignSystem } from '../../../../tailwindcss/src/design-system'
import * as version from '../../utils/version'

// Classes that used to exist in Tailwind CSS v3, but do not exist in Tailwind
// CSS v4 anymore.
const LEGACY_CLASS_MAP: Record<string, string> = {
  'overflow-ellipsis': 'text-ellipsis',

  'flex-grow': 'grow',
  'flex-grow-0': 'grow-0',
  'flex-shrink': 'shrink',
  'flex-shrink-0': 'shrink-0',

  'decoration-clone': 'box-decoration-clone',
  'decoration-slice': 'box-decoration-slice',

  // Since v4.1.0
  'bg-left-top': 'bg-top-left',
  'bg-left-bottom': 'bg-bottom-left',
  'bg-right-top': 'bg-top-right',
  'bg-right-bottom': 'bg-bottom-right',
  'object-left-top': 'object-top-left',
  'object-left-bottom': 'object-bottom-left',
  'object-right-top': 'object-top-right',
  'object-right-bottom': 'object-bottom-right',
}

let seenDesignSystems = new WeakSet<DesignSystem>()

export function migrateSimpleLegacyClasses(
  designSystem: DesignSystem,
  _userConfig: Config | null,
  rawCandidate: string,
): string {
  // `outline-none` in v3 has the same meaning as `outline-hidden` in v4. However,
  // `outline-none` in v4 _also_ exists but has a different meaning.
  //
  // We can only migrate `outline-none` to `outline-hidden` if we are migrating a
  // v3 project to v4.
  if (version.isMajor(3)) {
    LEGACY_CLASS_MAP['outline-none'] = 'outline-hidden'
  }

  // Prepare design system with the unknown legacy classes
  if (!seenDesignSystems.has(designSystem)) {
    for (let old in LEGACY_CLASS_MAP) {
      designSystem.utilities.static(old, () => [])
    }
    seenDesignSystems.add(designSystem)
  }

  for (let candidate of designSystem.parseCandidate(rawCandidate)) {
    if (candidate.kind === 'static' && Object.hasOwn(LEGACY_CLASS_MAP, candidate.root)) {
      return designSystem.printCandidate({
        ...candidate,
        root: LEGACY_CLASS_MAP[candidate.root as keyof typeof LEGACY_CLASS_MAP],
      })
    }
  }

  return rawCandidate
}