create-schema

Scaffold an IPFS schema type directory with data, attributes, tests, and index export.

1|Updated Apr 17, 2025
One-click install
npx skills add https://github.com/carrot-foundation/schemas --skill create-schema-carrot-foundation
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: create-schema
Source: https://github.com/carrot-foundation/schemas/tree/main/.cursor/skills/create-schema
Command: npx skills add https://github.com/carrot-foundation/schemas --skill create-schema-carrot-foundation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This tool guides developers to scaffold a complete IPFS schema type directory with all required data, attributes, tests, and exports, ensuring consistency across the project.

Core Features & Use Cases

  • Scaffold a new {type} directory structure and tests following project conventions.
  • Generate data and attribute schemas, main IPFS schema, and barrel exports.
  • Add and run tests to achieve code quality gates and ready for deployment.

Quick Start

Run the create-schema skill to scaffold a new schema type directory with all required files.

Frequently Asked Questions about create-schema

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

FAQPage Schema
How do I scaffold a new IPFS schema directory with tests?▼

Scaffolding a new IPFS schema directory is automated by generating a standardized src/{type} layout that includes data schemas, attributes, main schema files, barrel exports, and comprehensive test scaffolds for full coverage.

What files are generated when scaffolding an IPFS schema type?▼

Scaffolding an IPFS schema type generates {type}.data.schema.ts, {type}.attributes.ts, {type}.schema.ts, an index.ts barrel export, and associated test files to enforce project conventions.

Does this schema scaffolding tool work with TypeScript and Zod?▼

Schema scaffolding with TypeScript and Zod is fully supported, generating structured attribute and data schema files that align with project conventions for MassID-like schemas.

Why do I need to scaffold a standardized directory layout for IPFS schemas?▼

A standardized directory layout for IPFS schemas is needed to ensure consistency across the schemas package, enabling rapid setup for MassID-like schemas while enforcing project conventions.

Can I automatically generate test files when creating a new schema type?▼

Generating test files when creating a schema type is handled automatically, providing a comprehensive test scaffold designed to achieve full coverage and pass code quality gates.

What is the best way to ensure consistency when building new schema types across a package?▼

Ensuring consistency when building new schema types is best achieved by automating the scaffolding of directories, data schemas, attributes, and index exports to enforce standardized project conventions.