From 67bf9013151c4e6a13c91ecf4afd78c863d9e33f Mon Sep 17 00:00:00 2001
From: ddereszkiewicz <dawid.dereszkiewicz28@gmail.com>
Date: Fri, 21 Jun 2024 12:00:05 +0200
Subject: [PATCH] fix(@angular/cli): make `ng update` to keep newline at the
 end of package.json

As stated in https://github.com/angular/angular-cli/issues/11744,
`ng update` command removed the newline at the end of the package.json file.
This commit makes `ng update` to preserve newline, if it was present before running the command.

Fixes #11744

(cherry picked from commit 4947f29cfa8fef0457623966299e3cdf0d3173bc)
---
 .../src/commands/update/schematic/index.ts    | 11 ++--
 .../commands/update/schematic/index_spec.ts   | 53 +++++++++++++++++++
 2 files changed, 59 insertions(+), 5 deletions(-)

diff --git a/packages/angular/cli/src/commands/update/schematic/index.ts b/packages/angular/cli/src/commands/update/schematic/index.ts
index 562a0813f180..9b56ec01d363 100644
--- a/packages/angular/cli/src/commands/update/schematic/index.ts
+++ b/packages/angular/cli/src/commands/update/schematic/index.ts
@@ -263,7 +263,7 @@ function _performUpdate(
   logger: logging.LoggerApi,
   migrateOnly: boolean,
 ): void {
-  const packageJsonContent = tree.read('/package.json');
+  const packageJsonContent = tree.read('/package.json')?.toString();
   if (!packageJsonContent) {
     throw new SchematicsException('Could not find a package.json. Are you in a Node project?');
   }
@@ -310,11 +310,12 @@ function _performUpdate(
       logger.warn(`Package ${name} was not found in dependencies.`);
     }
   });
-
-  const newContent = JSON.stringify(packageJson, null, 2);
-  if (packageJsonContent.toString() != newContent || migrateOnly) {
+  const eofMatches = packageJsonContent.match(/\r?\n$/);
+  const eof = eofMatches?.[0] ?? '';
+  const newContent = JSON.stringify(packageJson, null, 2) + eof;
+  if (packageJsonContent != newContent || migrateOnly) {
     if (!migrateOnly) {
-      tree.overwrite('/package.json', JSON.stringify(packageJson, null, 2));
+      tree.overwrite('/package.json', newContent);
     }
 
     const externalMigrations: {}[] = [];
diff --git a/packages/angular/cli/src/commands/update/schematic/index_spec.ts b/packages/angular/cli/src/commands/update/schematic/index_spec.ts
index 929d8be44fc8..3954e3c78254 100644
--- a/packages/angular/cli/src/commands/update/schematic/index_spec.ts
+++ b/packages/angular/cli/src/commands/update/schematic/index_spec.ts
@@ -282,4 +282,57 @@ describe('@schematics/update', () => {
     expect(hasPeerdepMsg('typescript')).toBeTruthy();
     expect(hasPeerdepMsg('@angular/localize')).toBeFalsy();
   }, 45000);
+
+  it('does not remove newline at the end of package.json', async () => {
+    const newlineStyles = ['\n', '\r\n'];
+    for (const newline of newlineStyles) {
+      const packageJsonContent = `{
+        "name": "blah",
+        "dependencies": {
+          "@angular-devkit-tests/update-base": "1.0.0"
+        }
+      }${newline}`;
+      const inputTree = new UnitTestTree(
+        new HostTree(
+          new virtualFs.test.TestHost({
+            '/package.json': packageJsonContent,
+          }),
+        ),
+      );
+
+      const resultTree = await schematicRunner.runSchematic(
+        'update',
+        { packages: ['@angular-devkit-tests/update-base'] },
+        inputTree,
+      );
+
+      const resultTreeContent = resultTree.readContent('/package.json');
+      expect(resultTreeContent.endsWith(newline)).toBeTrue();
+    }
+  });
+
+  it('does not add a newline at the end of package.json', async () => {
+    const packageJsonContent = `{
+      "name": "blah",
+      "dependencies": {
+        "@angular-devkit-tests/update-base": "1.0.0"
+      }
+    }`;
+    const inputTree = new UnitTestTree(
+      new HostTree(
+        new virtualFs.test.TestHost({
+          '/package.json': packageJsonContent,
+        }),
+      ),
+    );
+
+    const resultTree = await schematicRunner.runSchematic(
+      'update',
+      { packages: ['@angular-devkit-tests/update-base'] },
+      inputTree,
+    );
+
+    const resultTreeContent = resultTree.readContent('/package.json');
+    expect(resultTreeContent.endsWith('}')).toBeTrue();
+  });
 });