Bbackstage

backstage/migrate-avatar-to-custom

Backstage 1.45.0: Migrate Avatar component from Base UI to custom implementation — remove render prop, rename size="large" to size="x-large"

backstagemigrationuiavatar1.45.0
Public
0 executions
Apply to Repository

Run locally

npx codemod @backstage/migrate-avatar-to-custom

@backstage/migrate-avatar-to-custom

Migrates Avatar component usage from the Base UI implementation to the custom implementation introduced in @backstage/ui@0.9.0 (Backstage v1.45.0).

What it transforms

  • render prop removal — removes the render prop and inserts a // TODO(backstage-codemod) comment so you can review custom rendering
  • size="large" → size="x-large" — the old large size maps to the new x-large token
  • Handles named imports (import { Avatar } from '@backstage/ui'), aliased imports, and namespace imports (import * as UI from '@backstage/ui')

Installation

bash

Usage (from this repo)

bash

Development

From the repo root:

bash

Known limitations

  • When a render prop is removed, the codemod cannot mechanically migrate the custom rendering logic — review the TODO comment and manually adjust
  • Namespace imports are supported for detection, but the namespace prefix is preserved as-is

Ready to contribute?

Build your own codemod and share it with the community.

Publish a codemodJoin the community