folio-embed-data

Étoiles10

Forks2

Mis à jour21 juillet 2026 à 11:35

Folio embed-data conventions for folio_embed_data, as: :embed, canonical embed JSON, embed validation, rendering, migrations, and console forms. Use when replacing legacy embed URL, HTML, or source fields, or when changing model-backed Folio embeds.

Installation

Installer avec Codex ou Claude Copiez ce prompt, collez-le dans Codex, Claude ou un autre assistant, puis laissez-le vérifier la page du skill et l'installer pour vous.

Source

sinfin

sinfin/folio

Ouvrir le dépôt GitHub Voir les dépôts du créateur

Téléchargement

Métiers associésSOC

Basé sur la classification professionnelle SOC

Développeurs de logicielsProfessions informatiques et mathématiques·SOC 15-1252

SKILL.md

readonly

name	folio-embed-data
description	Folio embed-data conventions for folio_embed_data, as: :embed, canonical embed JSON, embed validation, rendering, migrations, and console forms. Use when replacing legacy embed URL, HTML, or source fields, or when changing model-backed Folio embeds.

Folio embed data

Persist canonical folio_embed_data JSON; do not substitute a custom string field or application-specific embed parsing.

Contract

Use one normalized active shape:

{ "active": true, "html": "..." }

{ "active": true, "type": "youtube", "url": "..." }

Use Folio::Embed.normalize_value in model writers. It normalizes inactive, blank, and malformed input to nil.
Do not treat normalization as source validation: reject unsupported active types or URLs with Folio validation. EmbedInput checks invalid_reason_for before it normalizes invalid browser input to inactive.
Take supported URL types from data/embed/source/types.json; extend Folio itself rather than inventing application-specific parsing.

Models and persistence

Use a nullable JSONB column when an embed is optional or is one branch of a content-kind selector. Do not use default: {} or null: false where the normalizer represents blank data as nil.
For an unconditional embed, include Folio::Embed::Validation. For mutually exclusive image/embed variants, gate or override validate_folio_embed_data so the image variant can save without embed JSON.
Configure HTML sanitization deliberately with folio_embed_data: :unsafe_html in folio_html_sanitization_config.

Console forms and parameters

Use f.input :folio_embed_data, as: :embed; do not build a custom source textarea or embed controller.
EmbedInput owns the preview and serializes JSON into its hidden field. Browser and controller tests must submit folio_embed_data.to_json and permit the scalar field for this form contract.
If an API accepts nested embed hashes, explicitly permit Folio::Embed.hash_strong_params_keys; do not assume that shape works for the console hidden input.

Rendering, migrations, and tests

Render embeds with Folio::Embed::BoxComponent.
Migrate legacy data only when its semantics and deployed data justify it. Keep migrations reversible and never guess whether a legacy value is HTML or a URL.
Test normalization, conditional validation, sanitization, serialized JSON submission, and the image/embed switch independently.

Folio implementation

Plus depuis ce dépôt

même dépôt

folio-testing

sinfin/folio

Folio and host-app testing conventions. Use when adding, changing, debugging, or reviewing tests, test helpers, factories/fixtures, mocks, stubs, ViewComponent tests, JavaScript behavior tests, integration/system coverage, or files under test/ and packs/*/test.

2026-07-3010

folio-component-json-api

sinfin/folio

Folio “HTML over wire” JSON APIs: controllers use render_component_json so the response body is JSON with a string "data" key holding rendered ViewComponent HTML; JavaScript uses Folio.Api.apiGet/apiPost and response.data, not pure domain JSON for client-side rendering. Use when adding or changing render_component_json, console/API endpoints that return component fragments, or consumers of response.data as HTML.

2026-07-2810

folio-javascript

sinfin/folio

JavaScript conventions for Folio: ES6+, StandardJS linting, DOM APIs, Folio.Api fetch wrappers, debounce/throttle, flash events, and when to use Stimulus. Use when writing or editing .js files, adding behavior to components, or when the user asks about JavaScript patterns in Folio.

2026-07-2810

folio-pack

sinfin/folio

Folio optional pack boundary and namespace rules. Use when editing files in optional pack directories, adding pack controllers/components/models/lib code, wiring routes to pack code, or moving reusable behavior between a host app, the Folio engine, and an optional pack, including Packwerk verification.

2026-07-2810

folio-simple-form-inputs

sinfin/folio

Build or change Folio SimpleForm inputs and extensions: app/inputs classes, SimpleForm::Inputs overrides, register_stimulus wiring, input_controls, custom_html, standalone input JS/Sass assets, and rendered HTML tests.

2026-07-2810

folio-slim

sinfin/folio

Slim template formatting and best practices for Folio components and views. Use when writing or editing .slim templates, reviewing Slim formatting, or when the user asks about Slim conventions, multi-line attributes, or template structure in Folio.

2026-07-2810

Folio embed data

Persist canonical folio_embed_data JSON; do not substitute a custom string field or application-specific embed parsing.

Contract

Use one normalized active shape:

{ "active": true, "html": "..." }

{ "active": true, "type": "youtube", "url": "..." }

Use Folio::Embed.normalize_value in model writers. It normalizes inactive, blank, and malformed input to nil.

Do not treat normalization as source validation: reject unsupported active types or URLs with Folio validation. EmbedInput checks invalid_reason_for before it normalizes invalid browser input to inactive.

Take supported URL types from data/embed/source/types.json; extend Folio itself rather than inventing application-specific parsing.

Models and persistence

Use a nullable JSONB column when an embed is optional or is one branch of a content-kind selector. Do not use default: {} or null: false where the normalizer represents blank data as nil.

For an unconditional embed, include Folio::Embed::Validation. For mutually exclusive image/embed variants, gate or override validate_folio_embed_data so the image variant can save without embed JSON.

Configure HTML sanitization deliberately with folio_embed_data: :unsafe_html in folio_html_sanitization_config.

Console forms and parameters

Use f.input :folio_embed_data, as: :embed; do not build a custom source textarea or embed controller.

EmbedInput owns the preview and serializes JSON into its hidden field. Browser and controller tests must submit folio_embed_data.to_json and permit the scalar field for this form contract.

If an API accepts nested embed hashes, explicitly permit Folio::Embed.hash_strong_params_keys; do not assume that shape works for the console hidden input.

Rendering, migrations, and tests

Render embeds with Folio::Embed::BoxComponent.

Migrate legacy data only when its semantics and deployed data justify it. Keep migrations reversible and never guess whether a legacy value is HTML or a URL.

Test normalization, conditional validation, sanitization, serialized JSON submission, and the image/embed switch independently.

Folio implementation