From 55fee7051f2fe45afa5b3a97eb94907bb9005c64 Mon Sep 17 00:00:00 2001
From: Matt Sturgeon <matt@sturgeon.me.uk>
Date: Mon, 1 Jul 2024 14:20:12 +0100
Subject: [PATCH] standalone: rename `nixvimExtend` to `extend`

This is our scope, so there's no need to be explicit.

This also follows the precedent set by `lib.extend`, although that takes
an overlay function.
---
 docs/modules/standalone.md | 30 +++++++++++++++---------------
 tests/extend.nix           |  4 ++--
 wrappers/standalone.nix    |  5 +++--
 3 files changed, 20 insertions(+), 19 deletions(-)

diff --git a/docs/modules/standalone.md b/docs/modules/standalone.md
index deb5c6e6..1870f75c 100644
--- a/docs/modules/standalone.md
+++ b/docs/modules/standalone.md
@@ -24,34 +24,34 @@ The example assumes your standalone config is the `default` package of a flake,
 
 ## Extending an existing configuration
 
-Given a `nvim` derivation obtained from `makeNixvim` or `makeNivxmiWithModule` it is possible to create a new derivation with additional options.
+Given a `<nixvim>` derivation obtained from `makeNixvim` or `makeNivxmiWithModule` it is possible to create a new derivation with additional options.
 
-This is done through the `nvim.nixvimExtend` function. This function takes a NixOS module that is going to be merged with the currently set options.
+This is done through the `<nixvim>.extend` function. This function takes a Nixvim module that is merged with the options used to build `<nixvim>`.
 
-This attribute is recursive, meaning that it can be applied an arbitrary number of times.
+This function is recursive, meaning that it can be applied an arbitrary number of times.
 
 ### Example
 
 ```nix
-{makeNixvimWithModule}: let
-    first = makeNixvimWithModule {
-        module = {
-            extraConfigLua = "-- first stage";
-        };
-    };
-
-    second = first.nixvimExtend {extraConfigLua = "-- second stage";};
-    
-    third = second.nixvimExtend {extraConfigLua = "-- third stage";};
+{makeNixvim}: let
+    first = makeNixvim { extraConfigLua = "-- first stage"; };
+    second = first.extend {extraConfigLua = "-- second stage";};
+    third = second.extend {extraConfigLua = "-- third stage";};
 in
     third
 ```
 
-This will generate a `init.lua` that will contain the three comments from each stages.
+This will generate a `init.lua` that will contain the comments from each stages:
+
+```lua
+-- first stage
+-- second stage
+-- third stage
+```
 
 ## Accessing options used in an existing configuration
 
-The `config` used to produce a standalone nixvim derivation can be accessed as an attribute on the derivation, similar to `nixvimExtend`.
+The `config` used to produce a standalone nixvim derivation can be accessed as an attribute on the derivation, similar to `<nixvim>.extend`.
 
 This may be useful if you want unrelated parts of your NixOS or home-manager configuration to use the same value as something in your nixvim configuration.
 
diff --git a/tests/extend.nix b/tests/extend.nix
index 88a8b7ae..00bd8281 100644
--- a/tests/extend.nix
+++ b/tests/extend.nix
@@ -6,9 +6,9 @@ let
     };
   };
 
-  secondStage = firstStage.nixvimExtend { extraConfigLua = "-- second stage"; };
+  secondStage = firstStage.extend { extraConfigLua = "-- second stage"; };
 
-  generated = secondStage.nixvimExtend { extraConfigLua = "-- third stage"; };
+  generated = secondStage.extend { extraConfigLua = "-- third stage"; };
 in
 pkgs.runCommand "extend-test" { printConfig = "${generated}/bin/nixvim-print-init"; } ''
   config=$($printConfig)
diff --git a/wrappers/standalone.nix b/wrappers/standalone.nix
index 2e8ae16c..e09179bd 100644
--- a/wrappers/standalone.nix
+++ b/wrappers/standalone.nix
@@ -55,10 +55,10 @@ let
       ] ++ pkgs.lib.optional config.enableMan self.packages.${pkgs.stdenv.hostPlatform.system}.man-docs;
       meta.mainProgram = "nvim";
     })
-    // {
+    // rec {
       inherit config;
       inherit (evaledModule) options;
-      nixvimExtend =
+      extend =
         extension:
         mkNvim {
           imports = [
@@ -66,6 +66,7 @@ let
             extension
           ];
         };
+      nixvimExtend = lib.warn "<nixvim>.nixvimExtend has been renamed to <nixvim>.extend" extend;
     };
 in
 mkNvim module