frappe-doctype-builder_skill

Overview

This skill builds complete Frappe DocType definitions including fields, permissions, naming rules, and configuration files. It generates ready-to-save JSON structures, suggests controller hooks, and provides migration and placement instructions. Use it to create new DocTypes or modify existing structures with correct field types and permissions.

How this skill works

The skill inspects requested DocType requirements and produces a full DocType JSON with metadata, field definitions, form layout, permissions, and naming series. It also offers explanations for key fields, recommends controller methods for lifecycle events, and gives migration commands and file locations. Outputs are formatted to paste into apps/<app>/doctype/<doctype>/<doctype>.json and follow Frappe conventions.

When to use it

• Creating a new DocType (master, transaction, child table, or settings/single)
• Adding or changing fields and field types on an existing DocType
• Designing naming series, status fields, or computed/read-only fields
• Defining role-based permissions and access rules for a DocType
• Preparing DocType JSON for migrations or code repository

Best practices

• Use descriptive snake_case fieldnames and clear labels
• Mark truly essential fields as required; avoid over-restricting
• Start with conservative permissions and expand per role needs
• Add indexes for fields used frequently in queries or filters
• Group related fields into sections and use column breaks for clarity
• Provide sensible defaults and validate via controller hooks

Example use cases

• Generate a Customer DocType with name, email, phone, naming_series and basic permissions
• Create a Sales Order transaction DocType with items as a child table and submission workflow
• Define a Settings DocType as issingle with default configuration fields
• Add a computed Currency field 'total' that is read-only and populated in validate()
• Add dependent fields and mandatory_depends_on expressions for conditional validation