chore(*): commenting only at the start of the file

Author: igdmdimitrov

projects/igniteui-angular/migrations/update-13_0_0/index.spec.ts

@@ -201,14 +201,14 @@ describe(`Update to ${version}`, () => {
 `.replace(lineBreaksAndSpaceRegex, ''));
     });
 
-    it('should remove exporter services from module.ts files', async () => {
+    it('should insert a comment when exporter services are present in module.ts files', async () => {
         appTree.create('/testSrc/appPrefix/component/app.module.ts', `
 import { NgModule } from "@angular/core";
 import { FormsModule } from "@angular/forms";
 import { BrowserModule } from "@angular/platform-browser";
 import { BrowserAnimationsModule } from "@angular/platform-browser/animations";
 import { AppComponent } from "./app.component";
-import { IgxExcelExporterService, OtherService } from "igniteui-angular";
+import { IgxCsvExporterService, IgxExcelExporterService } from "igniteui-angular";
 import { ExcelExportComponent } from "./services/export-excel/excel-export.component";
 
 @NgModule({
@@ -222,7 +222,10 @@ imports: [
     BrowserAnimationsModule,
     FormsModule
 ],
-providers: [IgxExcelExporterService , OtherService],
+providers: [
+    IgxCsvExporterService,
+    IgxExcelExporterService
+],
 entryComponents: [],
 schemas: []
 })
@@ -235,14 +238,14 @@ export class AppModule {}
 
         expect(
             tree.readContent('/testSrc/appPrefix/component/app.module.ts')
-        ).toEqual( `
+        ).toEqual(
+`// IgxCsvExporterService and IgxExcelExporterService no longer need to be manually provided and can be safely removed.
 import { NgModule } from "@angular/core";
 import { FormsModule } from "@angular/forms";
 import { BrowserModule } from "@angular/platform-browser";
 import { BrowserAnimationsModule } from "@angular/platform-browser/animations";
 import { AppComponent } from "./app.component";
-// IgxExcelExporterService has been removed. Exporter services can now be used without providing.
-import { /*IgxExcelExporterService,*/ OtherService } from "igniteui-angular";
+import { IgxCsvExporterService, IgxExcelExporterService } from "igniteui-angular";
 import { ExcelExportComponent } from "./services/export-excel/excel-export.component";
 
 @NgModule({
@@ -256,8 +259,10 @@ imports: [
     BrowserAnimationsModule,
     FormsModule
 ],
-// IgxExcelExporterService has been removed. Exporter services can now be used without providing.
-providers: [/*IgxExcelExporterService,*/ OtherService],
+providers: [
+    IgxCsvExporterService,
+    IgxExcelExporterService
+],
 entryComponents: [],
 schemas: []
 })

projects/igniteui-angular/migrations/update-13_0_0/index.ts

@@ -66,30 +66,18 @@ export default (): Rule => (host: Tree, context: SchematicContext) => {
 
     for (const path of moduleTsFiles) {
         let content = host.read(path)?.toString();
+        const servicesInFile = [];
         SERVICES.forEach(service => {
             if (content.indexOf(service) > -1) {
-                const commentedService = '/*' + service + '*/';
-                const commentedServiceWithComa = '/*' + service + ',*/';
-                content = content.replace(new RegExp(service, 'gi'), commentedService);
-                content = content.replace(new RegExp('[/][*]' + service + '[*][/]\\s*[,]', 'gi'), commentedServiceWithComa);
-                const indexes = getIndicesOf('/*' + service, content);
-                indexes.reverse().forEach(index => {
-                    const preceedingContent = content.substring(0, index);
-                    const newLineIndex = preceedingContent.lastIndexOf('\n');
-                    const comment = '// ' + service + ' has been removed. Exporter services can now be used without providing.';
-                    if (newLineIndex > -1) {
-                        const newPreceedingContent =
-                            [preceedingContent.slice(0, newLineIndex), '\n' + comment, preceedingContent.slice(newLineIndex)].join('');
-                        content = content.replace(preceedingContent, newPreceedingContent);
-                    } else {
-                        // service is mentioned on the first row
-                        content = comment + '\n' + content;
-                    }
-                });
-
-                host.overwrite(path, content);
+                servicesInFile.push(service);
             }
         });
+
+        if (servicesInFile.length > 0) {
+            const comment = '// ' + servicesInFile.join(' and ') + ' no longer need to be manually provided and can be safely removed.';
+            content = comment + content;
+            host.overwrite(path, content);
+        }
     }
 
     update.applyChanges();