mason.nvim

Portable Package Manager pour Neovim qui s'exécute partout Neovim.
Installer et gérer facilement les serveurs LSP, les serveurs DAP, les liners et les formateurs.

:help mason.nvim

^{Dernière version: v1.10.0}

Table des matières

• Introduction
  • Comment utiliser les packages installés
• Captures d'écran
• Exigences
• Installation
• Installation
  • Extensions
• Commandes
• Registres
• Configuration

Introduction

:h mason-introduction

mason.nvim est un plugin Neovim qui vous permet de gérer facilement des outils d'éditeur externe tels que les serveurs LSP, les serveurs DAP, les liners et les formateurs via une seule interface. Il s'exécute partout que Neovim s'exécute (à travers Linux, MacOS, Windows, etc.), avec seulement un petit ensemble d'exigences externes nécessaires.

Les packages sont installés dans le répertoire de données de Neovim ( :h standard-path ) par défaut. Les exécutables sont liés à un seul bin/ répertoire, que mason.nvim ajoutera au chemin de Neovim lors de la configuration, permettant un accès transparent à partir de Neovim Butina (Shell, Terminal, etc.) ainsi que d'autres plugins tiers.

Pour une liste de tous les packages disponibles, voir https://mason-registry.dev/registry/list.

Comment utiliser les packages installés

:h mason-how-to-use-packages

Bien que de nombreux forfaits soient parfaitement utilisables hors de la boîte via Neovim Butina, il est recommandé d'utiliser d'autres plugins tiers pour les intégrer davantage. Les plugins suivants sont recommandés:

• Lsp: lspconfig & mason-lspconfig.nvim
• DAP: nvim-dap & nvim-dap-ui
• Ligneurs: null-ls.nvim ou nvim-lint
• Formatrers: null-ls.nvim ou formatter.nvim

Captures d'écran

Exigences

:h mason-requirements

mason.nvim détend les exigences minimales en tentant plusieurs utilitaires différents (par exemple, wget , curl et Invoke-WebRequest sont tous des substituts parfaits). Les exigences minimales recommandées sont:

• Neovim >= 0.7.0
• Pour les systèmes Unix:
  • git(1)
  • curl(1) ou wget(1)
  • unzip(1)
  • GNU TAR ( tar(1) ou gtar(1) selon la plate-forme)
  • gzip(1)
• Pour les systèmes Windows:
  • PWSH ou PowerShell
  • git
  • Goudron de gnu
  • L'un des éléments suivants:
    • 7zip
    • paazip
    • archiver
    • winzip
    • Winrar

Notez que mason.nvim sera régulièrement engendré aux gestionnaires de packages externes, tels que cargo et npm . Selon votre utilisation personnelle, certaines d'entre elles devront également être installées. Reportez-vous à :checkhealth mason pour une liste complète.

Installation

Emballeur

 use {
    " williamboman/mason.nvim "
}

paresseux.nvim

{
    " williamboman/mason.nvim "
}

vim-plug

Plug ' williamboman/mason.nvim '

Installation

:h mason-quickstart

 require ( " mason " ). setup ()

mason.nvim est optimisé pour charger le moins possible pendant la configuration. Le chargement paresseux du plugin, ou en quelque sorte de différer la configuration, n'est pas recommandé.

Reportez-vous à la section de configuration pour plus d'informations sur les paramètres disponibles.

Extensions

Reportez-vous au wiki pour une liste des extensions tierces.

• mason-lspconfig.nvim - Recommandé pour l'utilisation avec lspconfig

Commandes

:h mason-commands

• :Mason - ouvre une fenêtre d'état graphique
• :MasonUpdate - met à jour tous les registres gérés
• :MasonInstall <package> ... - Installe / réinstalle les packages fournis
• :MasonUninstall <package> ... - Désinstaller les packages fournis
• :MasonUninstallAll - désinstalle tous les packages
• :MasonLog - Ouvre le fichier journal mason.nvim dans une nouvelle fenêtre d'onglet

Registres

Le registre des packages de base de Mason est situé au Mason-Org / Mason-Registry. Avant que tout package puisse être utilisé, le registre doit être téléchargé. Cela est fait automatiquement pour vous lors de l'utilisation des différentes commandes Mason (par exemple :MasonInstall ), mais peut également être fait manuellement en utilisant la commande :MasonUpdate .

Si vous utilisez les packages LUA API de Mason pour accéder, il est recommandé d'utiliser les fonctions :h mason-registry.refresh() et / ou :h mason-registry.update() pour vous assurer d'avoir les dernières informations sur les packages avant de récupérer des packages .

Configuration

:h mason-settings

Vous pouvez éventuellement configurer certains comportements de mason.nvim lorsque vous appelez la fonction .setup() . Reportez-vous à la configuration par défaut pour une liste de tous les paramètres disponibles.

Exemple:

 require ( " mason " ). setup ({
    ui = {
        icons = {
            package_installed = " ✓ " ,
            package_pending = " ➜ " ,
            package_uninstalled = " ✗ "
        }
    }
})

Configuration par défaut

 --- @class MasonSettings
local DEFAULT_SETTINGS = {
    --- @since 1.0.0
    -- The directory in which to install packages.
    install_root_dir = path . concat { vim . fn . stdpath " data " , " mason " },

    --- @since 1.0.0
    -- Where Mason should put its bin location in your PATH. Can be one of:
    -- - "prepend" (default, Mason's bin location is put first in PATH)
    -- - "append" (Mason's bin location is put at the end of PATH)
    -- - "skip" (doesn't modify PATH)
    --- @type ' "prepend" ' | ' "append" ' | ' "skip" '
    PATH = " prepend " ,

    --- @since 1.0.0
    -- Controls to which degree logs are written to the log file. It's useful to set this to vim.log.levels.DEBUG when
    -- debugging issues with package installations.
    log_level = vim . log . levels . INFO ,

    --- @since 1.0.0
    -- Limit for the maximum amount of packages to be installed at the same time. Once this limit is reached, any further
    -- packages that are requested to be installed will be put in a queue.
    max_concurrent_installers = 4 ,

    --- @since 1.0.0
    -- [Advanced setting]
    -- The registries to source packages from. Accepts multiple entries. Should a package with the same name exist in
    -- multiple registries, the registry listed first will be used.
    registries = {
        " github:mason-org/mason-registry " ,
    },

    --- @since 1.0.0
    -- The provider implementations to use for resolving supplementary package metadata (e.g., all available versions).
    -- Accepts multiple entries, where later entries will be used as fallback should prior providers fail.
    -- Builtin providers are:
    --   - mason.providers.registry-api  - uses the https://api.mason-registry.dev API
    --   - mason.providers.client        - uses only client-side tooling to resolve metadata
    providers = {
        " mason.providers.registry-api " ,
        " mason.providers.client " ,
    },

    github = {
        --- @since 1.0.0
        -- The template URL to use when downloading assets from GitHub.
        -- The placeholders are the following (in order):
        -- 1. The repository (e.g. "rust-lang/rust-analyzer")
        -- 2. The release version (e.g. "v0.3.0")
        -- 3. The asset name (e.g. "rust-analyzer-v0.3.0-x86_64-unknown-linux-gnu.tar.gz")
        download_url_template = " https://github.com/%s/releases/download/%s/%s " ,
    },

    pip = {
        --- @since 1.0.0
        -- Whether to upgrade pip to the latest version in the virtual environment before installing packages.
        upgrade_pip = false ,

        --- @since 1.0.0
        -- These args will be added to `pip install` calls. Note that setting extra args might impact intended behavior
        -- and is not recommended.
        --
        -- Example: { "--proxy", "https://proxyserver" }
        install_args = {},
    },

    ui = {
        --- @since 1.0.0
        -- Whether to automatically check for new versions when opening the :Mason window.
        check_outdated_packages_on_open = true ,

        --- @since 1.0.0
        -- The border to use for the UI window. Accepts same border values as |nvim_open_win()|.
        border = " none " ,

        --- @since 1.0.0
        -- Width of the window. Accepts:
        -- - Integer greater than 1 for fixed width.
        -- - Float in the range of 0-1 for a percentage of screen width.
        width = 0.8 ,

        --- @since 1.0.0
        -- Height of the window. Accepts:
        -- - Integer greater than 1 for fixed height.
        -- - Float in the range of 0-1 for a percentage of screen height.
        height = 0.9 ,

        icons = {
            --- @since 1.0.0
            -- The list icon to use for installed packages.
            package_installed = " ◍ " ,
            --- @since 1.0.0
            -- The list icon to use for packages that are installing, or queued for installation.
            package_pending = " ◍ " ,
            --- @since 1.0.0
            -- The list icon to use for packages that are not installed.
            package_uninstalled = " ◍ " ,
        },

        keymaps = {
            --- @since 1.0.0
            -- Keymap to expand a package
            toggle_package_expand = " <CR> " ,
            --- @since 1.0.0
            -- Keymap to install the package under the current cursor position
            install_package = " i " ,
            --- @since 1.0.0
            -- Keymap to reinstall/update the package under the current cursor position
            update_package = " u " ,
            --- @since 1.0.0
            -- Keymap to check for new version for the package under the current cursor position
            check_package_version = " c " ,
            --- @since 1.0.0
            -- Keymap to update all installed packages
            update_all_packages = " U " ,
            --- @since 1.0.0
            -- Keymap to check which installed packages are outdated
            check_outdated_packages = " C " ,
            --- @since 1.0.0
            -- Keymap to uninstall a package
            uninstall_package = " X " ,
            --- @since 1.0.0
            -- Keymap to cancel a package installation
            cancel_installation = " <C-c> " ,
            --- @since 1.0.0
            -- Keymap to apply language filter
            apply_language_filter = " <C-f> " ,
            --- @since 1.1.0
            -- Keymap to toggle viewing package installation log
            toggle_package_install_log = " <CR> " ,
            --- @since 1.8.0
            -- Keymap to toggle the help view
            toggle_help = " g? " ,
        },
    },
}

---

^{Vous n'avez pas trouvé ce que vous cherchiez? Essayez de regarder dans les documents d'aide :help mason.nvim !}