Prune empty sections in composer.json

ergebnis · Feb 17, 2024 · 2a5e4d2 · 2a5e4d2
1 parent b6c84b1
commit 2a5e4d2
Show file tree

Hide file tree

Showing 16 changed files with 48 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -627,6 +627,19 @@ sections, the `Vendor\Composer\VersionConstraintNormalizer` will ensure that
    }
   ```
 
+- empty sections (which are defined as optional in the schema) are automatically removed
+
+  ```diff
+   {
+      "require": {
+          "foo/bar": "^2.3.4"
+      }
+  -   "config": {
+  -       "preferred-install": {}
+  -   }
+   }
+  ```
+
 ## Changelog
 
 The maintainers of this project record notable changes to this project in a [changelog](CHANGELOG.md).

diff --git a/src/SchemaNormalizer.php b/src/SchemaNormalizer.php
@@ -28,17 +28,20 @@ final class SchemaNormalizer implements Normalizer
     private SchemaValidator\SchemaValidator $schemaValidator;
     private SchemaStorage $schemaStorage;
     private string $schemaUri;
+    private bool $pruneEmpty;
 
     public function __construct(
         string $schemaUri,
         SchemaStorage $schemaStorage,
         SchemaValidator\SchemaValidator $schemaValidator,
-        Pointer\Specification $specificationForPointerToDataThatShouldNotBeSorted
+        Pointer\Specification $specificationForPointerToDataThatShouldNotBeSorted,
+        bool $pruneEmpty = false
     ) {
         $this->schemaUri = $schemaUri;
         $this->schemaStorage = $schemaStorage;
         $this->schemaValidator = $schemaValidator;
         $this->specificationForPointerToDataThatShouldNotBeSorted = $specificationForPointerToDataThatShouldNotBeSorted;
+        $this->pruneEmpty = $pruneEmpty;
     }
 
     public function normalize(Json $json): Json
@@ -223,6 +226,14 @@ private function normalizeObject(
                     $pointerToData->append(Pointer\ReferenceToken::fromString($name)),
                 );
 
+                if (
+                    $this->pruneEmpty
+                    && [] === (array) $normalized->{$name}
+                    && self::isKeyOptionalInSchema($schema, $name)
+                ) {
+                    unset($normalized->{$name});
+                }
+
                 unset($data->{$name});
             }
         }
@@ -327,4 +338,17 @@ private function resolveSchema(
 
         return $schema;
     }
+
+    private static function isKeyOptionalInSchema(object $schema, string $name): bool
+    {
+        if (
+            \property_exists($schema, 'required')
+            && \is_array($schema->required)
+            && \in_array($name, $schema->required, true)
+        ) {
+            return false;
+        }
+
+        return true;
+    }
 }
diff --git a/src/Vendor/Composer/ComposerJsonNormalizer.php b/src/Vendor/Composer/ComposerJsonNormalizer.php
@@ -89,6 +89,7 @@ public function __construct(string $schemaUri)
                      */
                     Pointer\Specification::equals(Pointer\JsonPointer::fromJsonString('/scripts/auto-scripts')),
                 ),
+                true,
             ),
             new BinNormalizer(),
             new ConfigHashNormalizer(),

diff --git a/...esJson/Json/IsObject/HasEntries/Yes/HasProperty/Bin/IsArray/HasEntries/No/normalized.json b/...esJson/Json/IsObject/HasEntries/Yes/HasProperty/Bin/IsArray/HasEntries/No/normalized.json
@@ -13,6 +13,5 @@
             "email": "[email protected]"
         }
     ],
-    "homepage": "https://getcomposer.org/doc/04-schema.md#bin",
-    "bin": []
+    "homepage": "https://getcomposer.org/doc/04-schema.md#bin"
 }
diff --git a/...malizesJson/Json/IsObject/HasEntries/Yes/HasProperty/Config/HasEntries/No/normalized.json b/...malizesJson/Json/IsObject/HasEntries/Yes/HasProperty/Config/HasEntries/No/normalized.json
@@ -13,6 +13,5 @@
             "email": "[email protected]"
         }
     ],
-    "homepage": "https://getcomposer.org/doc/06-config.md",
-    "config": {}
+    "homepage": "https://getcomposer.org/doc/06-config.md"
 }
diff --git a/...rty/Config/HasEntries/Yes/HasProperty/AllowPlugins/IsObject/HasEntries/No/normalized.json b/...rty/Config/HasEntries/Yes/HasProperty/AllowPlugins/IsObject/HasEntries/No/normalized.json
@@ -13,8 +13,5 @@
             "email": "[email protected]"
         }
     ],
-    "homepage": "https://getcomposer.org/doc/06-config.md#allow-plugins",
-    "config": {
-        "allow-plugins": {}
-    }
+    "homepage": "https://getcomposer.org/doc/06-config.md#allow-plugins"
 }
diff --git a/...Config/HasEntries/Yes/HasProperty/PreferredInstall/IsObject/HasEntries/No/normalized.json b/...Config/HasEntries/Yes/HasProperty/PreferredInstall/IsObject/HasEntries/No/normalized.json
@@ -13,8 +13,5 @@
             "email": "[email protected]"
         }
     ],
-    "homepage": "https://getcomposer.org/doc/06-config.md#preferred-install",
-    "config": {
-        "preferred-install": {}
-    }
+    "homepage": "https://getcomposer.org/doc/06-config.md#preferred-install"
 }
diff --git a/...sObject/HasEntries/Yes/HasProperty/Config/HasEntries/Yes/IsSortedByKey/No/normalized.json b/...sObject/HasEntries/Yes/HasProperty/Config/HasEntries/Yes/IsSortedByKey/No/normalized.json
@@ -15,7 +15,6 @@
     ],
     "homepage": "https://getcomposer.org/doc/06-config.md",
     "config": {
-        "allow-plugins": {},
         "platform": {
             "php": "8.0.25"
         },

diff --git a/...Object/HasEntries/Yes/HasProperty/Config/HasEntries/Yes/IsSortedByKey/Yes/normalized.json b/...Object/HasEntries/Yes/HasProperty/Config/HasEntries/Yes/IsSortedByKey/Yes/normalized.json
@@ -15,7 +15,6 @@
     ],
     "homepage": "https://getcomposer.org/doc/06-config.md",
     "config": {
-        "allow-plugins": {},
         "platform": {
             "php": "8.0.25"
         },

diff --git a/...rmalizesJson/Json/IsObject/HasEntries/Yes/HasProperty/Extra/HasEntries/No/normalized.json b/...rmalizesJson/Json/IsObject/HasEntries/Yes/HasProperty/Extra/HasEntries/No/normalized.json
@@ -13,6 +13,5 @@
             "email": "[email protected]"
         }
     ],
-    "homepage": "https://getcomposer.org/doc/04-schema.md#extra",
-    "extra": {}
+    "homepage": "https://getcomposer.org/doc/04-schema.md#extra"
 }
diff --git a/...sJson/Json/IsObject/HasEntries/Yes/HasProperty/Repositories/HasEntries/No/normalized.json b/...sJson/Json/IsObject/HasEntries/Yes/HasProperty/Repositories/HasEntries/No/normalized.json
@@ -13,6 +13,5 @@
             "email": "[email protected]"
         }
     ],
-    "homepage": "https://getcomposer.org/doc/04-schema.md#repositories",
-    "repositories": []
+    "homepage": "https://getcomposer.org/doc/04-schema.md#repositories"
 }
diff --git a/...malizesJson/Json/IsObject/HasEntries/Yes/HasProperty/RequireAndRequireDev/normalized.json b/...malizesJson/Json/IsObject/HasEntries/Yes/HasProperty/RequireAndRequireDev/normalized.json
@@ -1,6 +1,5 @@
 {
     "description": "This test exists to cover certain mutants from infection/infection",
-    "require": {},
     "require-dev": {
         "ergebnis/overlapping-version-constraints-1": "^1.0 || 3.4.5",
         "ergebnis/overlapping-version-constraints-2": "^1.0 || ^2.0",

diff --git a/...alizesJson/Json/IsObject/HasEntries/Yes/HasProperty/Scripts/HasEntries/No/normalized.json b/...alizesJson/Json/IsObject/HasEntries/Yes/HasProperty/Scripts/HasEntries/No/normalized.json
@@ -13,6 +13,5 @@
             "email": "[email protected]"
         }
     ],
-    "homepage": "https://getcomposer.org/doc/04-schema.md#scripts",
-    "scripts": {}
+    "homepage": "https://getcomposer.org/doc/04-schema.md#scripts"
 }
diff --git a/...alizesJson/Json/IsObject/HasEntries/Yes/HasProperty/Suggest/HasEntries/No/normalized.json b/...alizesJson/Json/IsObject/HasEntries/Yes/HasProperty/Suggest/HasEntries/No/normalized.json
@@ -1,4 +1,3 @@
 {
-    "homepage": "https://getcomposer.org/doc/04-schema.md#suggest",
-    "suggest": {}
+    "homepage": "https://getcomposer.org/doc/04-schema.md#suggest"
 }
diff --git a/...bject/HasEntries/Yes/HasProperty/Suggest/HasEntries/Yes/IsSortedByKey/Yes/normalized.json b/...bject/HasEntries/Yes/HasProperty/Suggest/HasEntries/Yes/IsSortedByKey/Yes/normalized.json
@@ -1,6 +1,5 @@
 {
     "homepage": "https://getcomposer.org/doc/04-schema.md#suggest",
-    "require": {},
     "suggest": {
         "php": "Nothing works without it",
         "hhvm": "Okay",

diff --git a/.../Yes/HasProperty/ValueContainsPackagesAndVersionConstraints/HasEntries/No/normalized.json b/.../Yes/HasProperty/ValueContainsPackagesAndVersionConstraints/HasEntries/No/normalized.json
@@ -1,3 +1 @@
-{
-    "value-contains-packages-and-version-constraints": {}
-}
+{}
-Original file line number
+Diff line change
@@ Expand Up / @@ -89,6 +89,7 @@ public function __construct(string $schemaUri) @@
                          */
                         Pointer\Specification::equals(Pointer\JsonPointer::fromJsonString('/scripts/auto-scripts')),
                     ),
+                    true,
                 ),
                 new BinNormalizer(),
                 new ConfigHashNormalizer(),
@@ Expand Down @@