fix(plist): add $delete support

Author: Murat Mehmet

src/__tests__/unit/tasks/pListTask.spec.ts

@@ -212,6 +212,39 @@ describe('pListTask', () => {
       { forth: 'test2' },
     ]);
   });
+  it('should delete value', () => {
+    let content: Record<string, any> = {
+      first: {
+        second: {
+          third: 'test',
+        },
+      },
+    };
+    const task: PlistTaskType = {
+      task: 'plist',
+      actions: [
+        {
+          set: {
+            first: {
+              second: {
+                $delete: true,
+              },
+            },
+          },
+          strategy: 'merge',
+        },
+      ],
+    };
+
+    content = plistTask({
+      configPath: 'path/to/config',
+      task: task,
+      content,
+      packageName: 'test-package',
+    });
+    expect(content.first).toEqual({});
+  });
+
   it('should skip if condition not met', () => {
     let content: Record<string, any> = {
       first: {

src/utils/applyObjectModification.ts

@@ -39,7 +39,13 @@ export function modifyObject(
     }
   } else {
     /* eslint-disable @typescript-eslint/no-unsafe-return */
-    const customizer = function (objValue: any, srcValue: any) {
+    const fieldsToDelete: [Record<string, any>, string][] = [];
+    const customizer = function (
+      objValue: any,
+      srcValue: any,
+      field: string,
+      objParent: Record<string, any>
+    ) {
       if (strategy == 'merge_concat') {
         if (Array.isArray(objValue) && Array.isArray(srcValue)) {
           return objValue.concat(srcValue);
@@ -61,6 +67,10 @@ export function modifyObject(
         delete srcValue.$append;
         return objValue;
       }
+      if (typeof srcValue === 'object' && srcValue.$delete) {
+        fieldsToDelete.push([objParent, field]);
+        return true;
+      }
       if (
         Array.isArray(objValue) &&
         typeof srcValue === 'object' &&
@@ -75,6 +85,7 @@ export function modifyObject(
     };
 
     content = mergeWith(content, modifier, customizer);
+    fieldsToDelete.forEach(([obj, field]) => delete obj[field]);
     /* eslint-enable @typescript-eslint/no-unsafe-return */
   }
   return content;