Getting Started with Code Hygienist Pro
Welcome to the future of cleanly managed Unity projects.
Code Hygienist Pro sits on top of your Unity project as a “Code Cleanup Engine.” Unlike typical static analyzers that just point out bad code and tell you to fix it by hand, Code Hygienist:
- Detects code smells using specific performance and architecture rules.
- Explains exactly why it’s bad and its performance impact.
- Previews the generated fix with a side-by-side diff.
- Applies the refactor securely using Roslyn AST (Syntax Tree) modification—not regex-based search-and-replace.
The Welcome Window
Upon first installation, the Welcome Window will guide you through the initial configuration. You can access it anytime from the top menu: Tools > Code Hygienist > Welcome Window. This window provides quick links to the documentation, common scan targets, and the main dashboard.
Core Concepts
If you’ve inherited messy prototype code, or just never got around to refactoring:
💡 “Safe Mode” (Diff Preview) Code Hygienist embraces safety. You will never have your codebase blindly overwritten. Every single fix goes through our Diff Preview Window. Approve it per-file, per-rule, or blindly click “Approve All” when you trust a rule!
💡 The Auto-Refactor Engine The engine doesn’t simply replace strings. If it detects
GetComponent<Rigidbody>()inside anUpdate()loop, it will gracefully inject a_rigidbodyprivate field and place the assignment in theAwake()method—ensuring minimal GC allocs across frames!
“Hello World” Scan 🌍
Ready to unleash it on your code? Head over to the Quick Start Guide to scan your first folder!