Skip to content

feat(but-ui-react): fail when a design note names something that's gone - #17179

Merged
PavelLaptev merged 1 commit into
masterfrom
but-ui-check-notes
Nov 11, 2026
Merged

PavelLaptev merged 1 commit into
masterfrom
but-ui-check-notes

Conversation

@PavelLaptev

Copy link
Copy Markdown
Contributor

Phase 5, step 3: a rename that leaves a note pointing at nothing now fails pnpm check.

  • scripts/check-notes.mjs checks what the notes name in code (tokens, components, the library's CSS variables, files, text classes, props) and the links between notes
  • Figma nodes a note names are checked only with FIGMA_API_KEY and FIGMA_FILE_KEY set, as when pulling tokens
  • Fixes the one it found: the toasts note pointed at the snackbar's deleted Figma node; it now names the Snackbar component set

A rename leaves a note pointing at nothing, and nobody notices until an
agent builds from it. check-notes.mjs runs in the library's check and
looks at what but-ui's notes and the library's name in code: tokens,
components, the library's own CSS variables, files, text classes and
props, plus the links between notes. A note's 🍑 But UI nodes are checked
too when FIGMA_API_KEY and FIGMA_FILE_KEY are set, as when pulling tokens.

It found one already: the toasts note pointed at the snackbar's old
Figma node, 1706-1682, which no longer exists. It now names the Snackbar
component set, 2210-1708.
@PavelLaptev
PavelLaptev merged commit 692db52 into master Nov 11, 2026
34 checks passed
@PavelLaptev
PavelLaptev deleted the but-ui-check-notes branch November 11, 2026 11:14

This branch was previously deployed

1 inactive deployment
Preview — 97d6e2be Deployed Nov 11, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant