Miq

🐌 Packer-inspired plugin Manager for Lite XL.

Miq is a declarative plugin manager for Lite XL, inspired by packer for Neovim. Miq plugins are installed by declaring them in a Lua table, then either calling the install function or running the install command.

Warning Miq is work in progress! If there are, please report them by opening an issue.

Install

Miq can be installed like any other Lite XL plugin, since it is pure Lua. Clone Miq to your Lite XL plugins directory:

git clone https://github.com/TorchedSammy/Miq ~/.config/lite-xl/plugins/miq

Quickstart

Here is an example of how to specify Miq plugins:

local config = require 'core.config'

-- Plugins are specified in this table:
config.plugins.miq.plugins = {
    -- Miq can manage itself
    'TorchedSammy/Miq',

    -- Normal plugins hosted on a single git repo can be specified with AuthorName/RepoName
    'lite-xl/lite-xl-lsp',

    -- Plugins on the central lite-xl-plugins repo can be specified by name
    'autoinsert'

    -- If you want to install a plugin with from a specific repo, it can be done
    -- format would be url:branch/commit
    {'plugin', repo = 'https://github.com/user/lite-xl-plugins:master'}

    -- If needed, you can setup a local plugin, which will simply be symlinked.
    -- I personally do this for Miq.
    '~/lite-xl-plugin-path'

    -- Any native plugin or similar that needs compiling can have a post install command.
    {'TorchedSammy/Litepresence', run = 'go get && go build'}

    -- The destination plugin name can be specified if other plugins rely on a special name
    -- (gitdiff-highlight requires itself with an underscore)
    {'vincens2005/lite-xl-gitdiff-highlight', name = 'gitdiff_highlight'}
}

Repositories that host several plugins (like the default lite-xl-plugins repo) can be specified with the following:

config.plugins.miq.repos = {
    'https://github.com/lite-xl/lite-xl-plugins.git:2.2'
}

Then any plugin which is specified by a simple name will be installed from these repositories.

Once all plugins are specified, the Miq: Install command can be ran to install them.

Details

Plugin Spec

Each plugin is defined via its spec. When declaring a plugin as a string, the fields will be filled in with their defaults. If you want to specify more though, you need to declare it as a table.

Here are the available fields for a plugin spec:

{
    -- The identifier for the plugin. This is usually in the form of the
    -- slug (AuthorName/RepoName) and does not need to be specified as
    -- `plugin`, since the 1st key of the spec will be used as it.
    plugin = '',
    -- A command to run after installing/upgrading plugins
    run = '',
    -- The name of the plugin when installed. This is mainly intended for
    -- "complex" plugins (those on single repos) which expect a different
    -- name than what Miq defaults to.
    -- By default, this will simply be based on the identifier, lowercasing it
    -- and removing "lite-xl-" prefixes and ".lxl" suffixes
    name = '',
    -- The URL of the repository which hosts the plugin. This is intended for repositories
    -- that host multiple plugins (like lite-xl-plugins) and is only useful to be specified
    -- if you have 2 repositories with a plugin that would cause conflicts (by having the same name).
    repo = '',
    -- Dependencies can be declared the same way plugins can, since they are just plugins.
    dependencies = {}
}

License

MIT