folio-pack

Stars10

Forks2

UpdatedJuly 28, 2026 at 08:34

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.

Installation

Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.

Source

sinfin

sinfin/folio

View GitHub Repository View Creator Repositories

Download

Related occupationsSOC

Based on SOC occupation classification

Software DevelopersComputer and Mathematical Occupations·SOC 15-1252

File Explorer

2 files

SKILL.md

readonly

name	folio-pack
description	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.

Folio Pack

Boundary

Keep every pack-owned constant under that pack namespace. For packs/ai, use Folio::Ai::*; console-facing code uses Folio::Ai::Console::*, not Folio::Console::*.
Match file paths to constants inside the pack. Example: packs/reports/app/controllers/folio/reports/console/api/items_controller.rb defines Folio::Reports::Console::Api::ItemsController.
A pack may expose engine routes in normal Folio URL space, but route entries must explicitly point to the pack controller namespace when it differs from the URL namespace.
Keep reusable pack behavior in packs/<name>. Keep host-specific labels, record context, demo data, rollout decisions, and app-specific aggregate workflows in the host app.

Components And Assets

Use the Folio component generator with --pack=<name> for new pack ViewComponents whenever possible.
Pack component BEM names follow their actual constant namespace. Do not use the Folio::Console special f-c prefix for Folio::<Pack>::Console components unless a component already established that block name.
Keep pack assets in the pack manifests and require/import colocated sidecars from there.

Routes

Prefer explicit to: mappings when a route URL is intentionally shared with engine conventions but the controller constant lives in a pack.
Do not create host-app routes or per-model endpoints for reusable pack behavior unless the feature genuinely requires host-owned request handling.

Verification

Run Packwerk through Bundler. Plain rake app:packwerk:* can activate the wrong rake version.

In sandboxed runs where $HOME is not writable, give Bundler a repo-local ignored home to avoid repeated temp-home cleanup traces from parallel Packwerk workers:

mkdir -p tmp/bundler-home-packwerk
env BUNDLE_USER_HOME="$PWD/tmp/bundler-home-packwerk" bundle exec rake app:packwerk:validate
env BUNDLE_USER_HOME="$PWD/tmp/bundler-home-packwerk" bundle exec rake app:packwerk:check

More from this repository

same repository

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-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-stimulus

sinfin/folio

Folio Stimulus conventions: controller registration, StimulusHelper data attributes, values/targets/actions, and controller file placement. Use when adding JavaScript behavior to a Folio component, wiring data-controller / data-action / data-target, using StimulusHelper in Slim, or writing a new Stimulus controller in Folio or a host app.

2026-07-2810

name	folio-pack
description	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.

Folio Pack

Boundary

Keep every pack-owned constant under that pack namespace. For packs/ai, use Folio::Ai::*; console-facing code uses Folio::Ai::Console::*, not Folio::Console::*.
Match file paths to constants inside the pack. Example: packs/reports/app/controllers/folio/reports/console/api/items_controller.rb defines Folio::Reports::Console::Api::ItemsController.
A pack may expose engine routes in normal Folio URL space, but route entries must explicitly point to the pack controller namespace when it differs from the URL namespace.
Keep reusable pack behavior in packs/<name>. Keep host-specific labels, record context, demo data, rollout decisions, and app-specific aggregate workflows in the host app.

Components And Assets

Use the Folio component generator with --pack=<name> for new pack ViewComponents whenever possible.
Pack component BEM names follow their actual constant namespace. Do not use the Folio::Console special f-c prefix for Folio::<Pack>::Console components unless a component already established that block name.
Keep pack assets in the pack manifests and require/import colocated sidecars from there.

Routes

Prefer explicit to: mappings when a route URL is intentionally shared with engine conventions but the controller constant lives in a pack.
Do not create host-app routes or per-model endpoints for reusable pack behavior unless the feature genuinely requires host-owned request handling.

Verification

Run Packwerk through Bundler. Plain rake app:packwerk:* can activate the wrong rake version.

In sandboxed runs where $HOME is not writable, give Bundler a repo-local ignored home to avoid repeated temp-home cleanup traces from parallel Packwerk workers:

mkdir -p tmp/bundler-home-packwerk
env BUNDLE_USER_HOME="$PWD/tmp/bundler-home-packwerk" bundle exec rake app:packwerk:validate
env BUNDLE_USER_HOME="$PWD/tmp/bundler-home-packwerk" bundle exec rake app:packwerk:check