How To Speed Up Vscode
Last updated
Last updated
VS Code users (and there are a lot of us) just love our extensions. There are thousands of VS Code extension to choose from and many of us have several installed. They do everything from lighting up your favorite language, formatting your code, or even colorizing your theme.
Have you ever noticed that some extensions take a few moments to initialize as you start VS Code? What might cause this delay?
What can you do about it? A lot actually. Stay with me to see how you can help your favorite extensions load fast!
One possible cause is the number of files or the size of the extension. Some extensions have so much functionality in them that they can slow down over time.
When we build apps for the web, we write dozens or hundreds of files in JavaScript, CSS, and HTML. We don't want to send 1,000 files across the web to a browser as it may be a poor experience of waiting and waiting. When we write our code it isn't optimized for the browser quite as much as it can be, either. Modern tools help us solve this by compressing the files into a single (or a small set) of files. One popular tool is WebPack.
If you use the command to "Developer: Show Running Extensions" you will see a list of the activated extensions in your VS Code instance. You will also see, to the right, how long each extension took to activate in ms.
This is a great way to find out which ones may be slower activating. Notice the list below from my instance of VS Code shows a few of my installed extensions and their activation times. Obviously, some take longer than others to load, because they do more.
What can you do if one is taking too long for your tastes? (maybe 1000ms?)
Recently the VS Code team released the ability to use WebPack to bundle the files in extensions.
The article covers it all really, and it can help when packaging an extension.
I found that my Peacock extension was putting 48 files in the package. I made a few tweaks and I cut this down by a lot.
First, I added some file to the .vscodeignore file\
Then I created a new branch for my extension. I went through the steps in the VS Code docs to update my project to use WebPack.
My goals were to make all of these still work:
packaging with npm run package
publishing with npm run publish
local and CI testing with npm run test
F5 debugging with the launch.json
F5 debugging the tests with the launch.json
The approach has me compiling both with webpack and tsc for the tests and debugging.
Here is my project https://github.com/johnpapa/vscode-peacock
Changed my main file in package.json\
My npm scripts in package.json\
My launch.json configurations for debugging the runtime and tests:\
And here is the entire repo where you can see everything in context 👇
Subtly change the color of your Visual Studio Code workspace. Ideal when you have multiple VS Code instances, use VS Live Share, or use VS Code's Remote features, and you want to quickly identify your editor.
Read the extensive documentation here which includes a guide on how to use Peacock and a changelog
Open Extensions sideBar panel in Visual Studio Code and choose the menu options for View → Extensions
Search for Peacock
Click Install
Click Reload, if required
Read the extensive documentation here which includes a guide on how to use Peacock and a changelog
Let's see Peacock in action!
Create/Open a VSCode Workspace (Peacock only works in a Workspace)
Press F1 to open the command palette
Type Peacock
Choose Peacock: Change to a favorite color
Choose one of the pre-defined colors and see how it changes…
This is a great question, and one we should definitely ask. I mean, after all, to make any code change there has to be some value. I was able to get permission (thanks to the VS Code team and Erich Gamma) to share some performance stats (unofficial tests) of two extensions you may have used.
Both of these extensions have a considerable amount of logic in them and do some pretty impressive and useful things.
The Azure Account extension's size and number of files decreased considerably ... like from "holy moly" to "not bad"!
The warm activation is a term for how long it takes the extension to activate, when that extension has already been installed previously (not the first time). This was cut in half for this extension. Not bad at all!
Download size (the .vsix): 6.2M to 840K.
Packaged files: 4300 to 11
Warm activation time: 676ms to 338ms
The Docker extension had a noticeable warm activation improvements to under 2 seconds. But the key aspect is the cold activation time. Cold activation is how long it might take the extension to activate when it was just installed.
Warm activation time: 3.5s to <2s
Cold activation time (after 1st install): 20s to 2s
Several things are affected by using webpack to bundle an extension. This is why it's super important to test all of these out.
Run the extension locally in your debugger (and test you can hit a breakpoint)
Package the extension and load it (load from VSIX) from the menu
Run your tests with your debugger (and test you can hit a breakpoint)
Run your test script from npm test
When you are done, you can check the activation time again.
I recently switched projects over to our large monorepo (the zip from GitHub is around 150mb, without node_modules). I found that not only was Webpack causing my fans to run on overdrive, Visual Studio Code would get so laggy that typing caused seconds of latency.
I tried switching back to a simpler code editor, but I'm extremely reliant on Code's built-in search features in such a big project like this.
So, I had to take some time to get to the bottom of this.
Firstly, I checked Activity Monitor. I saw that something called Code Helper (Renderer) was taking 150% of my CPU.
My initial assumption was to stop using Code's built-in terminal and switch over to iTerm. That didn't fix it.
I looked at a lot of GitHub Issues about this issue and saw repeated comments from the Code team that Code Helper (Renderer) is process that comes from an extension. Disable all extensions and it will work.
So... I did. It did not work. I didn't even have any themes installed.
Finally, I came across an unanswered StackOverflow question where the comments answered what I needed.
If you are having performance issues with Visual Studio Code, open Developer: Open Process Explorer.
I saw that something called electron_node tsserver.js was taking up over 100% of my CPU. What was this? I didn't use any TypeScript in my project.
Further looking around led me to the fact that Visual Studio Code has extensions built-in that you never installed. I did not know this! You can find these by searching @builtin in your extensions.
Specifically, there is an extension called TypeScript and JavaScript Language Features which includes a lot of functionality like closing tags. However, it automatically runs TypeScript type-checking even if you don't have a TypeScript project. (This begs the question, why is Visual Studio Code so deeply integrated with TypeScript that it automatically assumes you're using it? Microsoft is selling us its entire ecoystem.)
Once I disabled the TypeScript: Disable Automatic Type Acquisition feature, Visual Studio Code was instantly faster than I've ever seen it before.
TL;DR: To make Visual Studio Code extremely fast if you don't use TypeScript, add this line to your settings.json file:\
Visual Studio Code was released on November 18, 2015. Fast-forward five years, and it has become one of the most successful editors around. It is released under the MIT license, which makes it free to use. Its keys to success are:
Versatility
A large number of plugins
Availability on multiple platforms
Currently, VS Code is available natively on the following platforms:
OS X Yosemite (10.10+)
Windows 7 (with .NET Framework 4.5.2), 8.0, 8.1 and 10 (32-bit and 64-bit)
Linux (Debian): Ubuntu Desktop 16.04, Debian 9
Linux (Red Hat): Red Hat Enterprise Linux 7, CentOS 8, Fedora 24
It can also run in any modern browser with limited features.
Its huge platform availability is because it’s a web application delivered on Electron.
“Electron (formerly known as Atom Shell) is an open-source software framework developed and maintained by GitHub. It allows for the development of desktop GUI applications using web technologies: it combines the Chromium rendering engine and the Node.” — Wikipedia
The only downside is that Electron can be pretty resource-hungry and less effective than native-based applications. That means it can get slower if you are not careful.
Is your VS Code feeling a bit sluggish? Do you want it to run in a more performant way? Today, we will be looking at five tips that will help you get the most out of it.
Before going into optimization, let’s look at if we comply with the minimum hardware recommended by the Visual Studio Code team. We will need a minimum disk footprint of 200 MB.
Processor and memory recommendations:
1.6 GHz or faster processor
1 GB of RAM
Check out the more detailed list.
VS Code comes packed with features. However, you might not be interested in some of them. You can therefore disable those to improve the editor's performance.
File > Preferences > Settings > Files:Exclude: Add any pattern of files that you don’t want VS Code to use in your project.
File > Preferences > Text Editor > Minimap > Enabled: Checkbox to disable/enable the minimap.
File > Preferences > Text Editor > Suggestions: Here, you can fine-tune anything related to suggestions.
File > Preferences > Text Editor > From on save / Format on paste: You can disable formatting on saving and defer that to pre-commit, for example.
File > Preferences > Application > Telemetry: Telemetry might impact performance.
File > Preferences > Text Editor > Code lens: You can disable/enable the Code Lens feature.
There are a ton of extensions available. However, that doesn’t mean you need them all. Only add the ones that have a direct impact on your daily productive life.
Before adding any extension, ask yourself:
Isn’t that already built into VS Code?
Is it more than a one-off thing?
Does it really have an impact on your daily work?
Is this the best tool for your use case?
Does it have a good rating?
If the plugin does check all the boxes, then it might be a good fit for you. You can do that process with your already installed extensions too.
If you are working on many different projects with different code stacks, you might find yourself installing a lot of extensions. That can easily have an impact on performance.
One trick is to couple your extensions with your workspace. That way, you know you are only loading the plugins necessary for that workspace.
What you need to do is just go through all the plugins you have available and disable the ones that you don’t need for your particular workspace.Example of disabling a plugin for a workspace
It might look like a time-consuming task at the beginning but it pays off in the long run.
Once you have the bare minimum of plugins needed for your coding, you can check their performance. VS Code comes with some Developer options that you can take advantage of.
You can easily monitor the startup time of all those plugins by executing cmd + p > Developer: Show Running Extensions.Example of running extensions command
You will get the following information:
OS details
Performance metrics
Extension Activation details
Cache location
It gives a great overview of your VS Code performance. It is useful when trying to assert the impact of any changes on performance. Doing periodic checks is a good habit to make sure everything is running smoothly.
There might be situations where you have to further configure the startup of VS Code. You can do that by using arguments in the command line. It is easy to configure that on the argv.json file.
Run CMD + Shift + P > Configure Runtime Arguments.Configuring the runtime arguments
VS Code is a great widely used IDE. It is very flexible and highly customizable. However, this comes with a cost. Make sure you understand what you are adding and how you are loading it.
At first, it seems like it’s easier to add plugins for any minor task you find yourself doing. With time, that extension starts to fade away in search of a more performant editor.
I hope all these tips help you speed up your VS Code editor and enjoy a better coding experience.
You will get a list of all your active extensions and their activation time. As a general rule of thumb, you might want to double-check anything that takes more than 300 ms.Example of running extensions command
If you want to dig deeper, you can profile any of them by hitting the record button.Profiling an extension
If you want to get a clear picture of all that’s happening on the VS Code launch, you might want to check the cmd + p > Developer Startup Performance.Example of startup performance command
A sample run of startup performance command
Then edit the argv.json file with all your custom configurations.File for configuring the runtime arguments
