add ascii video

Author: IonBazan

.github/workflows/test.yml

@@ -2,11 +2,12 @@ name: Tests
 on: [push, pull_request]
 jobs:
   php:
-    name: PHP ${{ matrix.php-versions }}
-    runs-on: ubuntu-latest
+    name: PHP ${{ matrix.php-versions }} on ${{ matrix.operating-system }}
+    runs-on: ${{ matrix.operating-system }}
     strategy:
       fail-fast: false
       matrix:
+        operating-system: [ubuntu-latest]
         php-versions:
 #          - '5.4'
 #          - '5.5'
@@ -19,8 +20,12 @@ jobs:
         include:
           - php-versions: '5.3'
             composer-flags: '--prefer-lowest'
+            operating-system: ubuntu-latest
+          - php-versions: '7.4'
+            operating-system: windows-latest
           - php-versions: '8.0'
             composer-flags: '--ignore-platform-reqs'
+            operating-system: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -29,7 +34,6 @@ jobs:
         with:
           php-version: ${{ matrix.php-versions }}
           extensions: json
-          coverage: pcov
       - name: Get composer cache directory
         id: composer-cache
         run: echo "::set-output name=dir::$(composer config cache-files-dir)"

README.md

@@ -1,6 +1,78 @@
 # Composer Diff Plugin
 
-Generates packages changes report in Markdown format by comparing `composer.lock` files.
+Generates packages changes report in Markdown format by comparing `composer.lock` files. Compares with last-commited changes by default.
+
+![preview](preview.gif)
+
+## Example output
+
+```
+| Prod Packages                      | Base    | Target  |
+|------------------------------------|---------|---------|
+| psr/event-dispatcher               | New     | 1.0.0   |
+| symfony/deprecation-contracts      | New     | v2.1.2  |
+| symfony/event-dispatcher           | v2.8.52 | v5.1.2  |
+| symfony/event-dispatcher-contracts | New     | v2.1.2  |
+| symfony/polyfill-php80             | New     | v1.17.1 |
+| php                                | New     | >=5.3   |
+
+| Dev Packages                       | Base  | Target  |
+|------------------------------------|-------|---------|
+| phpunit/php-code-coverage          | 8.0.2 | 7.0.10  |
+| phpunit/php-file-iterator          | 3.0.2 | 2.0.2   |
+| phpunit/php-text-template          | 2.0.1 | 1.2.1   |
+| phpunit/php-timer                  | 5.0.0 | 2.1.2   |
+| phpunit/php-token-stream           | 4.0.2 | 3.1.1   |
+| phpunit/phpunit                    | 9.2.5 | 8.5.8   |
+| sebastian/code-unit-reverse-lookup | 2.0.1 | 1.0.1   |
+| sebastian/comparator               | 4.0.2 | 3.0.2   |
+| sebastian/diff                     | 4.0.1 | 3.0.2   |
+| sebastian/environment              | 5.1.1 | 4.2.3   |
+| sebastian/exporter                 | 4.0.1 | 3.1.2   |
+| sebastian/global-state             | 4.0.0 | 3.0.0   |
+| sebastian/object-enumerator        | 4.0.1 | 3.0.3   |
+| sebastian/object-reflector         | 2.0.1 | 1.1.1   |
+| sebastian/recursion-context        | 4.0.1 | 3.0.0   |
+| sebastian/resource-operations      | 3.0.1 | 2.0.1   |
+| sebastian/type                     | 2.1.0 | 1.1.3   |
+| sebastian/version                  | 3.0.0 | 2.0.1   |
+| phpunit/php-invoker                | 3.0.1 | Removed |
+| sebastian/code-unit                | 1.0.3 | Removed |
+```
+
+## Rendered: 
+
+| Prod Packages                      | Base    | Target  |
+|------------------------------------|---------|---------|
+| psr/event-dispatcher               | New     | 1.0.0   |
+| symfony/deprecation-contracts      | New     | v2.1.2  |
+| symfony/event-dispatcher           | v2.8.52 | v5.1.2  |
+| symfony/event-dispatcher-contracts | New     | v2.1.2  |
+| symfony/polyfill-php80             | New     | v1.17.1 |
+| php                                | New     | >=5.3   |
+
+| Dev Packages                       | Base  | Target  |
+|------------------------------------|-------|---------|
+| phpunit/php-code-coverage          | 8.0.2 | 7.0.10  |
+| phpunit/php-file-iterator          | 3.0.2 | 2.0.2   |
+| phpunit/php-text-template          | 2.0.1 | 1.2.1   |
+| phpunit/php-timer                  | 5.0.0 | 2.1.2   |
+| phpunit/php-token-stream           | 4.0.2 | 3.1.1   |
+| phpunit/phpunit                    | 9.2.5 | 8.5.8   |
+| sebastian/code-unit-reverse-lookup | 2.0.1 | 1.0.1   |
+| sebastian/comparator               | 4.0.2 | 3.0.2   |
+| sebastian/diff                     | 4.0.1 | 3.0.2   |
+| sebastian/environment              | 5.1.1 | 4.2.3   |
+| sebastian/exporter                 | 4.0.1 | 3.1.2   |
+| sebastian/global-state             | 4.0.0 | 3.0.0   |
+| sebastian/object-enumerator        | 4.0.1 | 3.0.3   |
+| sebastian/object-reflector         | 2.0.1 | 1.1.1   |
+| sebastian/recursion-context        | 4.0.1 | 3.0.0   |
+| sebastian/resource-operations      | 3.0.1 | 2.0.1   |
+| sebastian/type                     | 2.1.0 | 1.1.3   |
+| sebastian/version                  | 3.0.0 | 2.0.1   |
+| phpunit/php-invoker                | 3.0.1 | Removed |
+| sebastian/code-unit                | 1.0.3 | Removed |
 
 # Installation
 

composer.json

@@ -1,6 +1,17 @@
 {
     "name": "ion-bazan/composer-diff",
     "type": "composer-plugin",
+    "description": "Compares composer.lock changes and generates Markdown report so you can use it in PR description.",
+    "keywords": [
+        "composer",
+        "composer.lock",
+        "diff",
+        "packages",
+        "markdown",
+        "pullrequest",
+        "github",
+        "packagist"
+    ],
     "license": "MIT",
     "authors": [
         {
@@ -14,9 +25,9 @@
         "composer-plugin-api": "^1.1 || ^2.0"
     },
     "require-dev": {
-        "symfony/phpunit-bridge": "^4.2 || ^5.0",
         "composer/composer": "^1.1 || ^2.0",
-        "symfony/console": "^2.3 || ^3.0 || ^4.0 || ^5.0"
+        "symfony/console": "^2.3 || ^3.0 || ^4.0 || ^5.0",
+        "symfony/phpunit-bridge": "^4.2 || ^5.0"
     },
     "config": {
         "platform": {

phpunit.xml.dist

@@ -32,6 +32,6 @@
     </filter>
     <logging>
         <log type="coverage-clover" target="clover.xml" />
-        <log type="coverage-html" target="coverage.xml" />
+        <log type="coverage-html" target="coverage" />
     </logging>
 </phpunit>