README

⚠️ Archived: 2021-07-09 ⚠️

Thoughts & Ideas WordPress Coding Standards (TI-WPCS) is a development dependency for testing coding styles and quality in our WordPress PHP projects. Keeping the code base consistent and highlighting potential issues before they enter our products helps developers pickup our projects and improve their reliability in production.

Installation

Thoughts & Ideas recommend installing this dependancy via Composer.

As a Composer Dependancy

To include these standards as part of a project. Require this repository as a development dependancy:

composer require --dev thoughtsideas/ti-wpcs

The fixer and tests can be run from the command line:

./vendor/bin/phpcbf ./
./vendor/bin/phpcs ./
./vendor/bin/phpmd ./ text ./vendor/thoughtsideas/ti-wpcs/ti-wpmd/ruleset.xml

Automatically run tests before every Git commit.

Thoughts & Ideas recommend a pre-commit Git Hook.

Create the pre-commit hook file:

mkdir ./_scripts && touch ./_scripts/pre-commit

Add the pre-commit hook to our new file:

#!/bin/sh
#
# Pre Commit Hook.

# Remove un-staged changes.
git stash -q --keep-index

# Run QA script.
echo "Running WordPress PHP Coding Standards test"
composer run test-phpcbf
composer run test-phpcs
# PHPCS Results (bool)
QA_PHPCS=$?

echo "Running WordPress PHP Mess Detector test"
composer run test-phpmd
# PHPMD Results (bool)
QA_PHPMD=$?

# Apply un-staged changes.
git stash pop -q

# Get our test QA results.
[ $QA_PHPCS -ne 0 ] && exit 1
[ $QA_PHPMD -ne 0 ] && exit 1

# If test pass exit successfully.
exit 0

Link our new file to our git repository

ln -s ../../_scripts/pre-commit ./.git/hooks/pre-commit

Every time you commit to your Git repository the TI-WPCS test will run automatically.

Reporting Issues

If you spot any issues please create a ticket via GitHub's Issue Tracker. Including the issue, the browser and operating system, and how to replicate it. If the issue is security related please use the contact information below.

Contact

Thoughts & Ideas - hello@thoughtsideas.uk

License

This project is licensed under the terms of the MIT license. See the LICENSE file.

thoughtsideas / ti-wpcs

Maintainers

Details