bug #736 Fix NPM package sorting algorithm and encoding (tgalopin)

This PR was merged into the 1.9-dev branch.

Discussion
----------

Fix NPM package sorting algorithm and encoding

Commits
-------

22bfd14 Fix NPM package sorting algorithm and encoding

Author: tgalopin

src/PackageJsonSynchronizer.php

@@ -63,15 +63,6 @@ private function removePackageJsonLinks(array $packageJson)
         }
     }
 
-    private static function sortPackages(JsonManipulator $manipulator, $subNode)
-    {
-        $content = json_decode($manipulator->getContents(), true);
-        $subNodeContent = $content[$subNode];
-        ksort($subNodeContent);
-
-        return json_encode([$subNode => $subNodeContent]);
-    }
-
     private function addPackageJsonLink(string $phpPackage)
     {
         if (!$assetsDir = $this->resolveAssetsDir($phpPackage)) {
@@ -80,7 +71,14 @@ private function addPackageJsonLink(string $phpPackage)
 
         $manipulator = new JsonManipulator(file_get_contents($this->rootDir.'/package.json'));
         $manipulator->addSubNode('devDependencies', '@'.$phpPackage, 'file:vendor/'.$phpPackage.$assetsDir);
-        file_put_contents($this->rootDir.'/package.json', self::sortPackages($manipulator, 'devDependencies'));
+
+        $content = json_decode($manipulator->getContents(), true);
+
+        $devDependencies = $content['devDependencies'];
+        uksort($devDependencies, 'strnatcmp');
+        $content['devDependencies'] = $devDependencies;
+
+        file_put_contents($this->rootDir.'/package.json', $manipulator->format($content, -1));
     }
 
     private function registerWebpackResources(array $phpPackages)

tests/Fixtures/packageJson/package.json

@@ -1,7 +1,8 @@
 {
-    "devDependencies": {
-        "@symfony/stimulus-bridge": "^1.0.0",
-        "stimulus": "^1.1.1",
-        "@symfony/existing-package": "file:vendor/symfony/existing-package/Resources/assets"
-    }
+   "name": "symfony/fixture",
+   "devDependencies": {
+      "@symfony/stimulus-bridge": "^1.0.0",
+      "stimulus": "^1.1.1",
+      "@symfony/existing-package": "file:vendor/symfony/existing-package/Resources/assets"
+   }
 }

tests/PackageJsonSynchronizerTest.php

@@ -40,6 +40,7 @@ public function testSynchronizeNoPackage()
         // Should remove existing package references as it has been removed from the lock
         $this->assertSame(
             [
+                'name' => 'symfony/fixture',
                 'devDependencies' => [
                     '@symfony/stimulus-bridge' => '^1.0.0',
                     'stimulus' => '^1.1.1',
@@ -64,6 +65,7 @@ public function testSynchronizeExistingPackage()
         // Should keep existing package references and config
         $this->assertSame(
             [
+                'name' => 'symfony/fixture',
                 'devDependencies' => [
                     '@symfony/existing-package' => 'file:vendor/symfony/existing-package/Resources/assets',
                     '@symfony/stimulus-bridge' => '^1.0.0',
@@ -98,17 +100,18 @@ public function testSynchronizeNewPackage()
     {
         $this->synchronizer->synchronize(['symfony/existing-package', 'symfony/new-package']);
 
-        // Should keep existing package references and config and add the new package
+        // Should keep existing package references and config and add the new package, while keeping the formatting
         $this->assertSame(
-            [
-                'devDependencies' => [
-                    '@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',
-                    'stimulus' => '^1.1.1',
-                ],
-            ],
-            json_decode(file_get_contents($this->tempDir.'/package.json'), true)
+            '{
+   "name": "symfony/fixture",
+   "devDependencies": {
+      "@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",
+      "stimulus": "^1.1.1"
+   }
+}',
+            file_get_contents($this->tempDir.'/package.json')
         );
 
         $this->assertSame(