Create kdoc_check.py

GitHub action test for verifying Kdocs

kdoc_check.py

@@ -0,0 +1,46 @@
+import subprocess
+import re
+
+
+def run_command(command):
+ """Runs a shell command and returns the output."""
+ result = subprocess.run(command, stdout=subprocess.PIPE, shell=True, check=True)
+ return result.stdout.decode('utf-8')
+
+
+def get_changed_files():
+ """Returns a list of changed .kt files in the PR."""
+ files = run_command("git diff --name-only origin/main").splitlines()
+ return [f for f in files if f.endswith('.kt')]
+
+
+def get_file_diff(file_path):
+ """Returns the diff of the given file."""
+ return run_command(f"git diff origin/main -- {file_path}")
+
+
+def check_kdoc_in_function(function):
+ """Checks if a function has an associated KDoc comment."""
+ return re.match(r'\s*/\*\*\n(\s*\*.*\n)+\s*\*/\n\s*fun\s', function)
+
+
+def main():
+ changed_files = get_changed_files()
+ missing_kdoc = False
+
+ for file in changed_files:
+ diff = get_file_diff(file)
+ functions = re.findall(r'(\s*/\*\*.*?fun\s.*?\))', diff, re.DOTALL)
+
+ for function in functions:
+ if not check_kdoc_in_function(function):
+ print(f"Missing KDoc for function in file: {file}")
+ print(function)
+ missing_kdoc = True
+
+ if missing_kdoc:
+ raise Exception("Some functions are missing KDoc comments.")
+
+
+if __name__ == "__main__":
+ main()