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.

Viimeksi muokattu käyttäjän Roni Laukkarinen toimesta viestillä "Formatting", katso muutos 0ce4f1a GitHubissa. Näytä versiohistoria.

4.11.2019 09:10:26 Muokattu käyttäjän Roni Laukkarinen toimesta viestillä "Formatting", katso muutos 0ce4f1a GitHubissa.

4.11.2019 09:09:54 Muokattu käyttäjän Roni Laukkarinen toimesta viestillä "Tarkennus scss-lint:disable -komentoon", katso muutos f5cf69a GitHubissa.

4.11.2019 09:07:38 Muokattu käyttäjän Roni Laukkarinen toimesta viestillä "Koodiblokin korjaus", katso muutos 84bebc7 GitHubissa.

1.11.2019 11:55:44 Muokattu käyttäjän Roni Laukkarinen toimesta viestillä "Linttauksesta, ignorekommentit", katso muutos 8a1f6d2 GitHubissa.

1.11.2019 11:53:00 Muokattu käyttäjän Roni Laukkarinen toimesta viestillä "Github-linkin päivitys", katso muutos 3f91509 GitHubissa.

25.10.2017 13:03:04 Muokattu käyttäjän Roni Laukkarinen toimesta viestillä "Teeman-linkkaus ja täsmennys starteriin", katso muutos d0b80e9 GitHubissa.

25.10.2017 13:01:18 Muokattu käyttäjän Roni Laukkarinen toimesta viestillä "Koodausstandardien lisämäärittelyt, phpcs- ja phpcbf-ohjeet, otsikointi", katso muutos 143c141 GitHubissa.

7.8.2017 11:11:22 Muokattu käyttäjän Roni Laukkarinen toimesta viestillä "PHP_CodeSniffer-linkitys GitHubiin sekä typon korjaus", katso muutos 3e56ccd GitHubissa.

7.8.2017 09:25:53 Muokattu käyttäjän Roni toimesta viestillä "Full export from WordPress at https://handbook.dude.fi/wp (Dude Handbook) - wpghs", katso muutos a0ac9b5 GitHubissa.

Tämä Handbook kertoo kuinka me teemme asioita Dudella, mutta saa ottaa koppia myös omaan toimintaan. Emme takaa että kaikki meidän jutut toimivat muilla samalla tavalla. Ole mitä olet! Kaikki on avointa GitHubissa: digitoimistodude/handbook