Download the PHP package navikt/coding-standard without Composer
On this page you can find all versions of the php package navikt/coding-standard. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download navikt/coding-standard
More information about navikt/coding-standard
Files in navikt/coding-standard
Package coding-standard
Short Description PHP Coding Standard for NAV IT
License MIT
Homepage https://github.com/navikt/coding-standard-php
Informations about the package coding-standard
PHP Coding Standard for NAV IT
This is the coding standard for the PHP-based projects and tools at NAV IT. The ruleset is enforced using the PHP Coding Standards Fixer tool.
How to setup
First, add this package as a development dependency to your project:
composer require --dev navikt/coding-standard
then, create a PHP-CS-Fixer configuration file named .php-cs-fixer.php
local to your repository that includes the following:
You can adjust the $finder
instance if you wish to include/exclude other directories.
Now you can run the following command to check the coding standard in your project:
php-cs-fixer fix --dry-run --diff
You can drop the --dry-run
option to let the tool fix your files automatically.
Refer to the documentation on how to install php-cs-fixer locally.
Add step in the GitHub workflow
All PHP-based NAV IT projects use GitHub workflows, and checking the coding standard should be a part of that workflow:
PHP-CS-Fixer and PHP-8
To run PHP-CS-Fixer on PHP-8 you will need to set an environment variable that forces the php-cs-fixer command to ignore the environment requirement:
PHP_CS_FIXER_IGNORE_ENV=1 php-cs-fixer fix --dry-run --diff
PHP-8 support in PHP-CS-Fixer is tracked here: https://github.com/FriendsOfPHP/PHP-CS-Fixer/issues/4702.