Merge branch 'main' into main

Author: Jack251970

.github/workflows/pr_assignee.yml

@@ -0,0 +1,17 @@
+name: Assign PR to creator
+
+on:
+  pull_request_target:
+    types: [opened]
+    branches-ignore:
+      - l10n_dev
+
+permissions:
+  pull-requests: write
+
+jobs:
+  automation:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Assign PR to creator
+      uses: toshimaru/auto-author-assign@v3.0.1

README.md

@@ -35,17 +35,23 @@ Looking for a list of currently available plugins in Flow? Visit [here](https://
      "IcoPath": "Plugin icon image's CDN URL, e.g. https://cdn.jsdelivr.net/gh/Flow-Launcher/Flow.Launcher.Plugin.HelloWorldPython@main/Images/app.png"
    }
    ```
-5. Optionally, a plugin can also have the "MinimumAppVersion" property set, restricting it to only appear and be installable on versions of Flow Launcher that meet or exceed the specified version number. For example, setting `"MinimumAppVersion": "2.0.0"` ensures the plugin will not show up or be installable on any Flow Launcher version older than 2.0.0.
+5. Optionally, a plugin can also have the `MinimumAppVersion` property set, restricting it to only appear and be installable on versions of Flow Launcher that meet or exceed the specified version number. For example, setting `"MinimumAppVersion": "2.0.0"` ensures the plugin will not show up or be installable on any Flow Launcher version older than 2.0.0.
 6. For `IcoPath`, use a CDN provider for global accessibility. [jsdelivr.com](https://www.jsdelivr.com/) for example as shown above, works well with GitHub repositories.
 7. It is a requirement to set up a GitHub Actions workflow for automated build and release. Follow the guide [here](https://www.flowlauncher.com/docs/#/py-setup-project?id=_1-add-github-workflow) and use [this](https://github.com/Flow-Launcher/Flow.Launcher.Plugin.HelloWorldPython/blob/main/.github/workflows/Publish%20Release.yml) as an example.
 8. It is a requirement that your plugin conforms with the [Plugin Store policy](#plugin-store-policy).
-9. Submit a pull request.
+9. Submit a pull request targeting the default branch.
 10. The plugin will be available in Flow after the pull request is approved by the Flow Launcher Team.
 
 Flow downloads the manifest (plugins.json) file from various CDN providers, which means the availability of your new plugin depends on when these providers sync their updated files. This syncing process can take several days and sometimes up to a week across all providers. During this period, you may see intermittent updates for your plugin in the manifest, as the provider chosen for retrieval is selected randomly based on the fastest fetch speed.
 
 While the plugin has not yet appeared in the store, you and your users can manually install it using `pm install <url/local path>`.
 
+## How to remove your plugin
+
+1. Remove the `${name}-${uuid}.json` file for your plugin from the [plugins](https://github.com/Flow-Launcher/Flow.Launcher.PluginsManifest/tree/main/plugins) directory.
+2. Submit a pull request targeting the default branch.
+
+Note that the published `plugins.json` manifest is regenerated by CI on a schedule (approximately every three hours) and then distributed via multiple CDN providers. As a result, your removed plugin may continue to appear in the plugin store or manifest for some time after your pull request has been merged, until all providers have refreshed their caches.
 ## Plugin updates
 
 Every three hours the *CI* in this repository will check for new updates from plugins and automatically update them to the latest version.

ci/src/_utils.py

@@ -46,9 +46,31 @@
 description = "Description"
 plugin_name = "Name"
 github_url = "https://github.com"
+tested = "Tested"
 release_date = "LatestReleaseDate"
 date_added = "DateAdded"
 website = "Website"
+minimum_app_version = "MinimumAppVersion"
+
+necessary_fields = (
+    id_name,
+    plugin_name,
+    description,
+    author,
+    version,
+    language_name,
+    website,
+    url_download,
+    url_sourcecode,
+    icon_path,
+)
+
+optional_fields = (
+    minimum_app_version,
+    tested,
+    release_date,
+    date_added
+)
 
 # typing
 PluginType = Dict[str, str]
@@ -59,6 +81,22 @@
 ETagsType = Dict[str, str]
 
 
+def _raise_on_duplicate_keys(pairs):
+    seen = set()
+    duplicates = set()
+    result = {}
+    for key, value in pairs:
+        if key in seen:
+            duplicates.add(key)
+        else:
+            seen.add(key)
+            result[key] = value
+    if duplicates:
+        sorted_duplicates = sorted(duplicates)
+        raise ValueError(f"Duplicate keys found: {sorted_duplicates}")
+    return result
+
+
 def plugin_reader() -> P:
     plugin_file_paths = get_plugin_file_paths()
 

ci/src/validator.py

@@ -1,8 +1,10 @@
 # -*-coding: utf-8 -*-
+import json
 import uuid
 
 from _utils import (check_url, clean, get_new_plugin_submission_ids, get_plugin_file_paths, get_plugin_filenames,
-                    icon_path, id_name, language_list, language_name, plugin_reader, github_download_url_regex, url_download)
+                    icon_path, id_name, language_list, language_name, plugin_reader, github_download_url_regex,
+                    url_download, necessary_fields, optional_fields, _raise_on_duplicate_keys, plugin_name)
 
 plugin_infos = plugin_reader()
 
@@ -39,8 +41,8 @@ def test_file_name_construct():
     filenames = get_plugin_filenames()
     for info in plugin_infos:
         assert (
-            f"{info['Name']}-{info['ID']}.json" in filenames
-        ), 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"
+            f"{info[plugin_name]}-{info[id_name]}.json" in filenames
+        ), f"Plugin {info[plugin_name]} with ID {info[id_name]} does not have the correct filename. Make sure it's name + ID, i.e. {info[plugin_name]}-{info[id_name]}.json"
 
 
 def test_submitted_plugin_id_is_valid_uuid():
@@ -53,6 +55,29 @@ def test_submitted_plugin_id_is_valid_uuid():
 
         assert outcome is True, f"The submission plugin ID {id} is not a valid v4 UUID"
 
+
 def test_valid_download_url():
     for info in plugin_infos:
-        assert github_download_url_regex.fullmatch(info[url_download]), f" The plugin {info['Name']}-{info['ID']} does not have a valid download url: {info[url_download]}"
+        assert github_download_url_regex.fullmatch(info[url_download]), f"The plugin {info[plugin_name]} with ID {info[id_name]} does not have a valid download url: {info[url_download]}"
+
+
+def test_necessary_fields():
+    for info in plugin_infos:
+        missing_fields = [field for field in necessary_fields if field not in info]
+        assert not missing_fields, f"Plugin {info[plugin_name]} with ID {info[id_name]} is missing fields: {missing_fields}"
+
+
+def test_optional_fields():
+    allowed_fields = set(necessary_fields) | set(optional_fields)
+    for info in plugin_infos:
+        unknown_fields = [field for field in info if field not in allowed_fields]
+        assert not unknown_fields, f"Plugin {info[plugin_name]} with ID {info[id_name]} has unknown fields: {unknown_fields}"
+
+
+def test_no_duplicate_fields():
+    for file_path in get_plugin_file_paths():
+        with open(file_path, "r", encoding="utf-8") as f:
+            try:
+                json.load(f, object_pairs_hook=_raise_on_duplicate_keys)
+            except ValueError as e:
+                assert False, f"Plugin file {file_path} has {e}"