@tangible/php-beautify

PHP Beautify

This is a tool to lint and format source files with PHP Code Sniffer and WordPress Code Standards. It bundles a PHP runtime compiled to WebAssembly, so it doesn't depend on PHP being installed on the local system.

Install

As global command

It can be installed as a global command.

npm install --global @tangible/php-beautify

As dependency

Or install it as a dependency of an existing project.

npm install --save @tangible/php-beautify

In this case, use NPM script or npx php-beautify to run the commands described below.

Example of NPM script

{
  "scripts" {
    "lint": "php-beautify lint src/**/*.php",
    "format": "php-beautify format src/**/*.php"
  }
}

Usage

Help screen

php-beautify

Lint

php-beautify lint [...files]

Format

php-beautify format [...files]

Included libraries

• PHP WebAssembly

• PHP Code Sniffer

  curl -LO https://github.com/squizlabs/PHP_CodeSniffer/releases/download/3.7.2/phpcbf.phar && curl -LO https://github.com/squizlabs/PHP_CodeSniffer/releases/download/3.7.2/phpcs.phar
  

• WordPress Coding Standard

  curl -L https://github.com/WordPress/WordPress-Coding-Standards/archive/refs/tags/3.0.1.tar.gz | tar zx
  mkdir -p wpcs && for folder in WordPress WordPress-Core WordPress-Docs WordPress-Extra; do cp -r WordPress-Coding-Standards-3.0.1/"$folder" wpcs/"$folder"; done
  rm -rf WordPress-Coding-Standards-3.0.1
  

  • Dependencies
    • PHPCSUtils
    • PHPCSExtra