diff --git a/docs/manual/installation/modules/home-manager.md b/docs/manual/installation/modules/home-manager.md index a2170159..cf56acc3 100644 --- a/docs/manual/installation/modules/home-manager.md +++ b/docs/manual/installation/modules/home-manager.md @@ -44,12 +44,15 @@ Followed by importing the home-manager module somewhere in your configuration. }; outputs = { nixpkgs, home-manager, nvf, ... }: let - system = "x86_64-linux"; in { + system = "x86_64-linux"; + pkgs = nixpkgs.legacyPackages.${system}; + in { # ↓ this is your home output in the flake schema, expected by home-manager - "your-username@your-hostname" = home-manager.lib.homeManagerConfiguration + "your-username@your-hostname" = home-manager.lib.homeManagerConfiguration { + inherit pkgs; modules = [ nvf.homeManagerModules.default # <- this imports the home-manager module that provides the options - ./home.nix # <- your home entrypoint + ./home.nix # <- your home entrypoint, `programs.nvf.*` may be defined here ]; }; }; diff --git a/docs/manual/installation/modules/nixos.md b/docs/manual/installation/modules/nixos.md index d8be2035..ae5ce939 100644 --- a/docs/manual/installation/modules/nixos.md +++ b/docs/manual/installation/modules/nixos.md @@ -42,13 +42,12 @@ Followed by importing the NixOS module somewhere in your configuration. nvf.url = "github:notashelf/nvf"; }; - outputs = { nixpkgs, nvf, ... }: let - system = "x86_64-linux"; in { + outputs = { nixpkgs, nvf, ... }: { # ↓ this is your host output in the flake schema - nixosConfigurations."yourUsername»" = nixpkgs.lib.nixosSystem { + nixosConfigurations."your-hostname" = nixpkgs.lib.nixosSystem { modules = [ nvf.nixosModules.default # <- this imports the NixOS module that provides the options - ./configuration.nix # <- your host entrypoint + ./configuration.nix # <- your host entrypoint, `programs.nvf.*` may be defined here ]; }; }; diff --git a/modules/plugins/utility/wakatime/config.nix b/modules/plugins/utility/wakatime/config.nix index a1892e7b..675f0034 100644 --- a/modules/plugins/utility/wakatime/config.nix +++ b/modules/plugins/utility/wakatime/config.nix @@ -1,18 +1,22 @@ { config, - lib, pkgs, + lib, ... }: let inherit (lib.modules) mkIf; + inherit (lib.meta) getExe; cfg = config.vim.utility.vim-wakatime; in { config = mkIf cfg.enable { - vim.startPlugins = [pkgs.vimPlugins.vim-wakatime]; + vim = { + startPlugins = [pkgs.vimPlugins.vim-wakatime]; - vim.pluginRC.vim-wakatime = mkIf (cfg.cli-package != null) '' - vim.g.wakatime_CLIPath = "${cfg.cli-package}" - ''; + # Wakatime configuration is stored as vim globals. + globals = { + "wakatime_CLIPath" = mkIf (cfg.cli-package != null) "${getExe cfg.cli-package}"; + }; + }; }; } diff --git a/modules/plugins/utility/wakatime/default.nix b/modules/plugins/utility/wakatime/default.nix index d6d67d57..c72189d5 100644 --- a/modules/plugins/utility/wakatime/default.nix +++ b/modules/plugins/utility/wakatime/default.nix @@ -1,4 +1,4 @@ -_: { +{ imports = [ ./config.nix ./vim-wakatime.nix diff --git a/modules/plugins/utility/wakatime/vim-wakatime.nix b/modules/plugins/utility/wakatime/vim-wakatime.nix index 6b853821..04f27868 100644 --- a/modules/plugins/utility/wakatime/vim-wakatime.nix +++ b/modules/plugins/utility/wakatime/vim-wakatime.nix @@ -1,18 +1,24 @@ { - lib, pkgs, + lib, ... }: let inherit (lib.options) mkEnableOption mkOption; inherit (lib.types) nullOr package; in { options.vim.utility.vim-wakatime = { - enable = mkEnableOption "vim-wakatime: live code statistics"; + enable = mkEnableOption '' + automatic time tracking and metrics generated from your programming activity [vim-wakatime] + ''; cli-package = mkOption { type = nullOr package; - default = pkgs.wakatime; - description = "The package that should be used for wakatime-cli. Set as null to use the default path in `$XDG_DATA_HOME`"; + default = pkgs.wakatime-cli; + example = null; + description = '' + The package that should be used for wakatime-cli. + Set as null to use the default path in {env}`$XDG_DATA_HOME` + ''; }; }; }