Announcing Profanify
This weekend, I decided to work on a new plugin for PestPHP. If you don't already know, PestPHP is one of my absolute favourite tools. I use it on a pretty much daily basis and I love working with it, whether it be adding new Expectations to the PestPHP framework, or consuming it in one of my applications. I've wrote about it on this blog before, so feel free to check out my other posts:
Anyway, on to Profanify! The package is a Profanity checker for PestPHP, which makes it incredibly easy to scan your application for usages of Profanity. As developers, we've all faced moments of frustration, whether it be debugging an issue or trying to decipher confusing code written by someone else. These moments can sometimes result in the inclusion of profanity in your code.
So why did I build this?
Recently, I'd been working on fixing an issue in a work project for a couple of weeks and it was pretty solid, as in, I wasn't really working on much else because of the importance of it, it had to be resolved because of the nature of it.
I was getting more and more frustrated, I'd started littering various files with comments which were half useful information and half swear words to get out my confusion and frustration about why things weren't working.
The issue ended up getting resolved, and it turns out it was actually a 3rd party we use that caused it, however, it did give me some ideas on how I can refactor some things our side so that it doesn't impact us again. I was, however, left with code comments containing either useful nuggets of information or just sweary rants, which I went through and removed. That's when the idea for Profanify hit me, how great would it be for me to just have a test in my application, that scans the codebase and highlights any swear words, making it easy for me to then just go through and remove them 😍
Profanify seemed like the perfect candidate to become a PestPHP plugin, and I already had experience building PestPHP plugins thanks to one I built earlier this year called Lawman:
JonPurvisI laid the groundwork on Friday night and then on Saturday morning / afternoon, I hacked away until I had something that worked, I spent a couple of hours tinkering with it until I was completely happy with it, before releasing it to the world!
With Profanify, you can ensure your application has no profanity in just a couple of lines:
test('the application contains no profanity')
->expect('App')
->toHaveNoProfanity();Under the hood, it's pretty simple. The package comes with a config file that contains over 1000+ profanity words, using the shiny new toHaveNoProfanity() expectation, it loops over files in the given namespace and checks whether any of the words in the config file appear in the file. If a word is found, then the test fails and the output will show you the exact line that has profanity and in IDE's such as PHPStorm, you can click straight through to it 🔥
As this is a PestPHP plugin, we can of course combine this with all of the other Expectations Pest has to offer, for example, there might be a reason you want to include profanity:
test('the application contains no profanity')
->expect('App')
->not
->toHaveNoProfanity();I had fun building this package and I hope it comes in useful for your projects! You can find the repo for Profanify below, so feel free to check it out if you get chance and let me know what you think! Contributions are always welcome, just open a Pull Request!
JonPurvisTo get started using the package, you can use Composer to add it to your application as a dev dependancy
composer require jonpurvis/profanify --dev
