@10up/block-renderer-prompt-generator 0.1.4

package/dist/tokens-prompt.js

@@ -0,0 +1,214 @@
+/**
+ * Generates color tokens documentation.
+ */
+export function generateColorsPrompt(tokens, options) {
+    const lines = [
+        '### Colors',
+        '',
+    ];
+    // Add Ignite mode warning
+    if (options?.igniteMode) {
+        lines.push('> **⚠️ IMPORTANT:** For container blocks (groups, columns), use **Section Styles** instead of setting colors directly.');
+        lines.push('> Section styles ensure proper color inheritance for child elements.');
+        lines.push('> Only use direct colors for specific elements that need a fixed color regardless of context.');
+        lines.push('');
+    }
+    lines.push('Available color slugs:');
+    lines.push('');
+    if (tokens.colors.palette.length === 0) {
+        lines.push('*No color palette defined*');
+        return lines.join('\n');
+    }
+    for (const color of tokens.colors.palette) {
+        lines.push(`- \`${color.slug}\`: ${color.name} (${color.color})`);
+    }
+    return lines.join('\n');
+}
+/**
+ * Generates gradient tokens documentation.
+ */
+export function generateGradientsPrompt(tokens) {
+    if (tokens.colors.gradients.length === 0) {
+        return '';
+    }
+    const lines = [
+        '### Gradients',
+        '',
+        'Available gradient slugs:',
+        '',
+    ];
+    for (const gradient of tokens.colors.gradients) {
+        lines.push(`- \`${gradient.slug}\`: ${gradient.name}`);
+    }
+    return lines.join('\n');
+}
+/**
+ * Generates typography tokens documentation.
+ */
+export function generateTypographyPrompt(tokens, options) {
+    const lines = ['### Typography', ''];
+    // Add Ignite mode warning
+    if (options?.igniteMode && options?.igniteTokens?.typographyPresets?.length) {
+        lines.push('> **⚠️ IMPORTANT:** Use **Typography Presets** instead of font-size tokens directly.');
+        lines.push('> Presets apply consistent font-size, weight, line-height, and letter-spacing together.');
+        lines.push('> Use BOTH the `typographyPreset` attribute AND the `className`:');
+        lines.push('> `"typographyPreset": "display-lg", "className": "is-typography-preset-display-lg"`');
+        lines.push('');
+    }
+    // Font sizes
+    if (tokens.typography.fontSizes.length > 0) {
+        if (options?.igniteMode) {
+            lines.push('**Font Sizes** *(prefer Typography Presets instead)*:');
+        }
+        else {
+            lines.push('**Font Sizes:**');
+        }
+        for (const size of tokens.typography.fontSizes) {
+            lines.push(`- \`${size.slug}\`: ${size.name} (${size.size})`);
+        }
+        lines.push('');
+    }
+    // Font families
+    if (tokens.typography.fontFamilies.length > 0) {
+        lines.push('**Font Families:**');
+        for (const family of tokens.typography.fontFamilies) {
+            lines.push(`- \`${family.slug}\`: ${family.name}`);
+        }
+        lines.push('');
+    }
+    return lines.join('\n');
+}
+/**
+ * Generates spacing tokens documentation.
+ */
+export function generateSpacingPrompt(tokens) {
+    if (tokens.spacing.spacingSizes.length === 0) {
+        return '';
+    }
+    const lines = [
+        '### Spacing',
+        '',
+        'Use format `var:preset|spacing|{slug}` for margin/padding:',
+        '',
+    ];
+    for (const spacing of tokens.spacing.spacingSizes) {
+        lines.push(`- \`${spacing.slug}\`: ${spacing.name} (${spacing.size})`);
+    }
+    return lines.join('\n');
+}
+/**
+ * Generates shadow tokens documentation.
+ */
+export function generateShadowsPrompt(tokens) {
+    if (tokens.shadow.presets.length === 0) {
+        return '';
+    }
+    const lines = [
+        '### Shadows',
+        '',
+        'Available shadow presets:',
+        '',
+    ];
+    for (const shadow of tokens.shadow.presets) {
+        lines.push(`- \`${shadow.slug}\`: ${shadow.name}`);
+    }
+    return lines.join('\n');
+}
+/**
+ * Generates layout documentation.
+ */
+export function generateLayoutPrompt(tokens) {
+    const lines = ['### Layout', ''];
+    if (tokens.layout.contentSize) {
+        lines.push(`- Content width: ${tokens.layout.contentSize}`);
+    }
+    if (tokens.layout.wideSize) {
+        lines.push(`- Wide width: ${tokens.layout.wideSize}`);
+    }
+    if (!tokens.layout.contentSize && !tokens.layout.wideSize) {
+        lines.push('*No layout settings defined*');
+    }
+    return lines.join('\n');
+}
+/**
+ * Generates complete design tokens documentation.
+ */
+export function generateTokensPrompt(tokens, options) {
+    const sections = [
+        '## Available Design Tokens',
+        '',
+    ];
+    sections.push(generateColorsPrompt(tokens, options));
+    sections.push('');
+    const gradients = generateGradientsPrompt(tokens);
+    if (gradients) {
+        sections.push(gradients);
+        sections.push('');
+    }
+    sections.push(generateTypographyPrompt(tokens, options));
+    const spacing = generateSpacingPrompt(tokens);
+    if (spacing) {
+        sections.push(spacing);
+        sections.push('');
+    }
+    const shadows = generateShadowsPrompt(tokens);
+    if (shadows) {
+        sections.push(shadows);
+        sections.push('');
+    }
+    sections.push(generateLayoutPrompt(tokens));
+    sections.push('');
+    // Usage example - different for Ignite mode
+    if (options?.igniteMode) {
+        sections.push(`
+### Token Usage
+
+For spacing, use the preset format:
+\`\`\`json
+{
+  "style": {
+    "spacing": {
+      "padding": {
+        "top": "var:preset|spacing|40",
+        "bottom": "var:preset|spacing|40"
+      }
+    }
+  }
+}
+\`\`\`
+
+**Remember:** For colors and typography, prefer Section Styles and Typography Presets over direct tokens.
+`);
+    }
+    else {
+        sections.push(`
+### Example Usage
+
+Instead of:
+\`\`\`json
+{ "backgroundColor": "#007cba" }
+\`\`\`
+
+Use the preset slug:
+\`\`\`json
+{ "backgroundColor": "primary" }
+\`\`\`
+
+For spacing:
+\`\`\`json
+{
+  "style": {
+    "spacing": {
+      "padding": {
+        "top": "var:preset|spacing|40",
+        "bottom": "var:preset|spacing|40"
+      }
+    }
+  }
+}
+\`\`\`
+`);
+    }
+    return sections.join('\n');
+}
+//# sourceMappingURL=tokens-prompt.js.map

package/dist/tokens-prompt.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokens-prompt.js","sourceRoot":"","sources":["../src/tokens-prompt.ts"],"names":[],"mappings":"AAYA;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAAC,MAAmB,EAAE,OAA4B;IACpF,MAAM,KAAK,GAAa;QACtB,YAAY;QACZ,EAAE;KACH,CAAC;IAEF,0BAA0B;IAC1B,IAAI,OAAO,EAAE,UAAU,EAAE,CAAC;QACxB,KAAK,CAAC,IAAI,CAAC,wHAAwH,CAAC,CAAC;QACrI,KAAK,CAAC,IAAI,CAAC,sEAAsE,CAAC,CAAC;QACnF,KAAK,CAAC,IAAI,CAAC,+FAA+F,CAAC,CAAC;QAC5G,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;IACrC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvC,KAAK,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;QACzC,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QAC1C,KAAK,CAAC,IAAI,CAAC,OAAO,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC;IACpE,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,uBAAuB,CAAC,MAAmB;IACzD,IAAI,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzC,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,KAAK,GAAa;QACtB,eAAe;QACf,EAAE;QACF,2BAA2B;QAC3B,EAAE;KACH,CAAC;IAEF,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;QAC/C,KAAK,CAAC,IAAI,CAAC,OAAO,QAAQ,CAAC,IAAI,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;IACzD,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,wBAAwB,CAAC,MAAmB,EAAE,OAA4B;IACxF,MAAM,KAAK,GAAa,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;IAE/C,0BAA0B;IAC1B,IAAI,OAAO,EAAE,UAAU,IAAI,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,EAAE,CAAC;QAC5E,KAAK,CAAC,IAAI,CAAC,sFAAsF,CAAC,CAAC;QACnG,KAAK,CAAC,IAAI,CAAC,yFAAyF,CAAC,CAAC;QACtG,KAAK,CAAC,IAAI,CAAC,kEAAkE,CAAC,CAAC;QAC/E,KAAK,CAAC,IAAI,CAAC,sFAAsF,CAAC,CAAC;QACnG,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,aAAa;IACb,IAAI,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3C,IAAI,OAAO,EAAE,UAAU,EAAE,CAAC;YACxB,KAAK,CAAC,IAAI,CAAC,uDAAuD,CAAC,CAAC;QACtE,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAChC,CAAC;QACD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC;YAC/C,KAAK,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,OAAO,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;QAChE,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,gBAAgB;IAChB,IAAI,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC9C,KAAK,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QACjC,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC;YACpD,KAAK,CAAC,IAAI,CAAC,OAAO,MAAM,CAAC,IAAI,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;QACrD,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,MAAmB;IACvD,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7C,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,KAAK,GAAa;QACtB,aAAa;QACb,EAAE;QACF,4DAA4D;QAC5D,EAAE;KACH,CAAC;IAEF,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC;QAClD,KAAK,CAAC,IAAI,CAAC,OAAO,OAAO,CAAC,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC;IACzE,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,MAAmB;IACvD,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvC,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,KAAK,GAAa;QACtB,aAAa;QACb,EAAE;QACF,2BAA2B;QAC3B,EAAE;KACH,CAAC;IAEF,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QAC3C,KAAK,CAAC,IAAI,CAAC,OAAO,MAAM,CAAC,IAAI,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;IACrD,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAAC,MAAmB;IACtD,MAAM,KAAK,GAAa,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;IAE3C,IAAI,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;QAC9B,KAAK,CAAC,IAAI,CAAC,oBAAoB,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QAC3B,KAAK,CAAC,IAAI,CAAC,iBAAiB,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;IACxD,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QAC1D,KAAK,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;IAC7C,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAAC,MAAmB,EAAE,OAA4B;IACpF,MAAM,QAAQ,GAAa;QACzB,4BAA4B;QAC5B,EAAE;KACH,CAAC;IAEF,QAAQ,CAAC,IAAI,CAAC,oBAAoB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACrD,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAElB,MAAM,SAAS,GAAG,uBAAuB,CAAC,MAAM,CAAC,CAAC;IAClD,IAAI,SAAS,EAAE,CAAC;QACd,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACzB,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACpB,CAAC;IAED,QAAQ,CAAC,IAAI,CAAC,wBAAwB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAEzD,MAAM,OAAO,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;IAC9C,IAAI,OAAO,EAAE,CAAC;QACZ,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACpB,CAAC;IAED,MAAM,OAAO,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;IAC9C,IAAI,OAAO,EAAE,CAAC;QACZ,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACpB,CAAC;IAED,QAAQ,CAAC,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5C,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAElB,4CAA4C;IAC5C,IAAI,OAAO,EAAE,UAAU,EAAE,CAAC;QACxB,QAAQ,CAAC,IAAI,CAAC;;;;;;;;;;;;;;;;;;CAkBjB,CAAC,CAAC;IACD,CAAC;SAAM,CAAC;QACN,QAAQ,CAAC,IAAI,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;CA0BjB,CAAC,CAAC;IACD,CAAC;IAED,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC7B,CAAC"}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@10up/block-renderer-prompt-generator",
+  "version": "0.1.4",
+  "description": "Generate AI prompts for WordPress block generation",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@10up/block-renderer-core": "0.1.4",
+    "@10up/block-renderer-theme-json": "0.1.4",
+    "@10up/block-renderer-preferences": "0.1.4",
+    "@10up/block-renderer-patterns": "0.1.4"
+  },
+  "devDependencies": {
+    "typescript": "^5.7.0",
+    "vitest": "^2.1.0"
+  },
+  "keywords": [
+    "wordpress",
+    "blocks",
+    "ai",
+    "prompt",
+    "gutenberg"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/10up/json-block-renderer",
+    "directory": "packages/prompt-generator"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "dev": "tsc -p tsconfig.build.json --watch",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  }
+}