Koodausstandardit

Dude käyttää squizlabs/PHP_CodeSnifferin WordPress-standardeja taustatekniikoiden sekä teemojen kehityksessä ja Automattic/_s standardia frontend-kehityksessä. WordPress VIP -sääntöjä emme noudata ja osa WordPress-säännöistä on excludettu hyvin perustein.

digitoimistodude/air-pohjateeman kehityksessä suositaan underscoresin tapaa tehdä asioita. Automaattiset testit ajetaan Travisilla.

phpcs.xml

Excludettavia sääntöjä voi ehdottaa lisää, mutta ehdotuksen pitää olla perusteltavissa. Sääntöihin voi tehdä Pull Requesteja tai committeja suoraan digitoimistodude/air-repositorion phpcs.xml -tiedostoon.

PHP Code Beautifier and Fixer (phpcbf)

Phpcbf:llä on nopea refaktoroida koodia. Teemakansiossa komento ajetaan seuraavasti:

phpcbf --standard=phpcs.xml page.php

Indentointi ja linttaus

Koodin tulee olla selkeää ja dokumentoitua. Indentaatiossa käytämme 2 merkin väliä.

PHP-puolella tulee aina noudattaa phpcs.xml:ää. Jos tarvitsee ignorata sääntöjä, lisätään ne projektikohtaisesti kunkin projektin teemakansion alla olevaan phpcs.xml:ään tai seuraavasti koodiin:

<?php // phpcs:disable

Jos taas ignorettavaa on SCSS-puolella, lisää seuraava ignorettavaa riviä ennen (huomaa disable-sanan jälkeen ignoroitava määre):

// scss-lint:disable SelectorFormat

Disabloinnille/ignoroinnille pitää aina olla hyvä syy, lähtökohtaisesti varoitukset korjataan aina.

Editorin linter

Sublime Textille linter-asetukset ja exclude löytyvät GitHubista: SublimeLinter.sublime-settings.