Add an option to include raw XML files in the output

Author: Numynum

.github/workflows/live-mix-into-source.yml

@@ -13,3 +13,4 @@ jobs:
       TARGET_BRANCH_SUFFIX: '-mix-into-source'
       FLAVOR: mainline
       MIX_ANNOTATIONS_INTO_SOURCE: true
+      INCLUDE_RAW_XML_SOURCE: true

.github/workflows/template.yml

@@ -35,6 +35,11 @@ on:
         required: false
         default: false
         type: boolean
+      INCLUDE_RAW_XML_SOURCE:
+        description: 'Include raw XML source files'
+        required: false
+        default: false
+        type: boolean
   workflow_call:
     inputs:
       BRANCH:
@@ -62,6 +67,11 @@ on:
         required: false
         default: false
         type: boolean
+      INCLUDE_RAW_XML_SOURCE:
+        description: 'Include raw XML source files'
+        required: false
+        default: false
+        type: boolean
 
 jobs:
   build:
@@ -155,11 +165,14 @@ jobs:
           remote_commit_hash=$(git rev-parse HEAD)
           message="Synced to commit ${remote_commit_hash}"
           cd ..
-          mixAnnotationsIntoSource=""
+          extraArgs=""
           if [[ "${{ inputs.MIX_ANNOTATIONS_INTO_SOURCE }}" == "true" ]]; then
-            mixAnnotationsIntoSource="--mixAnnotationsIntoSource"
+            extraArgs="${extraArgs} --mixAnnotationsIntoSource"
+          fi
+          if [[ "${{ inputs.INCLUDE_RAW_XML_SOURCE }}" == "true" ]]; then
+              extraArgs="${extraArgs} --includeRawXmlSource"
           fi
-          bin/annotate ${flavor} --inputDir=./.wow-ui-source/Interface --outputDir=./.annotations_temp/Annotations --linkPrefix="https://github.com/Gethe/wow-ui-source/blob/${branch_name}/Interface" ${mixAnnotationsIntoSource}
+          bin/annotate ${flavor} --inputDir=./.wow-ui-source/Interface --outputDir=./.annotations_temp/Annotations --linkPrefix="https://github.com/Gethe/wow-ui-source/blob/${branch_name}/Interface" ${extraArgs}
           cd ./.annotations_temp
           git config user.name "GitHub Actions"
           git config user.email [email protected]

bin/annotate

@@ -31,14 +31,16 @@ require_once __DIR__ . '/../vendor/autoload.php';
     ->addOption('outputDir', 'o', InputOption::VALUE_REQUIRED, 'Output directory', './.annotated')
     ->addOption('inputDir', 'i', InputOption::VALUE_REQUIRED, 'Directory containing the files to annotate', '.')
     ->addOption('linkPrefix', 'l', InputOption::VALUE_REQUIRED, 'Prefix for links in the output')
-    ->addOption('mixAnnotationsIntoSource', 'm', InputOption::VALUE_NONE, 'Include all lua source files, and add class annotations to the source files')
+    ->addOption('mixAnnotationsIntoSource', 'm', InputOption::VALUE_NONE, 'Include all Lua source files, and add class annotations to the source files')
+    ->addOption('includeRawXmlSource', 'x', InputOption::VALUE_NONE, 'Include the raw XML source files in the output')
     ->setCode(function (InputInterface $input, ConsoleOutput $output) {
         $io = new SymfonyStyle($input, $output);
 
         $outputDir = $input->getOption('outputDir');
         $inputDir = $input->getOption('inputDir');
         $linkPrefix = $input->getOption('linkPrefix');
         $mixAnnotationsIntoSource = $input->getOption('mixAnnotationsIntoSource');
+        $includeRawXmlSource = $input->getOption('includeRawXmlSource');
         try {
             $flavor = FlavorEnum::from($input->getArgument('flavor'));
         } catch (Throwable) {
@@ -105,6 +107,9 @@ require_once __DIR__ . '/../vendor/autoload.php';
         foreach($fileList as $filePath) {
             if (str_ends_with($filePath, 'xml')) {
                 $xmlFileParser->writeAnnotationsToFile($filePath, $outputDir, $inputDir, $linkPrefix);
+                if ($includeRawXmlSource) {
+                    $xmlFileParser->writeRawXmlToFile($filePath, $outputDir, $inputDir);
+                }
             } elseif (str_ends_with($filePath, 'lua')) {
                 $luaFileParser->writeAnnotationsToFile($filePath, $outputDir, $inputDir);
             }

src/XmlFileParser.php

@@ -165,6 +165,20 @@ public function writeAnnotationsToFile(string $filename, string $outDir, string
         file_put_contents($targetFile, $data);
     }
 
+    public function writeRawXmlToFile(string $filename, string $outDir, string $prefixToStrip): void
+    {
+        $targetFile = $filename;
+        if (str_starts_with($targetFile, $prefixToStrip)) {
+            $targetFile = substr($targetFile, strlen($prefixToStrip));
+        }
+        $targetFile = rtrim($outDir, '/') . '/' . ltrim($targetFile, '/');
+        if (!is_dir(dirname($targetFile))) {
+            mkdir($outDir . '/' . dirname($filename), recursive: true);
+        }
+
+        copy($filename, $targetFile);
+    }
+
     private function childHasInterestingData(Frame $child): bool
     {
         return