Skip to content

plugins/yaml-companion: init #3375

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

plugins/yaml-companion: init #3375

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions plugins/by-name/yaml-companion/default.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
{
lib,
config,
...
}:
lib.nixvim.plugins.mkNeovimPlugin {
name = "yaml-companion";
packPathName = "yaml-companion.nvim";
package = "yaml-companion-nvim";

maintainers = [ lib.maintainers.GaetanLepage ];

settingsExample = {
schemas = [
{
name = "Argo CD Application";
uri = "https://raw.githubusercontent.com/datreeio/CRDs-catalog/main/argoproj.io/application_v1alpha1.json";
}
{
name = "SealedSecret";
uri = "https://raw.githubusercontent.com/datreeio/CRDs-catalog/main/bitnami.com/sealedsecret_v1alpha1.json";
}
];
lspconfig = {
settings = {
yaml = {
format.enable = false;
schemaStore = {
enable = false;
url = "";
};
schemas = lib.nixvim.nestedLiteralLua "require('schemastore').yaml.schemas()";
};
};
};
};

callSetup = false;
extraConfig = cfg: {
warnings = lib.nixvim.mkWarnings "plugins.yaml-companion" [
{
when = !config.plugins.lsp.enable;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should support either lsp or plugins.lsp.

See example:

nixvim/plugins/by-name/schemastore/default.nix

Line 132 in 2c0a9ff

cfg.json.enable && !(config.plugins.lsp.servers.jsonls.enable || config.lsp.servers.jsonls.enable);

Note that lsp doesn't have an enable option, so we'd want to check the relevant server is enabled.

For plugins.lsp, we may want to mkDefault the relevant server. This warning may want to check the plugins.lsp.servers enable option too?

message = "This plugin requires the `plugins.lsp.servers.yamlls` module to be enabled.";
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Warning condition is checking plugins.lsp.enable, while the warning message is referencing plugins.lsp.servers.yamlls.

Ideally, we should use "${opt.foo.bar}", as interpolating an actual option will lead to the correctly prefixed option path being used, and it verifies that the option we're referencing actually exists. This is only possible when the option is in in the same level of module eval; i.e. we can't easily reference submodule suboptions.

}
];

plugins = {
lsp.servers.yamlls.extraOptions = lib.nixvim.mkRaw "require('yaml-companion').setup(${lib.nixvim.toLuaObject cfg.settings})";
Comment on lines +47 to +48
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Should this be extraOptions or settings?
  2. We should consider plugins.lsp.servers.yamlls.enable = mkDefault true here
  3. We should also set the (new) lsp.servers.yamlls.settings option


telescope.enabledExtensions = [ "yaml_schema" ];
};
};
}
93 changes: 93 additions & 0 deletions tests/test-sources/plugins/by-name/yaml-companion/default.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
{ lib, pkgs, ... }:
{
empty = {
plugins = {
lsp = {
enable = true;
servers.yamlls.enable = true;
};

yaml-companion.enable = true;
};
};

defaults = {
plugins = {
lsp = {
enable = true;
servers.yamlls.enable = true;
};

yaml-companion = {
enable = true;

settings = {
builtin_matchers = {
kubernetes.enabled = true;
cloud_init.enabled = true;
};
schemas = [ ];
lspconfig = {
flags = {
debounce_text_changes = 150;
};
settings = {
redhat.telemetry.enabled = false;
yaml = {
validate = true;
format.enable = true;
hover = true;
schemaStore = {
enable = true;
url = "https://www.schemastore.org/api/json/catalog.json";
};
schemaDownload.enable = true;
schemas = [ ];
trace.server = "debug";
};
};
};
};
};
};
};

example = {
extraPlugins = [ pkgs.vimPlugins.SchemaStore-nvim ];
plugins = {
lsp = {
enable = true;
servers.yamlls.enable = true;
};

yaml-companion = {
enable = true;

settings = {
schemas = [
{
name = "Argo CD Application";
uri = "https://raw.githubusercontent.com/datreeio/CRDs-catalog/main/argoproj.io/application_v1alpha1.json";
}
{
name = "SealedSecret";
uri = "https://raw.githubusercontent.com/datreeio/CRDs-catalog/main/bitnami.com/sealedsecret_v1alpha1.json";
}
];
lspconfig = {
settings = {
yaml = {
format.enable = false;
schemaStore = {
enable = false;
url = "";
};
schemas = lib.nixvim.mkRaw "require('schemastore').yaml.schemas()";
};
};
};
};
};
};
};
}