Add VTL migration skill and comprehensive migration guide #34774
Add VTL migration skill and comprehensive migration guide #34774adrianjm-dotCMS wants to merge 2 commits intomainfrom
Conversation
❌ Issue Linking RequiredThis PR could not be linked to an issue. All PRs must be linked to an issue for tracking purposes. How to fix this:Option 1: Add keyword to PR body (Recommended - auto-removes this comment)
Why is this required?Issue linking ensures proper tracking, documentation, and helps maintain project history. It connects your code changes to the problem they solve.--- This comment was automatically generated by the issue linking workflow |
There was a problem hiding this comment.
Pull request overview
This pull request introduces a comprehensive VTL (Velocity Template Language) migration skill for GitHub Copilot Code that helps developers migrate DotCMS custom field templates from legacy Dojo/Dijit APIs to the modern DotCustomFieldApi. The skill includes detailed migration rules, a step-by-step checklist, complete code examples, and establishes a standardized three-file output pattern for safe coexistence of old and new editor modes.
Changes:
- Added
.claude/skills/vtl-migration/SKILL.mddefining the skill metadata, quick reference API mapping table, migration process, three-file output pattern, and quality checklist - Added
.claude/skills/vtl-migration/references/migration-guide.mdproviding comprehensive migration rules (11 rules), best practices, common pitfalls, special cases, and three complete end-to-end migration examples
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
.claude/skills/vtl-migration/SKILL.md |
Skill definition with metadata, quick API reference table, migration process overview, three-file output pattern explanation, and verification checklist |
.claude/skills/vtl-migration/references/migration-guide.md |
Comprehensive 892-line migration guide covering DotCustomFieldApi introduction, 11 detailed migration rules with code examples, best practices, step-by-step checklist, common pitfalls, special cases, and three complete real-world migration examples |
This pull request introduces a comprehensive skill definition for migrating DotCMS VTL custom field templates from legacy Dojo/Dijit APIs to the modern
DotCustomFieldApi. The documentation provides clear migration rules, a step-by-step checklist, and a standardized three-file output pattern to ensure safe coexistence of old and new editor modes.Migration process and rules:
.claude/skills/vtl-migration/SKILL.md, including a quick reference table mapping deprecated Dojo/Dijit API calls to their modern equivalents inDotCustomFieldApi.DotCustomFieldApi.ready(), and preserving business logic and VTL variables.Three-file output pattern:
_old.vtl), the fully migrated file (_new.vtl), and a router file with conditional parsing for legacy and new edit modes.Code and template migration examples:
onChangehandlers.Quality and verification checklist:
resolves #34450