add

Author: jjw24

ci/src/_utils.py

@@ -5,6 +5,9 @@
 import re
 import os
 
+# If adding a third-party library here, check CI workflows Python files
+# that are dependant on this and require pip install.
+
 # path
 utils_path = Path(__file__).resolve()
 
@@ -51,6 +54,10 @@ def plugin_reader() -> P:
 
     return manifests
 
+def save_plugins_json_file(content: list[dict[str]]) -> None:
+    with open("plugins.json", "w", encoding="utf-8") as f:
+        json.dump(content, f, indent=4, ensure_ascii=False)
+
 def get_plugin_file_paths() -> list[str]:
     return [os.path.join(plugin_dir, filename) for filename in get_plugin_filenames()]
 
@@ -66,7 +73,7 @@ def plugin_writer(content: P):
     for plugin in content:
         with open(plugin_dir / f"{plugin[plugin_name]}-{plugin[id_name]}.json", "w", encoding="utf-8") as f:
             json.dump(plugin, f, indent=4)
-        
+
 def etags_writer(content: ETagsType):
     with open(etag_file, "w", encoding="utf-8") as f:
         json.dump(content, f, indent=4)
@@ -100,3 +107,18 @@ def get_file_plugins_json_info(required_key: str = "") -> list[dict[str, str]]:
         return data
 
     return [{required_key: plugin[required_key]} for plugin in data]
+
+def get_new_plugin_submission_ids() -> list[str]:
+    plugins_json_ids = [item["ID"] for item in get_file_plugins_json_info("ID")]
+    existing_plugin_file_ids = [info["ID"] for info in plugin_reader()]
+
+    new_ids = []
+
+    for id in existing_plugin_file_ids:
+        # plugins.json would not contain new submission's ID.
+        if id in plugins_json_ids:
+            continue
+
+        new_ids.append(id)
+
+    return new_ids

ci/src/merge-manifest.py

@@ -1,15 +1,18 @@
-import glob
-import json
+import sys
+from _utils import get_new_plugin_submission_ids, plugin_reader, save_plugins_json_file
 
-if __name__ == "__main__":
-    plugins = sorted(glob.glob("plugins/*.json"))
+def get_all_plugins() -> list[dict[str]]:
+    return plugin_reader()
+
+def get_new_plugins() -> list[dict[str]]:
+    ids = get_new_plugin_submission_ids()
+    plugins_from_plugins_dir = plugin_reader()
 
-    manifests = []
+    return [plugins_from_plugins_dir[id] for id in ids]
 
-    for plugin in plugins:
-        with open(plugin, "r", encoding="utf-8") as f:
-            manifest = json.load(f)
-            manifests.append(manifest)
 
-    with open("plugins.json", "w", encoding="utf-8") as f:
-        json.dump(manifests, f, indent=4, ensure_ascii=False)
+if __name__ == "__main__":
+    if len(sys.argv) > 1 and str(sys.argv[1]) == "new-only":
+        save_plugins_json_file(get_new_plugins())
+    else:
+        save_plugins_json_file(get_all_plugins())

ci/src/validator.py

@@ -1,8 +1,8 @@
 # -*-coding: utf-8 -*-
 import uuid
 
-from _utils import (check_url, clean, get_file_plugins_json_info, get_plugin_file_paths, get_plugin_filenames,
-                    icon_path, id_name, language_list, language_name, plugin_reader)
+from _utils import (check_url, clean, get_plugin_file_paths, get_plugin_filenames,
+                    icon_path, id_name, language_list, language_name, plugin_reader, get_new_plugin_submission_ids)
 
 plugin_infos = plugin_reader()
 
@@ -40,14 +40,7 @@ def test_file_name_construct():
         ), f"Plugin {info['Name']} with ID {info['ID']} does not have the correct filename. Make sure it's name + ID, i.e. {info['Name']}-{info['ID']}.json"
 
 def test_submitted_plugin_id_is_valid_uuid():
-    plugins_json_ids = [item["ID"] for item in get_file_plugins_json_info("ID")]
-    existing_plugin_file_ids = [info["ID"] for info in plugin_infos]
-
-    for id in existing_plugin_file_ids:
-        # plugins.json would not contain new submission's ID.
-        if id in plugins_json_ids:
-            continue
-
+    for id in get_new_plugin_submission_ids():
         try:
             uuid.UUID(id, version=4)
             outcome = True