From fb37f748d47097db7f3657b80e067b8a99125ea5 Mon Sep 17 00:00:00 2001 From: Joshua Ramon Enslin Date: Sat, 10 Oct 2020 21:28:18 +0200 Subject: [PATCH] Add phpcs rules --- README.org | 4 + rules/md_phpcs_rules.xml | 221 ++++++++++++++++++++++++++++++++ rules/md_phpcs_rules_basic.xml | 223 +++++++++++++++++++++++++++++++++ 3 files changed, 448 insertions(+) create mode 100644 rules/md_phpcs_rules.xml create mode 100644 rules/md_phpcs_rules_basic.xml diff --git a/README.org b/README.org index 3f20cf0..8614d2a 100644 --- a/README.org +++ b/README.org @@ -1,5 +1,7 @@ * Quality Assurance Settings for museum-digital +Most of the code used at [museum-digital](https://www.museum-digital.org) is written in PHP. To keep a uniform code style throughout the code, we use [PHP Code Sniffer](https://github.com/squizlabs/PHP_CodeSniffer). + ** Tools used - [[https://github.com/squizlabs/PHP_CodeSniffer][php-codesniffer]] @@ -9,3 +11,5 @@ ** This Repository This repository serves to collect generally applicable rules, that can be embedded into the specific rule sets of the different projects. + +The file `md_phpcs_rules.xml` contains the main style guide. When rewriting files to fit the uniform style rules, `md_phpcs_rules_basic.xml` comes in handy as a first step. It contains the same rules, excluding some which require or encourage a more in-depth look at the code (the prohibition of procedural-style calls to mysqli functions is e.g. a good opportunity to check the efficiency of queries). diff --git a/rules/md_phpcs_rules.xml b/rules/md_phpcs_rules.xml new file mode 100644 index 0000000..53012d0 --- /dev/null +++ b/rules/md_phpcs_rules.xml @@ -0,0 +1,221 @@ + + + Coding standard for museum-digital. + Based on Zend with some additions. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/rules/md_phpcs_rules_basic.xml b/rules/md_phpcs_rules_basic.xml new file mode 100644 index 0000000..41c5909 --- /dev/null +++ b/rules/md_phpcs_rules_basic.xml @@ -0,0 +1,223 @@ + + + Coding standard for museum-digital. + Based on Zend with some additions. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +