Sort sniffs/rules in phpcs.xml.dist and write test to keep them sorted

- sniffers
+ sniffs

$ ./vendor/bin/phpcs --standard=Drupal,DrupalPractice --runtime-set installed_paths vendor/drupal/coder/coder_sniffer -e | grep sniff 

The Drupal standard contains 115 sniffs
Drupal (71 sniffs)
Generic (13 sniffs)
MySource (1 sniff)
PEAR (3 sniffs)
PSR2 (2 sniffs)
Squiz (24 sniffs)
Zend (1 sniff)
The DrupalPractice standard contains 37 sniffs
DrupalPractice (37 sniffs)

The categories/sub-categories of sniffs won't be sorted globally, just keep it inline with the output above. The Drupal standard with its sub-categories (sub=categories are sorted by default) at the top, followed by the Drupal DrupalPractice standard.

  <!-- Internal sniffs -->
  <rule ref="Internal.NoCodeFound">
    <!-- No PHP code in *.yml -->
    <exclude-pattern>*.yml</exclude-pattern>
  </rule>

Internal sniffs will be moved to the above of the Drupal standard.

First iteration

Before:

$ cat core/phpcs.xml.dist | grep sniff
  <!-- Only include specific sniffs that pass. This ensures that, if new sniffs are added, HEAD does not fail.-->
  <!-- Drupal sniffs -->
  <!-- Drupal Practice sniffs -->
  <!-- Generic sniffs -->
  <!-- Internal sniffs -->
  <!-- MySource sniffs -->
  <!-- PEAR sniffs -->
  <!-- PEAR sniffs -->
  <!-- The sniffs inside PEAR.Functions.FunctionCallSignature silenced below are
  <!-- PSR-2 sniffs -->
  <!-- Squiz sniffs -->
  <!-- Zend sniffs -->

After:

$ cat core/phpcs.xml.dist | grep sniff
  <!-- Only include specific sniffs that pass. This ensures that, if new sniffs are added, HEAD does not fail.-->
  <!-- Internal sniffs -->
  <!-- Drupal sniffs -->
  <!-- Generic sniffs -->
  <!-- MySource sniffs -->
  <!-- PEAR sniffs -->
  <!-- The sniffs inside PEAR.Functions.FunctionCallSignature silenced below are
  <!-- PSR-2 sniffs -->
  <!-- Squiz sniffs -->
  <!-- Zend sniffs -->
  <!-- Drupal Practice sniffs -->

2nd intention: sort Drupal sniffs

To verify:

$ cat core/phpcs.xml.dist | grep Drupal. | grep \<rule | grep -v DrupalPractice > unsorted.txt
$ cat core/phpcs.xml.dist | grep Drupal. | grep \<rule | grep -v DrupalPractice | sort > sorted.txt

unsorted.txt should be identical with sorted.txt

3rd iteration

1. Nothing to do with generic sniffs.

$ cat core/phpcs.xml.dist | grep Generic. | grep rule > before.txt
$ cat core/phpcs.xml.dist | grep Generic. | grep rule | sort> after.txt

Before.txt is identical with after.txt

2. MySource: only 1 sniff, skipped

3. Sorted PEAR sniffs: to verify:

$ cat core/phpcs.xml.dist | grep PEAR. | grep rule > unsorted.txt
$  cat core/phpcs.xml.dist | grep PEAR. | grep rule | sort > sorted.txt

unsorted.txt should be identical with sorted.txt

4th iteration (The last)

1. Nothing to do with PSR2 sniffs,

$ cat core/phpcs.xml.dist | grep PSR2. | grep rule > before.txt
$ cat core/phpcs.xml.dist | grep PSR2. | grep rule | sort > after.txt

Before.txt is identical with after.txt

2. Sorted Squiz sniffs: to verify:

$ cat core/phpcs.xml.dist | grep Squiz. | grep rule > unsorted.txt
$  cat core/phpcs.xml.dist | grep Squiz. | grep rule | sort > sorted.txt

unsorted.txt should be identical with sorted.txt

3. Zend sniffs, one sniff only, skipped
4. Drupal Practice sniffs, one sniff only, skipped

@alexpott thanks for your review!

From my understanding, the test in other issue planed is to test if all sniffs in phpcs.xml.dist in sync with the list got from the current version of coder locked in composer.lock. The test needed here is to test sorting.

Re #11, @alexpott commented on #3135935: Keep all sniffs in phpcs.xml.dist in sync with the locked version of Coder, I think we should continue. The patch sorted:

1. Level - 1: <file>, <description>, <rule> etc. tags sorted.
2. Level - 2: excluded sniffs ( with <exclude> tags) sorted.

Trying to make the bot work

Re #18, from my understanding, the two issues are not tightly relevant/related/bundled.

1. This one focuses on getting the "XML tree" -- phpcs.xml.dist, sorted. Sorted alphabetically will make CRUD on this file easier, no matter whether we will continue with #3135935 or not
2. That one focuses on keeping sniffs in sync with sniffs from coder locked in composer.lock,
3. Once the phpcs.xml.dist file gets sorted, it will make the sync thing easier, more or less
4. Yes, not all sniffs are in the phpcs.xml.dist file, while keeping them in sync, missing ones will be added to the file, commented ones will be converted to excluded ones if possible per @longwave's comment somewhere I couldn't remember that, using the solution below if applicable
   

    <rule ref="Drupal"> 
      <exclude name="Drupal.FooSniff"/>
    </rule>
   

I am not a native English speaker, please bear with me at sometimes, Thank you @jonathan1055!