1 files changed, 97 insertions, 0 deletions
diff --git a/pkgs/applications/editors/vim/plugins/update.py b/pkgs/applications/editors/vim/plugins/update.py
new file mode 100755
index 00000000000..ad1c38cb375
--- /dev/null
+++ b/pkgs/applications/editors/vim/plugins/update.py
@@ -0,0 +1,97 @@
+#!/usr/bin/env nix-shell
+#!nix-shell update-shell.nix -i python3
+
+
+# format:
+# $ nix run nixpkgs.python3Packages.black -c black update.py
+# type-check:
+# $ nix run nixpkgs.python3Packages.mypy -c mypy update.py
+# linted:
+# $ nix run nixpkgs.python3Packages.flake8 -c flake8 --ignore E501,E265,E402 update.py
+
+# If you see `HTTP Error 429: too many requests` errors while running this script,
+# refer to:
+#
+# https://github.com/NixOS/nixpkgs/blob/master/doc/languages-frameworks/vim.section.md#updating-plugins-in-nixpkgs-updating-plugins-in-nixpkgs
+#
+# (or the equivalent file /doc/languages-frameworks/vim.section.md from Nixpkgs master tree).
+#
+
+import inspect
+import os
+import sys
+import logging
+import textwrap
+from typing import List, Tuple
+from pathlib import Path
+
+log = logging.getLogger()
+log.addHandler(logging.StreamHandler())
+
+# Import plugin update library from maintainers/scripts/pluginupdate.py
+ROOT = Path(os.path.dirname(os.path.abspath(inspect.getfile(inspect.currentframe()))))
+# Ideally, ROOT.(parent^5) points to root of Nixpkgs official tree
+sys.path.insert(0, os.path.join(ROOT.parent.parent.parent.parent.parent, "maintainers", "scripts"))
+import pluginupdate
+
+GET_PLUGINS = f"""(with import <localpkgs> {{}};
+let
+  inherit (vimUtils.override {{inherit vim;}}) buildVimPluginFrom2Nix;
+  generated = callPackage {ROOT}/generated.nix {{
+    inherit buildVimPluginFrom2Nix;
+  }};
+  hasChecksum = value: lib.isAttrs value && lib.hasAttrByPath ["src" "outputHash"] value;
+  getChecksum = name: value:
+    if hasChecksum value then {{
+      submodules = value.src.fetchSubmodules or false;
+      sha256 = value.src.outputHash;
+      rev = value.src.rev;
+    }} else null;
+  checksums = lib.mapAttrs getChecksum generated;
+in lib.filterAttrs (n: v: v != null) checksums)"""
+
+HEADER = (
+    "# This file has been generated by ./pkgs/applications/editors/vim/plugins/update.py. Do not edit!"
+)
+
+
+class VimEditor(pluginupdate.Editor):
+    def generate_nix(self, plugins: List[Tuple[pluginupdate.PluginDesc, pluginupdate.Plugin]], outfile: str):
+        sorted_plugins = sorted(plugins, key=lambda v: v[0].name.lower())
+
+        with open(outfile, "w+") as f:
+            f.write(HEADER)
+            f.write(textwrap.dedent("""
+                { lib, buildVimPluginFrom2Nix, fetchFromGitHub, fetchgit }:
+
+                final: prev:
+                {"""
+            ))
+            for pdesc, plugin in sorted_plugins:
+
+                repo = pdesc.repo
+                src_nix = repo.as_nix(plugin)
+                f.write(
+                    f"""
+  {plugin.normalized_name} = buildVimPluginFrom2Nix {{
+    pname = "{plugin.name}";
+    version = "{plugin.version}";
+    src = {src_nix};
+    meta.homepage = "{repo.uri}";
+  }};
+"""
+                )
+            f.write("\n}\n")
+        print(f"updated {outfile}")
+
+
+
+def main():
+    editor = VimEditor("vim", ROOT, GET_PLUGINS)
+    parser = editor.create_parser()
+    args = parser.parse_args()
+    pluginupdate.update_plugins(editor, args)
+
+
+if __name__ == "__main__":
+    main()