Check rules are sorted

Author: spaze

.github/workflows/rules.yml

@@ -0,0 +1,11 @@
+name: Rules Checks
+
+on: [push, pull_request]
+
+jobs:
+  sorted:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Check rules are sorted
+      run: php tests/sorted.php

README.md

@@ -2,6 +2,7 @@
 PHP Code Sniffer rules
 
 [![XML Lint](https://github.com/spaze/coding-standard/actions/workflows/xml.yml/badge.svg)](https://github.com/spaze/coding-standard/actions/workflows/xml.yml)
+[![Rules Checks](https://github.com/spaze/coding-standard/actions/workflows/rules.yml/badge.svg)](https://github.com/spaze/coding-standard/actions/workflows/rules.yml)
 
 ```
 composer require --dev spaze/coding-standard

composer.json

@@ -16,6 +16,9 @@
 		"php": "^7.2 || ^8.0",
 		"slevomat/coding-standard": "^8.9"
 	},
+	"require-dev": {
+		"ext-simplexml": "*"
+	},
 	"autoload": {
 		"psr-4": {"Spaze\\CodingStandard\\": "src"}
 	},

tests/sorted.php

@@ -0,0 +1,18 @@
+<?php
+declare(strict_types = 1);
+
+$rules = simplexml_load_file('src/ruleset.xml');
+$refs = $refsSorted = [];
+foreach ($rules->rule as $rule) {
+	$refs[] = (string)$rule['ref'];
+}
+$refsSorted = $refs;
+sort($refsSorted, SORT_NATURAL | SORT_FLAG_CASE);
+$diff = array_diff_assoc($refs, $refsSorted);
+if (count($diff)) {
+	printf("Rules not sorted: %s should be listed before %s\n", $diff[array_key_last($diff)], $diff[array_key_first($diff)]);
+	exit(1);
+} else {
+	echo "Rules sorted just about right\n";
+	exit(0);
+}