Tool

Unity Project Linter

year
2021
ABOUT THE PROJECT

UnityProjectLinter is my favorite personal project. It's always growing. It's a tool that ensures your assets are named properly, according to your own rules. It reminds you to name things correctly, allows you to export logs (and define custom loggers) of asset naming inconsistencies, as well mass-rename assets whenever needed. You can use the powerful and customizable default rules to lint your project's assets, or create your own by extending a simple C# class.

DOWNLOAD

How It Solves Problems By Automating Organization

A simple showcase of the tool in action

Even when we're diligent and disciplined about organization, there are times that we let things slip by; either because we didn't notice, or because we couldn't be bothered to do it the typically slower right way. But in the words of Robert Sedgewick

The only way to go fast is to go well.

Unity Project Linter aims to do exactly that; make organizing an unity project's asset database a:

  • Simple
  • Human-error-free
  • Straightforward
  • Fast

process that can be done regularly and by any member of the team.

To do so, it provides you with a series of tools that can, for most projects, be utilized out-of-the-box, but that are also flexible and powerful enough to be customized to fit highly specific needs. Inspector-editable rules allow you to define how assets should be named without any technical knowledge required. Asset loggers allow you to stay on top of what assets are not conforming to your standards. Mass renamers allow to quickly stamp out disorganization.

The first three laws of behavior change—make it obvious, make it attractive, and make it easy—increase the odds that a behavior will be performed this time. The fourth law of behavior change—make it satisfying—increases the odds that a behavior will be repeated next time.
- James Clear

How It Impacted Projects

I've used Unity Project Linter throughout multiple projects now, and I've also received feedback from other users who've adopted the tool. Here's how it helped various projects:

  • It quickly turned around a completely disorganized project through its logging and mass renaming tools that allowed problems to be identified and dealt with in a matter of minutes.
  • It prevented disorganization from creeping in by reminding developers to name assets according to established rules right as the assets were created.
  • It freed up developers to work on tasks that add value to the project by significantly reducing the time necessary to organize and verify that a project is organized.
  • It allowed developers to identify sources of disorganization and address them through the custom logger feature, which had been set up to generate metrics and charts regarding asset rule violations.