fix(migrations): avoid duplicating comments when generating properties (#57367)

crisbeto · AndrewKushnir · commit b1a9d0f4de75 · 2024-08-13T09:54:25.000-07:00
Updates the logic that generates new component properties to avoid duplicating their doc strings. PR Close #57367
diff --git a/packages/core/schematics/ng-generate/inject-migration/migration.ts b/packages/core/schematics/ng-generate/inject-migration/migration.ts
@@ -93,9 +93,8 @@ export function migrateFile(sourceFile: ts.SourceFile, options: MigrationOptions
             return;
           }
 
-          const newProperty = ts.factory.updatePropertyDeclaration(
-            property,
-            property.modifiers,
+          const newProperty = ts.factory.createPropertyDeclaration(
+            cloneModifiers(property.modifiers),
             property.name,
             property.questionToken,
             property.type,
diff --git a/packages/core/schematics/test/inject_migration_spec.ts b/packages/core/schematics/test/inject_migration_spec.ts
@@ -1773,5 +1773,40 @@ describe('inject migration', () => {
         `}`,
       ]);
     });
+
+    it('should account for doc strings when inlining initializers', async () => {
+      writeFile(
+        '/dir.ts',
+        [
+          `import { Directive } from '@angular/core';`,
+          `import { Foo } from 'foo';`,
+          ``,
+          `@Directive()`,
+          `class MyDir {`,
+          `  /** Value of Foo */`,
+          `  private value: number;`,
+          ``,
+          `  constructor(private foo: Foo) {`,
+          `    this.value = this.foo.getValue();`,
+          `  }`,
+          `}`,
+        ].join('\n'),
+      );
+
+      await runInternalMigration();
+
+      expect(tree.readContent('/dir.ts').split('\n')).toEqual([
+        `import { Directive, inject } from '@angular/core';`,
+        `import { Foo } from 'foo';`,
+        ``,
+        `@Directive()`,
+        `class MyDir {`,
+        `  private foo = inject(Foo);`,
+        ``,
+        `  /** Value of Foo */`,
+        `  private value: number = this.foo.getValue();`,
+        `}`,
+      ]);
+    });
   });
 });
