northrook/php-cs

Custom PHP Coding Standards for Northrook projects.

dev-main 2024-11-13 05:58 UTC

Requires

• php: >=8.3
• erickskrauch/php-cs-fixer-custom-fixers: ^1.3
• friendsofphp/php-cs-fixer: @stable
• jetbrains/phpstorm-attributes: @stable
• phpstan/phpstan: @stable

MIT

• Martin

• dev

README

Using PHP-CS-Fixer.

This coding standard deviates from the PSR, focusing on comfort and ergonomics for me.

Important

This package is still in development, and intended for internal use.

Installation

This package is not (yet) available on packagist, but you can install manually by editing your coposer.json file:

{
  "require-dev": {
    "northrook/php-cs": "dev-main"
  },
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/northrook/php-cs"
    }
  ]
}

Then copy the included .php-cs-fixer.dist.php file from /vendor/northrook/php-cs/.php-cs-fixer.dist.phpto the project root.

Usage

Run the fixer mnually in the console:

./vendor/bin/php-cs-fixer fix

Your IDE might also have an integration, like PhpStorm.

License

MIT