Remove PHPCS and replace with ECS

.codecov.yml

@@ -13,6 +13,7 @@ coverage:
 
 # See https://docs.codecov.io/docs/ignoring-paths
 ignore:
+  - "/ecs.php"
   - "/bin"
 
 comment: false

.github/workflows/test.yml

@@ -42,6 +42,10 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-composer-
 
+      - name: Remove ECS on lower PHP versions
+        if: ${{ matrix.php == '5.6' || matrix.php == '7.0' }}
+        run: composer remove --dev symplify/easy-coding-standard -W
+
       - name: Install Composer dependencies
         run: composer install
 
@@ -75,7 +79,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php: ['7.4']
+        php: ['8.0']
 
     steps:
       - name: Checkout
@@ -86,7 +90,7 @@ jobs:
         with:
           php-version: ${{ matrix.php }}
           extensions: dom, iconv, json, libxml, zip
-          tools: composer, cs2pr
+          tools: composer
 
       - name: Get Composer Cache Directory
         id: composer-cache
@@ -102,8 +106,11 @@ jobs:
       - name: Install Composer dependencies
         run: composer install
 
-      - name: Detect coding standard violations (PHPCS)
-        run: vendor/bin/phpcs -q --report=checkstyle --runtime-set ignore_errors_on_exit 1 --runtime-set ignore_warnings_on_exit 1 | cs2pr --graceful-warnings
+      - name: Detect coding standard violations in source code
+        run: composer cs
+
+      - name: Detect coding standard violations in documentation
+        run: composer cs-md
 
   static-analysis:
     name: Static analysis / PHP ${{ matrix.php }}

README.md

@@ -60,7 +60,7 @@ use AmpProject\Optimizer\ErrorCollection;
 use AmpProject\Optimizer\TransformationEngine;
 
 $transformationEngine = new TransformationEngine();    // 1.
-$errorCollection      = new ErrorCollection;           // 2.
+$errorCollection      = new ErrorCollection();         // 2.
 
 $optimizedHtml = $transformationEngine->optimizeHtml(  // 3.
     $unoptimizedHtml,                                  // 4.
@@ -90,7 +90,7 @@ if (! $dom instanceof Document) {
 }
 
 $transformationEngine = new TransformationEngine();
-$errorCollection      = new ErrorCollection;
+$errorCollection      = new ErrorCollection();
 $transformationEngine->optimizeDom($dom, $errorCollection);
 ```
 
@@ -103,32 +103,32 @@ The [`AmpProject\Optimizer\ErrorCollection`](https://github.com/ampproject/amp-t
 To check whether errors were found, you can iterate over the collection, which will provide you with 0 or more [`AmpProject\Optimizer\Error`](https://github.com/ampproject/amp-toolbox-php/blob/main/src/Optimizer/Error.php) objects.
 
 ```php
-$errorCollection = new ErrorCollection;
+$errorCollection = new ErrorCollection();
 
 // Do the transformation here, while passing in the $errorCollection object.
 
 foreach ($errorCollection as $error) {
-	printf(
-	    "Error code: %s\nError Message: %s\n",
-	    $error->getCode(),
-	    $error->getMessage()
-	);
+    printf(
+        "Error code: %s\nError Message: %s\n",
+        $error->getCode(),
+        $error->getMessage()
+    );
 }
 ```
 
 A quick count of the errors can be done for early returns as needed:
 
 ```php
 if ($errorCollection->count() > 0) {
-	$this->log('The AMP serverside optimization process produced one or more errors.');
+    $this->log('The AMP serverside optimization process produced one or more errors.');
 }
 ```
 
 You can check whether the collection of errors contains an error with a specific code as well. The current convention is that all errors have their class shortname (the class name without the namespace) as the error code.
 
 ```php
 if ($errorCollection->has('CannotRemoveBoilerplate')) {
-	$this->log('The boilerplate was not removed by the Optimizer.');
+    $this->log('The boilerplate was not removed by the Optimizer.');
 }
 ```
 
@@ -161,15 +161,15 @@ use AmpProject\Optimizer\TransformationEngine;
 use AmpProject\Optimizer\Transformer;
 
 $configurationData = [
-	Configuration::KEY_TRANSFORMERS => [
-		Transformer\ServerSideRendering::class,
-		Transformer\AmpRuntimeCss::class,
-		Transformer\TransformedIdentifier::class,
-	],
+    Configuration::KEY_TRANSFORMERS => [
+        Transformer\ServerSideRendering::class,
+        Transformer\AmpRuntimeCss::class,
+        Transformer\TransformedIdentifier::class,
+    ],
 ];
 
 $transformationEngine = new TransformationEngine(
-	new DefaultConfiguration($configurationData)
+    new DefaultConfiguration($configurationData)
 );
 ```
 
@@ -186,13 +186,13 @@ use AmpProject\Optimizer\TransformationEngine;
 use AmpProject\Optimizer\Transformer;
 
 $configurationData = [
-	Transformer\AmpRuntimeCss::class => [
-		Configuration\AmpRuntimeCssConfiguration::CANARY => true,
-	],
+    Transformer\AmpRuntimeCss::class => [
+        Configuration\AmpRuntimeCssConfiguration::CANARY => true,
+    ],
 ];
 
 $transformationEngine = new TransformationEngine(
-	new DefaultConfiguration($configurationData)
+    new DefaultConfiguration($configurationData)
 );
 ```
 
@@ -220,16 +220,16 @@ use AmpProject\Optimizer\TransformationEngine;
 use MyProject\MyCustomTransformer;
 
 $configurationData = [
-	Configuration::KEY_TRANSFORMERS => array_merge(
-		Configuration::DEFAULT_TRANSFORMERS,
-		[
-			MyCustomTransformer::class
-		],
-	),
+    Configuration::KEY_TRANSFORMERS => array_merge(
+        Configuration::DEFAULT_TRANSFORMERS,
+        [
+            MyCustomTransformer::class,
+        ],
+    ),
 ];
 
 $transformationEngine = new TransformationEngine(
-	new DefaultConfiguration($configurationData)
+    new DefaultConfiguration($configurationData)
 );
 ```
 
@@ -249,22 +249,22 @@ use MyProject\MyCustomTransformer;
 use MyProject\MyCustomTransformerConfiguration;
 
 $configurationData = [
-	Configuration::KEY_TRANSFORMERS => array_merge(
-		Configuration::DEFAULT_TRANSFORMERS,
-		[
-			MyCustomTransformer::class
-		],
-	),
-	MyCustomTransformer::class => [
-		MyCustomTransformerConfiguration::SOME_CONFIG_KEY => 'some value',
-	],
+    Configuration::KEY_TRANSFORMERS => array_merge(
+        Configuration::DEFAULT_TRANSFORMERS,
+        [
+            MyCustomTransformer::class,
+        ],
+    ),
+    MyCustomTransformer::class => [
+        MyCustomTransformerConfiguration::SOME_CONFIG_KEY => 'some value',
+    ],
 ];
 
 $configuration = new DefaultConfiguration($configurationData);
 
 $configuration->registerConfigurationClass(
-	MyCustomTransformer::class,
-	MyCustomTransformerConfiguration::class
+    MyCustomTransformer::class,
+    MyCustomTransformerConfiguration::class
 );
 
 $transformationEngine = new TransformationEngine($configuration);
@@ -285,24 +285,24 @@ use AmpProject\Optimizer\Configuration\BaseTransformerConfiguration;
 
 final class MyCustomTransformerConfiguration extends BaseTransformerConfiguration
 {
-	const SOME_CONFIG_KEY = 'some_config_key';
-
-	protected function getAllowedKeys()
-	{
-		return [
-			self::SOME_CONFIG_KEY => 'default value',
-		];
-	}
-
-	protected function validate($key, $value)
-	{
-		switch ($key) {
-			case self::SOME_CONFIG_KEY:
-				// Validate configuration value here.
-		}
-
-		return $value;
-	}
+    const SOME_CONFIG_KEY = 'some_config_key';
+
+    protected function getAllowedKeys()
+    {
+        return [
+            self::SOME_CONFIG_KEY => 'default value',
+        ];
+    }
+
+    protected function validate($key, $value)
+    {
+        switch ($key) {
+            case self::SOME_CONFIG_KEY:
+                // Validate configuration value here.
+        }
+
+        return $value;
+    }
 }
 ```
 
@@ -349,40 +349,40 @@ This layer of abstraction allows code outside of the transformation engine to co
 namespace MyProject;
 
 use AmpProject\Dom\Document;
-use AmpProject\RemoteGetRequest;
 use AmpProject\Optimizer\ErrorCollection;
 use AmpProject\Optimizer\Transformer;
+use AmpProject\RemoteGetRequest;
 use Throwable;
 
 final class MyCustomTransformer implements Transformer
 {
-	const END_POINT = 'https://example.com/some_endpoint/';
+    const END_POINT = 'https://example.com/some_endpoint/';
 
-	private $remoteRequest;
+    private $remoteRequest;
 
-	public function __construct(RemoteGetRequest $remoteRequest)
-	{
-		$this->remoteRequest = $remoteRequest;
-	}
+    public function __construct(RemoteGetRequest $remoteRequest)
+    {
+        $this->remoteRequest = $remoteRequest;
+    }
 
-	public function transform(Document $document, ErrorCollection $errors)
-	{
-		try {
-			$response = $this->remoteRequest->get(self::END_POINT);
-		} catch (Throwable $exception) {
-			// Add error handling here.
-		}
+    public function transform(Document $document, ErrorCollection $errors)
+    {
+        try {
+            $response = $this->remoteRequest->get(self::END_POINT);
+        } catch (Throwable $exception) {
+            // Add error handling here.
+        }
 
-		$statusCode = $response->getStatusCode();
+        $statusCode = $response->getStatusCode();
 
-		if (200 < $statusCode || $statusCode >= 300) {
-			// Add error handling here.
-		}
+        if (200 < $statusCode || $statusCode >= 300) {
+            // Add error handling here.
+        }
 
-		$content = $response->getBody();
-		
-		// Make use of the $content you've just retrieved from an external source.
-	}
+        $content = $response->getBody();
+
+        // Make use of the $content you've just retrieved from an external source.
+    }
 }
 ```
 
@@ -395,10 +395,10 @@ use AmpProject\Optimizer\DefaultConfiguration;
 use AmpProject\Optimizer\TransformationEngine;
 
 $transformationEngine = new TransformationEngine(
-	new DefaultConfiguration(),
+    new DefaultConfiguration(),
 
-	// A custom implementation that lets you control how remote requests are handled.
-	new MyCustomRemoteGetRequestImplementation()
+    // A custom implementation that lets you control how remote requests are handled.
+    new MyCustomRemoteGetRequestImplementation()
 );
 ```
 
@@ -423,12 +423,12 @@ use AmpProject\RemoteRequest\FallbackRemoteGetRequest;
 use AmpProject\RemoteRequest\FilesystemRemoteGetRequest;
 
 const FALLBACK_MAPPING = [
-	'https://example.com/some_endpoint/' => __DIR__ . '/../fallback_files/some_endpoint.json',
+    'https://example.com/some_endpoint/' => __DIR__ . '/../fallback_files/some_endpoint.json',
 ];
 
 $remoteRequest = new FallbackRemoteGetRequest(
-	new CurlRemoteGetRequest(true, 5, 0),                  // 5 second timeout with no retries, and ...
-	new FilesystemRemoteGetRequest(self::FALLBACK_MAPPING) // ... fall back to shipped files.
+    new CurlRemoteGetRequest(true, 5, 0),                  // 5 second timeout with no retries, and ...
+    new FilesystemRemoteGetRequest(self::FALLBACK_MAPPING) // ... fall back to shipped files.
 );
 
 $transformationEngine = new TransformationEngine(new DefaultConfiguration(), $remoteRequest);

composer.json

@@ -14,13 +14,10 @@
   "require-dev": {
     "ext-zip": "*",
     "civicrm/composer-downloads-plugin": "^2.1 || ^3.0",
-    "dealerdirect/phpcodesniffer-composer-installer": "0.7.1",
     "php-parallel-lint/php-parallel-lint": "^1.2",
-    "phpcompatibility/phpcompatibility-wp": "2.1.1",
     "phpunit/phpunit": "^5 || ^6 || ^7 || ^8 || ^9",
     "roave/security-advisories": "dev-master",
-    "sirbrillig/phpcs-variable-analysis": "2.11.0",
-    "squizlabs/php_codesniffer": "^3",
+    "symplify/easy-coding-standard": "^9.3",
     "yoast/phpunit-polyfills": "^0.2.0"
   },
   "suggest": {
@@ -53,17 +50,20 @@
     }
   },
   "scripts": {
-    "cbf": "phpcbf",
-    "cs": "if [ -z $TEST_SKIP_PHPCS ]; then phpcs; fi",
-    "lint": "if [ -z $TEST_SKIP_LINTING ]; then parallel-lint -j 10 --colors --exclude vendor .; fi",
+    "fix": "ecs check --fix",
+    "fix-md": "ecs check-markdown README.md --fix",
+    "cs": "ecs check",
+    "cs-md": "ecs check-markdown README.md",
+    "lint": "parallel-lint -j 10 --colors --exclude vendor .",
     "test": [
       "@lint",
       "@unit",
       "@cs",
+      "@cs-md",
       "@analyze"
     ],
-    "analyze": "if [ -z $TEST_SKIP_PHPSTAN ]; then phpstan --version; phpstan analyze --ansi; fi",
-    "unit": "if [ -z $TEST_SKIP_PHPUNIT ]; then phpunit --colors=always; fi",
+    "analyze": "phpstan --version; phpstan analyze --ansi",
+    "unit": "phpunit --colors=always",
     "sync-fallback-files":  "bin/sync-amp-runtime-local-fallback-resources.php",
     "sync-test-specs":  "rm -rf tests/spec && bin/sync-amp-toolbox-test-suite.php",
     "sync": [