feature #764 Copy peerDependencies to the root package.json (nicolas-grekas)

This PR was merged into the 1.12-dev branch.

Discussion
----------

Copy peerDependencies to the root package.json

As spotted in symfony/ux#93

/cc `@weaverryan`

Commits
-------

0c79df1 Copy peerDependencies to the root package.json

Author: nicolas-grekas

src/PackageJsonSynchronizer.php

@@ -13,6 +13,9 @@
 
 use Composer\Json\JsonFile;
 use Composer\Json\JsonManipulator;
+use Composer\Semver\Constraint\ConstraintInterface;
+use Composer\Semver\Intervals;
+use Composer\Semver\VersionParser;
 
 /**
  * Synchronize package.json files detected in installed PHP packages with
@@ -41,6 +44,8 @@ public function synchronize(array $packagesNames): bool
             $didAddLink = $this->addPackageJsonLink($packageName) || $didAddLink;
         }
 
+        $this->registerPeerDependencies($packagesNames);
+
         // Register controllers and entrypoints in controllers.json
         $this->registerWebpackResources($packagesNames);
 
@@ -106,11 +111,8 @@ private function registerWebpackResources(array $phpPackages)
                 continue;
             }
 
-            if (!file_exists($packageJsonPath = $this->rootDir.'/vendor/'.$phpPackage.$assetsDir.'/package.json')) {
-                continue;
-            }
-
             // Register in config
+            $packageJsonPath = $this->rootDir.'/vendor/'.$phpPackage.$assetsDir.'/package.json';
             $packageJson = (new JsonFile($packageJsonPath))->read();
 
             foreach ($packageJson['symfony']['controllers'] ?? [] as $controllerName => $defaultConfig) {
@@ -158,6 +160,41 @@ private function registerWebpackResources(array $phpPackages)
         file_put_contents($controllersJsonPath, json_encode($newControllersJson, \JSON_PRETTY_PRINT | \JSON_UNESCAPED_SLASHES)."\n");
     }
 
+    public function registerPeerDependencies(array $phpPackages)
+    {
+        $peerDependencies = [];
+
+        foreach ($phpPackages as $phpPackage) {
+            if (!$assetsDir = $this->resolveAssetsDir($phpPackage)) {
+                continue;
+            }
+
+            $packageJsonPath = $this->rootDir.'/vendor/'.$phpPackage.$assetsDir.'/package.json';
+            $packageJson = (new JsonFile($packageJsonPath))->read();
+            $versionParser = new VersionParser();
+
+            foreach ($packageJson['peerDependencies'] ?? [] as $peerDependency => $constraint) {
+                $peerDependencies[$peerDependency][$constraint] = $versionParser->parseConstraints($constraint);
+            }
+        }
+
+        if (!$peerDependencies) {
+            return;
+        }
+
+        $manipulator = new JsonManipulator(file_get_contents($this->rootDir.'/package.json'));
+        $content = json_decode($manipulator->getContents(), true);
+        $devDependencies = $content['devDependencies'] ?? [];
+
+        foreach ($peerDependencies as $peerDependency => $constraints) {
+            $devDependencies[$peerDependency] = $this->compactConstraints($constraints);
+        }
+        uksort($devDependencies, 'strnatcmp');
+        $manipulator->addMainKey('devDependencies', $devDependencies);
+
+        file_put_contents($this->rootDir.'/package.json', $manipulator->getContents());
+    }
+
     private function resolveAssetsDir(string $phpPackage)
     {
         foreach (['/assets', '/Resources/assets'] as $subdir) {
@@ -168,4 +205,28 @@ private function resolveAssetsDir(string $phpPackage)
 
         return null;
     }
+
+    /**
+     * @param ConstraintInterface[] $constraints
+     */
+    private function compactConstraints(array $constraints): string
+    {
+        if (method_exists(Intervals::class, 'isSubsetOf')) {
+            foreach ($constraints as $k1 => $constraint1) {
+                foreach ($constraints as $k2 => $constraint2) {
+                    if ($k1 !== $k2 && Intervals::isSubsetOf($constraint1, $constraint2)) {
+                        unset($constraints[$k2]);
+                    }
+                }
+            }
+        }
+
+        uksort($constraints, 'strnatcmp');
+
+        foreach ($constraints as $k => $constraint) {
+            $constraints[$k] = \count($constraints) > 1 && false !== strpos($k, '|') ? '('.$k.')' : $k;
+        }
+
+        return implode(',', $constraints);
+    }
 }

tests/Fixtures/packageJson/vendor/symfony/existing-package/Resources/assets/package.json

@@ -10,5 +10,9 @@
                 }
             }
         }
+    },
+    "peerDependencies": {
+        "@hotcookies": "^1.1|^2",
+        "@hotdogs": "^2"
     }
 }

tests/Fixtures/packageJson/vendor/symfony/new-package/assets/package.json

@@ -10,5 +10,8 @@
             }
         },
         "entrypoints": ["admin.js"]
+    },
+    "peerDependencies": {
+        "@hotcookies": "^1.1"
     }
 }

tests/PackageJsonSynchronizerTest.php

@@ -11,6 +11,7 @@
 
 namespace Symfony\Flex\Tests;
 
+use Composer\Semver\Intervals;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Filesystem\Filesystem;
 use Symfony\Flex\PackageJsonSynchronizer;
@@ -70,6 +71,8 @@ public function testSynchronizeExistingPackage()
             [
                 'name' => 'symfony/fixture',
                 'devDependencies' => [
+                    '@hotcookies' => '^1.1|^2',
+                    '@hotdogs' => '^2',
                     '@symfony/existing-package' => 'file:vendor/symfony/existing-package/Resources/assets',
                     '@symfony/stimulus-bridge' => '^1.0.0',
                     'stimulus' => '^1.1.1',
@@ -111,6 +114,8 @@ public function testSynchronizeNewPackage()
             '{
    "name": "symfony/fixture",
    "devDependencies": {
+      "@hotcookies": "'.(method_exists(Intervals::class, 'isSubsetOf') ? '^1.1' : '^1.1,(^1.1|^2)').'",
+      "@hotdogs": "^2",
       "@symfony/existing-package": "file:vendor/symfony/existing-package/Resources/assets",
       "@symfony/new-package": "file:vendor/symfony/new-package/assets",
       "@symfony/stimulus-bridge": "^1.0.0",
@@ -161,6 +166,8 @@ public function testArrayFormattingHasNotChanged()
             '{
    "name": "symfony/fixture",
    "devDependencies": {
+      "@hotcookies": "^1.1|^2",
+      "@hotdogs": "^2",
       "@symfony/existing-package": "file:vendor/symfony/existing-package/Resources/assets",
       "@symfony/stimulus-bridge": "^1.0.0",
       "stimulus": "^1.1.1"