feat: can declare extra lua packages

BREAKING CHANGE: The init configuration has moved out of runtime
configuration. It is now in the mkNeovimPkg confuguration.

CHANGELOG.md

@@ -2,6 +2,56 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.0.10] - 2024-06-09
+
+### Features
+
+- Runtime is now optional
+- [**breaking**] `init.lua` configuration is now a `mkNeovimPkg`'s option
+- Add option init config object to generate `init.lua`
+
+### Miscellaneous Tasks
+
+- Add alejandra to nix shell
+
+## [0.0.9] - 2024-06-09
+
+### Features
+
+- Sloth command has now completion
+- Add describe subcommand
+- Introduce mkPluginsFromInputs function
+
+### Bug Fixes
+
+- Init/config are loaded to on-the-fly build plugins
+- Plugins with init are now loaded as they should be
+
+### Refactor
+
+- Filters are now fully dynamic
+
+### Miscellaneous Tasks
+
+- Remove sourcesWith fn, using lib.fileset
+- Move back to flake-utils
+
+## [0.0.8] - 2024-06-04
+
+### Features
+
+- Can load lazy plugins on events
+- Can load lazy plugins on keymaps
+
+### Bug Fixes
+
+- Move files instead of copying them
+- Sloth list was broken since refactoring
+
+### Miscellaneous Tasks
+
+- Switch from nixpkgs `23.11` to `unstable`
+
 ## [0.0.7] - 2024-06-03
 
 ### Features

README.md

@@ -12,6 +12,7 @@ A [neovim] plugin and configuration management plugin, highly inspired by [lazy]
 - [Usage](#usage)
 - [Documentation](#documentation)
   - [nix](#nix)
+    - [`mkPluginsFromInputs`](#mkpluginsfrominputs)
     - [`mkNeovimPkg`](#mkneovimpkg)
   - [neovim (lua)](#neovim-lua)
     - [Using default `init.lua`](#using-default-initlua)
@@ -44,8 +45,8 @@ A [neovim] plugin and configuration management plugin, highly inspired by [lazy]
 - [X] Lazy load your plugins
   - [X] on command
   - [X] on filetype
-  - [ ] on event
-  - [ ] on keybinding
+  - [X] on event
+  - [X] on keybinding
 - [X] load plugins in order (via plugin `dependencies` property)
 - [X] Have a `:Sloth` command to load or query your plugins
 - [ ] Generate spell files on build (maybe)
@@ -122,6 +123,58 @@ sloth-flake.lib.mkNeovimPkg {
 
 ### nix
 
+#### `mkPluginsFromInputs`
+
+`mkPluginsFromInputs` is a helper function that converts flake inputs (starting by `"plugin-"` by default) into vimPlugins.
+
+Example:
+```nix
+{
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
+    sloth-flake.url = "github:lemarsu/sloth-flake.nvim";
+    utils.url = "github:numtide/flake-utils";
+
+    plugin-base64 = {
+      url = "github:moevis/base64.nvim";
+      flake = false;
+    };
+
+    plugin-cellular-automaton = {
+      url = "github:eandrju/cellular-automaton.nvim";
+      flake = false;
+    };
+  };
+  outputs = {utils, sloth-flake, ...}@inputs: let
+    fu = utils.lib;
+  in fu.eachDefaultSystem (system: let
+    plugins = sloth-flake.lib.mkPluginsFromInputs {
+      inherit pkgs inputs;
+    };
+  in {
+    packages = rec {
+      default = neovim;
+      neovim = pkgs.callPackage ./package.nix {
+        # By adding `plugins` here, we can use `with plugins; base64 cellular-automaton`, 
+        inherit plugins sloth-flake;
+      };
+    };
+  };
+}
+```
+
+The function accepts the following attributes:
+
+- `pkgs` **REQUIRED** the nixpkgs set.
+- `inputs` **REQUIRED** the inputs from a flake.
+- `predicate` **optional** predicate to filter input by name. By default, it's
+  filter inputs with `hasPrefix "plugin-"`.
+- `nameMap` **optional** function to change the key of the input in the resulting
+  set. By default, the 7 first letters are removed, so to remove the "plugin-"
+  prefix.
+- `buildVimPlugin` **optional** function used to build the plugin. Defaults to
+  `pkgs.vimUtils.buildVimPlugin`.
+
 #### `mkNeovimPkg`
 
 `mkNeovimPkg` requires only the `pkgs` argument.
@@ -129,27 +182,36 @@ sloth-flake.lib.mkNeovimPkg {
 Here's a list of all accepted arguments
 
 | name                    | default                 | description                                                         |
-|-------------------------|-------------------------|----------------------------------------------------------------|
+|-------------------------|-------------------------|---------------------------------------------------------------------|
 | `pkgs`                  | N/A                     | The nixpkgs set. **REQUIRED**                                       |
 | `package`               | `pkgs.neovim-unwrapped` | The unwrapped neovim package to use                                 |
+| `init`                  | `null`                  | The `init.lua` of your config (string, path or init config object)¹ |
 | `runtime`               | `{}`                    | Your Runtime configuration (see below)                              |
 | `dependencies`          | `[]`                    | A list of your dependencies (see below)                             |
 | `dependenciesExtraArgs` | `{}`                    | Extra arguments to load your dependencies in other files            |
+| `extraLuaPackages`      | `null`                  | Extra lua packages needed for the plugin                            |
 | `viAlias`               | `false`                 | Wether to create a `vi` alias to run neovim                         |
 | `vimAlias`              | `false`                 | Wether to create a `vim` alias to run neovim                        |
 | `vimdiffAlias`          | `false`                 | Wether to create a `vimdiff` alias to run neovim in diff mode       |
 | `nvimdiffAlias`         | `false`                 | Wether to create a `nvimdiff` alias to run neovim in diff mode      |
 
+> ¹ If you give your own `init.lua` as string or path, you'll have to call `sloth-flake` lua plugin yourself. See more below.
+
+The init configuration object accepts the following properties:
+
+| name       | default | description                                                                |
+|------------|---------|----------------------------------------------------------------------------|
+| `init`     | `null`  | Lua code call before plugins init. String or path.                         |
+| `postInit` | `null`  | Lua code call after plugins init and before plugin config. String or path. |
+| `config`   | `null`  | Luas cod call after plugins config. String or path.                        |
+
 The Runtime configuration object accepts the following properties:
 
 | name      | default | description                    |
 |-----------|---------|--------------------------------|
 | `version` | `null`  | The version of your runtime    |
-| `init`    | `null`  | The `init.lua` of your config¹ |
 | `src`     | `null`  | The content of your runtime    |
 
-> ¹ If you give your own `init.lua`, you'll have to call `sloth-flake` lua plugin yourself. See more below.
-
 The dependencies is a list of element of either:
 - path: the path of the file to load other dependencies
 - package: a nix package of a neovim/vim plugin
@@ -158,14 +220,17 @@ The dependencies is a list of element of either:
 The Plugin configuration object accepts the following properties:
 
 | name               | default | description                                                    |
-|----------------|---------|----------------------------------------------------------------|
+|--------------------|---------|----------------------------------------------------------------|
 | `plugin`           | N/A     | The plugin to load² **REQUIRED**                               |
 | `init`             | `null`  | Lua code (as string of path) to call before loading the plugin |
 | `config`           | `null`  | Lua code (as string of path) to call after loading the plugin  |
 | `dependencies`     | `[]`    | The plugin dependencies³                                       |
+| `extraLuaPackages` | `null`  | Extra lua packages needed for the plugin                       |
 | `lazy`             | `false` | Should the plugin be loaded lazily                             |
-| `cmd`          | `[]`    | Command to put as place_holder to lazy load the plugin⁴        |
-| `ft`           | `[]`    | Filetype to watch to lazy load the plugin⁴                     |
+| `cmd`              | `[]`    | Command to put as place_holder to load the lazy plugin⁴        |
+| `ft`               | `[]`    | Filetype to watch to load the lazy plugin⁴                     |
+| `events`           | `[]`    | Events to watch to load the lazy plugin⁴⁵                      |
+| `keymaps`          | `[]`    | Keymaps that when press will load the lazy plugin⁴⁶            |
 
 > ² The plugin can be either a nix package or an object with only `name` and
 > `src` as properties. The latter will be used to create a nix package of your
@@ -178,6 +243,26 @@ The Plugin configuration object accepts the following properties:
 
 > ⁴ Setting this property implicitly set `lazy` to `true`.
 
+> ⁵ Events can be a string, an Event object or a list of either. You can
+> represent a simple event name and pattern with the following string format :
+> "BufRead *.md".
+
+> ⁶ Keymaps can be a string, an Keymap object or a list of either.
+
+The Event configuration object accepts the following properties:
+
+| name      | default | description                                                    |
+|-----------|---------|----------------------------------------------------------------|
+| `name`    | N/A     | The name of the event as string or list of string **REQUIRED** |
+| `pattern` | `null`  | Pattern (as string or list of string) associated to the event  |
+
+The Keymap configuration object accepts the following properties:
+
+| name      | default | description                                        |
+|-----------|---------|----------------------------------------------------|
+| `mode`    | `"n"`   | The mode of the keymap as string or list of string |
+| `mapping` | N/A     | The actual mapping **REQUIRED**                    |
+
 ### neovim (lua)
 
 #### Using default `init.lua`

VERSION

@@ -1 +1 @@
-0.0.7
+0.0.10

flake.lock

@@ -63,24 +63,6 @@
         "type": "github"
       }
     },
-    "flake-utils_2": {
-      "inputs": {
-        "systems": "systems_2"
-      },
-      "locked": {
-        "lastModified": 1694529238,
-        "narHash": "sha256-zsNZZGTGnMOf9YpHKJqMSsa0dXbfmxeoJ7xHlrt+xmY=",
-        "owner": "numtide",
-        "repo": "flake-utils",
-        "rev": "ff7b65b44d01cf9ba6a71320833626af21126384",
-        "type": "github"
-      },
-      "original": {
-        "owner": "numtide",
-        "repo": "flake-utils",
-        "type": "github"
-      }
-    },
     "flakeCompat": {
       "flake": false,
       "locked": {
@@ -135,16 +117,16 @@
     },
     "nixpkgs_2": {
       "locked": {
-        "lastModified": 1716991068,
-        "narHash": "sha256-Av0UWCCiIGJxsZ6TFc+OiKCJNqwoxMNVYDBChmhjNpo=",
+        "lastModified": 1717196966,
+        "narHash": "sha256-yZKhxVIKd2lsbOqYd5iDoUIwsRZFqE87smE2Vzf6Ck0=",
         "owner": "nixos",
         "repo": "nixpkgs",
-        "rev": "25cf937a30bf0801447f6bf544fc7486c6309234",
+        "rev": "57610d2f8f0937f39dbd72251e9614b1561942d8",
         "type": "github"
       },
       "original": {
         "owner": "nixos",
-        "ref": "nixos-23.11",
+        "ref": "nixos-unstable",
         "repo": "nixpkgs",
         "type": "github"
       }
@@ -247,20 +229,19 @@
     },
     "utils": {
       "inputs": {
-        "flake-utils": "flake-utils_2"
+        "systems": "systems_2"
       },
       "locked": {
-        "lastModified": 1696281284,
-        "narHash": "sha256-xcmtTmoiiAOSk4abifbtqVZk0iwBcqJfg47iUbkwhcE=",
-        "owner": "gytis-ivaskevicius",
-        "repo": "flake-utils-plus",
-        "rev": "6cf1e312fb259693c4930d07ca3cbe1d07ef4a48",
+        "lastModified": 1710146030,
+        "narHash": "sha256-SZ5L6eA7HJ/nmkzGG7/ISclqe6oZdOZTNoesiInkXPQ=",
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "rev": "b1d9ab70662946ef0850d488da1c9019f3a9752a",
         "type": "github"
       },
       "original": {
-        "owner": "gytis-ivaskevicius",
-        "ref": "v1.4.0",
-        "repo": "flake-utils-plus",
+        "owner": "numtide",
+        "repo": "flake-utils",
         "type": "github"
       }
     },

flake.nix

@@ -2,8 +2,8 @@
   description = "My neovim configuration";
 
   inputs = {
-    nixpkgs.url = "github:nixos/nixpkgs/nixos-23.11";
-    utils.url = "github:gytis-ivaskevicius/flake-utils-plus/v1.4.0";
+    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
+    utils.url = "github:numtide/flake-utils";
     nil.url = "github:oxalica/nil";
     yants.url = "github:divnix/yants";
     alejandra = {
@@ -20,24 +20,25 @@
     yants,
     ...
   } @ inputs: let
-    versionFile = builtins.replaceStrings ["\n"] [""] (builtins.readFile ./VERSION);
-
-    version = if self.sourceInfo ? dirtyShortRev
+    inherit (builtins) readFile replaceStrings;
+    fu = utils.lib;
+    versionFile = replaceStrings ["\n"] [""] (readFile ./VERSION);
+    version =
+      if self.sourceInfo ? dirtyShortRev
       then "${versionFile}-${self.sourceInfo.dirtyShortRev}"
       else versionFile;
-  in
-    utils.lib.mkFlake {
-      inherit self inputs;
-      outputsBuilder = channel: let
-        system = channel.nixpkgs.system;
-      in {
-        formatter = alejandra.defaultPackage.${channel.nixpkgs.system};
-        devShells.default = import ./shell.nix {
-          pkgs = channel.nixpkgs;
-          inherit (inputs.nil.packages.${system}) nil;
-        };
-      };
 
-      lib = import ./lib {inherit version yants;};
+    forSystem = system: let
+      pkgs = nixpkgs.legacyPackages.${system};
+      formatter = alejandra.defaultPackage.${system};
+      inherit (inputs.nil.packages.${system}) nil;
+    in {
+      inherit formatter;
+      devShells.default = import ./shell.nix {
+        inherit pkgs nil formatter;
       };
+    };
+  in
+    (fu.eachDefaultSystem forSystem)
+    // {lib = import ./lib {inherit version yants;};};
 }

lib/default.nix

@@ -1,18 +1,9 @@
-{version, yants}: let
+{
+  version,
+  yants,
+}: let
   types = import ./types.nix {inherit yants;};
 in {
   mkNeovimPkg = import ./mkNeovimPkg.nix {inherit version types;};
-
-  sourcesWith = path: paths: let
-    samePath = a: let a' = builtins.toString a; in b: a' == builtins.toString b;
-    isRoot = samePath "/";
-    isInPath = path: subPath:
-      if isRoot subPath
-      then false
-      else (samePath path subPath) || (isInPath path (builtins.dirOf subPath));
-    filter = src: _type: builtins.any (includePath: isInPath includePath src) paths;
-  in
-    builtins.path {
-      inherit path filter;
-    };
+  mkPluginsFromInputs = import ./mkPluginsFromInputs.nix;
 }

lib/deps.nix

@@ -6,14 +6,19 @@
   types,
   ...
 }: let
-  inherit (builtins) isPath foldl';
+  inherit (builtins) foldl' isPath isList isString mapAttrs match elemAt;
   inherit (lib.attrsets) attrNames optionalAttrs;
   inherit (lib.lists) concatMap;
-  inherit (lib.strings) fileContents;
+  inherit (lib.strings) fileContents splitString;
   lua = callPackage ./lua.nix {};
-
   callPackage = lib.callPackageWith (pkgs // dependenciesExtraArgs);
 
+  hasMatch = pattern: str: isList (match pattern str);
+  wrapArray = value:
+    if isList value
+    then value
+    else [value];
+
   defaultPlugin = {
     enabled = true;
     init = null;
@@ -22,6 +27,8 @@
     lazy = false;
     cmd = [];
     ft = [];
+    events = [];
+    keymaps = [];
   };
 
   remotePluginToNeovimPlugin = p:
@@ -30,6 +37,39 @@
       pname = name;
     };
 
+  defaultKeymap = {mode = "n";};
+  normalizeKeymap = keymap: let
+    value = (
+      if isString keymap
+      then {mapping = keymap;}
+      else keymap
+    );
+  in
+    mapAttrs (_: wrapArray) (defaultKeymap // value);
+  normalizeKeymaps = keymaps:
+    if isList keymaps
+    then map normalizeKeymap keymaps
+    else [(normalizeKeymap keymaps)];
+
+  normalizeEvent = event: let
+    value =
+      if ! isString event
+      then event
+      else if ! hasMatch ".* .*" event
+      then {name = event;}
+      else let
+        part = elemAt (splitString " " event);
+      in {
+        name = part 0;
+        pattern = part 1;
+      };
+  in
+    mapAttrs (_: wrapArray) value;
+  normalizeEvents = events:
+    if isList events
+    then map normalizeEvent events
+    else [(normalizeEvent events)];
+
   withPluginDefaults = dep: defaultPlugin // dep;
   normalizePlugin = d: let
     dep = types.dependency d;
@@ -40,7 +80,7 @@
         inherit (dep) plugin;
       in
         if attrNames plugin == ["name" "src"]
-        then {plugin = remotePluginToNeovimPlugin plugin;}
+        then dep // {plugin = remotePluginToNeovimPlugin plugin;}
         else dep;
     p = withPluginDefaults plugin;
   in
@@ -48,7 +88,11 @@
     // rec {
       hasCommands = p.cmd != [];
       hasFileTypes = p.ft != [];
-      lazy = p.lazy || hasCommands || hasFileTypes;
+      keymaps = normalizeKeymaps p.keymaps;
+      hasKeymaps = p.keymaps != [];
+      events = normalizeEvents p.events;
+      hasEvents = p.events != [];
+      lazy = p.lazy || hasCommands || hasFileTypes || hasEvents || hasKeymaps;
       optional = lazy || p.init != null;
     };
 
@@ -78,16 +122,13 @@
     vimUtils.buildVimPlugin {
       inherit version;
       pname = "sloth-flake";
-      src = ../lua/sloth-flake;
+      src = with lib.fileset;
+        toSource {
+          root = ../.;
+          fileset = ../lua/sloth-flake;
+        };
       buildPhase = ''
         dir=lua/sloth-flake
-        mkdir -p $dir
-        cp *.lua $dir
-        for d in *; do
-          if [[ -d "$d" ]] && [[ "$d" != 'lua' ]]; then
-            cp -r "$d" $dir
-          fi
-        done
 
         cat <<'LUA' > $dir/dependencies.lua
         ${pluginsLuaDef plugins}
@@ -107,7 +148,6 @@
     else content;
 
   pluginLuaDef = memo: plugin: let
-    # plugin = builtins.removeAttrs plugin ["dependencies" "plugin"];
     mkTypeFn = type: let
       content = textOrContent plugin.${type};
     in
@@ -137,6 +177,12 @@
         })
         // (optionalAttrs plugin.hasFileTypes {
           inherit (plugin) ft;
+        })
+        // (optionalAttrs plugin.hasEvents {
+          inherit (plugin) events;
+        })
+        // (optionalAttrs plugin.hasKeymaps {
+          inherit (plugin) keymaps;
         });
     };
   pluginsLuaDef = plugins:

lib/mkNeovimPkg.nix

@@ -6,21 +6,21 @@
   package ? pkgs.neovim-unwrapped,
   dependencies ? [],
   dependenciesExtraArgs ? {},
-  runtime ? {},
+  extraLuaPackages ? (_: []),
+  runtime ? null,
+  init ? null,
   viAlias ? false,
   vimAlias ? false,
   vimdiffAlias ? false,
   nvimdiffAlias ? false,
   ...
 } @ config: let
-  inherit (builtins) map;
+  inherit (builtins) isString isPath map;
   inherit (pkgs) callPackage bash lib;
   inherit (lib.strings) optionalString;
+  inherit (lib.lists) concatMap optional;
   inherit (lib.trivial) flip;
-  # inherit (lib.lists) concatMap filter foldl' map optional reverseList;
-  # inherit (lib.attrsets) attrNames optionalAttrs;
-  # inherit (lib.strings) concatStringsSep fileContents hasSuffix removePrefix removeSuffix replaceStrings;
-  # inherit (lib.debug) traceIf traceSeq traceVal traceValSeq traceValFn;
+  inherit (lib.attrsets) optionalAttrs;
 
   deps = callPackage ./deps.nix {inherit dependenciesExtraArgs types;};
 
@@ -29,20 +29,69 @@
   runtimePlugin = deps.mkRuntimePlugin runtime;
   plugins =
     normalizedPlugins
-    ++ (deps.normalizePlugins [runtimePlugin sloth-flake]);
+    ++ (
+      deps.normalizePlugins
+      ([sloth-flake] ++ (optional (runtime != null) runtimePlugin))
+    );
 
   extractPlugin = p: {inherit (p) optional plugin;};
   extractPlugins = map extractPlugin;
 
-  customRC = let
-    rc = ({init ? ../lua/default_init.lua, ...}: init) runtime;
+  extractLuaPackageFn = plugin:
+    optional (plugin ? extraLuaPackages) plugin.extraLuaPackages;
+  extractLuaPackagesFn = plugins: let
+    fnList = concatMap extractLuaPackageFn plugins;
+    concatPackages = ps: fn: fn ps;
   in
-    deps.textOrContent rc;
+    ps: concatMap (concatPackages ps) fnList;
+
+  buildInit = {
+    init ? null,
+    postInit ? null,
+    config ? null,
+  }: let
+    initStr = optionalString (! isNull init) ''
+      (function()
+      ${deps.textOrContent init}
+      end)();
+
+    '';
+
+    slothCall =
+      if isNull postInit
+      then "require('sloth-flake').setup {}"
+      else ''
+        require('sloth-flake').setup {
+          post_init = function()
+            ${deps.textOrContent postInit}
+          end,
+        };
+      '';
+
+    configStr = optionalString (! isNull config) ''
+
+      (function()
+      ${deps.textOrContent config}
+      end)()
+    '';
+  in ''
+    -- Generated by sloth-flake
+    ${initStr}
+    ${slothCall}
+    ${configStr}
+  '';
+
+  customRC =
+    if isString init || isPath init
+    then deps.textOrContent init
+    else buildInit (optionalAttrs (! isNull init) init);
 
   neovimConfig =
     pkgs.neovimUtils.makeNeovimConfig {
       inherit customRC;
       plugins = extractPlugins plugins;
+      extraLuaPackages = ps:
+        (extractLuaPackagesFn plugins ps) ++ (extraLuaPackages ps);
     }
     // {luaRcContent = customRC;};
   params =

lib/mkPluginsFromInputs.nix

@@ -0,0 +1,20 @@
+{
+  pkgs,
+  inputs,
+  predicate ? pkgs.lib.strings.hasPrefix "plugin-",
+  nameMap ? builtins.substring 7 (-1),
+  buildVimPlugin ? pkgs.vimUtils.buildVimPlugin,
+}: let
+  inherit (builtins) attrNames filter foldl' mapAttrs;
+  names = filter predicate (attrNames inputs);
+  mkPlugin = m: k: let
+    name = nameMap k;
+    pluginDef = {
+      inherit name;
+      src = inputs.${k};
+    };
+  in
+    m // {${name} = pluginDef;};
+  plugins = foldl' mkPlugin {} names;
+in
+  mapAttrs (_: buildVimPlugin) plugins

lib/types.nix

@@ -1,17 +1,30 @@
-{yants, ...}: rec {
+{yants, ...}: let
+  stringList = with yants; list string;
+  stringOrStringList = with yants; either string stringList;
+  stringOrStringListOr = type:
+    with yants;
+      option (eitherN [string type (list (either string type))]);
+in rec {
   # The runtime object
   runtimeType = with yants;
     struct "runtime" {
       # The version of the runtime
       version = option string;
 
-      # The init configuration file
-      init = option (either path string);
-
       # The content of the runtime directory
       src = any;
     };
 
+  neovimInitType = with yants;
+    struct "neovimInit" {
+      # Lua code to call before plugins loaded
+      init = option (either string path);
+      # Lua code called after init but before import
+      postInit = option (either string path);
+      # Lua code called after all plugins are loaded
+      config = option (either string path);
+    };
+
   # As simple remote plugin definition
   basicPluginType = with yants;
     struct "basicPlugin" {
@@ -22,10 +35,24 @@
       src = any;
     };
 
+  eventType = with yants;
+    struct "event" {
+      # The name of the event
+      name = stringOrStringList;
+      # The pattern of the event
+      pattern = stringOrStringList;
+    };
+
+  keymapType = with yants;
+    struct "keymap" {
+      # The mode of the keymap
+      mode = option stringOrStringList;
+      # The mapping of the keymap
+      mapping = stringOrStringList;
+    };
+
   # The plugin type of dependencies
-  pluginType = with yants; let
-    stringList = list string;
-  in
+  pluginType = with yants;
     struct "plugin" {
       # Whether this plugin should be enabled. This option allows specific
       # plugins to be disabled.
@@ -45,11 +72,14 @@
       # Ensure thoses plugins are loaded before the current one
       dependencies = option (list drv);
 
+      # Ensure those packages are available
+      extraLuaPackages = option function;
+
       # Should this plugin be load lazily ?
       lazy = option bool;
 
       # List of events on which the plugin should be loaded
-      # events = option stringList;
+      events = option (stringOrStringListOr eventType);
 
       # List of commands on which the plugin should be loaded
       cmd = option stringList;
@@ -58,7 +88,7 @@
       ft = option stringList;
 
       # List of keystrokes on which the plugin should be loaded
-      # keys = option stringList;
+      keymaps = option (stringOrStringListOr keymapType);
 
       # Priority of the module. Influence the order of loading plugins.
       # Highest values get loaded before.
@@ -78,14 +108,20 @@
       # Default is pkgs.neovim-unwrapped
       package = option drv;
 
+      # init.lua configuration
+      init = option (eitherN [string path neovimInitType]);
+
       # An array of dependencies.
-      dependencies = list dependency;
+      dependencies = option (list dependency);
 
       # Extra argument to pass to dependencies files
-      dependenciesExtraArgs = attrs any;
+      dependenciesExtraArgs = option (attrs any);
+
+      # Ensure those packages are available
+      extraLuaPackages = option function;
 
       # Runtime configuration
-      runtime = runtimeType;
+      runtime = option runtimeType;
 
       # Create a vi alias
       viAlias = option bool;

lua/sloth-flake/command/describe.lua

@@ -0,0 +1,74 @@
+local Dep = require 'sloth-flake.dep'
+local utils = require 'sloth-flake.utils'
+
+local function yesno(value)
+  return value and "Yes" or "No"
+end
+
+local function list(items)
+  if items == nil or #items == 0 then
+    return "None"
+  end
+  return vim.iter(items):join(', ')
+end
+
+local function describe(dep)
+  utils.info('Name:         %s', dep.name)
+  utils.info('Is loaded:    %s', yesno(dep.is_loaded))
+  utils.info('Is lazy:      %s', yesno(dep.is_lazy))
+  utils.info('Has init:     %s', yesno(dep.init))
+  utils.info('Has config:   %s', yesno(dep.config))
+  utils.info('Dependencies: %s', list(dep.dependency_names))
+  utils.info('Filetypes:    %s', list(dep.ft))
+  utils.info('Commands:     %s', list(dep.cmd))
+  if dep.events == nil then
+    utils.info('Events:       None')
+  else
+    utils.info('Events:')
+    for _, event in ipairs(dep.events) do
+      for _, name in ipairs(event.name) do
+        for _, pattern in ipairs(event.pattern) do
+          utils.info(' - %s %s', name, pattern)
+        end
+      end
+    end
+  end
+  if dep.keymaps == nil then
+    utils.info('Keymaps:      None')
+  else
+    utils.info('Keymaps:')
+    for _, keymap in ipairs(dep.keymaps) do
+      for _, mode in ipairs(keymap.mode) do
+        for _, mapping in ipairs(keymap.mapping) do
+          utils.info(' - %s %s', mode, mapping)
+        end
+      end
+    end
+  end
+end
+
+return {
+  complete = function(line)
+    if line.arg_idx == 3 then
+      local prefix = line.args[line.arg_idx].arg
+      return vim.iter(Dep.all()):map(function(name)
+        return name
+      end):filter(function(name)
+        return vim.startswith(name, prefix)
+      end):totable()
+    end
+  end,
+
+  cmd = function(plugins)
+    if #plugins == 0 then
+      utils.error("You should at least give a plugin to describe!")
+      return
+    end
+    local plugin = plugins[1]
+    local dep = Dep.get(plugin)
+    if dep == nil then
+      return utils.error([[Unknown plugin "%s"]], plugin)
+    end
+    describe(dep)
+  end,
+}

lua/sloth-flake/command/init.lua

@@ -6,15 +6,72 @@ local commands = {
   list = require 'sloth-flake.command.list',
   load = require 'sloth-flake.command.load',
   version = require 'sloth-flake.command.version',
+  describe = require 'sloth-flake.command.describe',
 }
 
-function sloth_cmd(param)
+local function parse_line(line, cursor_pos)
+  local raw_args = vim.split(line, ' +', { trimempty = true })
+  local parse_pos = 1
+  local args = vim.iter(raw_args):map(function(arg)
+    local start, stop = string.find(line, arg, parse_pos, { plain = true })
+    parse_pos = stop
+    return {
+      arg = arg,
+      start = start,
+      stop = stop,
+    }
+  end):totable()
+  parse_pos = 1
+  local arg_idx = 1
+  vim.iter(args):find(function(arg)
+    if cursor_pos < arg.start then
+      arg_idx = arg_idx - 1
+      return true
+    elseif cursor_pos <= arg.stop then
+      return true
+    end
+    arg_idx = arg_idx + 1
+    return false
+  end)
+  arg_idx = arg_idx < 1 and 1 or arg_idx
+  if arg_idx > #args then
+    args[#args + 1] = {
+      arg = "",
+      start = line:len(),
+      stop = line:len(),
+    }
+  end
+  return {
+    line = line,
+    args = args,
+    arg_idx = arg_idx,
+    pos = cursor_pos,
+    in_arg_pos = args[arg_idx] and cursor_pos - args[arg_idx].start + 1,
+  }
+end
+-- print(vim.inspect(parse_line('Sloth ', 6)))
+
+local function sloth_cmd_complete(arg_lead, cmd_line, cursor_pos)
+  local parsed_line = parse_line(cmd_line, cursor_pos)
+  local arg = parsed_line.args[parsed_line.arg_idx]
+  if parsed_line.arg_idx == 2 then
+    return vim.iter(commands):map(function(name, command)
+      return vim.startswith(name, arg.arg) and name or nil
+    end):totable()
+  elseif parsed_line.arg_idx > 2 then
+    local cmd = parsed_line.args[2].arg
+    local command = commands[cmd]
+    return command and command.complete(parsed_line)
+  end
+end
+
+local function sloth_cmd(param)
   local args = param.fargs
   local cmd = args[1] or "list";
   table.remove(args, 1)
-  local fn = commands[cmd]
-  if fn then
-    fn(args)
+  local command = commands[cmd]
+  if command then
+    command.cmd(args)
   else
     vim.api.nvim_err_writeln(string.format([[No Sloth subcommand "%s"]], cmd))
   end
@@ -23,6 +80,7 @@ end
 function M.register()
   vim.api.nvim_create_user_command('Sloth', sloth_cmd, {
     nargs = '*',
+    complete = sloth_cmd_complete
   })
 end
 

lua/sloth-flake/command/list.lua

@@ -1,29 +1,55 @@
 local Dep = require 'sloth-flake.dep'
 local utils = require 'sloth-flake.utils'
 
-return function(args)
-  local filter = args[1] or "all"
-  local deps = vim.iter(Dep.all()):map(function(_, dep)
-    return dep:name()
-  end)
-  if filter == "all" then
+local filters = {
+  all = {
+    filter = function(iter)
       -- Nothing to do
-  elseif filter == "loaded" then
-    deps = deps:filter(function(dep)
-      return Dep.get(dep):is_loaded()
+      return iter
+    end
+  },
+  loaded = {
+    filter = function(iter)
+      return iter:filter(function(dep)
+        return Dep.get(dep).is_loaded
       end)
-  elseif filter == "notloaded" then
-    deps = deps:filter(function(dep)
-      return not Dep.get(dep):is_loaded()
+    end
+  },
+  notloaded = {
+    filter = function(iter)
+      return iter:filter(function(dep)
+        return not Dep.get(dep).is_loaded
       end)
-  else
+    end
+  },
+}
+
+return {
+  complete = function(line)
+    if line.arg_idx == 3 then
+      local prefix = line.args[3].arg
+      return vim.iter(vim.tbl_keys(filters)):filter(function(name)
+        return vim.startswith(name, prefix)
+      end):totable()
+    end
+  end,
+
+  cmd = function(args)
+    local filter_name = args[1] or "all"
+    local filter = filters[filter_name]
+    if not filter then
       utils.error([[No Sloth list filter "%s".]], cmd)
-    utils.error("Filters are: all, loaded, notloaded")
+      utils.error("Filters are: %s", vim.iter(vim.tbl_keys(filters)):join(', '))
       return
     end
-  deps = deps:totable()
+
+    local deps = vim.iter(Dep.all()):map(function(_, dep)
+      return dep.name
+    end)
+    deps = filter.filter(deps):totable()
     table.sort(deps)
     for _, dep in ipairs(deps) do
       print(string.format("- %s", dep))
     end
-end
+  end,
+}

lua/sloth-flake/command/load.lua

@@ -1,7 +1,23 @@
 local Dep = require 'sloth-flake.dep'
 local utils = require 'sloth-flake.utils'
 
-return function(plugins)
+return {
+  complete = function(line)
+    local previous_deps = vim.iter(line.args):enumerate():map(function(i, arg)
+      if i < 3 or i > line.arg_idx then return end
+      return arg.arg
+    end):totable()
+
+    local prefix = line.args[line.arg_idx].arg
+    return vim.iter(Dep.all()):filter(function(name, dep)
+      return vim.startswith(name, prefix) and not dep.is_loaded
+          and not vim.list_contains(previous_deps, name)
+    end):map(function(name)
+      return name
+    end):totable()
+  end,
+
+  cmd = function(plugins)
     if #plugins == 0 then
       utils.error("You should at least give a plugin to load!")
       return
@@ -12,4 +28,5 @@ return function(plugins)
         dep:load()
       end
     end
-end
+  end,
+}

lua/sloth-flake/command/version.lua

@@ -1,4 +1,7 @@
-return function()
+return {
+  complete = function() end,
+  cmd = function()
     local version = require('sloth-flake.version')
     print(string.format('Sloth v%s', version()))
-end
+  end,
+}

lua/sloth-flake/dep.lua

@@ -18,26 +18,7 @@ function M.new(values)
   self.sm = state_machine.build(State, {
     enter = {
       [State.Shimed] = function()
-        if self.cmd then
-          for _, cmd in ipairs(self.cmd) do
-            vim.api.nvim_create_user_command(cmd, self:lazy_load_cmd(cmd), {
-              desc = "Sloth-flake placeholder for plugin " .. self.name,
-              nargs = '*',
-              bang = true,
-            })
-          end
-        end
-
-        if self.ft then
-          local group_id = vim.api.nvim_create_augroup(self.augroup_name, {
-            clear = true,
-          })
-          vim.api.nvim_create_autocmd('FileType', {
-            group = group_id,
-            pattern = self.ft,
-            callback = self:lazy_load_ft()
-          })
-        end
+        return self:_shim()
       end,
       [State.Inited] = function()
         for _, dep in ipairs(self.dependencies) do
@@ -52,7 +33,7 @@ function M.new(values)
           dep:import()
         end
 
-        if self.is_lazy then
+        if self.is_lazy or self.values.init then
           vim.cmd("packadd " .. self.name)
         end
       end,
@@ -67,15 +48,7 @@ function M.new(values)
     },
     exit = {
       [State.Shimed] = function()
-        if self.cmd then
-          for _, cmd in ipairs(self.cmd) do
-            vim.api.nvim_del_user_command(cmd)
-          end
-        end
-
-        if self.ft then
-          vim.api.nvim_del_augroup_by_name(self.augroup_name)
-        end
+        self:_unshim()
       end,
     },
     events = {
@@ -134,6 +107,14 @@ function M:get_ft()
   return self.values.ft
 end
 
+function M:get_events()
+  return self.values.events
+end
+
+function M:get_keymaps()
+  return self.values.keymaps
+end
+
 function M:get_is_lazy()
   return self.values.lazy or false
 end
@@ -150,6 +131,10 @@ function M:get_is_loaded()
   return self.state >= State.Loaded
 end
 
+function M:get_has_events()
+  return self.ft or self.events
+end
+
 function M:get_augroup_name()
   return "Sloth-plugin-" .. self.name
 end
@@ -158,6 +143,70 @@ function M:shim()
   return self.sm:shim()
 end
 
+function M:_shim()
+  if self.cmd then
+    for _, cmd in ipairs(self.cmd) do
+      vim.api.nvim_create_user_command(cmd, self:lazy_load_cmd(cmd), {
+        desc = "Sloth-flake placeholder for plugin " .. self.name,
+        nargs = '*',
+        bang = true,
+      })
+    end
+  end
+
+  if self.has_events then
+    local group_id = vim.api.nvim_create_augroup(self.augroup_name, {
+      clear = true,
+    })
+
+    if self.ft then
+      vim.api.nvim_create_autocmd('FileType', {
+        group = group_id,
+        pattern = self.ft,
+        callback = self:lazy_load_event('FileType')
+      })
+    end
+
+    if self.events then
+      for _, event in ipairs(self.events) do
+        vim.api.nvim_create_autocmd(event.name, {
+          group = group_id,
+          pattern = event.pattern,
+          callback = self:lazy_load_event(event.name)
+        })
+      end
+    end
+  end
+
+  if self.keymaps then
+    for _, keymap in ipairs(self.keymaps) do
+      for _, mapping in ipairs(keymap.mapping) do
+        vim.keymap.set(keymap.mode, mapping, self:lazy_load_mapping(mapping))
+      end
+    end
+  end
+end
+
+function M:_unshim()
+  if self.cmd then
+    for _, cmd in ipairs(self.cmd) do
+      vim.api.nvim_del_user_command(cmd)
+    end
+  end
+
+  if self.has_events then
+    vim.api.nvim_del_augroup_by_name(self.augroup_name)
+  end
+
+  if self.keymaps then
+    for _, keymap in ipairs(self.keymaps) do
+      for _, mapping in ipairs(keymap.mapping) do
+        vim.keymap.del(keymap.mode, mapping)
+      end
+    end
+  end
+end
+
 function M:init()
   return self.sm:init()
 end
@@ -187,15 +236,22 @@ function M:lazy_load_cmd(cmd)
   end
 end
 
-function M:lazy_load_ft()
+function M:lazy_load_event(name)
   return function(param)
     self:load()
-    vim.api.nvim_exec_autocmds('FileType', {
+    vim.api.nvim_exec_autocmds(name, {
       pattern = param.match,
     })
   end
 end
 
+function M:lazy_load_mapping(mapping)
+  return function(param)
+    self:load()
+    vim.cmd.normal(mapping)
+  end
+end
+
 local deps = {}
 for k, v in pairs(raw_deps) do
   deps[k] = M.new(v)

lua/sloth-flake/state_machine.lua

@@ -50,8 +50,8 @@ function SM:run_enter_state(state)
 end
 
 function SM:run_exit_state(state)
-  local enter_fn = self.defs.exit and self.defs.exit[state] or empty_fn
-  enter_fn(self.state)
+  local exit_fn = self.defs.exit and self.defs.exit[state] or empty_fn
+  exit_fn(self.state)
 end
 
 local function wrap_state_array(val)

lua/sloth-flake/utils.lua

@@ -1,5 +1,9 @@
 local M = {}
 
+function M.info(...)
+  print(string.format(...))
+end
+
 function M.error(...)
   vim.api.nvim_err_writeln(string.format(...))
 end

shell.nix

@@ -1,13 +1,15 @@
 {
-  pkgs,
+  formatter,
   nil,
+  pkgs,
   ...
 }:
 with pkgs;
   mkShell {
     buildInputs = [
+      formatter
+      git-cliff
       nil
       sumneko-lua-language-server
-      git-cliff
     ];
   }