Browse Source

docs: add useful extensions for managing settings/extensions

Baptiste Augrain 3 weeks ago
parent
commit
d3ac1bf13d
4 changed files with 66 additions and 16 deletions
  1. 5 10
      docs/extensions-compatibility.md
  2. 29 1
      docs/extensions.md
  3. 3 1
      docs/index.md
  4. 29 4
      docs/migration.md

+ 5 - 10
docs/extensions-compatibility.md

@@ -9,9 +9,8 @@
   - [C/C++](#cc)
   - [C/C++](#cc)
   - [Python](#python)
   - [Python](#python)
   - [Remote](#remote)
   - [Remote](#remote)
-- [Beyond](#beyond)
 
 
-## Incompatibility
+## <a id="incompatibility"></a>Incompatibility
 
 
 Most MS extensions are limited to run on only MS products by their license and by running additional checks in their proprietary code.
 Most MS extensions are limited to run on only MS products by their license and by running additional checks in their proprietary code.
 
 
@@ -25,24 +24,20 @@ Most MS extensions are limited to run on only MS products by their license and b
 - [Remote - SSH: Editing Configuration Files](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh-edit)
 - [Remote - SSH: Editing Configuration Files](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh-edit)
 - [Remote - WSL](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl)
 - [Remote - WSL](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl)
 
 
-## Replacements
+##<a id="replacements"></a>Replacements
 
 
 The following extensions are functional replacements for incompatible extensions:
 The following extensions are functional replacements for incompatible extensions:
 
 
-### C/C++
+### <a id="cc"></a>C/C++
 
 
 - [clangd](https://open-vsx.org/extension/llvm-vs-code-extensions/vscode-clangd)
 - [clangd](https://open-vsx.org/extension/llvm-vs-code-extensions/vscode-clangd)
 
 
-### Python
+### <a id="python"></a>Python
 
 
 - [BasedPyright](https://open-vsx.org/extension/detachhead/basedpyright)
 - [BasedPyright](https://open-vsx.org/extension/detachhead/basedpyright)
 
 
-### Remote
+### <a id="remote"></a>Remote
 
 
 - [Open Remote - SSH](https://open-vsx.org/extension/jeanp413/open-remote-ssh)
 - [Open Remote - SSH](https://open-vsx.org/extension/jeanp413/open-remote-ssh)
 > SSH server must be configured with the setting `AllowTcpForwarding yes`.
 > SSH server must be configured with the setting `AllowTcpForwarding yes`.
 - [Open Remote - WSL](https://open-vsx.org/extension/jeanp413/open-remote-wsl)
 - [Open Remote - WSL](https://open-vsx.org/extension/jeanp413/open-remote-wsl)
-
-## Beyond
-
-[VSIX Manager](https://github.com/zokugun/vscode-vsix-manager) allows you to be able install extensions from multiple sources.

+ 29 - 1
docs/extensions.md

@@ -11,9 +11,9 @@
 - [Visual Studio Marketplace](#visual-studio-marketplace)
 - [Visual Studio Marketplace](#visual-studio-marketplace)
 - [Proprietary Debugging Tools](#proprietary-debugging-tools)
 - [Proprietary Debugging Tools](#proprietary-debugging-tools)
 - [Proprietary Extensions](#proprietary-extensions)
 - [Proprietary Extensions](#proprietary-extensions)
+- [Using the "VSIX Manager" Extension](#vsix-manager)
 - [Extensions compatibility](https://github.com/VSCodium/vscodium/blob/master/docs/extensions-compatibility.md)
 - [Extensions compatibility](https://github.com/VSCodium/vscodium/blob/master/docs/extensions-compatibility.md)
 
 
-
 ## <a id="marketplace"></a>Marketplace
 ## <a id="marketplace"></a>Marketplace
 
 
 Being a vscode based editor, VSCodium gets additional features by installing Visual Studio Code extensions.
 Being a vscode based editor, VSCodium gets additional features by installing Visual Studio Code extensions.
@@ -106,3 +106,31 @@ Like the debuggers mentioned above, some extensions you may find in the marketpl
 ```
 ```
 
 
 In some cases, the above change won't help because the extension is hard-coded to only work with the official Visual Studio Code product.
 In some cases, the above change won't help because the extension is hard-coded to only work with the official Visual Studio Code product.
+
+## <a id="vsix-manager"></a>Using the "VSIX Manager" Extension
+
+The [**VSIX Manager**](https://github.com/zokugun/vscode-vsix-manager) extension provides a powerful and user-friendly interface for managing `.vsix` files directly within VSCodium. Its author is the main maintainer of VSCodium ;)
+
+It is particularly beneficial for:
+- **Support for Multiple Marketplaces**: Seamlessly install and manage extensions from several marketplaces at the same time, allowing access to a broader range of extensions.
+- **Local Files**: Manage a collection of `.vsix` files stored locally.
+- **GitHub/Forgejo Release**: Install the extension directly from its GitHub/Forgejo release pages.
+- **Fallback Options**
+
+### <a id="use-cases"></a>Use Cases
+
+- Developers working offline can easily manage `.vsix` files.
+- Teams can distribute specific versions of extensions across systems.
+- Enterprises with restricted environments can maintain control over installed extensions.
+- Users can connect to multiple marketplaces and access a wider range of extensions or switch seamlessly between them.
+
+### <a id="marketplace-support"></a>Marketplace Support
+
+The **VSIX Manager** extension supports managing extensions from several marketplaces simultaneously. This feature enables:
+- **Access to Diverse Extensions**: Install extensions from different sources like Open VSX or private repositories.
+- **Fallback Options**: Ensure extension availability even if one marketplace is temporarily inaccessible.
+- **Enterprise Flexibility**: Use private or self-hosted marketplaces alongside public ones to meet security and compliance requirements.
+- **Custom Configurations**: Prioritize specific marketplaces for particular needs while keeping access to others.
+
+## [Extensions compatibility](https://github.com/VSCodium/vscodium/blob/master/docs/extensions-compatibility.md)
+

+ 3 - 1
docs/index.md

@@ -23,9 +23,11 @@
   - [Visual Studio Marketplace](https://github.com/VSCodium/vscodium/blob/master/docs/extensions.md#visual-studio-marketplace)
   - [Visual Studio Marketplace](https://github.com/VSCodium/vscodium/blob/master/docs/extensions.md#visual-studio-marketplace)
   - [Proprietary Debugging Tools](https://github.com/VSCodium/vscodium/blob/master/docs/extensions.md#proprietary-debugging-tools)
   - [Proprietary Debugging Tools](https://github.com/VSCodium/vscodium/blob/master/docs/extensions.md#proprietary-debugging-tools)
   - [Proprietary Extensions](https://github.com/VSCodium/vscodium/blob/master/docs/extensions.md#proprietary-extensions)
   - [Proprietary Extensions](https://github.com/VSCodium/vscodium/blob/master/docs/extensions.md#proprietary-extensions)
+  - [Using the "VSIX Manager" Extension](https://github.com/VSCodium/vscodium/blob/master/docs/extensions.md#vsix-manager)
   - [Extensions compatibility](https://github.com/VSCodium/vscodium/blob/master/docs/extensions-compatibility.md)
   - [Extensions compatibility](https://github.com/VSCodium/vscodium/blob/master/docs/extensions-compatibility.md)
 - [Migration](https://github.com/VSCodium/vscodium/blob/master/docs/migration.md)
 - [Migration](https://github.com/VSCodium/vscodium/blob/master/docs/migration.md)
-  - [Migrating from Visual Studio Code to VSCodium](https://github.com/VSCodium/vscodium/blob/master/docs/migration.md#migrating)
+  - [Manual Migration from Visual Studio Code to VSCodium](https://github.com/VSCodium/vscodium/blob/master/docs/migration.md#manual-migration)
+  - [Semi-Automatic Migration with Sync Settings Extension](https://github.com/VSCodium/vscodium/blob/master/docs/migration.md#semi-automatic-migration)
 - [Usage](https://github.com/VSCodium/vscodium/blob/master/docs/usage.md)
 - [Usage](https://github.com/VSCodium/vscodium/blob/master/docs/usage.md)
   - [Sign in with GitHub](https://github.com/VSCodium/vscodium/blob/master/docs/usage.md#signin-github)
   - [Sign in with GitHub](https://github.com/VSCodium/vscodium/blob/master/docs/usage.md#signin-github)
   - [Accounts authentication](https://github.com/VSCodium/vscodium/blob/master/docs/accounts-authentication.md)
   - [Accounts authentication](https://github.com/VSCodium/vscodium/blob/master/docs/accounts-authentication.md)

+ 29 - 4
docs/migration.md

@@ -4,11 +4,12 @@
 
 
 ## Table of Contents
 ## Table of Contents
 
 
-- [Migrating from Visual Studio Code to VSCodium](#migrating)
+- [Manual Migration from Visual Studio Code to VSCodium](#manual-migration)
+- [Semi-Automatic Migration with Sync Settings Extension](#semi-automatic-migration)
 
 
-## <a id="migrating"></a>Migrating from Visual Studio Code to VSCodium
+## <a id="manual-migration"></a>Manual Migration from Visual Studio Code to VSCodium
 
 
-VSCodium (and a freshly cloned copy of vscode built from source) stores its extension files in `~/.vscode-oss`. So if you currently have Visual Studio Code installed, your extensions won't automatically populate. You can reinstall your extensions from the Marketplace in VSCodium, or copy the `extensions` from `~/.vscode/extensions` to `~/.vscode-oss/extensions`.
+VSCodium (and a freshly cloned copy of vscode built from source) stores its extension files in `~/.vscode-oss`. So if you currently have Visual Studio Code installed, your extensions won't automatically populate. You can copy the `extensions` from `~/.vscode/extensions` to `~/.vscode-oss/extensions`.
 
 
 Visual Studio Code stores its `keybindings.json` and `settings.json` file in these locations:
 Visual Studio Code stores its `keybindings.json` and `settings.json` file in these locations:
 
 
@@ -24,6 +25,30 @@ You can copy these files to the VSCodium user settings folder:
 
 
 To copy your settings manually:
 To copy your settings manually:
 
 
-- In Visual Studio Code, go to Settings (Command+, if on a Mac)
+- In Visual Studio Code, go to Settings (`Meta+,`)
 - Click the three dots `...` and choose 'Open settings.json'
 - Click the three dots `...` and choose 'Open settings.json'
 - Copy the contents of settings.json into the same place in VSCodium
 - Copy the contents of settings.json into the same place in VSCodium
+
+## <a id="semi-automatic-migration"></a>Semi-Automatic Migration with Sync Settings Extension
+
+The [**Sync Settings**](https://github.com/zokugun/vscode-sync-settings) extension can simplify the migration process by enabling synchronization of settings, keybindings, extensions, and more between Visual Studio Code and VSCodium. Its author is the main maintainer of VSCodium ;)
+
+The extension is available in the Visual Studio Marketplace, OpenVSX or directly in its GitHub repository.
+
+### Steps:
+
+1. Install the **Sync Settings** extension in both Visual Studio Code and VSCodium.
+2. Configure the extension on both Visual Studio Code and VSCodium:
+  - Open Command Palette (`Meta+Shift+P`).
+  - Search for `Sync Settings: Open the repository settings` and execute the command.
+  - Configure the repository
+3. Export your current settings from Visual Studio Code:
+  - Open Command Palette (`Meta+Shift+P`).
+  - Search for `Sync Settings: Upload (user -> repository)` and execute the command.
+4. Import the settings into VSCodium:
+  - I recommend the setting `"syncSettings.openOutputOnActivity": true,`.
+  - Open Command Palette (`Meta+Shift+P`).
+  - Search for `Sync Settings: Download (repository -> user)` and execute the command.
+  - Wait for all the extensions to be downloaded and installed (follow logs in the `Output` panel) before restarting VSCodium.
+
+This method ensures that all supported configurations are seamlessly transferred.