unity-script-validator_skill

Overview

This skill validates C# Unity scripts for best practices, common anti-patterns, and performance issues specific to Unity projects. It provides actionable findings, estimated performance impacts, and small refactor examples to speed code reviews and reduce runtime costs. Use it to catch costly patterns early and enforce consistent Unity conventions across a codebase.

How this skill works

The validator scans scripts for patterns such as public fields that should be [SerializeField] private, costly operations in Update (e.g., GetComponent, GameObject.Find), and inefficient string concatenation. For each issue it reports a description, the likely performance impact, and a suggested fix. It can also suggest organization improvements (regions, ordering) and missing XML <summary> comments for public APIs.

When to use it

• Quick code review of existing Unity C# scripts before merging
• Automated validation as part of CI to catch regressions
• Prior to performance testing to remove obvious runtime hotspots
• During refactoring to ensure Unity-specific best practices are applied
• When auditing legacy scripts for modernization opportunities

Best practices

• Mark serialized fields as [SerializeField] private to preserve encapsulation
• Cache GetComponent, transforms, and references in Awake/Start rather than Update
• Avoid GameObject.Find in Update; resolve references at initialization
• Use StringBuilder for repeated string concatenation in loops or frequent updates
• Use Coroutines for intermittent timed work instead of polling in Update
• Use FixedUpdate only for physics-related updates; keep rendering logic in Update

Example use cases

• Scan a gameplay script and get a list of Update-time GetComponent/GameObject.Find calls with fixes
• Identify public fields that should be serialized privately and generate the refactored field declarations
• Suggest replacing frequent string concatenation in UI updates with StringBuilder and show before/after code
• Flag missing XML <summary> on public methods to improve API documentation
• Recommend coroutine conversion for a timer loop that currently runs in Update