agentleFS
CloudflareKnown publishercloudflare/kumo-astro/packages/kumo-figma/src/generators/AGENTS.md

kumo-astro / generators

AGENTS.md4 starsChanged 9 months agoMITView on GitHub

37 component generators creating Figma components from component-registry.json. Registry is source of truth. Parent: See packages/kumo-figma/AGENTS.md for plugin context. Every generator follows this structure: ALL magic numbers and constants MUST live here: Key utilities:

1 other project uses a version of this.

Adopted by

Steady: 0 new projects took it in the last 4 weeks, none the 4 weeks before.thin data

Week of Sep 13: 0 new projectsWeek of Sep 20: 0 new projectsWeek of Sep 27: 0 new projectsWeek of Oct 4: 0 new projectsWeek of Oct 11: 0 new projectsWeek of Oct 18: 0 new projectsWeek of Oct 25: 0 new projectsWeek of Nov 1: 0 new projects
Sep 2026Oct 2026Nov 2026
New projects taking a version of this file each week, over the 8 weeks our latest run read: only 0 in all, so this is a hint, not a trend.

Most recently taken up by

The file

We split this AGENTS.md into the rules it gives an agent

10 rules. About 0 are common, 6 are distinctive, and 4 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈6

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 4

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Every generator follows this structure:

    line 22
  2. Distinctive:

    ALL magic numbers and constants MUST live here:

    line 96
  3. Very specific:

    Create generators/yourcomponent.ts following 4-step pattern

    line 126
  4. Distinctive:

    Add testable exports (pure functions)

    line 127
  5. Very specific:

    Add to EXCLUDED_COMPONENTS in drift-detection.test.ts (with reason)

    line 134
  6. Distinctive:

    Generator existence: Every registry component has a generator (or is excluded)

    line 140
  7. Distinctive:

    Shadow centralization: No hardcoded shadow effects

    line 145
  8. Very specific:

    Opacity centralization: No hardcoded opacity = 0.5

    line 146
  9. Distinctive:

    RGB centralization: No hardcoded RGB color objects

    line 147
  10. Very specific:

    Font size usage: Must use FONT_SIZE or FIGMA-SPECIFIC comment

    line 148

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

Figma Generators (src/generators/)

37 component generators creating Figma components from component-registry.json. Registry is source of truth.

Parent: See packages/kumo-figma/AGENTS.md for plugin context.

STRUCTURE

generators/
├── shared.ts              # ALL constants (1544 lines) - CRITICAL, see below
├── icon-utils.ts          # Icon creation, placeholder, color binding (308 lines)
├── _test-utils.ts         # Shared test assertions (345 lines)
├── drift-detection.test.ts  # Meta-test: 1733 lines, enforces sync
├── button.ts              # Example generator (see pattern below)
├── button.test.ts         # Tests for button generator
└── ... (35+ component generators + tests)

GENERATOR PATTERN (Canonical 4-Step)

Every generator follows this structure:

1. Imports

import { SPACING, FONT_SIZE, createAutoLayoutFrame, ... } from "./shared";
import { parseTailwindClasses } from "../parsers/tailwind-to-figma";
import registry from "@cloudflare/kumo/ai/component-registry.json";

2. Extract Registry Data

const componentProps = registry.components.Button.props;
const variantProp = componentProps.variant as { values: string[]; classes: Record<string, string>; };
const sizeProp = componentProps.size as { ... };

3. Testable Exports (Pure Functions - NO Figma API)

// These enable unit testing without Figma runtime
export function getButtonVariantConfig() {
  return { values, classes, descriptions, default: variantProp.default };
}

export function getButtonParsedBaseStyles() {
  return parseTailwindClasses(baseClasses);
}

export function getButtonParsedVariantStyles(variant: string) {
  return parseTailwindClasses(variantProp.classes[variant]);
}

export function getAllButtonVariantData() {
  // Aggregates all intermediate data for testing
}

4. Generator Function

export async function generateButtonComponents(
  page: PageNode,
  startY: number,
): Promise<number> {
  // 1. Generate ComponentNodes for each variant
  const components: ComponentNode[] = [];
  for (const variant of variants) {
    const component = await createButtonVariant(variant);
    components.push(component);
  }

  // 2. Combine as Figma variants
  const componentSet = figma.combineAsVariants(components, page);
  componentSet.name = "Button";

  // 3. Create light/dark mode sections
  const lightSection = createModeSection(page, "Button", "light");
  const darkSection = createModeSection(page, "Button", "dark");

  // 4. Place in sections
  lightSection.frame.appendChild(componentSet);
  for (const comp of components) {
    darkSection.frame.appendChild(comp.createInstance());
  }

  // 5. Return next Y position
  return startY + totalHeight + SECTION_GAP;
}

SHARED.TS (CRITICAL)

ALL magic numbers and constants MUST live here:

CategoryConstants
LayoutSECTION_PADDING, SECTION_GAP, SECTION_LAYOUT, GRID_LAYOUT
SpacingSPACING.xs/sm/base/lg
TypographyFONT_SIZE.xs/sm/base/lg, FALLBACK_VALUES.fontWeight.*
BordersBORDER_RADIUS.xs/sm/md/lg/xl/full
EffectsSHADOWS.xs/sm/lg/dialog/subtle (via getShadowLayer())
OpacityOPACITY.disabled/backdrop/shortcut
ColorsCOLORS.placeholder/spinner/border (RGB fallbacks)
VariablesVAR_NAMES.text.*, VAR_NAMES.color.* (semantic mapping)
DashDASH_PATTERN.standard ([4, 4])

Key utilities:

  • createAutoLayoutFrame(config) - Creates frame with auto-layout
  • createTextNode(text, fontSize, fontWeight) - Styled text with Inter font (async)
  • createModeSection(page, name, "light"|"dark") - Creates mode-scoped section
  • createComponentSectionPair(page, name, startY, width, height) - Light+dark pair
  • createRowLabel(text, x, y) - Styled label for grids
  • createColumnHeaders(headers, y, frame) - Header row for grids
  • bindFillToVariable(node, variableId) - Binds fill to Figma variable
  • bindFillToVariableWithOpacity(node, varName) - Handles "color/20" opacity suffix
  • getVariableByName(name) - Looks up variable from kumo-colors collection (cached)
  • getOrCreateVariableWithOpacity(nameWithOpacity) - Creates opacity variants at runtime
  • applyCornerRadius(node, radius) - Apply radius by key or number

ADDING A GENERATOR

  1. Create generators/yourcomponent.ts following 4-step pattern
  2. Add testable exports (pure functions)
  3. Register in code.ts GENERATORS array:
    { name: "YourComponent", execute: async (page, y) => ({ nextY: await generateYourComponentComponents(page, y) }) }
  4. Either:
    • Create yourcomponent.test.ts OR
    • Add to EXCLUDED_COMPONENTS in drift-detection.test.ts (with reason)

DRIFT DETECTION

drift-detection.test.ts enforces:

  1. Generator existence: Every registry component has a generator (or is excluded)
  2. Code.ts registration: Generator file imported and in GENERATORS array
  3. Testable exports: Warns if missing get*Config() or get*Data() functions
  4. No magic numbers: Catches local redeclaration of shared.ts constants
  5. Import validation: Constants must be imported, not copied
  6. Shadow centralization: No hardcoded shadow effects
  7. Opacity centralization: No hardcoded opacity = 0.5
  8. RGB centralization: No hardcoded RGB color objects
  9. Font size usage: Must use FONT_SIZE or FIGMA-SPECIFIC comment

Excluded components (with reasons): Field, Grid, PageHeader, Popover

ANTI-PATTERNS

PatternWhyInstead
const PADDING = 16Drift detection failsimport { SPACING } from "./shared"
{ r: 0.5, g: 0.5, b: 0.5 }Not themeableCOLORS.* or variable binding
.toBe(16) in testsFragileFONT_SIZE.base or registry values
Hardcoding variant namesRegistry is truthRead from registry.components.*.props
Skipping testable exportsUntestableAlways export pure get* functions

NOTES

  • 74 files total: 37 generators + 34 tests + 3 utilities
  • Largest: shared.ts (1544 lines), drift-detection.test.ts (1733 lines)
  • Component coverage: Badge, Banner, Button, Checkbox, Combobox, Dialog, Input, Select, Table, etc.
  • Variable binding: getVariableByName() + bindFillToVariable() for theme-aware colors
  • Opacity variants: Created at runtime via getOrCreateVariableWithOpacity("color/20")
  • Component variant naming: "variant=primary, size=base, disabled=false" format

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.