Umbraco Test Builders

What it does

This skill provides fluent builder classes for creating Umbraco backoffice models, simplifying test data creation and scaffolding. It allows developers to configure model properties with sensible defaults and chainable methods. The builders are part of the @umbraco/json-models-builders package and help ensure content structure integrity during development.

When to use it

• Generating test data for Umbraco backoffice models.
• Creating scaffolding to quickly set up initial content structures.
• Integrating with end-to-end (E2E) testing workflows.
• Mocking data for MSW (Mock Service Worker) tests.

Key capabilities

• Fluent Builder Pattern: Uses a chainable method structure (withXxx(), addXxx(), done(), build()) to configure models.
• DocumentTypeBuilder: Specifically designed for creating and configuring document types, including properties, groups, and tabs.
• Property Configuration: Allows setting scalar property values using the withProperty() method.
• Nested Builder Support: Enables creation of nested builders for complex model structures.

Example prompts

• "Generate a DocumentType builder with name 'Article' and alias 'article'."
• "Create a test data structure for an Umbraco document type using the builder pattern."
• "Show me how to add a text box property to a DocumentTypeBuilder."

Tips & gotchas

• Requires installation of the @umbraco/json-models-builders package (npm install @umbraco/json-models-builders).
• The builders follow a specific pattern; understanding withXxx(), addXxx(), done(), and build() is crucial for effective use.
• This skill is primarily intended for developers working with Umbraco backoffice models, not general AI tasks.