A lightweight VS Code extension that formats PHP files using PHP-CS-Fixer. Zero dependencies, auto-discovers your config and executable.
- Formats PHP files on demand or on save
- Finds the nearest PHP-CS-Fixer: Composer's bin dir (honors
bin-dir),tools/(phive), or a global installation - Finds the nearest
.php-cs-fixer.phpor.php-cs-fixer.dist.php, so each package of a monorepo uses its own; without one, PHP-CS-Fixer's default rules apply - Shows the PHP-CS-Fixer and config in use, or why it cannot run, in the language status of PHP files
- Multi-root workspace support, with per-folder settings
- Workspace Trust support: in Restricted Mode the workspace's own PHP-CS-Fixer and config are not run
- Minimal footprint (~4 KB bundled)
- PHP-CS-Fixer installed locally or globally
- PHP available in your PATH
# Local installation (recommended)
composer require --dev friendsofphp/php-cs-fixer
# Global installation
composer global require friendsofphp/php-cs-fixer- Install this extension from the VS Code Marketplace or Open VSX
- Install PHP-CS-Fixer via Composer
- Optionally create a
.php-cs-fixer.phpconfig file in your project root - Set this extension as your default PHP formatter:
{
"[php]": {
"editor.defaultFormatter": "muuvmuuv.vscode-just-php-cs-fixer",
"editor.formatOnSave": true
}
}| Setting | Default | Description |
|---|---|---|
php-cs-fixer.executable |
Auto-detect | Path to PHP-CS-Fixer executable |
php-cs-fixer.config |
Auto-detect | Path to config file |
php-cs-fixer.allow-risky |
false |
Allow risky rules |
Relative paths are resolved against the workspace folder of the file being formatted.
{
"php-cs-fixer.executable": "vendor/bin/php-cs-fixer",
"php-cs-fixer.config": ".php-cs-fixer.php",
"php-cs-fixer.allow-risky": true,
"[php]": {
"editor.defaultFormatter": "muuvmuuv.vscode-just-php-cs-fixer",
"editor.formatOnSave": true
}
}Create a .php-cs-fixer.php file in your project root:
<?php
$finder = PhpCsFixer\Finder::create()
->in(__DIR__)
->exclude('vendor');
return (new PhpCsFixer\Config())
->setRules([
'@PSR12' => true,
'@Symfony' => true,
])
->setFinder($finder);Other PHP formatting extensions tend to be complex, bundle PHP-CS-Fixer themselves, or include HTML formatting that conflicts with PHP-CS-Fixer. This extension:
- Does one thing well - runs PHP-CS-Fixer
- Has zero runtime dependencies
- Uses your PHP-CS-Fixer installation and config
- Works seamlessly with other extensions like Intelephense
- Hover the
{}language status in the status bar of a PHP file: it names the PHP-CS-Fixer and config in use, or the problem - Click "Show Log" there (or open "PHP-CS-Fixer" in the Output panel) for details; set the log level to Debug for the full command line
| Issue | Solution |
|---|---|
| Executable not found | Install via composer require --dev friendsofphp/php-cs-fixer or set php-cs-fixer.executable |
| Config not found | The file set in php-cs-fixer.config does not exist; fix the path or remove the setting |
| Untrusted workspace | Grant workspace trust or configure settings at user level |
# Install dependencies
pnpm install
# Build
pnpm run compile
# Watch mode
pnpm run dev
# Run tests
pnpm test
# Package
pnpm run packageThe PHP-CS-Fixer logo is © Fabien Potencier
