Skip to content

DekodeInteraktiv/coding-standards

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

69 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Dekode Coding Standards

Installation and usage

$ composer require --dev dekode/coding-standards

Add lint script to composer.json

"scripts": {
  "lint": [
    "./vendor/bin/phpcs ."
  ]
}

Configuration File

Create a phpcs.xml.dist file in your project root with the following contents. (Update required PHP version and text_domain accordingly.)

<?xml version="1.0"?>
<ruleset>
	<file>.</file>
	<arg name="extensions" value="php" />
	<config name="testVersion" value="8.2" />
	<config name="text_domain" value="block-theme,default" />
	<rule ref="Dekode" />
</ruleset>

DekodeNoAlignment ruleset

DekodeNoAlignment extends Dekode with additional strictness. Use it in place of Dekode for projects that want tighter formatting enforcement:

  • Adds a custom DekodeNoAlignment.Formatting.DisallowDoubleSpace sniff: disallows two or more consecutive spaces on a line (outside indentation) — auto-fixable via phpcbf
  • Suppresses noisy warnings for value-alignment (MultipleStatementAlignment, DoubleArrowNotAligned)
  • Suppresses Squiz.Commenting.FunctionComment.SpacingAfterParamType
<?xml version="1.0"?>
<ruleset>
	<file>.</file>
	<arg name="extensions" value="php" />
	<config name="testVersion" value="8.2" />
	<config name="text_domain" value="block-theme,default" />
	<rule ref="DekodeNoAlignment" />
</ruleset>