Skip global functions for now, and don't create empty files

NumyAddon · Aug 30, 2024 · 45ca03c · 45ca03c
1 parent 107eca9
commit 45ca03c
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -21,6 +21,7 @@ Generated annotations are limited to
    - "methods" for a given mixin
    - inheritence through `CreateFromMixins`
  - Global functions
+   - for now disabled, using Ketho's annotations, and including the wow source as workspace libraries is probably better
 
 prerequisites to run this yourself:
 - PHP 8.3

diff --git a/annotation_branch_readme.md b/annotation_branch_readme.md
@@ -23,3 +23,4 @@ Generated annotations are limited to
     - "methods" for a given mixin
     - inheritence through `CreateFromMixins`
 - Global functions
+  - for now disabled, using Ketho's annotations, and including the wow source as workspace libraries is probably better
diff --git a/src/LuaFileParser.php b/src/LuaFileParser.php
@@ -109,29 +109,33 @@ private function extractFunctions(string $fileContents, array $mixins, ?string $
             }
         }
 
-        // e.g. `function SomeGlobal_Function()`
-        $functionDeclarations = [];
-        preg_match_all(
-            '/^function ([A-Za-z0-9_]+)\s*\([^)]*\)/m',
-            $fileContents,
-            $functionDeclarations,
-            PREG_SET_ORDER | PREG_OFFSET_CAPTURE,
-        );
-        foreach ($functionDeclarations as $match) {
-            $data = $match[0][0] . ' end';
-            if ($linkPrefix) {
-                $lineNr = $this->getLineNrFromOffset($fileContents, $match[0][1]);
-                $data = "--- [Source]($linkPrefix#L$lineNr)\n$data";
-            }
-
-            $functions[$match[1][0]] = $data;
-        }
+// disabled for now
+//        // e.g. `function SomeGlobal_Function()`
+//        $functionDeclarations = [];
+//        preg_match_all(
+//            '/^function ([A-Za-z0-9_]+)\s*\([^)]*\)/m',
+//            $fileContents,
+//            $functionDeclarations,
+//            PREG_SET_ORDER | PREG_OFFSET_CAPTURE,
+//        );
+//        foreach ($functionDeclarations as $match) {
+//            $data = $match[0][0] . ' end';
+//            if ($linkPrefix) {
+//                $lineNr = $this->getLineNrFromOffset($fileContents, $match[0][1]);
+//                $data = "--- [Source]($linkPrefix#L$lineNr)\n$data";
+//            }
+//
+//            $functions[$match[1][0]] = $data;
+//        }
 
         return $functions;
     }
 
     public function writeAnnotationsToFile(string $filename, string $outDir, string $prefixToStrip): void
     {
+        if (empty($this->mixins[$filename]) && empty($this->functions[$filename])) {
+            return;
+        }
         $data = "--- @meta _\n\n";
         $data .= $this->mixins[$filename] ? implode("\n\n", $this->mixins[$filename]) . "\n\n" : '';
         $data .= $this->functions[$filename] ? implode("\n\n", $this->functions[$filename]) . "\n" : '';