Merge pull request #932 from Nyholm/8.14.x-modification

Add modification type in json output

Author: Ocramius

Resources/errors.schema.json

@@ -52,6 +52,9 @@
               "type": "null"
             }
           ]
+        },
+        "modificationType": {
+          "type": "string"
         }
       },
       "required": [

src/Change.php

@@ -71,6 +71,11 @@ public function isSkipped(): bool
         return $this->modificationType === self::SKIPPED;
     }
 
+    public function getModificationType(): string
+    {
+        return $this->modificationType;
+    }
+
     /** @internal */
     public function withFilePositionsIfNotAlreadySet(
         string|null $file,

src/Formatter/JsonFormatter.php

@@ -31,6 +31,7 @@ public function write(Changes $changes): void
                 'path' => $change->file === null ? null : Str\replace($change->file, $basePath, ''),
                 'line' => $change->line,
                 'column' => $change->column,
+                'modificationType' => $change->getModificationType(),
             ];
         }
 

test/unit/Formatter/JsonFormatterTest.php

@@ -63,13 +63,13 @@ public function testWrite(): void
 
         $expected = [
             'errors' => [
-                ['description' => 'foo', 'path' => null, 'line' => null, 'column' => null],
-                ['description' => 'bar', 'path' => null, 'line' => null, 'column' => null],
-                ['description' => 'baz', 'path' => 'baz-file.php', 'line' => null, 'column' => null],
-                ['description' => 'tab', 'path' => 'tab-file.php', 'line' => 5, 'column' => null],
-                ['description' => 'taz', 'path' => 'taz-file.php', 'line' => 6, 'column' => 15],
-                ['description' => 'tar', 'path' => 'tar-file.php', 'line' => -1, 'column' => -1],
-                ['description' => 'file-in-checked-out-dir', 'path' => 'subpath/file-in-checked-out-dir.php', 'line' => 10, 'column' => 20],
+                ['description' => 'foo', 'path' => null, 'line' => null, 'column' => null, 'modificationType' => 'removed'],
+                ['description' => 'bar', 'path' => null, 'line' => null, 'column' => null, 'modificationType' => 'added'],
+                ['description' => 'baz', 'path' => 'baz-file.php', 'line' => null, 'column' => null, 'modificationType' => 'changed'],
+                ['description' => 'tab', 'path' => 'tab-file.php', 'line' => 5, 'column' => null, 'modificationType' => 'changed'],
+                ['description' => 'taz', 'path' => 'taz-file.php', 'line' => 6, 'column' => 15, 'modificationType' => 'changed'],
+                ['description' => 'tar', 'path' => 'tar-file.php', 'line' => -1, 'column' => -1, 'modificationType' => 'changed'],
+                ['description' => 'file-in-checked-out-dir', 'path' => 'subpath/file-in-checked-out-dir.php', 'line' => 10, 'column' => 20, 'modificationType' => 'changed'],
             ],
         ];
 
@@ -86,7 +86,7 @@ public function testWrite(): void
 
         self::assertJsonStringEqualsJsonString(
             <<<'OUTPUT'
-{"errors":[{"description":"foo","path":null,"line":null,"column":null},{"description":"bar","path":null,"line":null,"column":null},{"description":"baz","path":"baz-file.php","line":null,"column":null},{"description":"tab","path":"tab-file.php","line":5,"column":null},{"description":"taz","path":"taz-file.php","line":6,"column":15},{"description":"tar","path":"tar-file.php","line":-1,"column":-1},{"description":"file-in-checked-out-dir","path":"subpath\/file-in-checked-out-dir.php","line":10,"column":20}]}
+{"errors":[{"description":"foo","path":null,"line":null,"column":null,"modificationType":"removed"},{"description":"bar","path":null,"line":null,"column":null,"modificationType":"added"},{"description":"baz","path":"baz-file.php","line":null,"column":null,"modificationType":"changed"},{"description":"tab","path":"tab-file.php","line":5,"column":null,"modificationType":"changed"},{"description":"taz","path":"taz-file.php","line":6,"column":15,"modificationType":"changed"},{"description":"tar","path":"tar-file.php","line":-1,"column":-1,"modificationType":"changed"},{"description":"file-in-checked-out-dir","path":"subpath\/file-in-checked-out-dir.php","line":10,"column":20,"modificationType":"changed"}]}
 
 OUTPUT
             ,