Differences

This shows you the differences between two versions of the page.

--- development:coding_standards [2015/12/09 19:13] – created demiankatz
+++ development:coding_standards [2020/07/30 14:08] – [Templates] crhallberg
@@ Line 1: / Line 1: @@
 ====== Coding Standards ======
-VuFind uses the [[http://pear.php.net/manual/en/standards.php|PEAR Coding Standards]] for its PHP code. Several additional recommendations are enforced using the php-cs-fixer tool. For help with standards compliance, see the [[vufind2:recommended_tools#style|recommended tools page]].
+===== PHP =====
+VuFind uses the [[http://pear.php.net/manual/en/standards.php|PEAR Coding Standards]] for its PHP code. Several additional recommendations are enforced using the php-cs-fixer tool. For help with standards compliance, see the [[development:recommended_tools#style|recommended tools page]].
+===== Javascript =====
+ESLint style enforcement in progress. Will use ESLint recommended with a few extra rules. Join in the conversation on [[https://github.com/vufind-org/vufind/pull/700|this pull request]].
+===== Templates =====
+Templates are looser with their styles due to the difficult mix of conditional PHP and HTML. Here's a few guidelines to help write clearer templates.
+  * 2 Space Indents
+  * Long php tags - ''<?php''
+  * Use short echo tags - ''<?=$var ?>''
+  * Use if blocks instead of brackets and indent inside - ''<?php if(): ?><?php endif; ?>''
+  * Use Slots to simply buffering and conditional content, especially across templates
+  * If a loop is producing multiple buttons, links, etc. per item, consider making a subtemplate and using ''<?=$this->render('') ?>''
+  * Don't call Model methods from Views, perform this logic in the Controllers
+===== CSS =====
+No strict coding practices enforced, although the [[http://codeguide.co/|Code Guide]] by Bootstrap creator Mark Otto is a recommended read.
+===== Editor Config =====
+<code>
+# editorconfig.org
+root = true
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+[*.php]
+indent_size = 4
+</code>
 ---- struct data ----
 ----