VSCodium/vscodium
1
1
Fork 0
mirror of https://github.com/VSCodium/vscodium.git synced 2024-12-16 04:04:53 +03:00
Code Issues Projects Releases Wiki Activity
06cc20f63b
vscodium/DOCS.md
Simone Foschi 5dfd780291 Fixed other typos and one image path in DOCS.md
2019-06-26 18:51:31 +02:00

6.3 KiB
Raw Blame History

More Info

Table of Contents

Getting all the Telemetry Out

Even though we do not pass the telemetry build flags (and go out of our way to cripple the baked-in telemetry), Microsoft will still track usage by default.

We do however set the default telemetry.enableCrashReporter and telemetry.enableTelemetry values to false. You can see those by viewing your VSCodium settings.json and searching for telemetry.

The instructions here and here help with explaining and toggling telemetry.

It is also highly recommended that you review all the settings that "use online services" by following these instructions. The @tag:usesOnlineServices filter on the settings page will show that by default:

  • Extensions auto check for updates and auto install updates
  • Searches within the app are sent to an online service for "natural language processing"
  • Updates to the app are fetched in the background

These can all be disabled.

Please note that some extensions send telemetry data to Microsoft as well. We have no control over this and can only recommend removing the extension.

(For example the C# extension ms-vscode.csharp sends tracking data to Microsoft.)

Extensions + Marketplace

Until something more open comes around, we use the Microsoft Marketplace/Extensions in the product.json file. Those links are licensed under MIT as per the comments on this issue.

If you use the code-settings-sync extension, you may have an issue installing extensions (via the plugin). Refer to this workaround to get it working properly.

Proprietary Debugging Tools

The debugger provided with Microsoft's C# extension as well as the (Windows) debugger provided with their C++ extension are very restrictively licensed to only work with the offical Visual Studio Code build. See this comment in the C# extension repo and this comment in the C++ extension repo.

A workaround exists to get debugging working in C# projects, by using Samsung's opensource netcoredbg package. See this comment for instructions on how to set that up.

Migrating 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.

Visual Studio Code stores its keybindings.json and settings.json file in the these locations:

  • Windows: %APPDATA%\Code\User
  • macOS: $HOME/Library/Application Support/Code/User
  • Linux: $HOME/.config/Code/User

You can copy these files to the VSCodium user settings folder:

  • Windows: %APPDATA%\VSCodium\User
  • macOS: $HOME/Library/Application Support/VSCodium/User
  • Linux: $HOME/.config/VSCodium/User

To copy your settings manually:

  • In Visual Studio Code, go to Settings (Command+, if on a Mac)
  • Click the three dots ... and choose 'Open settings.json'
  • Copy the contents of settings.json into the same place in VSCodium

How do I run VSCodium in portable mode?

You can follow the Portable Mode instructions from the Visual Studio Code website. For Windows and Linux the instructions can be followed as written. For Mac OS, portable mode is enabled by the existence of a specially named folder. For Visual Studio Code that folder name is code-portable-data. For VSCodium, that folder name is vscodium-portable-data.

So to enable portable mode for VSCodium on Mac OS, follow the instructions outlined in the link above, but create a folder named vscodium-portable-data instead of code-portable-data.

How do I press and hold a key and have it repeat in VSCodium (Mac)?

This is a common question for Visual Studio Code and the procedure is slightly different in VSCodium because the defaults path is different.

$ defaults write com.visualstudio.code.oss ApplePressAndHoldEnabled -bool false

How do I open VSCodium from the terminal?

  • Go to the command palette (View | Command Palette...)
  • Choose Shell command: Install 'codium' command in PATH.

This allows you to open files or directories in VSCodium directly from your terminal:

~/in-my-project $ codium . # open this directory
~/in-my-project $ codium file.txt # open this file

Feel free to alias this command to something easier to type in your shell profile (e.g. alias code=codium).

Gentoo ebuild/overlay

There is an external Gentoo overlay with a working ebuild to install VSCodium, provided by @wolviecb. The overlay can be found here.