building-a-format-package

Standardize text format parsing library architecture within the @effected monorepo.

2|Updated Jul 2, 2026
One-click install
npx skills add https://github.com/spencerbeggs/effected --skill building-a-format-package
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: building-a-format-package
Source: https://github.com/spencerbeggs/effected/tree/main/plugin/skills/building-a-format-package
Command: npx skills add https://github.com/spencerbeggs/effected --skill building-a-format-package

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill solves the inconsistency and maintenance burden of building format-parsing libraries (like JSONC, YAML, or TOML) by providing a unified, battle-tested architectural blueprint for the @effected ecosystem.

Core Features & Use Cases

  • Canonical Surface Pattern: Implements a strict module-per-concept layout (Facade, Document, Node, Edit, Format, Visitor, Diagnostic) to ensure predictable API surfaces across all format packages.
  • Hardening & Parity: Enforces cross-package parity for error handling, nesting depth limits, and edit/range field-identity, ensuring that consumer code remains generic and robust.
  • Conformance-Corpus Harness: Provides a standardized testing strategy using vendored fixtures, differential oracles, and strict serialization verification to guarantee parser correctness.

Quick Start

Use the building-a-format-package skill to scaffold a new format library following the canonical module-per-concept surface and parity contract.

Frequently Asked Questions about building-a-format-package

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I standardize format parsing library architecture in an Effect monorepo?

Standardize format parsing library architecture by applying a strict module-per-concept surface pattern, enforcing engine-origin policies, and wrapping all format-specific tooling in Effect to ensure cross-package parity and predictable APIs.

What is the module-per-concept pattern for building text format parsers?

The module-per-concept pattern structures format parsers into distinct modules like Facade, Document, Node, Edit, Format, Visitor, and Diagnostic, ensuring predictable API surfaces and consistent architectural design across all format packages.

How do I test format parser correctness using a conformance corpus?

Test format parser correctness by utilizing a conformance-corpus harness that runs vendored fixtures, checks differential oracles, and performs strict serialization verification to guarantee accurate parsing and diagnostic output.

Does the Effected ecosystem enforce cross-package parity for error handling and nesting limits?

Yes, the Effected ecosystem enforces cross-package parity for error handling, nesting depth limits, and edit field-identity, ensuring consumer code remains generic and robust across different format parsing libraries.

How do I scaffold a new format library following a strict parity contract?

Scaffold a new format library by generating the canonical module-per-concept layout, implementing strict Effect-wrapping, integrating a diagnostic core, and setting up the required conformance-corpus testing harness for format-specific tooling.

What limitations exist when standardizing format library architecture across multiple packages?

Limitations include strict adherence to engine-origin policies and mandatory conformance-corpus testing, requiring all format packages to implement Effect-wrapping and diagnostic cores without deviation to maintain architectural consistency.