Integrate php codesniffer standards #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed

.gitignore

-Original file line number
+Diff line change
@@ Expand Up / @@ -2,5 +2,6 @@ vendor/ @@
     .env
     compose.yaml
     composer.lock
+    !wiki/composer.lock
     database/
     images/

README.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -2,6 +2,12 @@ @@
     tbc
+    ## Code quality
+    - Install PHP dependencies inside `wiki/` via `composer install` (Composer 2).
+    - Run `composer test` from `wiki/` to execute MediaWiki CodeSniffer checks defined in `.phpcs.xml`.
+    - Run `composer fix` to automatically fix sniffs via `phpcbf` and re-run the sniffer if needed.
     # License
     Copyright 2025 Atmois <[email protected]>
@@ Expand Down @@

wiki/.phpcs.xml

-Original file line number
+Diff line change
@@ -0,0 +1,14 @@
+    <?xml version="1.0"?>
+    <ruleset name="atl.wiki MediaWiki standards">
+        <description>Enforce MediaWiki coding standards for all PHP configuration in this repo.</description>
+        <rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki"/>
+        <file>.</file>
+        <arg name="bootstrap" value="./vendor/mediawiki/mediawiki-codesniffer/utils/bootstrap-ci.php"/>
+        <arg name="extensions" value="php"/>
+        <arg name="encoding" value="UTF-8"/>
+        <exclude-pattern>./vendor/</exclude-pattern>
+        <exclude-pattern>./node_modules/</exclude-pattern>
+    </ruleset>

wiki/composer.json

-Original file line number
+Diff line change
@@ Expand Up / @@ -4,5 +4,23 @@ @@
         "type": "project",
         "require": {
             "vlucas/phpdotenv": "^5.6.2"
+        },
+        "require-dev": {
+            "mediawiki/mediawiki-codesniffer": "48.0.0"
+        },
+        "scripts": {
+            "phpcs": "phpcs -ps",
+            "phpcbf": "phpcbf",
+            "test": [
+                "@phpcs"
+            ],
+            "fix": [
+                "@phpcbf"
+            ]
+        },
+        "config": {
+            "allow-plugins": {
+                "dealerdirect/phpcodesniffer-composer-installer": true
+            }
         }
     }

Provide feedback