Public documentation for Visual Studio Code

Related tags

Spring Boot vscode
Overview

vscode logo

Visual Studio Code Documentation

You've found the Visual Studio Code documentation GitHub repository, which contains the content for the Visual Studio Code documentation.

Topics submitted here will be published to the Visual Studio Code portal.

If you are looking for the VS Code product GitHub repository, you can find it here.

Note: The vscode-docs repository uses Git LFS (Large File Storage) for storing binary files such as images and .gifs. If you are contributing or updating images, please enable Git LFS per the instructions in the Contributing section below.

Index

Visual Studio Code

VS Code is a lightweight source code editor and powerful development environment for building and debugging modern web, mobile, and cloud applications. It is free and available on your favorite platform - Linux, macOS, and Windows.

If you landed here looking for other information about VS Code, head over to our website for additional information.

Feedback

If you want to give documentation feedback, please use the feedback control located at the bottom of each documentation page.

Documentation Issues

To enter documentation bugs, please create a new GitHub issue. Please check if there is an existing issue first.

If you think the issue is with the VS Code product itself, please enter issues in the VS Code product repo here.

Contributing

To contribute new topics/information or make changes to existing documentation, please read the Contributing Guideline.

Workflow

The two suggested workflows are:

  • For small changes, use the "Edit" button on each page to edit the Markdown file directly on GitHub.
  • If you plan to make significant changes or preview the Markdown files in VS Code, clone the repo to edit and preview the files directly in VS Code.

Markdown Preview Button

Cloning

  1. Install Git LFS.
  2. Run git lfs install to setup global git hooks. You only need to run this once per machine.
  3. git clone [email protected]:Microsoft/vscode-docs.git.
  4. Now you can git add binary files and commit them. They'll be tracked in LFS.

Cloning without binary files

You might want to clone the repo without the 1.6GB images. Here are the steps:

  1. Install Git LFS.
  2. Run git lfs install to setup global git hooks. You only need to run this once per machine.
  3. Clone the repo without binary files.
    • macOS / Linux: GIT_LFS_SKIP_SMUDGE=1 git clone [email protected]:Microsoft/vscode-docs.git.
    • Windows: $env:GIT_LFS_SKIP_SMUDGE="1"; git clone [email protected]:Microsoft/vscode-docs.git.
  4. Now you can selectively checkout some binary files to work with. For example:
    • git lfs pull -I "docs/nodejs" to only download images in docs/nodejs
    • git lfs pull -I "release-notes/images/1_4*/*" to only download images in release-notes/images/1_4*
    • git lfs pull -I "docs,api" to download all images in docs and in api
    • git lfs pull -I <PATTERN>, as long as <PATTERN> is a valid Git LFS Include and Exclude pattern.

The history of this repo before we adopted LFS can be found at microsoft/vscode-docs-archive.

Publishing

Steps for how to publish documentation changes can be found here in the (private) repository of the VS Code website.

Comments
  • Write

    Write "Working with Extensions / Bundling Extension" topic

    Related: https://github.com/Microsoft/vscode-extension-samples/issues/122

    • Create a new topic under api/working-with-extensions for https://github.com/Microsoft/vscode-extension-samples/tree/master/webpack-sample
    • Explain benefits of bundling
    • Together with the sample, illustrate how to bundle extensions using webpack
    extensibility 
    opened by octref 42
  • Error: Could not locate a Flask application.

    Error: Could not locate a Flask application.

    After following these steps in the Python Flask tutorial: https://code.visualstudio.com/docs/python/tutorial-flask#_refactor-the-project-to-support-further-development

    I can only run the app in the python debug console. I can't run it in powershell, although I am following the same steps, I get this error:

    Error: Could not locate a Flask application. You did not provide the "FLASK_APP" environment variable, and a "wsgi.py" or "app.py" module was not found in the current directory.

    python 
    opened by gchristofferson 38
  • Bad Owner or Permissions on username\.ssh\config file

    Bad Owner or Permissions on username\.ssh\config file

    opened by mashirozx 32
  • Space / enter do not trigger download link

    Space / enter do not trigger download link

    Reported by @jvesouza

    Keyboard navigate onto a user installation 64bit blue link or any other blue link. Hit space or enter -> nothing happens -> I can not download vscode

    Screenshot 2020-06-11 at 16 29 33

    accessibility important docs-experience 
    opened by isidorn 28
  • The term 'python' is not recognized as the name of a cmdlet, function, script file, or operable program. Check the spelling of the name, or if a path was  included, verify that the path is correct and try again.

    The term 'python' is not recognized as the name of a cmdlet, function, script file, or operable program. Check the spelling of the name, or if a path was included, verify that the path is correct and try again.

    "

    python -m venv venv python : The term 'python' is not recognized as the name of a cmdlet, function, script file, or operable program. Check the spelling of the name, or if a path was included, verify that the path is correct and try again. At line:1 char:1

    • python -m venv venv
    •   + CategoryInfo          : ObjectNotFound: (python:String) [], CommandNotFoundException
        + FullyQualifiedErrorId : CommandNotFoundException
      

    "

    This error is shown after installing and adding python to the path. It is simply there and does not let me work and set the environment. The extensions are added too.

    Do you have any suggestions on how to fix it? Thanks in advance,

    python 
    opened by LarryInfiniteMX 28
  • Document PowerShell language development

    Document PowerShell language development

    This proposal is to add a section for PowerShell within this list and not simply a PowerShell page under the Language section. I believe there is enough content needed for PowerShell development that warrants more details than a simply getting started in the language section with Python.

    image

    PowerShell being a main language for Microsoft products and with Azure management it warrants building out content so users can see how to get started with PowerShell development. I would propose the initial layout for pages to get started:

    PowerShell
    ├── Extension
    ├── Editing Code
    ├── Plaster
    ├── PSScriptAnalyzer
    ├── Pester
    ├── Debugging
    ├── Settings Reference
    
    opened by wsmelton 26
  • More details of documentation intent

    More details of documentation intent

    I see the current code of intent like this:

    The goal of the VS Code documentation is to educate users on VS Code features and how VS Code can be used to enhance their development experience with different programming languages and runtimes.

    The documentation is not intended to provide:

    • An introduction to coding or software development
    • Tutorials on technologies independent from VS Code
    • Promotion of third-party tools, plug-ins, or services
    • Excessive detail or advanced walkthroughs

    The documentation should target developers learning to use VS Code or searching for quick answers to commonly asked questions. Other forums such as blog posts can provide more detailed content elaborating on specific scenarios.

    I wonder the introduction to coding or software development should not include how to develope a Visual Studio Code Extension (henceforth referred to as "VSCE")

    I made a Chrome Extension, and used AWS & Firebase before and I think we could learn something from their documentations. There are some problems I want to point out but I don't know if this is against the original intention:

    1. #4905
    2. Is the "visibility": "collapsed" a property of contributes.views? It is not mentioned
    3. Where to add the when: "isLinux" in contributes.walkthroughs? I assume we can do it both under walkthroughs and under every step? Can we call it out?
    4. I want to see how the initial views look like right after the installation of the VSCE. I don't think F5 can do that. Nor tsc -watch -p ./ does, and the VSCE being developed is not able to uninstall. I think there are some configuration file but I don't know where to remove/modify it.

    In conclusion, I think the document can expalin more clearly if we are encouraged to make a more specific explain on each API.

    support-request extensibility doc-enhancement 
    opened by PabloLION 23
  • Video explanations of VS Code's settings

    Video explanations of VS Code's settings

    I've created a video playlist on YouTube explaining every single setting in VS Code (except 9 I don't yet understand, but will work on next) and I'd like to share that with the community. I'm guessing it would be most useful to share this in VS Code's documentation, but I'm not sure if that's appropriate. If it is, please let me know and I'll share the playlist link.

    doc-enhancement 
    opened by andrecasal 22
  • Update debugger topic

    Update debugger topic

    Writer: @weinand Reviewer: @roblourens


    • Page: https://vscode-ext-docs.azurewebsites.net/api/extension-guides/debug-extension
    • File to edit: https://github.com/Microsoft/vscode-docs/blob/ext-docs/api/extension-guides/debug-extension.md

    The problems:

    • This page does not link to the new DAP website
    • This page does not include updated illustrations such as those in this blog post, making it harder to understand the purpose of DAP (solving the ide*runtime debugging problem), and the way DAP works (as illustrated in the message communication image)

    Here are some inspirations, from docs I was trying to make for LSP:

    • https://vscode-ext-docs.azurewebsites.net/api/language-extensions/overview#programmatic-language-features
    • https://vscode-ext-docs.azurewebsites.net/api/language-extensions/smart-editing-lsp-guide

    The todo:

    • Update the page so it points to DAP website
    • Use the updated illustration from the blog post to better explain DAP and the way it works
    • Update the Debugger section of Extension Capabilities Overview page too. Include a short passage that explains what Debug Extension is capable of and point them to the more detailed guide. File to edit is: https://github.com/Microsoft/vscode-docs/blob/ext-docs/api/extension-capabilities/overview.md
    debug extensibility 
    opened by octref 21
  • Editor Tips & Tricks

    Editor Tips & Tricks

    From only two days with the team in Zurich, I have been exposed to a handful of tips and tricks in the editor I didn't know existed.

    This is an idea for a doc page - "Editor Tips & Tricks". The idea is to have a page (I'm imagining with lots of animated gifs to demonstrate) to show cool things within the editor.

    A couple I have already seen.

    • vertical text selection
    • staging portions of a commit

    I'm sure @joaomoreno could add a lot to this page.

    idea 
    opened by waderyan 20
  • ModuleNotFoundError: No module named 'keras'

    ModuleNotFoundError: No module named 'keras'

    Hi,

    This is my first time posting an issue, please let me know if I do it wrong or anything.

    I am currently following the instructions in Data Science in Visual Studio Code. Got the error until "(Optional) Use a neural network to increase accuracy":

    ModuleNotFoundError Traceback (most recent call last) in ----> 1 from keras.models import Sequential 2 from keras.layers import Dense 3 4 model = Sequential()

    ModuleNotFoundError: No module named 'keras'

    Note: I ran "conda create -n myenv python=3.7 pandas jupyter seaborn scikit-learn keras tensorflow" and changed my "Python: Select Interpreter" accordingly

    support-request python 
    opened by shenlong3010 19
  • c-cpp-properties-schema-reference.md: configurationProvider: mention vscode-cpptools-api

    c-cpp-properties-schema-reference.md: configurationProvider: mention vscode-cpptools-api

    This PR enhances the documentation about the configurationProvider option specified inside c-cpp-properties.json by introducing the requirement for an extension to become a configurationProvider candidate.

    Not sure how to name https://github.com/microsoft/vscode-cpptools-api properly, so I just call it vscode-cpptools-api.

    Fixes #5816

    C++ 
    opened by ShamrockLee 0
  • clang++ vscode mac os compilation problem

    clang++ vscode mac os compilation problem

    Hello, I am having a problem compiling c++ code in vscode on my mac. I was following this tutorial : https://code.visualstudio.com/docs/cpp/config-clang-mac Except when I try the first compilation I get an error :" launch: program '/Users/Agathe/projects/helloworld/helloworld' does not exist ".

    This is the launch.json file : { // Utilisez IntelliSense pour en savoir plus sur les attributs possibles. // Pointez pour afficher la description des attributs existants. // Pour plus d'informations, visitez : https://go.microsoft.com/fwlink/?linkid=830387 "version": "0.2.0", "configurations": [ { "name": "C/C++: clang++ build and debug active file", "type": "cppdbg", "request": "launch", "program": "${fileDirname}/${fileBasenameNoExtension}", "args": [], "stopAtEntry": true, "cwd": "${workspaceFolder}", "environment": [], "externalConsole": false, "MIMode": "lldb", "preLaunchTask": "C/C++: clang++ build active file" } ] }

    I was able to compile using the command g++ -std=c++11 helloworld.cpp -o helloworld but how don't know how to apply this method in the case where I have a CMakeLists file.

    I also have a warning warning: range-based for loop is a C++11 extension [-Wc++11-extensions] for (const string& word : msg) and part of my c_cpp_properties.json file is "cStandard": "c17", "cppStandard": "c++11",

    support-request C++ 
    opened by agathelhm 0
  • Fix missing reportFunctionMemberAccess

    Fix missing reportFunctionMemberAccess

    There is a duplicate "reportPropertyTypeMismatch" in Value. "reportFunctionMemberAccess" was not in the documentation, but seems to fit there.

    python 
    opened by 243f6a8885a308d313198a2e037 0
  • How to get automatic code completion to work for custom new programming language?

    How to get automatic code completion to work for custom new programming language?

    I am not able to get code completion to work without pressing CTRL+SPACE on the Mac, as described (with helpful screenshots/videos) here:

    https://stackoverflow.com/questions/74837030/why-isnt-code-completion-working-for-my-custom-programming-language-in-vscode

    Any ideas why it's not working and how to fix it? I would like it to work like the JavaScript/TypeScript example in the linked screenshot, where as you type it gives you a list of code completions.

    support-request extensibility 
    opened by lancejpollard 0
  • Document configuration scopes

    Document configuration scopes

    From @Colengms

    Scope | VS Code description | Overridable in workspace (or workspace folder in a single root scenario) | Overridable in workspace folder (in a multiroot scenario which has one or more folders) | Remote will inherit local user settings | Overridable remotely | Overridable at language level -- | -- | -- | -- | -- | -- | -- application | Settings that apply to all instances of VS Code and can only be configured in user settings. | no | no | yes | no | no window | Windows (instance) specific settings which can be configured in user, workspace, or remote settings. | yes | no | yes | yes | no resource | Resource settings, which apply to files and folders, and can be configured in all settings levels, even folder settings. | yes | yes | yes | yes | no machine | Machine specific settings that can be set only in user settings or only in remote settings. For example, an installation path which shouldn't be shared across machines. | no | no | no | yes (implicitly, as it's not inherited) | no machine-overridable | Machine specific settings that can be overridden by workspace or folder settings. | yes | yes | no | yes (implicitly, as it's not inherited) | no language-overridable | Resource settings that can be overridable at a language level. | yes | yes | yes | yes | Yes

    extensibility doc-enhancement 
    opened by sandy081 0
Owner
Microsoft
Open source projects and samples from Microsoft
Microsoft
OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)

OpenAPI Generator Master (5.4.x): 6.0.x (6.0.x): ⭐ ⭐ ⭐ If you would like to contribute, please refer to guidelines and a list of open tasks. ⭐ ⭐ ⭐ ‼️

OpenAPI Tools 14.8k Dec 30, 2022
RAML to HTML documentation generator.

A simple RAML to HTML documentation generator, written for Node.js, with theme support. RAML version support raml2html 4 and higher only support RAML

null 1.1k Nov 27, 2022
This project is an Android Studio plugin version of BlackObfuscator, it supports obfuscating code automatically. More information about this project are in BlackObfuscator.

DEX控制流混淆插件版 · BlackObfuscator-ASPlugin English Version 本项目为 BlackObfuscator 的Android Studio插件版,支持打包自动化混淆。功能及介绍方面请查看 BlackObfuscator 源项目 注意事项 首要注意:Blac

null 229 Dec 31, 2022
A visual implementation of OSHI, to view information about the system and hardware.

MooInfo A visual implementation of OSHI, to view information about the system and hardware. Such as OS, processes, memory, CPU, disks, devices, sensor

周波 104 Jan 6, 2023
Doing red/green/refactor with quick and visual feedback loop on your Nanoleaf

nanoleaf-intellij-plugin Want fancy coloured and visual quick feedback for your tests? Install the Nanoleaf IntelliJ plugin. The plugin listen to your

Baptiste Lecocq 5 Dec 27, 2022
Juerr is a Java port of the uerr crate, it provides stunning visual error handling.

Juerr Juerr is a Java port of the uerr crate, it provides stunning visual error handling. Showcase Using the code below, we can display a simple error

IkeVoodoo 3 Jul 17, 2022
Library App - Using Android studio / Final project

Library-App Library App - Using Android studio / Final project Screens SplashScreen: it’s launcher activity will be moved to MainActivity auto after 2

Baseel 3 Feb 2, 2022
This project was developed with the intention of improving my knowledge of Java in application development in Android Studio.

This project was developed with the intention of improving my knowledge of Java in application development in Android Studio.

Henrique Marinho Teixeira 2 Jan 26, 2022
An application created using Android Studio, Java and Firebase DB to serve patients and doctors at a medical clinic.

MEDICAL CLINIC APP An application created using Android Studio, Java and Firebase DB to serve patients and doctors at a medical clinic. Patients are a

Anik Sarker 16 Jan 5, 2023
A demo of Rongcloud uniapp sdk integration for compiling debug-apk in Android Studio

Rongcloud-uniapp-sdk-demo A demo of Rongcloud uniapp sdk integration for compiling debug-apk in Android Studio 这是一个为了给uniapp在Android平台打出debug-apk的demo

Zongkui Guo 1 Oct 13, 2021
Clone of Snapchat app made using android studio and java. 👀

Snapchat-Clone Clone of Snapchat app made using android studio and java. Screenshots of the app : License MIT License Copyright (c) 2021 Nisa Efendi

Nisa Efendioğlu 9 Nov 8, 2022
Mint 0.1.1 public release, HWID System removed. Feel free to use. (Note: for all of u thinking its ratted; its not.)

Mint By: zPrestige_ | ! zPrestige_#1514 | git Kambing | dragonhacker32_#3091 | git FB | FB#7334 | git ZenovJB | Zenov#0603 | git Support no support No

null 17 Dec 2, 2022
Lightweight service-based PubSub, RPC and public APIs in Java

kite - service-based RPC, public APIs and PubSub in Java kite is a collection of reactive application messaging libraries that aim at providing high l

teris.io 3 Feb 17, 2022
Public course repository for ENSF 409, WS 2022.

ENSF409 This is an instructional project for the course ENSF 409 at the Schulich School of Engineering at the University of Calgary. It is not a free/

null 14 May 19, 2022
A public, stripped down workspace of the Project Unity mod, a mega-collaboration Mindustry mod

A public, stripped down workspace of the Project Unity mod, a mega-collaboration Mindustry mod. Not intended to be played yet; this is purely for code publicity and healthy competition reasons.

Avant 137 Jan 1, 2023
An app to manage the libraray at school or in public.

MyCalc Intro An app to manage the libraray at school or in public. Written 100% in Java, no permission needed. Finished in about 1 month by Nguyen Huy

Nguyen Huy Thai 1 Jan 16, 2022
Onepop is an utlity client previously paid, but now public and open source

onepop Onepop is an utlity client previously paid, but now public and open source, the client license is the GNU General Public License v3.0. The clie

Wks JanStudio 50 Dec 30, 2022
Download or repost public instagram posts easily by selecting "Copy Link" in Instagram.

Insta Save and Repost Description Download or repost public instagram posts easily by selecting "Copy Link" in Instagram. Screenshots Features Downloa

null 1 Jan 21, 2022
Java & Spring based cryptocurrency trading robot (RPA) that uses the public Binance API

Santini Santini is a Java & Spring based cryptocurrency trading bot that uses the public Binance API. It is run by providing it with API keys generate

Tongjian Cui 22 Apr 19, 2022