rule-naming-conventions

Validate Zod schema naming conventions in TypeScript projects.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Naming consistency is critical across schemas, exports, and files to ensure maintainability and predictability.

Core Features & Use Cases

  • Enforces snake_case for schema properties and identifiers with the _id suffix
  • Enforces kebab-case for file and directory names
  • Enforces PascalCase exports with the Schema suffix for TypeScript types and Zod schemas
  • Provides guidance and examples for refactoring to the standard

Quick Start

Provide a concrete example showing a MassIDDataSchema and LocationSchema refactor to snake_case properties, kebab-case filenames, and PascalCase exports with a Schema suffix.

Frequently Asked Questions about rule-naming-conventions

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

FAQPage Schema
How do I enforce naming conventions for Zod schema properties in TypeScript?▼

To enforce naming conventions for Zod schema properties, apply snake_case validation to object properties and ensure identifier fields use the _id suffix. This provides precise guidance on violations to maintain schema consistency.

What is the standard for naming Zod schema exports and TypeScript files?▼

The standard for naming Zod schema exports and TypeScript files requires PascalCase exports with a Schema suffix and kebab-case for file and directory names to ensure maintainability and predictability.

Can I use this to check timestamp naming patterns in Zod schemas?▼

Yes, you can use this to check timestamp naming patterns in Zod schemas. It validates descriptive timestamp naming alongside snake_case properties and identifier _id suffixes to provide precise violation guidance.

How do I refactor TypeScript schema exports to include a Schema suffix?▼

To refactor TypeScript schema exports to include a Schema suffix, update PascalCase type names and apply kebab-case to filenames. The skill provides concrete examples like refactoring MassIDDataSchema and LocationSchema.

Does this naming convention validation work without external dependencies?▼

Yes, this naming convention validation works without external dependencies. It directly checks Zod schemas, snake_case properties, kebab-case filenames, and PascalCase exports to provide guidance on standard violations.