Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 1.83 KB

README.md

File metadata and controls

48 lines (32 loc) · 1.83 KB
Raw

WPCS for TSF files via Composer and phpcs

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.