feat: prep config, commands and search

Author: vhyrro

lua/lux-nvim/commands.lua

@@ -1,4 +1,4 @@
----@mod rocks-commands rocks.nvim commands
+---@mod lux-commands lux.nvim commands
 ---
 ---@brief [[
 ---
@@ -7,32 +7,32 @@
 --- command	  	                     action
 ---------------------------------------------------------------------------------
 ---
---- install {rock} {version?} {args[]?} Install {rock} with optional {version} and optional {args[]}.
----                                     Example: ':Lux install neorg 8.0.0 opt=true'
----                                     Will install or update to the latest version if called
----                                     without {version}.
----                                     args (optional):
----                                       - opt={true|false}
----                                         Rocks that have been installed with 'opt=true'
----                                         can be sourced with |packadd|.
----                                       - pin={true|false}
----                                         Rocks that have been installed with 'pin=true'
----                                         will be ignored by ':Lux update'.
----                                     Use 'Rocks! install ...' to skip prompts.
---- prune {rock}                        Uninstall {rock} and its stale dependencies,
----                                     and remove it from rocks.toml.
---- sync                                Synchronize installed rocks with rocks.toml.
----                                     It may take more than one sync to prune all rocks that can be pruned.
---- update {rock?}                      Search for updated rocks and install them.
----                                     If called with the optional {rock} argument, only {rock}
----                                     will be updated.
----                                     Use 'Rocks! update` to skip prompts.
----                                     with breaking changes.
---- edit                                Edit the rocks.toml file.
---- pin {rock}                          Pin {rock} to the installed version.
----                                     Pinned rocks are ignored by ':Lux update'.
---- unpin {rock}                        Unpin {rock}.
---- log                                 Open the log file.
+--- install {package} {version?} {args[]?} Install {package} with optional {version} and optional {args[]}.
+---                                        Example: ':Lux install neorg 8.0.0 opt=true'
+---                                        Will install or update to the latest version if called
+---                                        without {version}.
+---                                        args (optional):
+---                                          - opt={true|false}
+---                                            Packages that have been installed with 'opt=true'
+---                                            can be sourced with |packadd|.
+---                                          - pin={true|false}
+---                                            Packages that have been installed with 'pin=true'
+---                                            will be ignored by ':Lux update'.
+---                                        Use 'Lux! install ...' to skip prompts.
+--- prune {package}                        Uninstall {package} and its stale dependencies,
+---                                        and remove it from lux.toml.
+--- sync                                   Synchronize installed packages with lux.toml.
+---                                        It may take more than one sync to prune all packages that can be pruned.
+--- update {package?}                      Search for updated packages and install them.
+---                                        If called with the optional {packages} argument, only {packages}
+---                                        will be updated.
+---                                        Use 'Lux! update` to skip prompts.
+---                                        with breaking changes.
+--- edit                                   Edit the lux.toml file.
+--- pin {package}                          Pin {package} to the installed version.
+---                                        Pinned packages are ignored by ':Lux update'.
+--- unpin {package}                        Unpin {package}.
+--- log                                    Open the log file.
 ---
 ---@brief ]]
 ---

lua/lux-nvim/config/init.lua

@@ -17,6 +17,24 @@ local config = {}
 ---@tag g:lux_nvim
 ---@class LuxConfig
 ---
+-- TODO(vhyrro): Generate these automatically from lux-lua
+---@field server string
+---@field extra_servers string[]
+---@field only_sources string
+---@field namespace string
+---@field lua_dir string
+---@field user_tree fun(lua_version: string)
+---@field no_force boolean
+---@field verbose boolean
+---@field timeout number
+---@field cache_dir string
+---@field data_dir string
+---@field entrypoint_layout table
+---@field variables table<string, string>
+---@field make_cmd string
+---@field cmake_cmd string
+---@field enabled_dev_servers string[]
+---
 --- Whether to query luarocks.org lazily (Default: `false`).
 --- Setting this to `true` may improve startup time,
 --- but features like auto-completion will lag initially.

lua/lux-nvim/operations/search.lua

@@ -0,0 +1,23 @@
+---@mod lux.operations.search lux.nvim package searching
+---
+---@brief [[
+---
+---Search for packages available on luarocks.org
+---
+---@brief ]]
+
+local nio = require("nio")
+
+local search = {}
+
+---@class LuarocksSearchOpts
+---@field dev? boolean Include dev manifest? Default: false
+---@field servers? server_url[]|only_server_url Optional servers. Defaults to constants.ROCKS_SERVERS
+
+---Search luarocks.org for all packages.
+---@type async fun(callback: fun(rocks_table: { [string]: Rock } ), opts?: LuarocksSearchOpts)
+search.search_all = nio.create(function(callback, opts)
+    require("lux").operations.search()
+end)
+
+return search