Modified (for TSF) PHP_CodeSniffer rules (sniffs) to enforce WordPress and TSF coding conventions.

Installs: 4

Dependents: 1

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

Type:phpcodesniffer-standard

v1.1.0 2020-08-23 23:36 UTC

This package is auto-updated.

Last update: 2020-11-24 22:56:19 UTC


README

This package helps you validate your PHP files against WordPress coding standards, as used for The SEO Framework product family.

This package primarily relies on WordPress/WordPress-Coding-Standards, with added sniffs used in development for TSF.

Installation

  1. Open Terminal.
  2. cd to folder you want to install theseoframework/wcps-tsf.
  3. Enter: composer create-project theseoframework/wpcs-tsf

Updating

  1. Open Terminal.
  2. cd to root folder where this project's composer.json resides.
  3. Enter: composer update.

Usage (VScode)

  1. Download/install PHP on your drive.
  2. Install the phpcs VScode extension by Ioannis Kappas (more instructions in link).

Required VScode config (example for Windows)

Unlisted settings are optional.

{
    "php.validate.executablePath": "C:\\your-php-installation-folder\\php.exe",
    "phpcs.executablePath": "C:\\the-folder-you-ran-composer-for-this-project\\wpcs-tsf\\vendor\\bin\\phpcs.bat",
    "phpcs.standard": "TSF",
    "phpcs.errorSeverity": 1,
    "phpcs.warningSeverity": 1,
}

Issues

On Windows, PHP might not be recognized as an internal or external command.

For this, you need to set PHP to your PATH environmental variable at:

  • (enter this in the address bar at WLK+E) Control Panel\System and Security\System
    • Advanced system settings.

But, it's probably easier to install XAMPP, which should take care of this for you.

Be sure to restart VScode when you're done setting the PATH variable.