What is Canary?

Meet Gary the Canary. Back in the day, miners would bring caged canaries down into the mines with them to help warn them of dangerous gases. That's pretty much what Gary will do with code. The more technical debt your code acquires, the worse Gary is going to feel.

But the better your code gets, the better Gary will feel. So keep your complexity down, analyze often, and Gary (and your project) will do awesome.

Why Monitor Code Complexity?

We've all had the experience of sifting through another developers code, and we all know what a nightmare it can be.

The idea behind Canary is to keep everyone writing good, clean code all the time. That will keep us all on our toes, but it will also keep our code nice an tight. Who knows, maybe working on someone else's file won't be so bad.

How Canary Works

Sure, we could go into great detail about how Canary works, but that isn't very exciting. The best way for you to see how Canary does what it does is to try it for yourself. To the right are a couple of popular JS libraries for you to analyze. Go ahead, give it a go. See how Gary likes the way that code was written.

Contact the Canary Team

Have a question? Are you so happy that you want to buy us all a beer? Or maybe you found something that's broke and needs fixing? Either way, drop us a line and we'll get right back to you.

gary@gitcanary.com