mirror/nix-community.nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-07-21 11:14:40 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

plugins/rest: move to by-name again

Browse source
This commit is contained in:
Austin Horstman 2024-10-06 09:35:47 -05:00
parent d42c804ad5
commit 31acdd4b66
No known key found for this signature in database
3 changed files with 0 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

443
plugins/by-name/rest/default.nix Normal file
View file

@ -0,0 +1,443 @@
{
config,
lib,
pkgs,
...
}:
let
inherit (lib) mkRemovedOptionModule mkRenamedOptionModule types;
inherit (lib.nixvim) defaultNullOpts;
in
lib.nixvim.neovim-plugin.mkNeovimPlugin {
name = "rest";
originalName = "rest.nvim";
luaName = "rest-nvim";
package = "rest-nvim";
maintainers = [ lib.maintainers.GaetanLepage ];
# TODO introduced 2024-04-07: remove 2024-06-07
deprecateExtraOptions = true;
optionsRenamedToSettings = [
"envFile"
"encodeUrl"
"skipSslVerification"
"customDynamicVariables"
[
"highlight"
"timeout"
]
];
imports =
let
basePluginPath = [
"plugins"
"rest"
];
settingsPath = basePluginPath ++ [ "settings" ];
in
[
(mkRenamedOptionModule (basePluginPath ++ [ "resultSplitHorizontal" ]) (
settingsPath
++ [
"result"
"split"
"horizontal"
]
))
(mkRenamedOptionModule (basePluginPath ++ [ "resultSplitInPlace" ]) (
settingsPath
++ [
"result"
"split"
"in_place"
]
))
(mkRenamedOptionModule (basePluginPath ++ [ "stayInCurrentWindowAfterSplit" ]) (
settingsPath
++ [
"result"
"split"
"stay_in_current_window_after_split"
]
))
(mkRenamedOptionModule
(
basePluginPath
++ [
"result"
"showUrl"
]
)
(
settingsPath
++ [
"result"
"behavior"
"show_info"
"url"
]
)
)
(mkRenamedOptionModule
(
basePluginPath
++ [
"result"
"showHeaders"
]
)
(
settingsPath
++ [
"result"
"behavior"
"show_info"
"headers"
]
)
)
(mkRenamedOptionModule
(
basePluginPath
++ [
"result"
"showHttpInfo"
]
)
(
settingsPath
++ [
"result"
"behavior"
"show_info"
"http_info"
]
)
)
(mkRenamedOptionModule
(
basePluginPath
++ [
"result"
"showCurlCommand"
]
)
(
settingsPath
++ [
"result"
"behavior"
"show_info"
"curl_command"
]
)
)
(mkRemovedOptionModule
(
basePluginPath
++ [
"result"
"showStatistics"
]
)
''
Use `plugins.rest.settings.result.behavior.statistics.{enable,stats}` instead.
Refer to the documentation for more information.
''
)
(mkRenamedOptionModule
(
basePluginPath
++ [
"result"
"formatters"
]
)
(
settingsPath
++ [
"result"
"behavior"
"formatters"
]
)
)
(mkRenamedOptionModule
(
basePluginPath
++ [
"highlight"
"enabled"
]
)
(
settingsPath
++ [
"highlight"
"enable"
]
)
)
(mkRemovedOptionModule (basePluginPath ++ [ "jumpToRequest" ]) ''
This option has been deprecated upstream.
'')
(mkRemovedOptionModule (basePluginPath ++ [ "yankDryRun" ]) ''
This option has been deprecated upstream.
'')
(mkRemovedOptionModule (basePluginPath ++ [ "searchBack" ]) ''
This option has been deprecated upstream.
'')
];
settingsOptions = {
custom_dynamic_variables = lib.mkOption {
type = with types; nullOr (maybeRaw (attrsOf strLuaFn));
default = null;
example = {
"$timestamp" = "os.time";
"$randomInt" = ''
function()
return math.random(0, 1000)
end
'';
};
description = ''
Custom dynamic variables. Keys are variable names and values are lua functions.
default: `{}`
'';
};
request = {
skip_ssl_verification = defaultNullOpts.mkBool false ''
Skip SSL verification, useful for unknown certificates.
'';
hooks = {
encode_url = defaultNullOpts.mkBool true ''
Encode URL before making request.
'';
user_agent = defaultNullOpts.mkStr (lib.nixvim.mkRaw ''"rest.nvim v" .. require("rest-nvim.api").VERSION'') ''
Set `User-Agent` header when it is empty.
'';
set_content_type = defaultNullOpts.mkBool true ''
Set `Content-Type` header when it is empty and body is provided.
'';
};
};
response = {
hooks = {
decode_url = defaultNullOpts.mkBool true ''
Encode URL before making request.
'';
format = defaultNullOpts.mkBool true ''
Format the response body using `gq` command.
'';
};
};
clients = defaultNullOpts.mkAttrsOf types.anything {
curl = {
statistics = [
{
id = "time_total";
winbar = "take";
title = "Time taken";
}
{
id = "size_download";
winbar = "size";
title = "Download size";
}
];
opts = {
set_compressed = false;
};
};
} ''Table of client configurations.'';
cookies = {
enable = defaultNullOpts.mkBool true ''
Whether to enable cookies support or not.
'';
path = defaultNullOpts.mkStr (lib.nixvim.mkRaw ''vim.fs.joinpath(vim.fn.stdpath("data") --[[@as string]], "rest-nvim.cookies")'') ''
Environment variables file pattern for `telescope.nvim`.
'';
};
env = {
enable = defaultNullOpts.mkBool true ''
Whether to enable env file support or not.
'';
pattern = defaultNullOpts.mkStr "\\.env$" ''
Environment variables file pattern for `telescope.nvim`.
'';
};
highlight = {
enable = defaultNullOpts.mkBool true ''
Whether current request highlighting is enabled or not.
'';
timeout = defaultNullOpts.mkUnsignedInt 750 ''
Duration time of the request highlighting in milliseconds.
'';
};
_log_level = defaultNullOpts.mkNullableWithRaw types.logLevel "warn" ''
The logging level name, see `:h vim.log.levels`.
'';
keybinds =
defaultNullOpts.mkListOf (with types; listOf str)
[
[
"<localleader>rr"
"<cmd>Rest run<cr>"
"Run request under the cursor"
]
[
"<localleader>rl"
"<cmd>Rest run last<cr>"
"Re-run latest request"
]
]
''
Declare some keybindings.
Format: list of 3 strings lists: key, action and description.
'';
};
settingsExample = {
request = {
skip_ssl_verification = true;
};
response = {
hooks = {
format = false;
};
};
clients = {
curl = {
opts = {
set_compressed = true;
};
};
};
cookies = {
enable = false;
};
env = {
enable = false;
};
ui = {
winbar = false;
};
_log_level = "info";
};
extraOptions = {
curlPackage = lib.mkPackageOption pkgs "curl" {
nullable = true;
};
enableHttpFiletypeAssociation = lib.mkOption {
type = types.bool;
default = true;
description = ''
Sets up the filetype association of `.http` files to trigger treesitter support to enable `rest` functionality.
'';
};
enableTelescope = lib.mkEnableOption "telescope integration";
};
# NOTE: plugin uses globals table for configuration
callSetup = false;
extraConfig = cfg: {
assertions = [
{
assertion = config.plugins.treesitter.enable;
message = ''
Nixvim (plugins.rest): Requires the `http` parser from `plugins.treesitter`, please set `plugins.treesitter.enable`.
'';
}
{
assertion = cfg.enableTelescope -> config.plugins.telescope.enable;
message = ''
Nixvim (plugins.rest): You have `plugins.rest.enableTelescope` set to true, but `plugins.telescope.enable` is false.
Either disable the telescope integration or enable telescope.
'';
}
];
# TODO: introduced 2024-09-23: remove after 24.11
warnings =
let
definedOpts = lib.filter (opt: lib.hasAttrByPath (lib.toList opt) cfg.settings) [
"client"
"env_file"
"env_pattern"
"env_edit_command"
"encode_url"
"skip_ssl_verification"
[
"logs"
"level"
]
[
"logs"
"save"
]
[
"result"
"split"
]
[
"result"
"behavior"
]
[
"result"
"statistics"
]
[
"result"
"decode_url"
]
[
"result"
"formatters"
]
[
"result"
"keybinds"
]
];
in
lib.optional (definedOpts != [ ]) ''
Nixvim(plugins.rest): The following v2 settings options are no longer supported in v3:
${lib.concatMapStringsSep "\n" (opt: " - ${lib.showOption (lib.toList opt)}") definedOpts}
'';
# TODO: There may be some interactions between this & telescope, maybe requiring #2292
plugins.rest.luaConfig.post = lib.mkIf cfg.enableTelescope ''require("telescope").load_extension("rest")'';
globals.rest_nvim = cfg.settings;
extraPackages = [ cfg.curlPackage ];
filetype = lib.mkIf cfg.enableHttpFiletypeAssociation {
extension.http = "http";
};
};
}