From 622c266160e53badf1a9eaa52f580e2daf78460b Mon Sep 17 00:00:00 2001 From: Tom Zaspel <40226087+tzabbi@users.noreply.github.com> Date: Wed, 23 Oct 2024 17:57:13 +0200 Subject: [PATCH] docs: Add documentation for `auto_install_extensions` setting (#19559) Improved: Documenation for (un)installing extensions automatically. Signed-off-by: Tom Zaspel Co-authored-by: Peter Tripp --- docs/src/configuring-zed.md | 34 ++++++++++++++++++++ docs/src/extensions/installing-extensions.md | 4 +++ 2 files changed, 38 insertions(+) diff --git a/docs/src/configuring-zed.md b/docs/src/configuring-zed.md index 16f7fcf2d593d0a1e093b0a1b23fd46badb8ae37..78c7c62c941db7c30898c292d2e4b82f9ca20204 100644 --- a/docs/src/configuring-zed.md +++ b/docs/src/configuring-zed.md @@ -39,6 +39,40 @@ Extensions that provide language servers may also provide default settings for t `float` values +## Auto Install extensions + +- Description: Define extensions to be autoinstalled or never be installed. +- Setting: `auto_install_extension` +- Default: `{"html": true}` + +**Options** + +You can find the names of your currently installed extensions by listing the subfolders under the [extension installation location](./extensions/installing-extensions#installation-location): + +On MacOS: + +```sh +ls ~/Library/Application\ Support/Zed/extensions/installed/ +``` + +On Linux: + +```sh +ls ~/.local/share/zed/extensions/installed +``` + +Define extensions which should be installed (`true`) or never installed (`false`). + +```json +{ + "auto_install_extensions": { + "html": true, + "dockerfile": true, + "docker-compose": false + } +} +``` + ## Autosave - Description: When to automatically save edited buffers. diff --git a/docs/src/extensions/installing-extensions.md b/docs/src/extensions/installing-extensions.md index 86af3f0935a16feb0503f1aa429d837162b7ad85..aed8bef4288d58fa9892235704f1eb160320ddeb 100644 --- a/docs/src/extensions/installing-extensions.md +++ b/docs/src/extensions/installing-extensions.md @@ -13,3 +13,7 @@ This directory contains two subdirectories: - `installed`, which contains the source code for each extension. - `work` which contains files created by the extension itself, such as downloaded language servers. + +## Auto installing + +To automate extension installation/uninstallation see the docs for [auto_install_extensions](../configuring-zed.md#auto-install-extensions).