Add create_if_missing option to add-lines configurator

This option allows specifying YAML content that should be created
when the target is not found in the file. The content is appended
to the file followed by the regular content.

Example usage:
{
    "add-lines": [{
        "file": "config/packages/ai.yaml",
        "position": "after_target",
        "target": "    store:",
        "create_if_missing": "ai:\n    store:",
        "content": "        azuresearch:\n            ..."
    }]
}

Author: OskarStark

src/Configurator/AddLinesConfigurator.php

@@ -129,8 +129,9 @@ public function executeConfigure(Recipe $recipe, $config): void
                 continue;
             }
             $target = isset($patch['target']) ? $patch['target'] : null;
+            $createIfMissing = isset($patch['create_if_missing']) ? $patch['create_if_missing'] : null;
 
-            $newContents = $this->getPatchedContents($file, $content, $position, $target, $warnIfMissing);
+            $newContents = $this->getPatchedContents($file, $content, $position, $target, $warnIfMissing, $createIfMissing);
             $this->fileContents[$file] = $newContents;
         }
     }
@@ -164,7 +165,7 @@ public function executeUnconfigure(Recipe $recipe, $config): void
         }
     }
 
-    private function getPatchedContents(string $file, string $value, string $position, ?string $target, bool $warnIfMissing): string
+    private function getPatchedContents(string $file, string $value, string $position, ?string $target, bool $warnIfMissing, ?string $createIfMissing = null): string
     {
         $fileContents = $this->readFile($file);
 
@@ -192,6 +193,15 @@ private function getPatchedContents(string $file, string $value, string $positio
                         break;
                     }
                 }
+
+                if (!$targetFound && null !== $createIfMissing) {
+                    // Insert the create_if_missing content at the end of the file, then add the value after the target
+                    $createIfMissingLines = explode("\n", $createIfMissing);
+                    $lines = array_merge($lines, $createIfMissingLines);
+                    $lines[] = $value;
+                    $targetFound = true;
+                }
+
                 $fileContents = implode("\n", $lines);
 
                 if (!$targetFound) {

tests/Configurator/AddLinesConfiguratorTest.php

@@ -198,6 +198,46 @@ public function testSkippedIfTargetCannotBeFound()
         $this->assertSame($originalContent, $this->readFile('webpack.config.js'));
     }
 
+    public function testCreateIfMissingWithExistingTarget()
+    {
+        $this->copyFixture('ai_with_store.yaml', 'config/packages/ai.yaml');
+
+        $this->runConfigure([
+            [
+                'file' => 'config/packages/ai.yaml',
+                'position' => 'after_target',
+                'target' => '    store:',
+                'create_if_missing' => "ai:\n    store:",
+                'content' => "        azuresearch:\n            default:\n                endpoint: '%env(AZURE_SEARCH_ENDPOINT)%'",
+            ],
+        ]);
+
+        $this->assertSame(
+            $this->loadFixture('ai_with_store_expected.yaml'),
+            $this->readFile('config/packages/ai.yaml')
+        );
+    }
+
+    public function testCreateIfMissingNotUsedWhenTargetNotSet()
+    {
+        $this->copyFixture('no_ai_key.yaml', 'config/packages/ai.yaml');
+
+        $this->runConfigure([
+            [
+                'file' => 'config/packages/ai.yaml',
+                'position' => 'after_target',
+                'target' => '    store:',
+                'content' => "        azuresearch:\n            default:\n                endpoint: '%env(AZURE_SEARCH_ENDPOINT)%'",
+            ],
+        ]);
+
+        // Content should remain unchanged since target was not found and no create_if_missing was provided
+        $this->assertSame(
+            $this->loadFixture('no_ai_key.yaml'),
+            $this->readFile('config/packages/ai.yaml')
+        );
+    }
+
     public function testPatchIgnoredIfValueAlreadyExists()
     {
         $originalContents = <<<JS
@@ -677,6 +717,16 @@ private function readFile(string $filename): string
         return file_get_contents(FLEX_TEST_DIR.'/'.$filename);
     }
 
+    private function loadFixture(string $filename): string
+    {
+        return rtrim(file_get_contents(__DIR__.'/Fixtures/AddLines/'.$filename), "\n");
+    }
+
+    private function copyFixture(string $fixtureName, string $targetPath): void
+    {
+        $this->saveFile($targetPath, $this->loadFixture($fixtureName));
+    }
+
     private function createComposerMockWithPackagesInstalled(array $packages)
     {
         $packages = array_map(fn ($package) => explode(':', $package), $packages);

tests/Configurator/Fixtures/AddLines/ai_with_store.yaml

@@ -0,0 +1,5 @@
+ai:
+    store:
+        pinecone:
+            default:
+                api_key: 'xxx'

tests/Configurator/Fixtures/AddLines/ai_with_store_expected.yaml

@@ -0,0 +1,8 @@
+ai:
+    store:
+        azuresearch:
+            default:
+                endpoint: '%env(AZURE_SEARCH_ENDPOINT)%'
+        pinecone:
+            default:
+                api_key: 'xxx'

tests/Configurator/Fixtures/AddLines/no_ai_key.yaml

@@ -0,0 +1,2 @@
+framework:
+    secret: '%env(APP_SECRET)%'