2020/02/20/phpstorm-warn-symfony-dump

[romaricdrigon]

Please comment below!
Comments will automatically be published on the blog, too.

[ktherage]

I usually put a precommit hook checking that kind of things and disallowing pushing.

Here's the hook :

#!/usr/bin/env bash
LC_ALL=C
​
# blacklist check
echo "Checking blacklisted words additions ..."
currentBranch=$(git rev-parse --abbrev-ref HEAD)
searchBlacklistedWords=$(git diff --diff-filter=ACMRT origin/$currentBranch | egrep '^\+' | egrep '(@wip|print\s{1}last|\s{1}dd\(|\s{1}dump\(|\s{1}var_dump\(|\s{1}exit|\s{1}die)+')
hasBlacklistedWord=$(echo "$searchBlacklistedWords" | tr -d '[:space:] ' | wc -w)
​
if [[ $hasBlacklistedWord > 0 ]]; then
	echo "Blacklisted words were found ! Details :"
	echo "$searchBlacklistedWords"
	exit 1
fi
echo "Great job! No blacklisted words were found !"

[martijn80]

Awesome tips. Cheers both!

[nclavaud]

If you are using PHP-CS-Fixer, another option would be to use this (risky) fixer that removes all calls to dump() and other debug statements:
https://github.com/akovalyov/DebugStatementsFixers

I accidentally pushed a dump() statement to production once, and this fixer now runs in the CI pipeline.