plugins/schemastore: init

plugins/default.nix

@@ -103,6 +103,7 @@
     ./lsp/lsp-lines.nix
     ./lsp/lsp-status.nix
     ./lsp/nvim-lightbulb.nix
+    ./lsp/schemastore.nix
     ./lsp/trouble.nix
     ./lsp/wtf.nix
 

plugins/lsp/schemastore.nix

@@ -0,0 +1,164 @@
+{
+  lib,
+  helpers,
+  config,
+  pkgs,
+  ...
+}:
+with lib;
+helpers.vim-plugin.mkVimPlugin config {
+  name = "schemastore";
+  originalName = "SchemaStore.nvim";
+  defaultPackage = pkgs.vimPlugins.SchemaStore-nvim;
+
+  maintainers = [ maintainers.GaetanLepage ];
+
+  extraOptions =
+    let
+      schemaEntry = types.submodule {
+        freeformType = with types; attrsOf anything;
+        options = {
+          name = mkOption {
+            type = with helpers.nixvimTypes; maybeRaw str;
+            description = "The name of the schema.";
+          };
+
+          description = helpers.mkNullOrStr "A description for this schema.";
+
+          fileMatch =
+            helpers.mkNullOrOption (with helpers.nixvimTypes; maybeRaw (either str (listOf (maybeRaw str))))
+              ''
+                Which filename to match against for this schema.
+              '';
+
+          url = mkOption {
+            type = with helpers.nixvimTypes; maybeRaw str;
+            description = "The URL of this schema.";
+          };
+        };
+      };
+
+      schemaOpts = {
+        select = helpers.defaultNullOpts.mkListOf types.str [ ] ''
+          A list of strings representing the names of schemas to select.
+          If this option is not present, all schemas are returned.
+          If it is present, only the selected schemas are returned.
+          `select` and `ignore` are mutually exclusive.
+
+          See the [schema catalog](https://github.com/SchemaStore/schemastore/blob/master/src/api/json/catalog.json).
+        '';
+
+        ignore = helpers.defaultNullOpts.mkListOf types.str [ ] ''
+          A list of strings representing the names of schemas to ignore.
+          `select` and `ignore` are mutually exclusive.
+
+          See the [schema catalog](https://github.com/SchemaStore/schemastore/blob/master/src/api/json/catalog.json).
+        '';
+
+        replace = helpers.defaultNullOpts.mkAttrsOf schemaEntry { } ''
+          An attrs of elements representing schemas to replace with a custom schema.
+
+          The string key is the name of the schema to replace, the table value is the schema definition.
+          If a schema with the given name isn't found, the custom schema will not be returned.
+        '';
+
+        extra = helpers.defaultNullOpts.mkListOf schemaEntry [ ] ''
+          Additional schemas to include.
+        '';
+      };
+    in
+    {
+      json = {
+        enable = mkOption {
+          type = types.bool;
+          default = true;
+          example = false;
+          description = "Whether to enable the json schemas in jsonls.";
+        };
+
+        settings = helpers.mkSettingsOption {
+          options = schemaOpts;
+          description = "Options supplied to the `require('schemastore').json.schemas` function.";
+          example = {
+            replace."package.json" = {
+              description = "package.json overridden";
+              fileMatch = [ "package.json" ];
+              name = "package.json";
+              url = "https://example.com/package.json";
+            };
+            extra = [
+              {
+                description = "My custom JSON schema";
+                fileMatch = "foo.json";
+                name = "foo.json";
+                url = "https://example.com/schema/foo.json";
+              }
+              {
+                description = "My other custom JSON schema";
+                fileMatch = [
+                  "bar.json"
+                  ".baar.json"
+                ];
+                name = "bar.json";
+                url = "https://example.com/schema/bar.json";
+              }
+            ];
+          };
+        };
+      };
+
+      yaml = {
+        enable = mkOption {
+          type = types.bool;
+          default = true;
+          example = false;
+          description = "Whether to enable the yaml schemas in yamlls.";
+        };
+
+        settings = helpers.mkSettingsOption {
+          options = schemaOpts;
+          description = "Options supplied to the `require('schemastore').yaml.schemas` function.";
+        };
+      };
+    };
+
+  extraConfig = cfg: {
+    warnings =
+      (optional (!(cfg.json.enable || cfg.yaml.enable)) ''
+        NixVim(plugins.schemastore): you have enabled the plugin, but neither `json` or `yaml` schemas are enabled.
+      '')
+      ++ (optional (!(cfg.json.enable -> config.plugins.lsp.servers.jsonls.enable)) ''
+        NixVim(plugins.schemastore): you have enabled `json` schemas, but `plugins.lsp.servers.jsonls` is not enabled.
+      '')
+      ++ (optional (!(cfg.yaml.enable -> config.plugins.lsp.servers.yamlls.enable)) ''
+        NixVim(plugins.schemastore): you have enabled `yaml` schemas, but `plugins.lsp.servers.yamlls` is not enabled.
+      '');
+
+    plugins.lsp.servers = {
+      jsonls.settings = mkIf cfg.json.enable {
+        schemas.__raw = ''
+          require('schemastore').json.schemas({${helpers.toLuaObject cfg.json.settings}})
+        '';
+
+        # The plugin recommends to enable this option in its README.
+        # Learn more: https://github.com/b0o/SchemaStore.nvim/issues/8
+        validate = mkDefault true;
+      };
+
+      yamlls.settings = mkIf cfg.yaml.enable {
+        schemaStore = {
+          # From the README: "You must disable built-in schemaStore support if you want to use
+          # this plugin and its advanced options like `ignore`."
+          enable = mkDefault false;
+
+          # From the README: "Avoid TypeError: Cannot read properties of undefined (reading 'length')"
+          url = mkDefault "";
+        };
+
+        schemas.__raw = ''
+          require('schemastore').yaml.schemas({${helpers.toLuaObject cfg.yaml.settings}})
+        '';
+      };
+    };
+  };
+}

tests/test-sources/plugins/lsp/schemastore.nix

@@ -0,0 +1,93 @@
+{
+  empty = {
+    plugins.schemastore.enable = true;
+  };
+
+  example = {
+    plugins = {
+      lsp = {
+        enable = true;
+
+        servers = {
+          jsonls.enable = true;
+          yamlls.enable = true;
+        };
+      };
+
+      schemastore = {
+        enable = true;
+
+        json = {
+          enable = true;
+          settings = {
+            replace."package.json" = {
+              description = "package.json overridden";
+              fileMatch = [ "package.json" ];
+              name = "package.json";
+              url = "https://example.com/package.json";
+            };
+            extra = [
+              {
+                description = "My custom JSON schema";
+                fileMatch = "foo.json";
+                name = "foo.json";
+                url = "https://example.com/schema/foo.json";
+              }
+              {
+                description = "My other custom JSON schema";
+                fileMatch = [
+                  "bar.json"
+                  ".baar.json"
+                ];
+                name = "bar.json";
+                url = "https://example.com/schema/bar.json";
+              }
+            ];
+          };
+        };
+        yaml = {
+          enable = true;
+          settings = { };
+        };
+      };
+    };
+  };
+
+  withJson = {
+    plugins = {
+      lsp = {
+        enable = true;
+        servers.jsonls.enable = true;
+      };
+
+      schemastore = {
+        enable = true;
+
+        json = {
+          enable = true;
+          settings = { };
+        };
+        yaml.enable = false;
+      };
+    };
+  };
+
+  withYaml = {
+    plugins = {
+      lsp = {
+        enable = true;
+        servers.yamlls.enable = true;
+      };
+
+      schemastore = {
+        enable = true;
+
+        json.enable = false;
+        yaml = {
+          enable = true;
+          settings = { };
+        };
+      };
+    };
+  };
+}