Add Moodle coding standards compliance and CI workflow

All PHP files now pass phpcs --standard=moodle with zero errors and
warnings. Added file docblocks with @copyright/@license to all files,
class and function docblocks, renamed member variables from snake_case
to camelCase per Moodle naming conventions, fixed inline comment
formatting, and removed unnecessary MOODLE_INTERNAL checks from
autoloaded classes. Added moodle-cs.yml GitHub Action.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Author: allanhaggett

.github/workflows/moodle-cs.yml

@@ -0,0 +1,28 @@
+name: Moodle Coding Standards
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  codestyle:
+    name: Moodle PHP CodeSniffer
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout plugin
+        uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.2'
+          tools: composer:v2
+
+      - name: Install dependencies
+        run: composer install --no-interaction
+
+      - name: Run PHP CodeSniffer
+        run: vendor/bin/phpcs --standard=moodle --extensions=php --ignore=vendor/,phpstan-bootstrap.php .

README.md

@@ -300,6 +300,16 @@ composer install
 vendor/bin/phpstan analyse --memory-limit=512M
 ```
 
+### Moodle Coding Standards
+
+[PHP CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) with the [moodlehq/moodle-cs](https://github.com/moodlehq/moodle-cs) ruleset enforces Moodle's coding standards — file docblocks, naming conventions, inline comment formatting, and PHPDoc annotations.
+
+**Running locally:**
+```bash
+composer install
+vendor/bin/phpcs --standard=moodle --extensions=php --ignore=vendor/,phpstan-bootstrap.php .
+```
+
 ## File Structure
 
 ```
@@ -335,6 +345,7 @@ local/githubsync/
   .github/workflows/
     semgrep.yml                        # Semgrep OWASP security scan
     phpstan.yml                        # PHPStan static analysis
+    moodle-cs.yml                      # Moodle coding standards
 ```
 
 ## License

classes/form/config_form.php

@@ -20,8 +20,17 @@
 
 require_once($CFG->libdir . '/formslib.php');
 
+/**
+ * Configuration form for GitHub Sync course settings.
+ *
+ * @package    local_githubsync
+ * @copyright  2026 Allan Haggett
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
 class config_form extends \moodleform {
-
+    /**
+     * Form definition.
+     */
     protected function definition() {
         $mform = $this->_form;
 
@@ -42,20 +51,35 @@ protected function definition() {
         $mform->setType('branch', PARAM_TEXT);
         $mform->setDefault('branch', get_config('local_githubsync', 'default_branch') ?: 'main');
 
-        $mform->addElement('advcheckbox', 'auto_sync', get_string('auto_sync', 'local_githubsync'),
-            get_string('auto_sync_desc', 'local_githubsync'));
+        $mform->addElement(
+            'advcheckbox',
+            'auto_sync',
+            get_string('auto_sync', 'local_githubsync'),
+            get_string('auto_sync_desc', 'local_githubsync')
+        );
 
         // Show last sync info if available.
         if (!empty($this->_customdata['last_sync_time'])) {
             $lastsynced = userdate($this->_customdata['last_sync_time']);
             $sha = $this->_customdata['last_sync_sha'] ?? '';
-            $mform->addElement('static', 'lastsyncinfo', get_string('lastsynced', 'local_githubsync'),
-                $lastsynced . ($sha ? ' (commit ' . s($sha) . ')' : ''));
+            $mform->addElement(
+                'static',
+                'lastsyncinfo',
+                get_string('lastsynced', 'local_githubsync'),
+                $lastsynced . ($sha ? ' (commit ' . s($sha) . ')' : '')
+            );
         }
 
         $this->add_action_buttons(true, get_string('savesettings', 'local_githubsync'));
     }
 
+    /**
+     * Form validation.
+     *
+     * @param array $data Form data
+     * @param array $files Uploaded files
+     * @return array Validation errors
+     */
     public function validation($data, $files) {
         $errors = parent::validation($data, $files);
 

classes/github/client.php

@@ -25,9 +25,12 @@
  *
  * Uses the GitHub REST API to fetch repository content without requiring
  * git to be installed on the Moodle server.
+ *
+ * @package    local_githubsync
+ * @copyright  2026 Allan Haggett
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class client {
-
     /** @var string GitHub API base URL */
     private const API_BASE = 'https://api.github.com';
 
@@ -44,10 +47,10 @@ class client {
     private string $pat;
 
     /** @var int Remaining API requests (from X-RateLimit-Remaining header) */
-    private int $ratelimit_remaining = -1;
+    private int $ratelimitremaining = -1;
 
     /** @var int Rate limit reset timestamp */
-    private int $ratelimit_reset = 0;
+    private int $ratelimitreset = 0;
 
     /**
      * Constructor.
@@ -190,8 +193,8 @@ private function repo_endpoint(string $suffix = ''): string {
      */
     public function get_rate_limit_status(): array {
         return [
-            'remaining' => $this->ratelimit_remaining,
-            'reset' => $this->ratelimit_reset,
+            'remaining' => $this->ratelimitremaining,
+            'reset' => $this->ratelimitreset,
         ];
     }
 
@@ -229,17 +232,21 @@ private function api_request(string $endpoint, array $params = []): array {
         // Track rate limit headers.
         $responseheaders = $curl->getResponse();
         if (isset($responseheaders['X-RateLimit-Remaining'])) {
-            $this->ratelimit_remaining = (int) $responseheaders['X-RateLimit-Remaining'];
+            $this->ratelimitremaining = (int) $responseheaders['X-RateLimit-Remaining'];
         }
         if (isset($responseheaders['X-RateLimit-Reset'])) {
-            $this->ratelimit_reset = (int) $responseheaders['X-RateLimit-Reset'];
+            $this->ratelimitreset = (int) $responseheaders['X-RateLimit-Reset'];
         }
 
         // Handle rate limiting.
-        if ($httpcode === 403 && $this->ratelimit_remaining === 0) {
-            $resettime = userdate($this->ratelimit_reset);
-            throw new \moodle_exception('connectionfailed', 'local_githubsync', '',
-                "GitHub API rate limit exceeded. Resets at {$resettime}");
+        if ($httpcode === 403 && $this->ratelimitremaining === 0) {
+            $resettime = userdate($this->ratelimitreset);
+            throw new \moodle_exception(
+                'connectionfailed',
+                'local_githubsync',
+                '',
+                "GitHub API rate limit exceeded. Resets at {$resettime}"
+            );
         }
 
         if ($httpcode >= 400) {

classes/sync/asset_handler.php

@@ -16,8 +16,6 @@
 
 namespace local_githubsync\sync;
 
-defined('MOODLE_INTERNAL') || die();
-
 use local_githubsync\github\client;
 
 /**
@@ -32,9 +30,12 @@
  *   filename:  the file name
  *
  * A pluginfile handler in lib.php serves these files.
+ *
+ * @package    local_githubsync
+ * @copyright  2026 Allan Haggett
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class asset_handler {
-
     /** @var array Allowed asset file extensions */
     private const ALLOWED_EXTENSIONS = [
         'css', 'js',
@@ -65,6 +66,12 @@ class asset_handler {
     /** @var int Count of assets skipped (unchanged) */
     private int $skipped = 0;
 
+    /**
+     * Constructor.
+     *
+     * @param int $courseid The course ID
+     * @param client $github GitHub API client
+     */
     public function __construct(int $courseid, client $github) {
         $this->courseid = $courseid;
         $this->context = \context_course::instance($courseid);
@@ -82,7 +89,7 @@ public function process_assets(array $assetpaths): array {
         global $DB;
 
         foreach ($assetpaths as $repopath) {
-            // Derive the storage path: assets/css/custom.css -> filepath=/css/, filename=custom.css
+            // Derive the storage path: assets/css/custom.css -> filepath=/css/, filename=custom.css.
             $relpath = preg_replace('#^assets/#', '', $repopath);
             $dirname = dirname($relpath);
             $filename = basename($relpath);
@@ -205,6 +212,8 @@ public function rewrite_asset_urls(string $html): string {
 
     /**
      * Get the operations log.
+     *
+     * @return array The operations log.
      */
     public function get_operations(): array {
         return $this->operations;

classes/sync/course_builder.php

@@ -23,15 +23,23 @@
 
 /**
  * Handles creating and updating Moodle course structure from repo data.
+ *
+ * @package    local_githubsync
+ * @copyright  2026 Allan Haggett
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class course_builder {
-
     /** @var \stdClass The course object */
     private \stdClass $course;
 
     /** @var array Module IDs from the modules table, keyed by module name */
     private array $moduleids = [];
 
+    /**
+     * Constructor.
+     *
+     * @param \stdClass $course The course record
+     */
     public function __construct(\stdClass $course) {
         global $DB;
         $this->course = $course;
@@ -287,8 +295,12 @@ public function create_activity(int $sectionnum, string $name, string $htmlconte
             case 'url':
                 $url = $frontmatter['url'] ?? '';
                 if (empty($url)) {
-                    throw new \moodle_exception('syncfailed', 'local_githubsync', '',
-                        "URL activity requires 'url' in front matter");
+                    throw new \moodle_exception(
+                        'syncfailed',
+                        'local_githubsync',
+                        '',
+                        "URL activity requires 'url' in front matter"
+                    );
                 }
                 return $this->create_url($sectionnum, $name, $url, $htmlcontent);
 
@@ -333,15 +345,17 @@ public static function parse_front_matter(string $content): array {
                 $value = trim($m[2]);
 
                 // Remove surrounding quotes.
-                if ((str_starts_with($value, '"') && str_ends_with($value, '"')) ||
-                    (str_starts_with($value, "'") && str_ends_with($value, "'"))) {
+                if (
+                    (str_starts_with($value, '"') && str_ends_with($value, '"')) ||
+                    (str_starts_with($value, "'") && str_ends_with($value, "'"))
+                ) {
                     $value = substr($value, 1, -1);
                 }
 
                 // Handle booleans.
                 if ($value === 'true') {
                     $value = true;
-                } elseif ($value === 'false') {
+                } else if ($value === 'false') {
                     $value = false;
                 }