From 428e49d3038a44d970fbd3aee44aea4957fb7002 Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Fri, 5 Jan 2024 19:24:02 +0300 Subject: [PATCH 1/3] modules/rich-presence: deprecate presence-nvim in favor of neocord --- configuration.nix | 12 +--- flake.lock | 34 ++++----- flake.nix | 6 +- lib/types/plugins.nix | 2 +- modules/rich-presence/default.nix | 4 +- .../{presence-nvim => neocord}/config.nix | 30 ++++---- .../{presence-nvim => neocord}/default.nix | 4 +- .../presence-nvim.nix => neocord/neocord.nix} | 70 ++++++++++++++----- 8 files changed, 95 insertions(+), 67 deletions(-) rename modules/rich-presence/{presence-nvim => neocord}/config.nix (57%) rename modules/rich-presence/{presence-nvim => neocord}/default.nix (56%) rename modules/rich-presence/{presence-nvim/presence-nvim.nix => neocord/neocord.nix} (53%) diff --git a/configuration.nix b/configuration.nix index f12fc88..0c122a2 100644 --- a/configuration.nix +++ b/configuration.nix @@ -232,17 +232,7 @@ inputs: let }; vim.presence = { - presence-nvim = { - enable = true; - auto_update = true; - image_text = "The Superior Text Editor"; - client_id = "793271441293967371"; - main_image = "neovim"; - show_time = true; - rich_presence = { - editing_text = "Editing %s"; - }; - }; + neocord.enable = true; }; }; }; diff --git a/flake.lock b/flake.lock index 4410222..9563dfc 100644 --- a/flake.lock +++ b/flake.lock @@ -778,6 +778,22 @@ "type": "github" } }, + "neocord": { + "flake": false, + "locked": { + "lastModified": 1704948184, + "narHash": "sha256-HnaMKTNjMuDwHDvxHH5kd4ysa5WU+MlbdD9jH/iJcU8=", + "owner": "IogaMaster", + "repo": "neocord", + "rev": "9b624d5189f699ab454e9515262c13965395b8dd", + "type": "github" + }, + "original": { + "owner": "IogaMaster", + "repo": "neocord", + "type": "github" + } + }, "neodev-nvim": { "flake": false, "locked": { @@ -1397,22 +1413,6 @@ "type": "github" } }, - "presence-nvim": { - "flake": false, - "locked": { - "lastModified": 1674984077, - "narHash": "sha256-ZpsunLsn//zYgUtmAm5FqKVueVd/Pa1r55ZDqxCimBk=", - "owner": "andweeb", - "repo": "presence.nvim", - "rev": "87c857a56b7703f976d3a5ef15967d80508df6e6", - "type": "github" - }, - "original": { - "owner": "andweeb", - "repo": "presence.nvim", - "type": "github" - } - }, "project-nvim": { "flake": false, "locked": { @@ -1511,6 +1511,7 @@ "mind-nvim": "mind-nvim", "minimap-vim": "minimap-vim", "modes-nvim": "modes-nvim", + "neocord": "neocord", "neodev-nvim": "neodev-nvim", "nil": "nil", "nixpkgs": "nixpkgs", @@ -1545,7 +1546,6 @@ "orgmode-nvim": "orgmode-nvim", "oxocarbon": "oxocarbon", "plenary-nvim": "plenary-nvim", - "presence-nvim": "presence-nvim", "project-nvim": "project-nvim", "registers": "registers", "rnix-lsp": "rnix-lsp", diff --git a/flake.nix b/flake.nix index 5b7caab..0e8d402 100644 --- a/flake.nix +++ b/flake.nix @@ -262,9 +262,9 @@ }; # Presence - presence-nvim = { - url = "github:andweeb/presence.nvim"; - flake = false; + neocord = { + url = "github:IogaMaster/neocord"; + flake = false; # uses flake-utils, avoid the flake }; # Autopairs diff --git a/lib/types/plugins.nix b/lib/types/plugins.nix index ee33a42..75056b6 100644 --- a/lib/types/plugins.nix +++ b/lib/types/plugins.nix @@ -53,7 +53,7 @@ with lib; let "cheatsheet-nvim" "ccc" "cellular-automaton" - "presence-nvim" + "neocord" "icon-picker-nvim" "dressing-nvim" "orgmode-nvim" diff --git a/modules/rich-presence/default.nix b/modules/rich-presence/default.nix index ef16a42..4e7fe0f 100644 --- a/modules/rich-presence/default.nix +++ b/modules/rich-presence/default.nix @@ -1,5 +1,5 @@ -_: { +{ imports = [ - ./presence-nvim + ./neocord ]; } diff --git a/modules/rich-presence/presence-nvim/config.nix b/modules/rich-presence/neocord/config.nix similarity index 57% rename from modules/rich-presence/presence-nvim/config.nix rename to modules/rich-presence/neocord/config.nix index 452af4f..08bcea1 100644 --- a/modules/rich-presence/presence-nvim/config.nix +++ b/modules/rich-presence/neocord/config.nix @@ -4,26 +4,29 @@ ... }: let inherit (lib) mkIf nvim boolToString; + inherit (lib.nvim.lua) listToLuaTable; + inherit (builtins) toString; - cfg = config.vim.presence.presence-nvim; + cfg = config.vim.presence.neocord; in { config = mkIf cfg.enable { - vim.startPlugins = ["presence-nvim"]; + vim.startPlugins = ["neocord"]; - vim.luaConfigRC.presence-nvim = nvim.dag.entryAnywhere '' - -- Description of each option can be found in https://github.com/andweeb/presence.nvim - require("presence").setup({ + vim.luaConfigRC.neocord = nvim.dag.entryAnywhere '' + -- Description of each option can be found in https://github.com/IogaMaster/neocord#lua + require("neocord").setup({ -- General options - auto_update = true, - neovim_image_text = "${cfg.image_text}", + logo = "${cfg.logo}", + logo_tooltip = "${cfg.logo_tooltip}", main_image = "${cfg.main_image}", client_id = "${cfg.client_id}", - log_level = nil, - debounce_timeout = 10, - enable_line_number = "${boolToString cfg.enable_line_number}", - blacklist = {}, - buttons = "${boolToString cfg.buttons}", - file_assets = {}, + log_level = "${ + if cfg.log_level == null + then "nil" + else cfg.log_level + }", + debounce_timeout = ${toString cfg.debounce_timeout}, + blacklist = ${listToLuaTable cfg.blacklist}, show_time = "${boolToString cfg.show_time}", -- Rich Presence text options @@ -34,6 +37,7 @@ in { reading_text = "${cfg.rich_presence.reading_text}", workspace_text = "${cfg.rich_presence.workspace_text}", line_number_text = "${cfg.rich_presence.line_number_text}", + terminal_text = "${cfg.rich_presence.terminal_text}", }) ''; }; diff --git a/modules/rich-presence/presence-nvim/default.nix b/modules/rich-presence/neocord/default.nix similarity index 56% rename from modules/rich-presence/presence-nvim/default.nix rename to modules/rich-presence/neocord/default.nix index e263c3a..0b651bc 100644 --- a/modules/rich-presence/presence-nvim/default.nix +++ b/modules/rich-presence/neocord/default.nix @@ -1,6 +1,6 @@ -_: { +{ imports = [ ./config.nix - ./presence-nvim.nix + ./neocord.nix ]; } diff --git a/modules/rich-presence/presence-nvim/presence-nvim.nix b/modules/rich-presence/neocord/neocord.nix similarity index 53% rename from modules/rich-presence/presence-nvim/presence-nvim.nix rename to modules/rich-presence/neocord/neocord.nix index 911ff2b..514c7ff 100644 --- a/modules/rich-presence/presence-nvim/presence-nvim.nix +++ b/modules/rich-presence/neocord/neocord.nix @@ -1,31 +1,58 @@ -{ - config, - lib, - ... -}: let - inherit (lib) mkEnableOption mkOption types; +{lib, ...}: let + inherit (lib) mkEnableOption mkOption types literalExpression mkRemovedOptionModule; in { - options.vim.presence.presence-nvim = { - enable = mkEnableOption "presence.nvim plugin for discord rich presence"; + imports = [ + (mkRemovedOptionModule ["vim" "presence" "presence-nvim"] '' + The option vim.presence.presence-nvim has been deprecated in favor of the new neocord module. + Options provided by the plugin remain mostly the same, but manual migration is required. - image_text = mkOption { + Please see neocord documentation and the neovim-flake options for more info + '') + ]; + + options.vim.presence.neocord = { + enable = mkEnableOption "neocord plugin for discord rich presence"; + + logo = mkOption { + type = types.str; # TODO: can the default be documented better, maybe with an enum? + default = "auto"; + description = '' + Logo to be displayed on the RPC item + + This must be either "auto" or an URL to your image of choice + ''; + }; + + logo_tooltip = mkOption { type = types.str; default = "The One True Text Editor"; description = "Text displayed when hovering over the Neovim image"; }; main_image = mkOption { - type = types.str; - default = "neovim"; + type = types.enum ["language" "logo"]; + default = "language"; description = "Main image to be displayed"; }; client_id = mkOption { type = types.str; - default = "79327144129396737"; + default = "1157438221865717891"; description = "Client ID of the application"; }; + log_level = mkOption { + type = with types; nullOr (enum ["debug" "info" "warn" "error"]); + default = null; + description = "Log level to be used by the plugin"; + }; + + debounce_timeout = mkOption { + type = types.int; + default = 10; + description = "Number of seconds to debounce events"; + }; + auto_update = mkOption { type = types.bool; default = true; @@ -38,18 +65,19 @@ in { description = "Show line number on the RPC item"; }; - buttons = mkOption { - type = types.bool; - default = true; - description = "Show buttons on the RPC item"; - }; - show_time = mkOption { type = types.bool; default = true; description = "Show time on the RPC item"; }; + blacklist = mkOption { + type = with types; listOf str; + default = []; + example = literalExpression ''["Alpha"]''; + description = "List of filetypes to ignore"; + }; + rich_presence = { editing_text = mkOption { type = types.str; @@ -92,6 +120,12 @@ in { default = "Line %s out of %s"; description = "Text displayed when showing line number"; }; + + terminal_text = mkOption { + type = types.str; + default = "Working on the terminal"; + description = "Text displayed when working on the terminal"; + }; }; }; } From 4dba0948c95287ec2cd37563bc7d01204a7b3257 Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Fri, 5 Jan 2024 19:24:41 +0300 Subject: [PATCH 2/3] flake: bump nixpkgs input --- flake.lock | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/flake.lock b/flake.lock index 9563dfc..35bffc0 100644 --- a/flake.lock +++ b/flake.lock @@ -836,11 +836,11 @@ }, "nixpkgs": { "locked": { - "lastModified": 1703013332, - "narHash": "sha256-+tFNwMvlXLbJZXiMHqYq77z/RfmpfpiI3yjL6o/Zo9M=", + "lastModified": 1704194953, + "narHash": "sha256-RtDKd8Mynhe5CFnVT8s0/0yqtWFMM9LmCzXv/YKxnq4=", "owner": "nixos", "repo": "nixpkgs", - "rev": "54aac082a4d9bb5bbc5c4e899603abfb76a3f6d6", + "rev": "bd645e8668ec6612439a9ee7e71f7eac4099d4f6", "type": "github" }, "original": { From cffe399b85a9544974811329d6fc0789c73ebb21 Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Fri, 12 Jan 2024 20:34:37 +0300 Subject: [PATCH 3/3] docs: add presence.nvim deprecation notice --- docs/release-notes/rl-0.6.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/release-notes/rl-0.6.md b/docs/release-notes/rl-0.6.md index 95a7363..d48e1d0 100644 --- a/docs/release-notes/rl-0.6.md +++ b/docs/release-notes/rl-0.6.md @@ -17,3 +17,7 @@ Release notes for release 0.6 - Finished moving to `nixosOptionsDoc` in the documentation and changelog. We are fully free of asciidoc now - Bumped plugin inputs to their latest versions + +- Deprecated `presence.nvim` in favor of `neocord`. This means `vim.rich-presence.presence-nvim` is removed and will throw + a warning if used. You are recommended to rewrite your neocord config from scratch based on the + [official documentation](https://github.com/IogaMaster/neocord)