From 883671526c742217eb794bff11ec436cecdb3503 Mon Sep 17 00:00:00 2001 From: Greg Van Liew Date: Wed, 7 Dec 2022 09:29:10 -0800 Subject: [PATCH] Merge vnext to main (#5834) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Add 1.73 release notes placeholder * Initial tunnel updates * More info and updates * Typo * Update desktop * Wording and flow * JSONC documentation seems incomplete, doesn't mention trailing commas. Fixes #5728 * VS Code for the Web supports Language Packs! * add tunnel to ext host configurations table * Input latency notes * fix #164628 * Mention that trailing commas in JSONC are discouraged * Update 1.73 vscode.d.ts commit ID * news * Add Settings editor release notes * Update workspace trust settings picture * Adding placeholder sections * Add placeholder * added notes for include/exclude search result commands * Update 1.73 Windows keybindings * Dev Containers release notes * update * Issue trackers * adding release notes * Release notes * Add Python release notes * Update v1_73.md * VS Code for the Web branch protection release notes * Add command center content * Add rounded corners entry * Update release notes * Add quick pick styles entry * Add list codicons update entry * Add list icon video * Adding proposed api sections * Add ts preview section * Add dev container template info * Undo non-lfs image * Reupload with lfs * Adding md link update * localization for the web * add accessibility updates * Add jupyter release note TODOs * Add startDebugging release note * Notable fix * typos and section reordering * Jupyter debug release notes * Add Markdown link occurrence highlighting section * Update 1.73 settings * release notes edits * Add section on md insert links * Add api sections * Add dup md section * Update thank you. * edit * Make doc links absolute * Small edits * add logging improvements * add settings profiles improvements * Add screenshot * chore: add windows11 context menu notes * merge editor release notes * release notes: list.collapseAllToFocus * Updates merge editor release notes. * More merge editor release notes * Merge editor wording improvements * Add community contributions for vscode-dev-chrome-launcher * ImageOptim * Update channel name * Fix setting value for Pylance auto imports * Tune image alt text * Update 1.73 vscode.d.ts commit ID * Add 1.73 highlights and social image * Remove Jupyter release notes from deferred release * Remove the sections on the Jupyter extension * Update 1.73 social image to remove Jupyter * Shrink images and optimize .gifs * Update theme color. * release notes edits * Edit theme-color.md * Update DateApproved * Add 1.74 release notes placeholder * Add quick pick title and placeholder guidance * Incorrect "Request forwarding" conclusion about diagnostics. Fixes #5778 * Edit pass * Wording polish * Update 1.74 settings * Edit pass * Edit pass * Polish and feedback * Wording * Wording * Add blog * Formatting * Update 1.74 vscode.d.ts commit ID * Update 1.74 Windows keybindings * 1.74 settings updates * A few initial edits and formatting * mangle news * Git - unsafe repositories (#5818) * Unsafe repository question * Tweak the message * Mention accessibility tag * Add release notes for indicators a11y and WCO * Clarify WCO re-enablement * add accessibility, task, terminal updates * Update release notes * Dev Container notes * Thank yous * Add release notes * Fix typo * Implicit activation events * Polish implicit activation events section * add release notes * make link work * Implicit activation events documentation updates * Edits and reordering * Add note * Update remote-even-better.md * Typo * auth bundle improvements * call out l10n * Update command * VS Code for the Web release notes * Add statement * SCM action button * finalise log api * Sharing profiles * document Install Extension from Location command * Adding TS sections * Adding sections * update kernel picker change * Update jupyter extension changelog * Jupyter release notes * Notebook audio cues * Small edits and formatting * killOnServerStop release notes * Exception breakpoints view release notes * add acknowledgements for 1.74 * Update release notes * First cut for Python on the Web * update color referemce * platform specific extension docs clarifications regarding https://github.com/microsoft/vscode-vsce/issues/785 * release notes: extension signing and verification fyi @sandy081 * Release notes * Adds merge editor release notes * Mentions command to partially accept inline suggestions. * More Python documentation * Sell the WCO re-enablement better * Minor word tweaks * Elaborate on improved Settings editor a11y * Add images to Git LFS * Small edits, reordering, and mention sandbox blog * 1.74 highlights and social image * Small updates * Alt text tuning * Comments and GHPRI release notes * update acknowledgements * release notes: @vscode/vsce * 🎀 Introduce `search` file location method Signed-off-by: Babak K. Shandiz * Small edits to recent updates * Edit pass on Python for the Web * Add tunnels topic to sitemap * Prep for Insiders snapshot, add images to Git LFS * Add new content back to TOC, tune images * first pass at profiling docs (#5833) * Edit pass and Audio Cues dropdown image * Edit pass on new JS profiling topic * Shrink .gifs * Edit pass on blog post * Edit pass on tunnels topic * Refer to insider version * Update DateApproved Signed-off-by: Babak K. Shandiz Co-authored-by: bamurtaugh Co-authored-by: Martin Aeschlimann Co-authored-by: Connor Peet Co-authored-by: Daniel Imms <2193314+Tyriar@users.noreply.github.com> Co-authored-by: Megan Rogge Co-authored-by: Johannes Co-authored-by: Raymond Zhao <7199958+rzhao271@users.noreply.github.com> Co-authored-by: Matt Bierner Co-authored-by: David Dossett Co-authored-by: andreamah Co-authored-by: Andrea Mah <31675041+andreamah@users.noreply.github.com> Co-authored-by: Christof Marti Co-authored-by: SteVen Batten Co-authored-by: Logan Ramos Co-authored-by: Courtney Webster Co-authored-by: Courtney Webster <60238438+cwebster-99@users.noreply.github.com> Co-authored-by: Joyce Er Co-authored-by: Alex Ross Co-authored-by: Brigit Murtaugh Co-authored-by: Tyler Leonhardt Co-authored-by: Rob Lourens Co-authored-by: Peng Lyu Co-authored-by: Sandeep Somavarapu Co-authored-by: deepak1556 Co-authored-by: Henning Dieterichs Co-authored-by: Joao Moreno Co-authored-by: Ladislau Szomoru <3372902+lszomoru@users.noreply.github.com> Co-authored-by: Luciana Abud <45497113+luabud@users.noreply.github.com> Co-authored-by: Joyce Er Co-authored-by: rebornix Co-authored-by: Dirk BΓ€umer Co-authored-by: isidor Co-authored-by: Alex Dima Co-authored-by: Babak K. Shandiz --- api/advanced-topics/extension-host.md | 4 +- api/advanced-topics/remote-extensions.md | 2 +- .../tslint-eslint-migration.md | 2 +- api/advanced-topics/using-proposed-api.md | 2 +- .../common-capabilities.md | 2 +- .../extending-workbench.md | 2 +- api/extension-capabilities/overview.md | 2 +- api/extension-capabilities/theming.md | 2 +- api/extension-guides/color-theme.md | 2 +- api/extension-guides/command.md | 2 +- api/extension-guides/custom-data-extension.md | 2 +- api/extension-guides/custom-editors.md | 2 +- api/extension-guides/debugger-extension.md | 2 +- api/extension-guides/file-icon-theme.md | 2 +- api/extension-guides/markdown-extension.md | 2 +- api/extension-guides/notebook.md | 2 +- api/extension-guides/overview.md | 2 +- api/extension-guides/product-icon-theme.md | 2 +- api/extension-guides/scm-provider.md | 2 +- api/extension-guides/task-provider.md | 2 +- api/extension-guides/telemetry.md | 2 +- api/extension-guides/testing.md | 2 +- api/extension-guides/tree-view.md | 2 +- api/extension-guides/virtual-documents.md | 2 +- api/extension-guides/virtual-workspaces.md | 2 +- api/extension-guides/web-extensions.md | 2 +- api/extension-guides/webview.md | 2 +- api/extension-guides/workspace-trust.md | 2 +- api/get-started/extension-anatomy.md | 2 +- api/get-started/wrapping-up.md | 2 +- api/get-started/your-first-extension.md | 2 +- api/index.md | 2 +- api/language-extensions/embedded-languages.md | 2 +- .../language-configuration-guide.md | 2 +- .../language-server-extension-guide.md | 2 +- api/language-extensions/overview.md | 2 +- .../programmatic-language-features.md | 2 +- .../semantic-highlight-guide.md | 2 +- api/language-extensions/snippet-guide.md | 2 +- .../syntax-highlight-guide.md | 2 +- api/references/activation-events.md | 2 +- api/references/commands.md | 2 +- api/references/contribution-points.md | 2 +- api/references/document-selector.md | 2 +- api/references/extension-manifest.md | 2 +- api/references/icons-in-labels.md | 2 +- api/references/theme-color.md | 2 +- api/references/vscode-api.md | 2 +- api/references/vscode-api.template | 2 +- api/references/when-clause-contexts.md | 2 +- api/ux-guidelines/activity-bar.md | 2 +- api/ux-guidelines/command-palette.md | 2 +- api/ux-guidelines/context-menus.md | 2 +- api/ux-guidelines/editor-actions.md | 2 +- api/ux-guidelines/notifications.md | 2 +- api/ux-guidelines/overview.md | 2 +- api/ux-guidelines/panel.md | 2 +- api/ux-guidelines/quick-picks.md | 2 +- api/ux-guidelines/settings.md | 2 +- api/ux-guidelines/sidebars.md | 2 +- api/ux-guidelines/status-bar.md | 2 +- api/ux-guidelines/views.md | 2 +- api/ux-guidelines/walkthroughs.md | 2 +- api/ux-guidelines/webviews.md | 2 +- .../bundling-extension.md | 2 +- .../continuous-integration.md | 2 +- .../publishing-extension.md | 2 +- .../testing-extension.md | 2 +- blogs/2022/12/07/remote-even-better.md | 153 +++++++++++++++++ .../2022/12/07/tunneling-blog-access-red.png | 3 + .../12/07/tunneling-blog-code-help-new.png | 3 + .../2022/12/07/tunneling-blog-containers.png | 3 + blogs/2022/12/07/tunneling-blog-download.png | 3 + .../12/07/tunneling-blog-enabled-prompt.png | 3 + blogs/2022/12/07/tunneling-blog-extension.png | 3 + blogs/2022/12/07/tunneling-blog-list.png | 3 + .../12/07/tunneling-blog-remote-explorer.png | 3 + .../12/07/tunneling-blog-remote-spectrum.png | 3 + blogs/2022/12/07/tunneling-blog-wsl.png | 3 + build/sitemap.xml | 5 + docs/azure/deployment.md | 2 +- docs/azure/docker.md | 2 +- docs/azure/extensions.md | 2 +- docs/containers/bridge-to-kubernetes.md | 2 +- docs/datascience/overview.md | 2 +- docs/datascience/python-interactive.md | 2 +- docs/devcontainers/attach-container.md | 2 +- docs/devcontainers/containers-advanced.md | 2 +- docs/devcontainers/containers.md | 2 +- docs/devcontainers/create-dev-container.md | 2 +- docs/devcontainers/devcontainer-cli.md | 2 +- .../devcontainerjson-reference.md | 2 +- docs/devcontainers/faq.md | 2 +- docs/devcontainers/tips-and-tricks.md | 2 +- docs/devcontainers/tutorial.md | 2 +- docs/editor/accessibility.md | 2 +- docs/editor/codebasics.md | 2 +- docs/editor/command-line.md | 24 ++- docs/editor/debugging.md | 2 +- docs/editor/editingevolved.md | 2 +- docs/editor/emmet.md | 2 +- docs/editor/extension-marketplace.md | 2 +- .../images/command-line/tunnel-help.png | 3 + docs/editor/intellisense.md | 2 +- docs/editor/multi-root-workspaces.md | 2 +- docs/editor/portable.md | 2 +- docs/editor/refactoring.md | 2 +- docs/editor/settings-sync.md | 2 +- docs/editor/tasks-appendix.md | 2 +- docs/editor/tasks.md | 2 +- docs/editor/userdefinedsnippets.md | 2 +- docs/editor/variables-reference.md | 2 +- docs/editor/vscode-web.md | 2 +- docs/editor/whyvscode.md | 2 +- docs/editor/workspace-trust.md | 2 +- docs/editor/workspaces.md | 2 +- docs/getstarted/introvideos.md | 2 +- docs/getstarted/keybindings.md | 2 +- docs/getstarted/locales.md | 2 +- docs/getstarted/settings.md | 2 +- docs/getstarted/telemetry.md | 2 +- docs/getstarted/themes.md | 2 +- docs/getstarted/tips-and-tricks.md | 2 +- docs/getstarted/userinterface.md | 2 +- docs/languages/css.md | 2 +- docs/languages/html.md | 2 +- docs/languages/identifiers.md | 2 +- docs/languages/javascript.md | 2 +- docs/languages/jsconfig.md | 2 +- docs/languages/json.md | 2 +- docs/languages/markdown.md | 2 +- docs/languages/overview.md | 2 +- docs/languages/php.md | 2 +- docs/languages/typescript.md | 2 +- docs/nodejs/angular-tutorial.md | 2 +- docs/nodejs/browser-debugging.md | 2 +- docs/nodejs/debugging-recipes.md | 2 +- docs/nodejs/emberjs-tutorial.md | 2 +- docs/nodejs/extensions.md | 4 +- .../images/profiling/cpu-profile-nice.png | 3 + .../images/profiling/cpu-profile-noise.png | 3 + docs/nodejs/images/profiling/heap-profile.png | 3 + .../nodejs/images/profiling/profile-table.png | 3 + docs/nodejs/images/profiling/take-profile.png | 3 + .../nodejs/images/profiling/toggle-button.png | 3 + docs/nodejs/nodejs-debugging.md | 2 +- docs/nodejs/nodejs-deployment.md | 2 +- docs/nodejs/nodejs-tutorial.md | 2 +- docs/nodejs/profiling.md | 113 ++++++++++++ docs/nodejs/reactjs-tutorial.md | 2 +- docs/nodejs/vuejs-tutorial.md | 2 +- docs/nodejs/working-with-javascript.md | 2 +- docs/python/data-science.md | 2 +- docs/python/python-web.md | 7 +- docs/python/tutorial-create-containers.md | 2 +- docs/remote/codespaces.md | 2 +- docs/remote/dev-containers.md | 2 +- docs/remote/faq.md | 4 +- docs/remote/images/tunnels/tunnel-access.png | 3 + .../images/tunnels/tunneling-download.png | 3 + .../images/tunnels/tunneling-enabled.png | 3 + .../tunnels/tunneling-remote-explorer.png | 3 + .../vscode-server/server-arch-latest.png | 3 + .../images/vscode-server/server-arch.png | 3 - .../images/vscode-server/server-help.png | 3 - .../images/vscode-server/tunnel-help.png | 3 + docs/remote/linux.md | 2 +- docs/remote/remote-overview.md | 2 +- docs/remote/ssh-tutorial.md | 4 +- docs/remote/ssh.md | 2 +- docs/remote/troubleshooting.md | 4 +- docs/remote/tunnels.md | 116 +++++++++++++ docs/remote/vscode-server.md | 162 ++++-------------- docs/remote/wsl-tutorial.md | 4 +- docs/remote/wsl.md | 2 +- docs/setup/additional-components.md | 2 +- docs/setup/enterprise.md | 2 +- docs/setup/linux.md | 2 +- docs/setup/mac.md | 2 +- docs/setup/network.md | 2 +- docs/setup/raspberry-pi.md | 2 +- docs/setup/setup-overview.md | 2 +- docs/setup/uninstall.md | 2 +- docs/setup/windows.md | 2 +- docs/sourcecontrol/faq.md | 2 +- docs/sourcecontrol/github.md | 2 +- docs/sourcecontrol/overview.md | 2 +- docs/supporting/faq.md | 2 +- docs/supporting/oss-extensions.md | 2 +- docs/supporting/requirements.md | 2 +- .../troubleshoot-terminal-launch.md | 2 +- docs/terminal/advanced.md | 2 +- docs/terminal/appearance.md | 2 +- docs/terminal/basics.md | 2 +- docs/terminal/profiles.md | 2 +- docs/terminal/shell-integration.md | 2 +- docs/typescript/typescript-compiling.md | 2 +- docs/typescript/typescript-debugging.md | 2 +- docs/typescript/typescript-editing.md | 2 +- docs/typescript/typescript-refactoring.md | 2 +- docs/typescript/typescript-tutorial.md | 2 +- learn/overview.md | 2 +- .../images/1_74/audio-cues-dropdown.png | 3 + .../images/1_74/exception-breakpoints.gif | 4 +- release-notes/images/1_74/hide-view-badge.gif | 4 +- release-notes/images/1_74/profile-export.gif | 4 +- release-notes/images/1_74/profile-import.gif | 4 +- .../images/1_74/release-highlights.png | 4 +- .../images/1_74/scm-action-button.png | 4 +- release-notes/v1_74.md | 106 ++++++------ remote-release-notes/v1_74.md | 2 +- .../add-local-file-mount.md | 2 +- remote/advancedcontainers/add-nonroot-user.md | 2 +- .../avoid-extension-reinstalls.md | 2 +- .../change-default-source-mount.md | 2 +- .../configure-separate-containers.md | 2 +- .../connect-multiple-containers.md | 2 +- .../advancedcontainers/develop-remote-host.md | 2 +- remote/advancedcontainers/docker-options.md | 2 +- .../environment-variables.md | 2 +- .../advancedcontainers/improve-performance.md | 2 +- remote/advancedcontainers/overview.md | 2 +- .../persist-bash-history.md | 2 +- .../advancedcontainers/questions-feedback.md | 2 +- .../reduce-docker-warnings.md | 2 +- .../set-docker-compose-project-name.md | 2 +- remote/advancedcontainers/start-processes.md | 2 +- .../use-docker-kubernetes.md | 2 +- 228 files changed, 779 insertions(+), 397 deletions(-) create mode 100644 blogs/2022/12/07/remote-even-better.md create mode 100644 blogs/2022/12/07/tunneling-blog-access-red.png create mode 100644 blogs/2022/12/07/tunneling-blog-code-help-new.png create mode 100644 blogs/2022/12/07/tunneling-blog-containers.png create mode 100644 blogs/2022/12/07/tunneling-blog-download.png create mode 100644 blogs/2022/12/07/tunneling-blog-enabled-prompt.png create mode 100644 blogs/2022/12/07/tunneling-blog-extension.png create mode 100644 blogs/2022/12/07/tunneling-blog-list.png create mode 100644 blogs/2022/12/07/tunneling-blog-remote-explorer.png create mode 100644 blogs/2022/12/07/tunneling-blog-remote-spectrum.png create mode 100644 blogs/2022/12/07/tunneling-blog-wsl.png create mode 100644 docs/editor/images/command-line/tunnel-help.png create mode 100644 docs/nodejs/images/profiling/cpu-profile-nice.png create mode 100644 docs/nodejs/images/profiling/cpu-profile-noise.png create mode 100644 docs/nodejs/images/profiling/heap-profile.png create mode 100644 docs/nodejs/images/profiling/profile-table.png create mode 100644 docs/nodejs/images/profiling/take-profile.png create mode 100644 docs/nodejs/images/profiling/toggle-button.png create mode 100644 docs/nodejs/profiling.md create mode 100644 docs/remote/images/tunnels/tunnel-access.png create mode 100644 docs/remote/images/tunnels/tunneling-download.png create mode 100644 docs/remote/images/tunnels/tunneling-enabled.png create mode 100644 docs/remote/images/tunnels/tunneling-remote-explorer.png create mode 100644 docs/remote/images/vscode-server/server-arch-latest.png delete mode 100644 docs/remote/images/vscode-server/server-arch.png delete mode 100644 docs/remote/images/vscode-server/server-help.png create mode 100644 docs/remote/images/vscode-server/tunnel-help.png create mode 100644 docs/remote/tunnels.md create mode 100644 release-notes/images/1_74/audio-cues-dropdown.png diff --git a/api/advanced-topics/extension-host.md b/api/advanced-topics/extension-host.md index b731c6b5f6..a9bf0b93a0 100644 --- a/api/advanced-topics/extension-host.md +++ b/api/advanced-topics/extension-host.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 106AA11C-DB26-493A-9E3C-16F513B2AEC8 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: The Visual Studio Code Extension Host is responsible for managing extensions and ensuring the stability and performance of Visual Studio Code. @@ -24,7 +24,7 @@ The following table shows which extension hosts are available in the various con | Configuration | local extension host | web extension host | remote extension host | --- | --- | --- | --- | VS Code on the desktop | βœ”οΈ | βœ”οΈ | | -| [VS Code with remote](/docs/remote/remote-overview) (Container, SSH, WSL, GitHub Codespace) | βœ”οΈ | βœ”οΈ | βœ”οΈ | +| [VS Code with remote](/docs/remote/remote-overview) (Container, SSH, WSL, GitHub Codespace, Tunnel) | βœ”οΈ | βœ”οΈ | βœ”οΈ | | VS Code for the Web (vscode.dev, github.dev) | | βœ”οΈ | | | VS Code for the Web with Codespaces | | βœ”οΈ | βœ”οΈ | diff --git a/api/advanced-topics/remote-extensions.md b/api/advanced-topics/remote-extensions.md index e802135d8a..403f702e25 100644 --- a/api/advanced-topics/remote-extensions.md +++ b/api/advanced-topics/remote-extensions.md @@ -1,6 +1,6 @@ --- ContentId: 5c708951-e566-42db-9d97-e9715d95cdd1 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: A guide to adding Visual Studio Code Remote Development and GitHub Codespaces support to extensions diff --git a/api/advanced-topics/tslint-eslint-migration.md b/api/advanced-topics/tslint-eslint-migration.md index 8312709cbe..58c0c2cee2 100644 --- a/api/advanced-topics/tslint-eslint-migration.md +++ b/api/advanced-topics/tslint-eslint-migration.md @@ -1,6 +1,6 @@ --- ContentId: f00c4913-58e3-4a61-aa42-e769c3430906 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: A guide to migrating extension projects from the TSLint linter to ESLint. diff --git a/api/advanced-topics/using-proposed-api.md b/api/advanced-topics/using-proposed-api.md index 06537944bb..d35a5ed9bc 100644 --- a/api/advanced-topics/using-proposed-api.md +++ b/api/advanced-topics/using-proposed-api.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: f4d4e9e0-8901-405c-aaf5-faa16c32588b -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Use Visual Studio Code's Proposed API diff --git a/api/extension-capabilities/common-capabilities.md b/api/extension-capabilities/common-capabilities.md index 7d7d1ca45e..5583f4696a 100644 --- a/api/extension-capabilities/common-capabilities.md +++ b/api/extension-capabilities/common-capabilities.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 9c48dfbf-e49d-4f33-aadc-5ebf06d5dde0 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Common capabilities that Visual Studio Code extensions (plug-ins) can take advantage of diff --git a/api/extension-capabilities/extending-workbench.md b/api/extension-capabilities/extending-workbench.md index 52a5771cfd..c91418ed1e 100644 --- a/api/extension-capabilities/extending-workbench.md +++ b/api/extension-capabilities/extending-workbench.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: e0d5bd37-f020-4235-ad81-c977baaeb24f -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Explain how to extend Visual Studio Code's workbench area with custom UI components diff --git a/api/extension-capabilities/overview.md b/api/extension-capabilities/overview.md index 660e6da6af..b83b8085ec 100644 --- a/api/extension-capabilities/overview.md +++ b/api/extension-capabilities/overview.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: d22675fc-6609-43f2-a66b-8f2a52597195 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Learn the details of what's possible with Visual Studio Code's rich extension (plug-in) API. diff --git a/api/extension-capabilities/theming.md b/api/extension-capabilities/theming.md index 66faf98479..9e0ca28d5f 100644 --- a/api/extension-capabilities/theming.md +++ b/api/extension-capabilities/theming.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 37b6ae0a-d1b5-48b6-9bd4-9b50ef11d573 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Learn how to add custom themes for colors and icons in Visual Studio Code. diff --git a/api/extension-guides/color-theme.md b/api/extension-guides/color-theme.md index 4aac052ceb..920580d557 100644 --- a/api/extension-guides/color-theme.md +++ b/api/extension-guides/color-theme.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 113b458a-3692-4ccf-a181-048bd572a120 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: A guide to creating Color Theme in Visual Studio Code diff --git a/api/extension-guides/command.md b/api/extension-guides/command.md index 0891eab356..2cc27d9e4d 100644 --- a/api/extension-guides/command.md +++ b/api/extension-guides/command.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 995c7085-5fc0-44e0-a171-30a759c0b7da -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: A guide to using commands programmatically in Visual Studio Code extensions (plug-ins) diff --git a/api/extension-guides/custom-data-extension.md b/api/extension-guides/custom-data-extension.md index 32a554e455..5863ce2061 100644 --- a/api/extension-guides/custom-data-extension.md +++ b/api/extension-guides/custom-data-extension.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: d40b8849-6a4e-428c-b463-c8d61f18136f -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Learn how to extend Visual Studio Code's HTML and CSS language support. diff --git a/api/extension-guides/custom-editors.md b/api/extension-guides/custom-editors.md index 4b042254ca..c8d558e56f 100644 --- a/api/extension-guides/custom-editors.md +++ b/api/extension-guides/custom-editors.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 6eb86aa4-0f4c-4168-b34a-6ec6b204e960 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Use the Custom Editor API to create customizable editors within Visual Studio Code. diff --git a/api/extension-guides/debugger-extension.md b/api/extension-guides/debugger-extension.md index 64c9236c84..9c89f221b5 100644 --- a/api/extension-guides/debugger-extension.md +++ b/api/extension-guides/debugger-extension.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 49EF49AD-8BE6-4D46-ADC8-D678BDC04E85 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Learn how to provide debugger extensions (plug-ins) for Visual Studio Code through a Debug Adapter. diff --git a/api/extension-guides/file-icon-theme.md b/api/extension-guides/file-icon-theme.md index 59b3f8c2a5..4150c1c44d 100644 --- a/api/extension-guides/file-icon-theme.md +++ b/api/extension-guides/file-icon-theme.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: f470466d-89b0-4115-ab7a-2448023b0a6d -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: A guide to creating a File Icon Theme in Visual Studio Code diff --git a/api/extension-guides/markdown-extension.md b/api/extension-guides/markdown-extension.md index 70545b2397..bd4a996956 100644 --- a/api/extension-guides/markdown-extension.md +++ b/api/extension-guides/markdown-extension.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 1664249a-ba7a-4a53-b3f0-9d757cff7d27 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Learn how to extend Visual Studio Code's built-in Markdown preview. diff --git a/api/extension-guides/notebook.md b/api/extension-guides/notebook.md index 2c41e359ba..5de5197998 100644 --- a/api/extension-guides/notebook.md +++ b/api/extension-guides/notebook.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 535b4d05-c2c8-424a-b075-2cd91566b8da -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Use the Notebook API to create rich Notebook experiences within Visual Studio Code. diff --git a/api/extension-guides/overview.md b/api/extension-guides/overview.md index 91582fb707..46971b98ba 100644 --- a/api/extension-guides/overview.md +++ b/api/extension-guides/overview.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: B32601A8-27ED-4D97-BA83-F1C8C945C635 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Learn from Visual Studio Code extension guides and code samples diff --git a/api/extension-guides/product-icon-theme.md b/api/extension-guides/product-icon-theme.md index 40c00a95b1..13c4bfb2bc 100644 --- a/api/extension-guides/product-icon-theme.md +++ b/api/extension-guides/product-icon-theme.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: f470466d-89b0-4115-ab7a-2448023b0a6d -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: A guide to creating Product Icon Theme in Visual Studio Code diff --git a/api/extension-guides/scm-provider.md b/api/extension-guides/scm-provider.md index 25ecc705a3..a6e2b21896 100644 --- a/api/extension-guides/scm-provider.md +++ b/api/extension-guides/scm-provider.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 79996489-8D16-4C0A-8BE8-FF4B1E9C223A -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: A guide illustrating how to use Source Control API. diff --git a/api/extension-guides/task-provider.md b/api/extension-guides/task-provider.md index 0d01f8a255..56bbb68ae0 100644 --- a/api/extension-guides/task-provider.md +++ b/api/extension-guides/task-provider.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 49744351-83ef-4ef6-99e7-2485e6e9c79f -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Learn how to contribute tasks to Visual Studio Code through an extension (plug-in). diff --git a/api/extension-guides/telemetry.md b/api/extension-guides/telemetry.md index d06f2526cc..8b37c63929 100644 --- a/api/extension-guides/telemetry.md +++ b/api/extension-guides/telemetry.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: b31344d9-a1d9-4f87-82df-9c7151ef99e3 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Learn how Visual Studio Code extensions can enable telemetry and respect user telemetry choices. diff --git a/api/extension-guides/testing.md b/api/extension-guides/testing.md index b228663b13..ecc4f71198 100644 --- a/api/extension-guides/testing.md +++ b/api/extension-guides/testing.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 4ced0b2a-3f5a-44e6-a8b0-66b9012af8c0 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Testing APIs in VS Code allow users to discover and run unit tests in their workspace diff --git a/api/extension-guides/tree-view.md b/api/extension-guides/tree-view.md index e201ae91fe..43986a7f52 100644 --- a/api/extension-guides/tree-view.md +++ b/api/extension-guides/tree-view.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 9b10cda2-4eb0-4989-8f82-23a46b96c1bb -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: A guide to using Tree View in Visual Studio Code extension (plug-in). diff --git a/api/extension-guides/virtual-documents.md b/api/extension-guides/virtual-documents.md index 28781d0863..67fb20a88a 100644 --- a/api/extension-guides/virtual-documents.md +++ b/api/extension-guides/virtual-documents.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 54fdcc33-7ad1-40cc-bc87-ded1841d01ad -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: A guide to using Virtual Documents in Visual Studio Code extensions (plug-ins) diff --git a/api/extension-guides/virtual-workspaces.md b/api/extension-guides/virtual-workspaces.md index 0748b43ca7..64c49e7ac8 100644 --- a/api/extension-guides/virtual-workspaces.md +++ b/api/extension-guides/virtual-workspaces.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: c64264b1-09cd-4680-b0dc-9f0f7803e451 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Learn how to support virtual workspaces in extensions diff --git a/api/extension-guides/web-extensions.md b/api/extension-guides/web-extensions.md index 4e48ab8e03..bc20258c09 100644 --- a/api/extension-guides/web-extensions.md +++ b/api/extension-guides/web-extensions.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 282670bb-cc72-4b01-9b51-08bf8f5a13a1 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Learn how to run extensions in Visual Studio Code for the web and the web extension host. diff --git a/api/extension-guides/webview.md b/api/extension-guides/webview.md index fdb3f5aa67..661e6c947d 100644 --- a/api/extension-guides/webview.md +++ b/api/extension-guides/webview.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: adddd33e-2de6-4146-853b-34d0d7e6c1f1 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Use the Webview API to create fully customizable views within Visual Studio Code. diff --git a/api/extension-guides/workspace-trust.md b/api/extension-guides/workspace-trust.md index 72381d6c03..a7b314df95 100644 --- a/api/extension-guides/workspace-trust.md +++ b/api/extension-guides/workspace-trust.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 31f461b7-c216-414a-b701-78c205fde8a8 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: A guide for updating Visual Studio Code extensions to support Workspace Trust diff --git a/api/get-started/extension-anatomy.md b/api/get-started/extension-anatomy.md index f0fa34482b..54defec224 100644 --- a/api/get-started/extension-anatomy.md +++ b/api/get-started/extension-anatomy.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 8027f6fb-6c9e-4106-8ef1-f9b0ba1b7085 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Explain the structure of a Visual Studio Code extension (plug-in) diff --git a/api/get-started/wrapping-up.md b/api/get-started/wrapping-up.md index 5fbc2120e0..3afd4f5078 100644 --- a/api/get-started/wrapping-up.md +++ b/api/get-started/wrapping-up.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: a15875fa-19b5-4c11-8903-864af133ce57 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Next steps to take after studying the Getting Started section diff --git a/api/get-started/your-first-extension.md b/api/get-started/your-first-extension.md index 06ab9e6c4e..7266583abb 100644 --- a/api/get-started/your-first-extension.md +++ b/api/get-started/your-first-extension.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: DC915D6C-13D4-4022-9101-57C4A4118B07 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Create your first Visual Studio Code extension (plug-in) with a simple Hello World example. diff --git a/api/index.md b/api/index.md index b4ac084793..252cc4ca49 100644 --- a/api/index.md +++ b/api/index.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: AD26EFB1-FFC6-4284-BAB8-F3BCB8294728 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Visual Studio Code has a rich extension API. Learn how to create your own extensions for VS Code. diff --git a/api/language-extensions/embedded-languages.md b/api/language-extensions/embedded-languages.md index bd33676ddf..544b6e7337 100644 --- a/api/language-extensions/embedded-languages.md +++ b/api/language-extensions/embedded-languages.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: b76a223a-a210-4bdb-b537-36c1ea6814ae -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Learn how to create Language Servers to provide rich language features for embedded programming languages in Visual Studio Code. diff --git a/api/language-extensions/language-configuration-guide.md b/api/language-extensions/language-configuration-guide.md index 5dcca55737..11262e4b00 100644 --- a/api/language-extensions/language-configuration-guide.md +++ b/api/language-extensions/language-configuration-guide.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: cd928e7f-bb5a-43b0-8e15-d398e416386d -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: A guide to configure language support for any language in Visual Studio Code. diff --git a/api/language-extensions/language-server-extension-guide.md b/api/language-extensions/language-server-extension-guide.md index f8a32a0130..50f9d5f90e 100644 --- a/api/language-extensions/language-server-extension-guide.md +++ b/api/language-extensions/language-server-extension-guide.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: A8CBE8D6-1FEE-47BF-B81E-D79FA0DB5D03 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Learn how to create Language Servers to provide rich language features in Visual Studio Code. diff --git a/api/language-extensions/overview.md b/api/language-extensions/overview.md index 5b685b5e10..06bf691d6d 100644 --- a/api/language-extensions/overview.md +++ b/api/language-extensions/overview.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 8b70dba5-f71d-46dd-8da1-f5d44b9a6a96 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Learn how to write a Language Extension (plug-in) to add support for a programming language in Visual Studio Code. diff --git a/api/language-extensions/programmatic-language-features.md b/api/language-extensions/programmatic-language-features.md index 8dc07eedff..d74ddca638 100644 --- a/api/language-extensions/programmatic-language-features.md +++ b/api/language-extensions/programmatic-language-features.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: A9D40038-7837-4320-8C2D-E0CA5769AA69 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Visual Studio Code language extensions contribute programming language features. These guidelines present the language features available in Visual Studio Code and explain the API. diff --git a/api/language-extensions/semantic-highlight-guide.md b/api/language-extensions/semantic-highlight-guide.md index 18b9105341..2bf748bb79 100644 --- a/api/language-extensions/semantic-highlight-guide.md +++ b/api/language-extensions/semantic-highlight-guide.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 8308017a-75de-430a-b420-d9d2064162b9 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: A guide to syntax highlighting diff --git a/api/language-extensions/snippet-guide.md b/api/language-extensions/snippet-guide.md index 3ada418599..8e38deaf89 100644 --- a/api/language-extensions/snippet-guide.md +++ b/api/language-extensions/snippet-guide.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 4b24790b-781a-43cc-afe6-58b1d57d6163 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Learn how to bundle snippets into an extension (plug-in) for Visual Studio Code diff --git a/api/language-extensions/syntax-highlight-guide.md b/api/language-extensions/syntax-highlight-guide.md index 8a0822ede5..77c495c83f 100644 --- a/api/language-extensions/syntax-highlight-guide.md +++ b/api/language-extensions/syntax-highlight-guide.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 2bb06188-d394-4b98-872c-0bf26c8a674d -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: A guide to syntax highlighting diff --git a/api/references/activation-events.md b/api/references/activation-events.md index ae1e5ce05b..544a549ede 100644 --- a/api/references/activation-events.md +++ b/api/references/activation-events.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: C83BB647-A37E-45CE-BA4C-837B397C2ABE -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: To support lazy activation of Visual Studio Code extensions (plug-ins), your extension controls when it should be loaded through a set of Activation Events. diff --git a/api/references/commands.md b/api/references/commands.md index 7f5988b95c..91476ff024 100644 --- a/api/references/commands.md +++ b/api/references/commands.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: A010AEDF-EF37-406E-96F5-E129408FFDE1 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Visual Studio Code built-in commands reference. diff --git a/api/references/contribution-points.md b/api/references/contribution-points.md index d9dd240140..178d0248e4 100644 --- a/api/references/contribution-points.md +++ b/api/references/contribution-points.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 2F27A240-8E36-4CC2-973C-9A1D8069F83F -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: To extend Visual Studio Code, your extension (plug-in) declares which of the various Contribution Points it is using in its package.json Extension Manifest file. diff --git a/api/references/document-selector.md b/api/references/document-selector.md index c987fcbb15..7c10209005 100644 --- a/api/references/document-selector.md +++ b/api/references/document-selector.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: f328d7e0-8982-4510-b7fb-975188eca502 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Visual Studio Code extensions can filter their features based on Document Selectors by language, file type, and location. diff --git a/api/references/extension-manifest.md b/api/references/extension-manifest.md index 3ea93f4eb4..75d0bc6b61 100644 --- a/api/references/extension-manifest.md +++ b/api/references/extension-manifest.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: C4F184A5-A804-4B0B-9EBA-AFE83B88EE49 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: At the core of Visual Studio Code's extensibility model is an extension (plug-in) manifest file where your extension declares its extension type(s), activation rules, and runtime resources. diff --git a/api/references/icons-in-labels.md b/api/references/icons-in-labels.md index b898ec28aa..f2ac6e2d33 100644 --- a/api/references/icons-in-labels.md +++ b/api/references/icons-in-labels.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 109a10fc-2d64-44b6-98ce-b8375d245776 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Reference of all product icons by id diff --git a/api/references/theme-color.md b/api/references/theme-color.md index 25f4e45165..2c82304778 100644 --- a/api/references/theme-color.md +++ b/api/references/theme-color.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 8e03996d-35e9-4e9f-a60e-50d0962231b8 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Theme Color reference that lists all themable colors in Visual Studio Code. diff --git a/api/references/vscode-api.md b/api/references/vscode-api.md index f9e98d8cb3..eab2ffee3e 100644 --- a/api/references/vscode-api.md +++ b/api/references/vscode-api.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 8CEBCDF8-4F0A-4C81-A904-3DEA43480EA6 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 VSCodeCommitHash: 96d03d1ecc393a047d549dc8bd13c74dc174f20a VSCodeVersion: 1.51.0 diff --git a/api/references/vscode-api.template b/api/references/vscode-api.template index a1b7241018..4137dadef7 100644 --- a/api/references/vscode-api.template +++ b/api/references/vscode-api.template @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 8CEBCDF8-4F0A-4C81-A904-3DEA43480EA6 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 VSCodeCommitHash: 56d73a45e38259976188a982331c9fb5d156cd25 VSCodeVersion: 1.74.0 diff --git a/api/references/when-clause-contexts.md b/api/references/when-clause-contexts.md index 518eef219f..a3c8264c8c 100644 --- a/api/references/when-clause-contexts.md +++ b/api/references/when-clause-contexts.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 38af73fd-ca95-48e3-9965-81f4cfe29996 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Visual Studio Code when clause context reference. --- diff --git a/api/ux-guidelines/activity-bar.md b/api/ux-guidelines/activity-bar.md index 626792d2c4..89f82e58dc 100644 --- a/api/ux-guidelines/activity-bar.md +++ b/api/ux-guidelines/activity-bar.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 13b649f1-156f-489a-9c03-c2cff8060733 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: UX guidelines for the Activity Bar in a Visual Studio Code extension. diff --git a/api/ux-guidelines/command-palette.md b/api/ux-guidelines/command-palette.md index 8f5d408219..0d56e8a82c 100644 --- a/api/ux-guidelines/command-palette.md +++ b/api/ux-guidelines/command-palette.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: bf0d9a5e-897b-450a-adf4-3c8ca9b8e9de -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: UX guidelines for the Command Palette in a Visual Studio Code extension. diff --git a/api/ux-guidelines/context-menus.md b/api/ux-guidelines/context-menus.md index 97ba0241f0..3548abbadb 100644 --- a/api/ux-guidelines/context-menus.md +++ b/api/ux-guidelines/context-menus.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: fdd5476c-13e2-4f78-9dd3-0157eed36a29 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: UX guidelines for using context menus in a Visual Studio Code extension. diff --git a/api/ux-guidelines/editor-actions.md b/api/ux-guidelines/editor-actions.md index 1298279035..967a560cd7 100644 --- a/api/ux-guidelines/editor-actions.md +++ b/api/ux-guidelines/editor-actions.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: ce5c9fff-df86-454a-b4e8-4ae05c8158e2 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: UX guidelines for editor actions in a Visual Studio Code extension. diff --git a/api/ux-guidelines/notifications.md b/api/ux-guidelines/notifications.md index 853522e86d..08d23ae3c0 100644 --- a/api/ux-guidelines/notifications.md +++ b/api/ux-guidelines/notifications.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 92904eb4-6ef0-4801-80d2-6c2c3326ad82 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: UX guidelines for notifications in a Visual Studio Code extension. diff --git a/api/ux-guidelines/overview.md b/api/ux-guidelines/overview.md index a7ebed84c9..9520d8eaf3 100644 --- a/api/ux-guidelines/overview.md +++ b/api/ux-guidelines/overview.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 5b4962ff-2dc9-4201-aa95-46edb5a575b6 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Guidelines that showcase best practices for creating Visual Studio Code extensions. diff --git a/api/ux-guidelines/panel.md b/api/ux-guidelines/panel.md index a62db92299..87c9775b3f 100644 --- a/api/ux-guidelines/panel.md +++ b/api/ux-guidelines/panel.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 06ce3b57-9fd5-428a-98aa-d730edbd2728 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: UX guidelines for the Panel Bar in a Visual Studio Code extension. diff --git a/api/ux-guidelines/quick-picks.md b/api/ux-guidelines/quick-picks.md index 6340f07d12..2044a690ab 100644 --- a/api/ux-guidelines/quick-picks.md +++ b/api/ux-guidelines/quick-picks.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 85918f63-ff5d-4ab8-8a18-26ad00618eff -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: UX guidelines for quick picks used in a Visual Studio Code extension. diff --git a/api/ux-guidelines/settings.md b/api/ux-guidelines/settings.md index 1b7b311a91..9a674a8b1b 100644 --- a/api/ux-guidelines/settings.md +++ b/api/ux-guidelines/settings.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 9f5daebb-1566-46b8-a04d-0fd6c5d4a926 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: UX guidelines for settings contributed by a Visual Studio Code extension. diff --git a/api/ux-guidelines/sidebars.md b/api/ux-guidelines/sidebars.md index 3b2aa109ea..84e77fb7ee 100644 --- a/api/ux-guidelines/sidebars.md +++ b/api/ux-guidelines/sidebars.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 05bd995d-946e-4046-8816-c6d50dccb1b4 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: UX guidelines for the Side Bar in a Visual Studio Code extension. diff --git a/api/ux-guidelines/status-bar.md b/api/ux-guidelines/status-bar.md index 8024952778..8d94df714d 100644 --- a/api/ux-guidelines/status-bar.md +++ b/api/ux-guidelines/status-bar.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 2d16d367-2831-47ca-8f0e-22e3e5fd24bc -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: UX guidelines for status bar and status bar items in a Visual Studio Code extension. diff --git a/api/ux-guidelines/views.md b/api/ux-guidelines/views.md index 3a1edcd86d..308f24f070 100644 --- a/api/ux-guidelines/views.md +++ b/api/ux-guidelines/views.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 1e37b895-d0b3-45b8-a071-107bd665248e -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: UX guidelines for views in a Visual Studio Code extension. diff --git a/api/ux-guidelines/walkthroughs.md b/api/ux-guidelines/walkthroughs.md index 8f2b81eb62..dfff42042f 100644 --- a/api/ux-guidelines/walkthroughs.md +++ b/api/ux-guidelines/walkthroughs.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: e8e157c4-ac6e-4278-9994-953212a1bb88 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: UX guidelines for walkthroughs in a Visual Studio Code extension. diff --git a/api/ux-guidelines/webviews.md b/api/ux-guidelines/webviews.md index 4913b3fe0d..9df9e44a9d 100644 --- a/api/ux-guidelines/webviews.md +++ b/api/ux-guidelines/webviews.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 1c1f6d51-5914-44fa-ae10-0360be0ae2a3 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: UX guidelines for webviews in a Visual Studio Code extension. diff --git a/api/working-with-extensions/bundling-extension.md b/api/working-with-extensions/bundling-extension.md index 4522b368b1..4318f4d5a3 100644 --- a/api/working-with-extensions/bundling-extension.md +++ b/api/working-with-extensions/bundling-extension.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 26f0c0d6-1ea8-4cc1-bd10-9fa744056e7c -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Bundling Visual Studio Code extensions (plug-ins) with webpack. diff --git a/api/working-with-extensions/continuous-integration.md b/api/working-with-extensions/continuous-integration.md index 974e33f77f..72a55da42a 100644 --- a/api/working-with-extensions/continuous-integration.md +++ b/api/working-with-extensions/continuous-integration.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 891072bb-c46d-4392-800a-84d747072ce3 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Use Continuous Integration for testing Visual Studio Code extensions (plug-ins). diff --git a/api/working-with-extensions/publishing-extension.md b/api/working-with-extensions/publishing-extension.md index 0a7adafd96..43c9bbce1d 100644 --- a/api/working-with-extensions/publishing-extension.md +++ b/api/working-with-extensions/publishing-extension.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 7EA90618-43A3-4873-A9B5-61CC131CE4EE -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Learn how to publish Visual Studio Code extensions to the public Marketplace and share them with other developers. diff --git a/api/working-with-extensions/testing-extension.md b/api/working-with-extensions/testing-extension.md index 3eb0ae7c3c..cc8a6c8dbb 100644 --- a/api/working-with-extensions/testing-extension.md +++ b/api/working-with-extensions/testing-extension.md @@ -1,7 +1,7 @@ --- # DO NOT TOUCH β€” Managed by doc writer ContentId: 2447F8EB-15F1-4279-B621-126C7B8EBF4B -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 # Summarize the whole topic in less than 300 characters for SEO purpose MetaDescription: Write tests for your Visual Studio Code extension (plug-in). diff --git a/blogs/2022/12/07/remote-even-better.md b/blogs/2022/12/07/remote-even-better.md new file mode 100644 index 0000000000..fd9aa497c4 --- /dev/null +++ b/blogs/2022/12/07/remote-even-better.md @@ -0,0 +1,153 @@ +--- +Order: 79 +TOCTitle: Remote Development Even Better +PageTitle: Making Remote Development Even Better +MetaDescription: Announcing the release of the unified Visual Studio Code command-line interface and the latest improvements to remote development. +Date: 2022-12-07 +Author: Brigit Murtaugh +--- + +# Remote Development Even Better + +December 07, 2022 by Brigit Murtaugh, [@BrigitMurtaugh](https://twitter.com/BrigitMurtaugh) + +At its core, Visual Studio Code is a code editor, and it integrates with other environments through our [remote development experiences](https://code.visualstudio.com/docs/remote/remote-overview) to become even more powerful and flexible: + +![Spectrum of remote development options](tunneling-blog-remote-spectrum.png) + +You may not think about it, but VS Code has a built-in [command-line interface](https://code.visualstudio.com/docs/editor/command-line) (CLI) that lets you control how you launch and manage the editor - you can open files, install extensions, and output diagnostics through command-line options: + +![Output of code CLI](tunneling-blog-code-help-new.png) + +The CLI is incredibly useful in workflows using VS Code Desktop, but there was a gap: you couldn't start a remote instance with it. So, we wanted to fix that gap by bringing local and remote closer together to make the CLI even more powerful. + +Today, we're thrilled to share our enhanced `code` CLI that lets you both launch VS Code and connect to a machine remotely from VS Code Desktop or vscode.dev. The updated CLI is built into the latest VS Code release and is also available for standalone install, so you can create a secure connection to any computer and connect to it remotely, even if you can't install VS Code Desktop on it. + +In addition to the new CLI, we've made the following updates to improve remote development: + +* You can enable tunneling directly from the VS Code UI. +* Tunneling is no longer in private preview – anyone can create and use tunnels, no sign up required. +* We renamed two remote extensions to be clearer about how they work and where they can help development: + * The "Remote - WSL" extension is now simply [WSL](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl). + * The "Remote - Containers" extension is renamed [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) to reflect it's use for creating development environments. + +## Tunnel to anywhere, from one tool + +Tunneling, also known as port forwarding, securely transmits data from one network to another. You can use secure tunnels to develop against any machine of your choosing from a VS Code desktop or web client, without the hassle of setting up SSH or HTTPS (although you can do that if you want as well 😊). + +You have two great options for tunneling to remote machines from VS Code: + +* Use the new, enhanced `code` CLI. +* Enable tunneling from the VS Code UI directly. + +We'll explore both options in the following sections. + +### Enhanced `code` CLI + +When we released the VS Code Server, we [mentioned](https://code.visualstudio.com/blogs/2022/07/07/vscode-server#_a-preview-of-a-larger-journey) our long-term vision to integrate it into the `code` [CLI](https://code.visualstudio.com/docs/editor/command-line). We've now achieved this, and we've also made it available for standalone install, in case you're working on a VM or locked down machine where you can't install VS Code Desktop. + +Below are the steps to install the `code` CLI and create a secure tunnel with it. If you tried the private preview of the VS Code Server, the steps will be very similar. + +> **Note:** If you were using the standalone `code-server` CLI during the private preview of the VS Code Server, you should now use the latest `code` CLI (via the latest VS Code Desktop or standalone download) instead. + +1. Install the `code` CLI on a remote machine you'd like to develop against in a local VS Code client. This could be a remote desktop, VM, or even a [Windows Subsystem for Linux](https://learn.microsoft.com/en-us/windows/wsl/) (WSL) distro. + + The CLI is automatically included in your existing VS Code installation – no additional setup required. If you don't have VS Code installed or can't install it on your remote machine, you can grab the CLI through a [standalone install](https://code.visualstudio.com/#alt-downloads) on our download page: + + ![CLI download section](tunneling-blog-download.png) + + > **Note:** If you're using the standalone install, the commands in the following section will start with `./code` rather than `code`. + +2. Double-check the CLI installed successfully by using the help command: + + ```bash + code -h + ``` + + You may explore tunneling-specific commands with: + + ```bash + code tunnel -h + ``` + + Now that you've installed the CLI, let's set up this machine for tunneling so that you can connect to it from any VS Code client. + +3. Create a secure tunnel with the `tunnel` command: + + ```bash + code tunnel + ``` + + This command downloads and starts the VS Code Server on this machine and then creates a tunnel to it. + + >**Note:** You will be prompted to accept the server license terms when you first start a tunnel on a machine. You can also pass `--accept-server-license-terms` on the command line to avoid the prompt. + +4. This CLI will output a vscode.dev URL tied to this remote machine, such as `https://vscode.dev/tunnel//`. You can open this URL from any machine you want. + +5. When opening the vscode.dev URL for the first time on a client, you'll be prompted to log into your GitHub account at a `https://github.com/login/oauth/authorize...` URL. This authenticates you to the tunneling service to ensure you have access to the right set of remote machines. + +Congratulations, you've successfully installed and used the latest tunneling features of the `code` CLI! + +### Enable Tunneling from VS Code UI + +You may also choose to create tunnels directly from the VS Code UI if you have VS Code installed on your remote machine. This is a quick, convenient way to enable remote access to your machine if you're already working in VS Code. + +Open VS Code on your remote machine. In the VS Code Account menu, select the option to **Turn on Remote Tunnel Access…**, as demonstrated in the image below. You may also open the Command Palette (`kbstyle(F1)`) and run the command **Remote Tunnels: Turn on Remote Tunnel Access...**. + +![Turn on Remote Tunnel Access in the Account menu](tunneling-blog-access-red.png) + +You'll be prompted to log into GitHub. Once you've logged in, a tunnel will start up on this remote machine, and you'll be able to connect to it: + +![Remote tunnel access is enabled toast](tunneling-blog-enabled-prompt.png) + +In a client of your choice, you can open the vscode.dev link from the notification above and start coding! + +### Connect via Remote Tunnels + +The [Remote - Tunnels](https://aka.ms/remote-tunnels-doc) extension manages these secure tunnels between your local and remote machines. The vscode.dev instances you open through the `code` CLI or VS Code UI come with the Remote Tunnels extension preinstalled. + +If you're already working in a VS Code client (desktop or web) and would like to connect to a remote tunnel, you can install and use the [Remote - Tunnels](https://marketplace.visualstudio.com/items?itemName=ms-vscode.remote-server) extension directly. Once you install the extension, open the Command Palette (`kbstyle(F1)`) and run the command **Remote Tunnels: Connect to Tunnel**. You'll be able to connect to any remote machines with an active tunnel: + +![List of remote machines in Quick Pick](tunneling-blog-list.png) + +You can also view your remote machines in the Remote Explorer, which you can open through the command **Remote Explorer: Focus on Remote View**: + +![List of remote machines in Remote Explorer](tunneling-blog-remote-explorer.png) + +### Removing a tunnel or machine + +If you'd like to stop a tunnel you're running via the CLI, use `kbstyle(Ctrl + C)` to end the active connection. If you've enabled tunneling through the VS Code UI, run the command **Remote Tunnels: Turn of Remote Tunnel Access...**. + +You can remove a machine's association with tunneling by running `code tunnel unregister` on that machine. In VS Code, select the Remote Explorer view, right-click on the machine you'd like to remove, and select **unregister**. + +## Remote Development extensions + +Along with the updates to tunneling and the `code` CLI, we've made some updates to our [Remote Development](https://code.visualstudio.com/docs/remote/remote-overview) extensions, which allow you to use a development container, remote machine, or WSL as a full-featured development environment. + +### WSL and Dev Containers + +We heard your feedback about the names of the **Remote - WSL** and **Remote - Containers** extensions. We intended for `Remote` to indicate that you are developing in a "remote" or "separate" WSL distro or development container, rather than traditional local development. However, this is a different use of "remote" than many people use, and it can cause confusion (for example, is the Dev Container on my local machine?). + +We updated naming and in-product commands in these extensions to be clearer, renaming them to [WSL](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl) and [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers). Links such as the extension identifier in the Marketplace and documentation remain the same, so you shouldn't see breakage in your current use of these two extensions. + +![WSL extension in the Marketplace](tunneling-blog-wsl.png) + +![Dev Containers extension in the Marketplace](tunneling-blog-containers.png) + +### Remote Tunnels + +As described above, you can use the [Remote - Tunnels](https://marketplace.visualstudio.com/items?itemName=ms-vscode.remote-server) extension to connect to a remote machine via a secure tunnel, without the requirement of SSH. We've renamed the extension to "Remote - Tunnels" from "Remote Server" as we believe this more clearly indicates its behavior (the extension is used to develop on remote machines via secure tunnels after all!). + +![Remote - Tunnels extension in the Marketplace](tunneling-blog-extension.png) + +## Closing – thank you! + +We've heard your feedback over the years on our remote experiences and most recently on the VS Code Server – we can't thank you enough for sharing the thoughts that continue to shape our product experiences. We're excited to see how you use our latest remote features and for your feedback! + +If you'd like a more in-depth look at the tools described in this blog, we created a [topic](https://aka.ms/remote-tunnels-doc) on the Remote - Tunnels extension, along with updating the [VS Code Server](https://code.visualstudio.com/docs/remote/vscode-server) and [`code` CLI](https://code.visualstudio.com/docs/editor/command-line) documnetation to reflect the latest changes. + +Please feel free to file feature requests or bugs in our [vscode-remote-release](https://github.com/microsoft/vscode-remote-release/issues) GitHub repository, or you can Tweet us your thoughts [@code](https://twitter.com/code). + +Happy Coding! + +Brigit Murtaugh, [@BrigitMurtaugh](https://twitter.com/BrigitMurtaugh) diff --git a/blogs/2022/12/07/tunneling-blog-access-red.png b/blogs/2022/12/07/tunneling-blog-access-red.png new file mode 100644 index 0000000000..ee2b4d1a2d --- /dev/null +++ b/blogs/2022/12/07/tunneling-blog-access-red.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:deec6b80f1e82024f0cd772ab046f3145b36e72a58428955cdc298ad9036b25f +size 51512 diff --git a/blogs/2022/12/07/tunneling-blog-code-help-new.png b/blogs/2022/12/07/tunneling-blog-code-help-new.png new file mode 100644 index 0000000000..f735d48668 --- /dev/null +++ b/blogs/2022/12/07/tunneling-blog-code-help-new.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e51682d7c008608ed4febae13a19b8026b308a43045f785b3ab2e183f8e5517e +size 123716 diff --git a/blogs/2022/12/07/tunneling-blog-containers.png b/blogs/2022/12/07/tunneling-blog-containers.png new file mode 100644 index 0000000000..ee925f270c --- /dev/null +++ b/blogs/2022/12/07/tunneling-blog-containers.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:98cb2bb68de51615166847d79165e850a420b8961276e317073cc5b32ec5accb +size 67033 diff --git a/blogs/2022/12/07/tunneling-blog-download.png b/blogs/2022/12/07/tunneling-blog-download.png new file mode 100644 index 0000000000..e47c6cfcd4 --- /dev/null +++ b/blogs/2022/12/07/tunneling-blog-download.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f8cb6ef7472e0e57568720320ecf9b38d3873384f44e6f8bb0ec2e13d84ae907 +size 27921 diff --git a/blogs/2022/12/07/tunneling-blog-enabled-prompt.png b/blogs/2022/12/07/tunneling-blog-enabled-prompt.png new file mode 100644 index 0000000000..20b3ac89bc --- /dev/null +++ b/blogs/2022/12/07/tunneling-blog-enabled-prompt.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:04457e3dff2f645947179c060a7c5d30d6f3fe83980b92dda82f42a8c52bbaab +size 42923 diff --git a/blogs/2022/12/07/tunneling-blog-extension.png b/blogs/2022/12/07/tunneling-blog-extension.png new file mode 100644 index 0000000000..2ff9274d5a --- /dev/null +++ b/blogs/2022/12/07/tunneling-blog-extension.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e96de8602c90099d73883da7d947ceb0584ee9f37a33d9a81d5fcd6ecc894659 +size 42741 diff --git a/blogs/2022/12/07/tunneling-blog-list.png b/blogs/2022/12/07/tunneling-blog-list.png new file mode 100644 index 0000000000..943b2eea2f --- /dev/null +++ b/blogs/2022/12/07/tunneling-blog-list.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4b8d04a1efa18a648dd70b64816d2c686fbd31957f5adefc9e3d397f8c5b0ac1 +size 24760 diff --git a/blogs/2022/12/07/tunneling-blog-remote-explorer.png b/blogs/2022/12/07/tunneling-blog-remote-explorer.png new file mode 100644 index 0000000000..9dbab69f61 --- /dev/null +++ b/blogs/2022/12/07/tunneling-blog-remote-explorer.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:902d32bb38942e4063cd543c723de1f42a231193afa1bc68b4c47123c8838502 +size 49067 diff --git a/blogs/2022/12/07/tunneling-blog-remote-spectrum.png b/blogs/2022/12/07/tunneling-blog-remote-spectrum.png new file mode 100644 index 0000000000..71f468fac9 --- /dev/null +++ b/blogs/2022/12/07/tunneling-blog-remote-spectrum.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7edc91aabd4e271699c9af40d0d04bbe3070e046b859917210bdef42ffb61944 +size 1217459 diff --git a/blogs/2022/12/07/tunneling-blog-wsl.png b/blogs/2022/12/07/tunneling-blog-wsl.png new file mode 100644 index 0000000000..9db92da918 --- /dev/null +++ b/blogs/2022/12/07/tunneling-blog-wsl.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7b099e330d7101d3a5ebd6fb86cc6cd4a99c71d64191ad8102df8186daf812b9 +size 82912 diff --git a/build/sitemap.xml b/build/sitemap.xml index a027194204..69b556c0ef 100644 --- a/build/sitemap.xml +++ b/build/sitemap.xml @@ -600,6 +600,11 @@ weekly 0.8 + + https://code.visualstudio.com/docs/python/python-web + weekly + 0.8 + https://code.visualstudio.com/docs/datascience/overview weekly diff --git a/docs/azure/deployment.md b/docs/azure/deployment.md index a2d31ea215..ddd9445ea7 100644 --- a/docs/azure/deployment.md +++ b/docs/azure/deployment.md @@ -5,7 +5,7 @@ TOCTitle: Deployment PageTitle: Visual Studio Code Azure Tutorials ContentId: 90f8dc30-1e71-4ea7-8230-2bf09bfb97d4 MetaDescription: Visual Studio Code Azure Tutorials -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 --- # Deploying Applications to Azure diff --git a/docs/azure/docker.md b/docs/azure/docker.md index 9700f86be0..4993aaa78c 100644 --- a/docs/azure/docker.md +++ b/docs/azure/docker.md @@ -4,7 +4,7 @@ Area: azure TOCTitle: Docker ContentId: 42F8B9F8-BD03-4159-9479-17C5BDE30531 PageTitle: Working with Docker in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Working with Docker containers in Visual Studio Code. --- # Working with Docker diff --git a/docs/azure/extensions.md b/docs/azure/extensions.md index e2d53c2b51..be43b505db 100644 --- a/docs/azure/extensions.md +++ b/docs/azure/extensions.md @@ -5,7 +5,7 @@ TOCTitle: Extensions PageTitle: Visual Studio Code Azure Extensions ContentId: d2e93075-4cfe-48f4-b05e-f985c86d9713 MetaDescription: Visual Studio Code Azure Extensions -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 --- # Azure Extensions diff --git a/docs/containers/bridge-to-kubernetes.md b/docs/containers/bridge-to-kubernetes.md index 561a09021a..8de17f4044 100644 --- a/docs/containers/bridge-to-kubernetes.md +++ b/docs/containers/bridge-to-kubernetes.md @@ -4,7 +4,7 @@ Area: containers TOCTitle: Develop with Kubernetes ContentId: 80bd336b-0d2d-4d63-a771-8b3ea22a64d3 PageTitle: Use Bridge to Kubernetes to run and debug locally with Kubernetes -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Learn how to use Bridge to Kubernetes. --- diff --git a/docs/datascience/overview.md b/docs/datascience/overview.md index b72a6a5662..83845452b8 100644 --- a/docs/datascience/overview.md +++ b/docs/datascience/overview.md @@ -4,7 +4,7 @@ Area: datascience TOCTitle: Overview ContentId: 23ce059e-95ec-4eaa-975c-d4cf76159516 PageTitle: Doing Data Science in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Doing Data Science in Visual Studio Code. --- diff --git a/docs/datascience/python-interactive.md b/docs/datascience/python-interactive.md index 260cb29314..884f4891f3 100644 --- a/docs/datascience/python-interactive.md +++ b/docs/datascience/python-interactive.md @@ -4,7 +4,7 @@ Area: datascience TOCTitle: Python Interactive ContentId: 09645514-3c23-49ec-8e27-71831bc06ce7 PageTitle: Working with Jupyter code cells in the Python Interactive window -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Working with Jupyter code cells in the Python Interactive window MetaSocialImage: images/tutorial/social.png --- diff --git a/docs/devcontainers/attach-container.md b/docs/devcontainers/attach-container.md index 36b6e3a97f..034f5161aa 100644 --- a/docs/devcontainers/attach-container.md +++ b/docs/devcontainers/attach-container.md @@ -5,7 +5,7 @@ TOCTitle: Attach to Container PageTitle: Attach to a running container using Visual Studio Code Remote Development ContentId: ed14ef07-f44c-4675-b95b-cb5faffc7abb MetaDescription: Attach to a running container using Visual Studio Code Remote Development -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 --- # Attach to a running container diff --git a/docs/devcontainers/containers-advanced.md b/docs/devcontainers/containers-advanced.md index 83fb940a9a..7eec020d3e 100644 --- a/docs/devcontainers/containers-advanced.md +++ b/docs/devcontainers/containers-advanced.md @@ -5,7 +5,7 @@ TOCTitle: Advanced Containers PageTitle: Advanced Container Configuration ContentId: f180ac25-1d59-47ec-bad2-3ccbf214bbd8 MetaDescription: Advanced setup for using the VS Code Dev Containers extension -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 --- # Advanced Container Configuration diff --git a/docs/devcontainers/containers.md b/docs/devcontainers/containers.md index 9d09dd8f14..822b946ba5 100644 --- a/docs/devcontainers/containers.md +++ b/docs/devcontainers/containers.md @@ -5,7 +5,7 @@ TOCTitle: Overview PageTitle: Developing inside a Container using Visual Studio Code Remote Development ContentId: 7ec8a02b-2eb7-45c1-bb16-ddeaac694ff6 MetaDescription: Developing inside a Container using Visual Studio Code Remote Development -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 --- # Developing inside a Container diff --git a/docs/devcontainers/create-dev-container.md b/docs/devcontainers/create-dev-container.md index 37fb2e6a42..c48f825a4a 100644 --- a/docs/devcontainers/create-dev-container.md +++ b/docs/devcontainers/create-dev-container.md @@ -5,7 +5,7 @@ TOCTitle: Create a Dev Container PageTitle: Create a development container using Visual Studio Code Remote Development ContentId: bae55561-1032-40d4-b6a6-47054da96098 MetaDescription: Create a development container using Visual Studio Code Remote Development -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 --- # Create a Dev Container diff --git a/docs/devcontainers/devcontainer-cli.md b/docs/devcontainers/devcontainer-cli.md index e9e3d150c4..b9ff03ed48 100644 --- a/docs/devcontainers/devcontainer-cli.md +++ b/docs/devcontainers/devcontainer-cli.md @@ -5,7 +5,7 @@ TOCTitle: Dev Container CLI PageTitle: Installing and working with the devcontainer CLI ContentId: 8946213d-716e-41ca-955f-944a41c70353 MetaDescription: Documentation on using the development container (dev container) command-line interface -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 --- # Dev Container CLI diff --git a/docs/devcontainers/devcontainerjson-reference.md b/docs/devcontainers/devcontainerjson-reference.md index 486f8b109c..158c00c7d1 100644 --- a/docs/devcontainers/devcontainerjson-reference.md +++ b/docs/devcontainers/devcontainerjson-reference.md @@ -5,7 +5,7 @@ TOCTitle: devcontainer.json PageTitle: devcontainer.json reference ContentId: 52eaec33-21c6-410c-8e10-1ee3658a854f MetaDescription: devcontainer.json reference -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 --- # devcontainer.json reference diff --git a/docs/devcontainers/faq.md b/docs/devcontainers/faq.md index 5dd0de8a2c..6fa137e5b2 100644 --- a/docs/devcontainers/faq.md +++ b/docs/devcontainers/faq.md @@ -5,7 +5,7 @@ TOCTitle: FAQ PageTitle: Visual Studio Code Dev Containers Frequently Asked Questions ContentId: c4784db6-ab00-4ac7-bca8-88edb638c593 MetaDescription: Visual Studio Code troubleshooting tips and tricks for Dev Containers -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 --- # Dev Containers FAQ diff --git a/docs/devcontainers/tips-and-tricks.md b/docs/devcontainers/tips-and-tricks.md index 46a01c7963..77e69ab77c 100644 --- a/docs/devcontainers/tips-and-tricks.md +++ b/docs/devcontainers/tips-and-tricks.md @@ -5,7 +5,7 @@ TOCTitle: Tips and Tricks PageTitle: Visual Studio Code Dev Containers Tips and Tricks ContentId: c4784db6-ab00-4ac7-bca8-88edb638c593 MetaDescription: Visual Studio Code Remote Development troubleshooting tips and tricks for Dev Containers -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 --- # Dev Containers Tips and Tricks diff --git a/docs/devcontainers/tutorial.md b/docs/devcontainers/tutorial.md index e2d88aa678..14b0218243 100644 --- a/docs/devcontainers/tutorial.md +++ b/docs/devcontainers/tutorial.md @@ -5,7 +5,7 @@ TOCTitle: Tutorial PageTitle: Get started with development Containers in Visual Studio Code ContentId: 8e1fb9e0-1a67-4e0c-a21b-c5ab9a6d979c MetaDescription: Get started with development Containers in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 --- # Dev Containers tutorial diff --git a/docs/editor/accessibility.md b/docs/editor/accessibility.md index e1780f9009..96392e158f 100644 --- a/docs/editor/accessibility.md +++ b/docs/editor/accessibility.md @@ -4,7 +4,7 @@ Area: editor TOCTitle: Accessibility ContentId: 62894B41-CC33-400A-8A56-8C761C77B4C7 PageTitle: Accessibility in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Visual Studio Code user accessibility features. Learn here about the various ways VS Code aids user accessibility. --- # Accessibility diff --git a/docs/editor/codebasics.md b/docs/editor/codebasics.md index bd79d7f2e1..da0b0e6330 100644 --- a/docs/editor/codebasics.md +++ b/docs/editor/codebasics.md @@ -4,7 +4,7 @@ Area: editor TOCTitle: Basic Editing ContentId: DE4EAE2F-4542-4363-BB74-BE47D64141E6 PageTitle: Basic Editing in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Learn about the basic editing features of Visual Studio Code. Search, multiple selection, code formatting. MetaSocialImage: codebasics_CodeBasics.png --- diff --git a/docs/editor/command-line.md b/docs/editor/command-line.md index a9572e0a46..bdf28c38b3 100644 --- a/docs/editor/command-line.md +++ b/docs/editor/command-line.md @@ -4,7 +4,7 @@ Area: editor TOCTitle: Command Line Interface ContentId: 8faef870-7a5f-4070-ad17-8ba791006912 PageTitle: The Visual Studio Code command-line interface -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Visual Studio Code command-line interface (switches). --- # Command Line Interface (CLI) @@ -105,6 +105,28 @@ Argument|Description **Multi-root**| `--add ` | Add folder(s) to the last active window for a multi-root workspace. +### Create remote tunnel + +VS Code integrates with other [remote environments](/docs/remote/remote-overview.md) to become even more powerful and flexible. Our goal is to provide a cohesive experience that allows you to manage both local and remote machines from one, unified CLI. + +The Visual Studio Code [Remote - Tunnels](https://marketplace.visualstudio.com/items?itemName=ms-vscode.remote-server) extension lets you connect to a remote machine, like a desktop PC or VM, via a secure tunnel. Tunneling, also known as port forwarding, securely transmits data from one network to another. You can then securely connect to that machine from anywhere, without the requirement of SSH. + +We've built functionality into the `code` CLI that will initiate tunnels on remote machines. You can run: + +```bash +code tunnel +``` + +to create a tunnel on your remote machine. You may connect to this machine through a web or desktop VS Code client. + +You can review the other tunneling commands by running `code tunnel -help`: + +![Output of tunnel help CLI command](images/command-line/tunnel-help.png) + +As you may need to run the CLI on a remote machine that can't install VS Code Desktop, the CLI is also available for standalone install on the [VS Code download page](https://code.visualstudio.com/insiders/). + +For more information on Remote Tunnels, you can review the [Remote Tunnels documentation](/docs/remote/tunnels.md). + ## Opening VS Code with URLs You can also open projects and files using the platform's URL handling mechanism. Use the following URL formats to: diff --git a/docs/editor/debugging.md b/docs/editor/debugging.md index 70bc356207..86c58fb4d9 100644 --- a/docs/editor/debugging.md +++ b/docs/editor/debugging.md @@ -4,7 +4,7 @@ Area: editor TOCTitle: Debugging ContentId: 4E9A74AA-D778-4D1C-B369-83763B3C340F PageTitle: Debugging in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: One of the great things in Visual Studio Code is debugging support. Set breakpoints, step-in, inspect variables and more. MetaSocialImage: images/debugging/Debugging.png --- diff --git a/docs/editor/editingevolved.md b/docs/editor/editingevolved.md index 6617203a6d..d96ed30442 100644 --- a/docs/editor/editingevolved.md +++ b/docs/editor/editingevolved.md @@ -4,7 +4,7 @@ Area: editor TOCTitle: Code Navigation ContentId: 8966BBFD-C66D-4283-9DCA-8CAC0179886E PageTitle: Code Navigation in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Visual Studio Code is a first class editor - but it's also so much more with features such as IntelliSense and smart code navigation. --- # Code Navigation diff --git a/docs/editor/emmet.md b/docs/editor/emmet.md index 0976e8bc8b..5c25be7353 100644 --- a/docs/editor/emmet.md +++ b/docs/editor/emmet.md @@ -4,7 +4,7 @@ Area: editor TOCTitle: Emmet ContentId: baf4717c-ea52-486e-9ea3-7bf1c4134dad PageTitle: Emmet in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Using Emmet abbreviations inside Visual Studio Code. --- # Emmet in Visual Studio Code diff --git a/docs/editor/extension-marketplace.md b/docs/editor/extension-marketplace.md index 85a1f86fae..0f4d13a1a2 100644 --- a/docs/editor/extension-marketplace.md +++ b/docs/editor/extension-marketplace.md @@ -4,7 +4,7 @@ Area: editor TOCTitle: Extension Marketplace ContentId: 319916C4-93F2-471F-B448-FD416736C40C PageTitle: Managing Extensions in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Discover, add, update, disable and uninstall Visual Studio Code extensions (plug-ins) through the Extension Marketplace. --- # Extension Marketplace diff --git a/docs/editor/images/command-line/tunnel-help.png b/docs/editor/images/command-line/tunnel-help.png new file mode 100644 index 0000000000..185b719e07 --- /dev/null +++ b/docs/editor/images/command-line/tunnel-help.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5568b0be5f49e93337eadd19b958d15d882ae204520279f8ce81f4a4a92c0b69 +size 122593 diff --git a/docs/editor/intellisense.md b/docs/editor/intellisense.md index 12fc9f8d83..cef657426e 100644 --- a/docs/editor/intellisense.md +++ b/docs/editor/intellisense.md @@ -4,7 +4,7 @@ Area: editor TOCTitle: IntelliSense ContentId: 80f4fa1e-d4c5-42cf-8b12-4b8e88c41c3e PageTitle: IntelliSense in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Learn about Visual Studio Code IntelliSense (intelligent code completion). --- # IntelliSense diff --git a/docs/editor/multi-root-workspaces.md b/docs/editor/multi-root-workspaces.md index 3acf7033d0..50c86241fb 100644 --- a/docs/editor/multi-root-workspaces.md +++ b/docs/editor/multi-root-workspaces.md @@ -4,7 +4,7 @@ Area: editor TOCTitle: Multi-root Workspaces ContentId: 8d55f6b8-977f-4c26-a888-f3d8d982dd2d PageTitle: Multi-root Workspaces in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: You can open and work on multiple project folders in Visual Studio Code with multi-root workspaces. --- # Multi-root Workspaces diff --git a/docs/editor/portable.md b/docs/editor/portable.md index bd64615c01..df17c8d05d 100644 --- a/docs/editor/portable.md +++ b/docs/editor/portable.md @@ -4,7 +4,7 @@ Area: editor TOCTitle: Portable Mode ContentId: A5C839C4-67E9-449C-94B8-4B310FCAAB1B PageTitle: Portable Mode in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Visual Studio Code supports a Portable Mode. --- # Portable Mode diff --git a/docs/editor/refactoring.md b/docs/editor/refactoring.md index 035f4074a0..28059d66b5 100644 --- a/docs/editor/refactoring.md +++ b/docs/editor/refactoring.md @@ -4,7 +4,7 @@ Area: editor TOCTitle: Refactoring ContentId: 481dfd3a-d847-4ed3-b37b-7fc8d234a4c2 PageTitle: Refactoring source code in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Refactoring source code in Visual Studio Code. --- # Refactoring diff --git a/docs/editor/settings-sync.md b/docs/editor/settings-sync.md index 0232495ea1..2f15b8070b 100644 --- a/docs/editor/settings-sync.md +++ b/docs/editor/settings-sync.md @@ -4,7 +4,7 @@ Area: editor TOCTitle: Settings Sync ContentId: 6cb84e60-6d90-4137-83f6-bdab3438b8f5 PageTitle: Settings Sync in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Synchronize your user settings across all your Visual Studio Code instances. --- # Settings Sync diff --git a/docs/editor/tasks-appendix.md b/docs/editor/tasks-appendix.md index 4ad2e6a976..7d3e58fadc 100644 --- a/docs/editor/tasks-appendix.md +++ b/docs/editor/tasks-appendix.md @@ -2,7 +2,7 @@ TOCTitle: Tasks Appendix ContentId: 6DCA48F5-0566-4AEB-9C4C-CCBBA2945347 PageTitle: Visual Studio Code Tasks Appendix -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Additional info for using task runners in Visual Studio Code. --- # Appendix diff --git a/docs/editor/tasks.md b/docs/editor/tasks.md index 780e3ced98..94f1316a66 100644 --- a/docs/editor/tasks.md +++ b/docs/editor/tasks.md @@ -4,7 +4,7 @@ Area: editor TOCTitle: Tasks ContentId: F5EA1A52-1EF2-4127-ABA6-6CEF5447C608 PageTitle: Tasks in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Expand your development workflow with task integration in Visual Studio Code. --- # Integrate with External Tools via Tasks diff --git a/docs/editor/userdefinedsnippets.md b/docs/editor/userdefinedsnippets.md index 36e2ef39b3..a1f04b0fb2 100644 --- a/docs/editor/userdefinedsnippets.md +++ b/docs/editor/userdefinedsnippets.md @@ -4,7 +4,7 @@ Area: editor TOCTitle: Snippets ContentId: 79CD9B45-97FF-48B1-8DD5-2555F56206A6 PageTitle: Snippets in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: It is easy to add code snippets to Visual Studio Code both for your own use or to share with others on the public Extension Marketplace. TextMate .tmSnippets files are supported. --- # Snippets in Visual Studio Code diff --git a/docs/editor/variables-reference.md b/docs/editor/variables-reference.md index a1c1dd4b42..b0af7c20c2 100644 --- a/docs/editor/variables-reference.md +++ b/docs/editor/variables-reference.md @@ -4,7 +4,7 @@ Area: editor TOCTitle: Variables reference ContentId: ff9cd4ea-e3f0-4170-9451-2f2ea2b909ea PageTitle: Visual Studio Code Variables Reference -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Visual Studio Code variable substitution reference --- # Variables Reference diff --git a/docs/editor/vscode-web.md b/docs/editor/vscode-web.md index 20b17a39cc..09df85048a 100644 --- a/docs/editor/vscode-web.md +++ b/docs/editor/vscode-web.md @@ -4,7 +4,7 @@ Area: editor TOCTitle: VS Code for the Web ContentId: d665a790-1da1-4f45-bc0f-c09822528e55 PageTitle: Visual Studio Code for the Web -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Visual Studio Code for the Web and the vscode.dev URL --- # Visual Studio Code for the Web diff --git a/docs/editor/whyvscode.md b/docs/editor/whyvscode.md index d3578d3205..8ef63c6748 100644 --- a/docs/editor/whyvscode.md +++ b/docs/editor/whyvscode.md @@ -4,7 +4,7 @@ Area: editor TOCTitle: Why VS Code ContentId: FF543B32-703C-4894-9A3B-2B5BFAF8B6B8 PageTitle: Why Visual Studio Code? -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Visual Studio Code provides developers with a new choice of tool that combines the simplicity of a code editor with the best tooling for their core edit-build-debug cycle. Visual Studio Code is available for macOS, Linux, and Windows. --- # Why did we build Visual Studio Code? diff --git a/docs/editor/workspace-trust.md b/docs/editor/workspace-trust.md index 257cf4d225..790c47b073 100644 --- a/docs/editor/workspace-trust.md +++ b/docs/editor/workspace-trust.md @@ -4,7 +4,7 @@ Area: editor TOCTitle: Workspace Trust ContentId: 51280c26-f78b-4f9c-997f-8350bd6ed07f PageTitle: Visual Studio Code Workspace Trust security -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Visual Studio Code Workspace Trust folder security --- # Workspace Trust diff --git a/docs/editor/workspaces.md b/docs/editor/workspaces.md index 61c1f6d233..c21a13ce59 100644 --- a/docs/editor/workspaces.md +++ b/docs/editor/workspaces.md @@ -4,7 +4,7 @@ Area: editor TOCTitle: ContentId: 0144ad9a-14df-41b5-9629-cbba7dbfc396 PageTitle: Workspaces in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Learn about Visual Studio Code workspaces --- # What is a VS Code "workspace"? diff --git a/docs/getstarted/introvideos.md b/docs/getstarted/introvideos.md index 40b200bd9a..7b905187a4 100644 --- a/docs/getstarted/introvideos.md +++ b/docs/getstarted/introvideos.md @@ -4,7 +4,7 @@ Area: getstarted TOCTitle: Intro Videos ContentId: f29747b9-0f4f-4f62-b0a7-037ffc49d972 PageTitle: Visual Studio Code Introductory Videos -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Overview of Visual Studio Code's introductory videos. MetaSocialImage: images/introvideos/opengraph_introvideos.png --- diff --git a/docs/getstarted/keybindings.md b/docs/getstarted/keybindings.md index 09b21f8315..c12a4a30aa 100644 --- a/docs/getstarted/keybindings.md +++ b/docs/getstarted/keybindings.md @@ -4,7 +4,7 @@ Area: getstarted TOCTitle: Key Bindings ContentId: 045980C1-62C7-4E8E-8CE4-BAD722FFE31E PageTitle: Visual Studio Code Key Bindings -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Here you will find the complete list of key bindings for Visual Studio Code and how to change them. MetaSocialImage: images/keybinding/customization_keybindings.png --- diff --git a/docs/getstarted/locales.md b/docs/getstarted/locales.md index 9650c1de54..20625ff9cc 100644 --- a/docs/getstarted/locales.md +++ b/docs/getstarted/locales.md @@ -4,7 +4,7 @@ Area: getstarted TOCTitle: Display Language PageTitle: Visual Studio Code Display Language (Locale) ContentId: 413A7FA3-94F8-4FCB-A4A3-F4C1E77EF716 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: How to change the display language (locale) of Visual Studio Code. --- # Display Language diff --git a/docs/getstarted/settings.md b/docs/getstarted/settings.md index 63d6e3435d..6e1356890a 100644 --- a/docs/getstarted/settings.md +++ b/docs/getstarted/settings.md @@ -4,7 +4,7 @@ Area: getstarted TOCTitle: Settings ContentId: FDA6D86C-FF24-49BC-A1EB-E3BA43130FA0 PageTitle: Visual Studio Code User and Workspace Settings -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: How to modify Visual Studio Code User and Workspace Settings. --- # User and Workspace Settings diff --git a/docs/getstarted/telemetry.md b/docs/getstarted/telemetry.md index 0fb4f7f7a6..36dbe6ce4a 100644 --- a/docs/getstarted/telemetry.md +++ b/docs/getstarted/telemetry.md @@ -4,7 +4,7 @@ Area: getstarted TOCTitle: Telemetry PageTitle: Visual Studio Code Telemetry ContentId: 47a2e3b1-24f2-42e6-a6e6-272c2a0f3218 -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Learn about Visual Studio Code collected telemetry and how to opt out. --- # Telemetry diff --git a/docs/getstarted/themes.md b/docs/getstarted/themes.md index 19e1edcc9a..fbe82d5ce9 100644 --- a/docs/getstarted/themes.md +++ b/docs/getstarted/themes.md @@ -4,7 +4,7 @@ Area: getstarted TOCTitle: Themes ContentId: CAC88BC7-90A5-4384-8A05-2187117C0F72 PageTitle: Visual Studio Code Themes -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Changing the color theme in Visual Studio Code. You can use color themes provided by VS Code, the community or create your own new themes. --- # Color Themes diff --git a/docs/getstarted/tips-and-tricks.md b/docs/getstarted/tips-and-tricks.md index 8c408ea16b..6a42cd13b9 100644 --- a/docs/getstarted/tips-and-tricks.md +++ b/docs/getstarted/tips-and-tricks.md @@ -4,7 +4,7 @@ Area: getstarted TOCTitle: Tips and Tricks ContentId: 9bbbe55d-cf81-428f-8a9f-4f60280cb874 PageTitle: Visual Studio Code Tips and Tricks -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Visual Studio Code Tips and Tricks for power users. --- # Visual Studio Code Tips and Tricks diff --git a/docs/getstarted/userinterface.md b/docs/getstarted/userinterface.md index 2d4c71a109..62bc089db1 100644 --- a/docs/getstarted/userinterface.md +++ b/docs/getstarted/userinterface.md @@ -4,7 +4,7 @@ Area: getstarted TOCTitle: User Interface ContentId: 3a33f35b-cded-4f7f-8674-6f2ba5fca023 PageTitle: Visual Studio Code User Interface -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: A quick overview of the Visual Studio Code user interface. Learn about the editor, window management, and special UI to handle source control, extension management, full text search and more. --- # User Interface diff --git a/docs/languages/css.md b/docs/languages/css.md index 1537e8183c..291f2d9632 100644 --- a/docs/languages/css.md +++ b/docs/languages/css.md @@ -4,7 +4,7 @@ Area: languages TOCTitle: CSS, SCSS and Less ContentId: 039882CB-B5C4-46BD-A8D5-DB24A5E82706 PageTitle: CSS, SCSS, and Less support in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Find out how Visual Studio Code can support your CSS, SCSS and Less development. --- # CSS, SCSS and Less diff --git a/docs/languages/html.md b/docs/languages/html.md index ad8b1e6f98..9a4edeb162 100644 --- a/docs/languages/html.md +++ b/docs/languages/html.md @@ -4,7 +4,7 @@ Area: languages TOCTitle: HTML ContentId: 43095EAF-4B93-407C-A6F9-6DB173D79088 PageTitle: HTML Programming with Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Get the best out of Visual Studio Code for HTML development --- # HTML in Visual Studio Code diff --git a/docs/languages/identifiers.md b/docs/languages/identifiers.md index 7fe7bf06ca..b13255c8c3 100644 --- a/docs/languages/identifiers.md +++ b/docs/languages/identifiers.md @@ -3,7 +3,7 @@ Area: languages TOCTitle: Language Identifiers ContentId: 3f773ade-7e71-4fb9-9bb9-d9e0b20fa799 PageTitle: Visual Studio Code language identifiers -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Visual Studio Code language mode identifiers --- # Language Identifiers diff --git a/docs/languages/javascript.md b/docs/languages/javascript.md index 35fec16dbf..f030524642 100644 --- a/docs/languages/javascript.md +++ b/docs/languages/javascript.md @@ -4,7 +4,7 @@ Area: languages TOCTitle: JavaScript ContentId: F54BB3D4-76FB-4547-A9D0-F725CEBB905C PageTitle: JavaScript Programming with Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Get the best out of Visual Studio Code for JavaScript development --- diff --git a/docs/languages/jsconfig.md b/docs/languages/jsconfig.md index 8a1485dd74..d90d6fc3d9 100644 --- a/docs/languages/jsconfig.md +++ b/docs/languages/jsconfig.md @@ -4,7 +4,7 @@ Area: languages TOCTitle: Appendix - jsconfig.json ContentId: 201cd81d-523c-4f62-b1f5-ed26c091657b PageTitle: jsconfig.json Reference -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: View the reference for jsconfig.json. --- # jsconfig.json diff --git a/docs/languages/json.md b/docs/languages/json.md index e310780248..61758fd963 100644 --- a/docs/languages/json.md +++ b/docs/languages/json.md @@ -4,7 +4,7 @@ Area: languages TOCTitle: JSON ContentId: FB3B14D9-A59A-4968-ACFC-5FB5D4E9B70E PageTitle: JSON editing in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Edit JSON files in Visual Studio Code --- # Editing JSON with Visual Studio Code diff --git a/docs/languages/markdown.md b/docs/languages/markdown.md index 2a62983945..d6de6f01b6 100644 --- a/docs/languages/markdown.md +++ b/docs/languages/markdown.md @@ -4,7 +4,7 @@ Area: languages TOCTitle: Markdown ContentId: 47A8BA5A-A103-4B61-B5FB-185C15E54C52 PageTitle: Markdown editing with Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Get the best out of Visual Studio Code for Markdown --- # Markdown and Visual Studio Code diff --git a/docs/languages/overview.md b/docs/languages/overview.md index ed659f9257..8df32f8c42 100644 --- a/docs/languages/overview.md +++ b/docs/languages/overview.md @@ -4,7 +4,7 @@ Area: languages TOCTitle: Overview ContentId: AC888642-FBE5-43E5-9DC2-47B197717940 PageTitle: Language Support in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: In Visual Studio Code we have support for all common languages including smart code completion and debugging. --- # Programming Languages diff --git a/docs/languages/php.md b/docs/languages/php.md index 131421f7f4..02a169c861 100644 --- a/docs/languages/php.md +++ b/docs/languages/php.md @@ -4,7 +4,7 @@ Area: languages TOCTitle: PHP ContentId: DD4E5A59-1586-4A5D-8047-3D58B2FE6937 PageTitle: PHP Programming with Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Learn about Visual Studio Code editor features (syntax highlighting, snippets, linting) and extensions for PHP. --- # PHP in Visual Studio Code diff --git a/docs/languages/typescript.md b/docs/languages/typescript.md index d3e5b07853..d23eb2914a 100644 --- a/docs/languages/typescript.md +++ b/docs/languages/typescript.md @@ -4,7 +4,7 @@ Area: languages TOCTitle: TypeScript ContentId: 05C114DF-4FDC-4C65-8954-58F5F293FAFD PageTitle: TypeScript Programming with Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Get the best out editing TypeScript with Visual Studio Code. MetaSocialImage: images/typescript/Languages_typescript.png --- diff --git a/docs/nodejs/angular-tutorial.md b/docs/nodejs/angular-tutorial.md index f0c8931807..b0df7fa00a 100644 --- a/docs/nodejs/angular-tutorial.md +++ b/docs/nodejs/angular-tutorial.md @@ -4,7 +4,7 @@ Area: nodejs TOCTitle: Angular Tutorial ContentId: f6b7b0c2-ccbe-4e5f-8f2e-6c1ecea52f69 PageTitle: Angular TypeScript Tutorial in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Angular TypeScript tutorial showing IntelliSense, debugging, and code navigation support in the Visual Studio Code editor. MetaSocialImage: images/angular/Welcome-to-app.png --- diff --git a/docs/nodejs/browser-debugging.md b/docs/nodejs/browser-debugging.md index 54293d05a8..b229e1cfea 100644 --- a/docs/nodejs/browser-debugging.md +++ b/docs/nodejs/browser-debugging.md @@ -4,7 +4,7 @@ Area: nodejs TOCTitle: Browser Debugging ContentId: d0e271da-0372-4ab9-a2ab-b7add855bd5a PageTitle: Debug Browser Apps using Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: The Visual Studio Code editor includes browser debugging support. Set breakpoints, step-in, inspect variables and more. MetaSocialImage: /assets/docs/editor/debugging/Debugging.png --- diff --git a/docs/nodejs/debugging-recipes.md b/docs/nodejs/debugging-recipes.md index af6e7ff2b7..6bbb1524a9 100644 --- a/docs/nodejs/debugging-recipes.md +++ b/docs/nodejs/debugging-recipes.md @@ -4,7 +4,7 @@ Area: nodejs TOCTitle: Debugging Recipes ContentId: 215832f9-d5bd-4cea-8cea-bfc4dc7ff7d1 PageTitle: JavaScript Debugging Recipes for Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Learn more about how to setup debugging in Visual Studio Code with debugging recipes MetaSocialImage: debugging_Debugging.png --- diff --git a/docs/nodejs/emberjs-tutorial.md b/docs/nodejs/emberjs-tutorial.md index 8dd9a63a04..96b98a6a7d 100644 --- a/docs/nodejs/emberjs-tutorial.md +++ b/docs/nodejs/emberjs-tutorial.md @@ -4,7 +4,7 @@ Area: nodejs TOCTitle: Ember Tutorial ContentId: 4a60ed36-93ff-4ff3-b650-ce74baa405ca PageTitle: Ember JavaScript Tutorial in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Ember JavaScript tutorial showing IntelliSense and code navigation support in the Visual Studio Code editor. --- # Using Ember in Visual Studio Code diff --git a/docs/nodejs/extensions.md b/docs/nodejs/extensions.md index 5c8e225fbd..0fc55e0908 100644 --- a/docs/nodejs/extensions.md +++ b/docs/nodejs/extensions.md @@ -1,10 +1,10 @@ --- -Order: 11 +Order: 12 Area: nodejs TOCTitle: Extensions ContentId: 3224f624-a3fc-4eeb-81d1-eb653a90a6fc PageTitle: JavaScript Extensions in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Learn more about installing and integrating JavaScript and Node.js extensions in the Visual Studio Code editor. MetaSocialImage: /assets/images/nodejs_javascript_vscode.png --- diff --git a/docs/nodejs/images/profiling/cpu-profile-nice.png b/docs/nodejs/images/profiling/cpu-profile-nice.png new file mode 100644 index 0000000000..6e720fb953 --- /dev/null +++ b/docs/nodejs/images/profiling/cpu-profile-nice.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:eff62bbd8a21bb81cc8b544fd3d1b3a8a6becf7696cb1d4d73aab30d2c6e9702 +size 121004 diff --git a/docs/nodejs/images/profiling/cpu-profile-noise.png b/docs/nodejs/images/profiling/cpu-profile-noise.png new file mode 100644 index 0000000000..32b408c0d8 --- /dev/null +++ b/docs/nodejs/images/profiling/cpu-profile-noise.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3a9f921dc1046e204da579213bf2e30173ceb4667bef525558d6c5d658192c2c +size 20296 diff --git a/docs/nodejs/images/profiling/heap-profile.png b/docs/nodejs/images/profiling/heap-profile.png new file mode 100644 index 0000000000..1b0aa302a9 --- /dev/null +++ b/docs/nodejs/images/profiling/heap-profile.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9101b8ab2492a14b651934a1cb772876875372654d9a6a14e27b2b004c054f77 +size 226061 diff --git a/docs/nodejs/images/profiling/profile-table.png b/docs/nodejs/images/profiling/profile-table.png new file mode 100644 index 0000000000..101a5ae063 --- /dev/null +++ b/docs/nodejs/images/profiling/profile-table.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5354bd572268b89fb9478c9780ee2f13586e53efd9956aa1d2d24b7093456342 +size 107195 diff --git a/docs/nodejs/images/profiling/take-profile.png b/docs/nodejs/images/profiling/take-profile.png new file mode 100644 index 0000000000..164a4e9e45 --- /dev/null +++ b/docs/nodejs/images/profiling/take-profile.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7d40aad42382bb84ffd28443fcaa808ac063bdc4169d12a5d529fcd077aed21f +size 17327 diff --git a/docs/nodejs/images/profiling/toggle-button.png b/docs/nodejs/images/profiling/toggle-button.png new file mode 100644 index 0000000000..b960503e31 --- /dev/null +++ b/docs/nodejs/images/profiling/toggle-button.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:db1230ba83948bd34da2da4feac134d9c136efc065425e824f9c75ff07449520 +size 7209 diff --git a/docs/nodejs/nodejs-debugging.md b/docs/nodejs/nodejs-debugging.md index b09795e2a5..d8ea8802ab 100644 --- a/docs/nodejs/nodejs-debugging.md +++ b/docs/nodejs/nodejs-debugging.md @@ -4,7 +4,7 @@ Area: nodejs TOCTitle: Node.js Debugging ContentId: 3AC4DBB5-1469-47FD-9CC2-6C94684D4A9D PageTitle: Debug Node.js Apps using Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: The Visual Studio Code editor includes Node.js debugging support. Set breakpoints, step-in, inspect variables and more. MetaSocialImage: /assets/docs/editor/debugging/Debugging.png --- diff --git a/docs/nodejs/nodejs-deployment.md b/docs/nodejs/nodejs-deployment.md index a09435c0cf..a57b720772 100644 --- a/docs/nodejs/nodejs-deployment.md +++ b/docs/nodejs/nodejs-deployment.md @@ -5,7 +5,7 @@ TOCTitle: Deploy Node.js Apps PageTitle: Node.js Deployment with Visual Studio Code ContentId: 856a4a73-a4b4-4418-b88d-1f65d0ba7824 MetaDescription: Node.js Deployment to Azure with Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 --- # Deploy Node.js Web Apps diff --git a/docs/nodejs/nodejs-tutorial.md b/docs/nodejs/nodejs-tutorial.md index 6f0d75db49..fa05a1949c 100644 --- a/docs/nodejs/nodejs-tutorial.md +++ b/docs/nodejs/nodejs-tutorial.md @@ -4,7 +4,7 @@ Area: nodejs TOCTitle: Node.js Tutorial ContentId: ED394CD2-D09E-4E3A-96AD-6D3D8337BA9D PageTitle: Build Node.js Apps with Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: The Visual Studio Code editor has great support for writing and debugging Node.js applications. This tutorial takes you from Hello World to a full Express web application. MetaSocialImage: images/nodejs/runtimes_node.png --- diff --git a/docs/nodejs/profiling.md b/docs/nodejs/profiling.md new file mode 100644 index 0000000000..b06d266e9a --- /dev/null +++ b/docs/nodejs/profiling.md @@ -0,0 +1,113 @@ +--- +Order: 11 +Area: nodejs +TOCTitle: Performance Profiling +ContentId: 3DAE803B-D479-4143-976F-B69F00A73891 +PageTitle: Performance Profiling JavaScript in Visual Studio Code +DateApproved: 12/7/2022 +MetaDescription: Learn more about profiling your JavaScript performance in the Visual Studio Code editor. +MetaSocialImage: /assets/images/nodejs_javascript_vscode.png +--- +# Performance Profiling JavaScript + +Visual Studio Code supports collecting and viewing performance profiles for JavaScript programs. To get started, you'll first need to have the debugger configured for your [Node.js program](/docs/nodejs/nodejs-debugging.md) or [browser app](/docs/nodejs/browser-debugging.md). + +## Types of profiles + +Depending on what you want to optimize, there are different kinds of profiles you may want to take. + +* **CPU Profile** - A CPU profile tells you where your program is spending its time while in JavaScript. Remember that, while you can wait on asynchronous promises or callbacks, only one JavaScript expression is executed at a time. The CPU profile collects about 10,000 samples per second to tell you which expression--if any--is being run at that moment. +* **Heap Profile** - A heap profile tells you how memory is allocated over time in your program. Allocating memory can be costly, and reducing the amount of memory your code allocates can lead to performance wins. +* **Heap Snapshot** - A heap snapshot is an instantaneous view of where your program has allocated memory. If you notice your program is using a lot of RAM and want to find out where it's coming from, a heap snapshot can be useful. Note that collecting a heap snapshot can take several minutes for more complex programs, and viewing heap snapshots is not currently supported in the built-in editor. + +## Collecting a profile + +To collect a profile, you'll need to be debugging your program. Once you are, you can collect a profile through a few methods: + +* Using the 'record' button in the **Call Stack** view. This allows you to take CPU profiles, heap profiles, and heap snapshots. +* By calling `console.profile()` in your program. This will collect a CPU profile. + +### Using the record button + +Once you're debugging, switch to the Run and Debug view (`kb(workbench.view.debug)`), and find the **Call Stack** view. Hover over the session you want to debug, and select the **Take Performance Profile** button. You can also run this command from the Command Palette (`kb(workbench.action.showCommands)`). + +![Screenshot showing the button](images/profiling/take-profile.png) + +VS Code will then ask what [type of performance](#types-of-profiles) profile you'd like to take; pick the one that's relevant for you. + +Finally, VS Code will ask when you want to stop taking a profile. You can choose to either: + +* Take the profile until you stop it manually. +* Take the profile for a set duration. +* Take the profile until you hit a certain breakpoint. + +If you chose the first option, you can stop the profile by clicking the big red "record" icon shown in the debug toolbar. After the profile is collected, the [profile viewer](#analyzing-a-profile) will open automatically. + +### Using console.profile + +You can manually instrument your code using calls to `console.profile` to start a profile, and `console.profileEnd` to stop a profile. A CPU profile will be collected between these two call sites. + +```js +console.profile(); +doSomeVeryExpensiveWork(); +console.profileEnd(); +``` + +The resulting `.cpuprofile` will be saved in your workspace folder automatically. You can select that file to open it in the built-in [profile viewer](#analyzing-a-profile). + +## Analyzing a profile + +### Table view + +VS Code has an integrated visualizer that supports viewing JavaScript `.cpuprofile` and `.heapprofile` files. When you open one of these files, you will first be presented with a table view that looks something like this: + +![Screenshot showing the profile table](images/profiling/profile-table.png) + +This is a **bottom-up** view of your program. Each row represents a function in your program, and by default they're ordered by how much time is spent in that specific function. This is also known as the "Self Time". The "Total Time" of a function is the sum of the time spent in that function and all functions that it calls. You can expand each table row to see where that function was called from. + +For example, take the following code: + +```js +function a() { + doSomethingFor5Seconds(); + b(); +} + +function b() { + doSomethingFor3Seconds(); +} + +a(); +``` + +In this case, the Self Time for `a` would be 5 seconds and the Total Time for `a` is 8 seconds. Both the Self Time and Total Time for `b` is 3 seconds. Heap profiles operate the same way, but use Self Size and Total Size to indicate the amount of memory that was allocated in each function, or its callees. + +### Flame view + +The table view is nice for certain cases, but often you may want to see a more visual representation of the profile. You can do this by clicking the flame πŸ”₯ icon in the top right-hand side of the table view. If you have not already, you'll be prompted to install an additional extension that provides the flame view editor. + +![Heap profile flame chart](images/profiling/heap-profile.png) + +This might look confusing initially, but fear not, we'll make sense of it! + +For CPU profiles, the horizontal axis is the timeline of the profile, allowing you to see what your program was doing at each moment in time. For heap profiles, the horizontal axis is the total memory allocated by the program. + +Each bar, or 'flame', in the graph, is a call stack. The outermost, top-level function call (or, the 'bottom' of the call stack) is show at the top of the editor, and the functions that it calls are shown below. The width of the bar is determined by its Total Time or Total Memory. + +You can click on an entry in the flame graph to view more information about it, and you can zoom in and out using the mouse wheel. You may also drag anywhere on the chart to navigate if you've zoomed in. + +### Left-heavy view + +If you're working with a CPU profile, there's a good chance the flame graph you're looking at is not as understandable as the one above. You might have lots of individual call stacks that look like this: + +![A noisy CPU profile](images/profiling/cpu-profile-noise.png) + +For easier analysis, VS Code profiles a "left-heavy" view that groups all similar call stacks together. + +![Toggle button](images/profiling/toggle-button.png) + +This switches from a chronological view of the profile to something more similar to the Heap Profile. The horizontal axis is still the total profile duration, but each bar represents the Total Time of that function call across **all** times it was called from that stack. + +![A nicer CPU profile](images/profiling/cpu-profile-nice.png) + +This view is much more useful for certain applications, such as servers, where individual calls may be relatively fast, but you want to find out what were the overall most costly functions across many invocations. diff --git a/docs/nodejs/reactjs-tutorial.md b/docs/nodejs/reactjs-tutorial.md index 8571e5850a..e5b7769b89 100644 --- a/docs/nodejs/reactjs-tutorial.md +++ b/docs/nodejs/reactjs-tutorial.md @@ -4,7 +4,7 @@ Area: nodejs TOCTitle: React Tutorial ContentId: 2dd2eeff-2eb3-4a0c-a59d-ea9a0b10c468 PageTitle: React JavaScript Tutorial in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: React JavaScript tutorial showing IntelliSense, debugging, and code navigation support in the Visual Studio Code editor. MetaSocialImage: /assets/images/nodejs_javascript_vscode.png --- diff --git a/docs/nodejs/vuejs-tutorial.md b/docs/nodejs/vuejs-tutorial.md index bfeabc278b..d18fd152fb 100644 --- a/docs/nodejs/vuejs-tutorial.md +++ b/docs/nodejs/vuejs-tutorial.md @@ -4,7 +4,7 @@ Area: nodejs TOCTitle: Vue Tutorial ContentId: 85ce0bcc-d2b8-4b7c-b744-5eddce9a8d00 PageTitle: Vue JavaScript Tutorial in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Vue JavaScript tutorial showing IntelliSense, debugging, and code navigation support in the Visual Studio Code editor. --- # Using Vue in Visual Studio Code diff --git a/docs/nodejs/working-with-javascript.md b/docs/nodejs/working-with-javascript.md index c96a2b95ac..803221c7bb 100644 --- a/docs/nodejs/working-with-javascript.md +++ b/docs/nodejs/working-with-javascript.md @@ -4,7 +4,7 @@ Area: nodejs TOCTitle: Working with JavaScript PageTitle: Working with JavaScript in Visual Studio Code ContentId: 3e5af2a6-7669-4b5d-b19f-78077af14fda -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Working with JavaScript in Visual Studio Code --- # Working with JavaScript diff --git a/docs/python/data-science.md b/docs/python/data-science.md index fe2b5674eb..ba87e84353 100644 --- a/docs/python/data-science.md +++ b/docs/python/data-science.md @@ -4,7 +4,7 @@ Area: python TOCTitle: Data Science ContentId: 61af0524-2702-486e-a859-d1e993ddbf8f PageTitle: Data Science in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Data Science in Visual Studio Code --- diff --git a/docs/python/python-web.md b/docs/python/python-web.md index f689fadf99..f55bbd07a3 100644 --- a/docs/python/python-web.md +++ b/docs/python/python-web.md @@ -1,10 +1,10 @@ --- -Order: +Order: 13 Area: python TOCTitle: Python in the Web ContentId: 366e4bbf-fa87-4813-9dfc-6c831b20a4d2 PageTitle: Run and Debug Python in the Web -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Run and Debug Python code in the Web. --- # Run and Debug Python in the Web @@ -18,8 +18,9 @@ The following prerequisites are needed to use the extension: * You need to have the [GitHub Repositories](https://marketplace.visualstudio.com/items?itemName=GitHub.remotehub) extension installed. * You need to authenticate with GitHub. * You need to use a browser that supports [cross-origin isolation](https://developer.chrome.com/docs/extensions/mv3/cross-origin-isolation/). The extension has been tested with the Microsoft Edge and Google Chrome browsers. +* You need to use the insider version of [VS Code for the Web](/docs/editor/vscode-web.md) (e.g. `https://insiders.vscode.dev/`) * Your source code must either be hosted on a GitHub repository and accessed through the GitHub Repositories extension, or on your local file system. -* When starting [VS Code for the Web](/docs/editor/vscode-web.md) via either `https://vscode.dev/` or `https://insiders.vscode.dev/`, you need to add the following query parameter to the URL: `?vscode-coi=`. +* When starting [VS Code for the Web](/docs/editor/vscode-web.md), you need to add the following query parameter to the URL: `?vscode-coi=`. ## Run Hello World diff --git a/docs/python/tutorial-create-containers.md b/docs/python/tutorial-create-containers.md index 1b35fcbe64..1f15bd66ca 100644 --- a/docs/python/tutorial-create-containers.md +++ b/docs/python/tutorial-create-containers.md @@ -4,7 +4,7 @@ Area: python TOCTitle: Create containers ContentId: 4e45a3f6-b72d-4647-82a5-22f7ee593d47 PageTitle: Create Docker containers for Python web apps in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: How to create Docker containers for Python web apps using the VS Code Docker extension MetaSocialImage: images/tutorial/social.png --- diff --git a/docs/remote/codespaces.md b/docs/remote/codespaces.md index 46c71e9e7c..727f3131c6 100644 --- a/docs/remote/codespaces.md +++ b/docs/remote/codespaces.md @@ -5,7 +5,7 @@ TOCTitle: GitHub Codespaces PageTitle: Developing with GitHub Codespaces ContentId: 8d30ed21-208f-4b4e-8510-5a4a33c42618 MetaDescription: Using GitHub Codespaces -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 --- # GitHub Codespaces diff --git a/docs/remote/dev-containers.md b/docs/remote/dev-containers.md index 2d59af10ad..7e1dd3eb3b 100644 --- a/docs/remote/dev-containers.md +++ b/docs/remote/dev-containers.md @@ -5,7 +5,7 @@ TOCTitle: Dev Containers PageTitle: Developing inside a Container using Visual Studio Code Remote Development ContentId: 4f0942be-6808-4252-8940-b9e9688792af MetaDescription: Developing inside a Container using Visual Studio Code Remote Development -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 --- # Dev Containers diff --git a/docs/remote/faq.md b/docs/remote/faq.md index b2b059e356..4bae964ba8 100644 --- a/docs/remote/faq.md +++ b/docs/remote/faq.md @@ -1,11 +1,11 @@ --- -Order: 16 +Order: 17 Area: remote TOCTitle: FAQ PageTitle: Visual Studio Code Remote Development Frequently Asked Questions ContentId: 66bc3337-5fe1-4dac-bde1-a9302ff4c0cb MetaDescription: Visual Studio Code Remote Development Frequently Asked Questions (FAQ) for SSH, Containers, and WSL -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 --- # Remote Development FAQ diff --git a/docs/remote/images/tunnels/tunnel-access.png b/docs/remote/images/tunnels/tunnel-access.png new file mode 100644 index 0000000000..ee2b4d1a2d --- /dev/null +++ b/docs/remote/images/tunnels/tunnel-access.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:deec6b80f1e82024f0cd772ab046f3145b36e72a58428955cdc298ad9036b25f +size 51512 diff --git a/docs/remote/images/tunnels/tunneling-download.png b/docs/remote/images/tunnels/tunneling-download.png new file mode 100644 index 0000000000..e47c6cfcd4 --- /dev/null +++ b/docs/remote/images/tunnels/tunneling-download.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f8cb6ef7472e0e57568720320ecf9b38d3873384f44e6f8bb0ec2e13d84ae907 +size 27921 diff --git a/docs/remote/images/tunnels/tunneling-enabled.png b/docs/remote/images/tunnels/tunneling-enabled.png new file mode 100644 index 0000000000..20b3ac89bc --- /dev/null +++ b/docs/remote/images/tunnels/tunneling-enabled.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:04457e3dff2f645947179c060a7c5d30d6f3fe83980b92dda82f42a8c52bbaab +size 42923 diff --git a/docs/remote/images/tunnels/tunneling-remote-explorer.png b/docs/remote/images/tunnels/tunneling-remote-explorer.png new file mode 100644 index 0000000000..9dbab69f61 --- /dev/null +++ b/docs/remote/images/tunnels/tunneling-remote-explorer.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:902d32bb38942e4063cd543c723de1f42a231193afa1bc68b4c47123c8838502 +size 49067 diff --git a/docs/remote/images/vscode-server/server-arch-latest.png b/docs/remote/images/vscode-server/server-arch-latest.png new file mode 100644 index 0000000000..ff22399a3d --- /dev/null +++ b/docs/remote/images/vscode-server/server-arch-latest.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:64ea871e008203cd55c9b57923842554bc39b53214e01ba2c8da484cb1f4af4b +size 29479 diff --git a/docs/remote/images/vscode-server/server-arch.png b/docs/remote/images/vscode-server/server-arch.png deleted file mode 100644 index 86579c5ab3..0000000000 --- a/docs/remote/images/vscode-server/server-arch.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:be55a6fc6bb49cf9df4ed0b6189a93cfc3a6d5e9f281281bf16cb18da37c619c -size 22152 diff --git a/docs/remote/images/vscode-server/server-help.png b/docs/remote/images/vscode-server/server-help.png deleted file mode 100644 index b5ff89cad0..0000000000 --- a/docs/remote/images/vscode-server/server-help.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:2116c037792a81000d75b5c65b0196649c72279540bcb44c693c8b32934277c4 -size 354458 diff --git a/docs/remote/images/vscode-server/tunnel-help.png b/docs/remote/images/vscode-server/tunnel-help.png new file mode 100644 index 0000000000..185b719e07 --- /dev/null +++ b/docs/remote/images/vscode-server/tunnel-help.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5568b0be5f49e93337eadd19b958d15d882ae204520279f8ce81f4a4a92c0b69 +size 122593 diff --git a/docs/remote/linux.md b/docs/remote/linux.md index 58c19cf924..93ed6498d5 100644 --- a/docs/remote/linux.md +++ b/docs/remote/linux.md @@ -5,7 +5,7 @@ TOCTitle: Linux Prerequisites PageTitle: Linux Prerequisites for Visual Studio Code Remote Development ContentId: 7ec8dedf-0659-437e-98f1-2d27f5e243eb MetaDescription: Linux Prerequisites for VS Code Remote - SSH, Dev Containers, and WSL extensions -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 --- # Remote Development with Linux diff --git a/docs/remote/remote-overview.md b/docs/remote/remote-overview.md index ff5b41f07a..ad1e6be0ce 100644 --- a/docs/remote/remote-overview.md +++ b/docs/remote/remote-overview.md @@ -5,7 +5,7 @@ TOCTitle: Overview PageTitle: Visual Studio Code Remote Development ContentId: eceea3f0-feee-47c2-8b65-1f1b0825355b MetaDescription: Visual Studio Code Remote Development -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 --- # VS Code Remote Development diff --git a/docs/remote/ssh-tutorial.md b/docs/remote/ssh-tutorial.md index 4888eadea3..df51ba69e7 100644 --- a/docs/remote/ssh-tutorial.md +++ b/docs/remote/ssh-tutorial.md @@ -1,11 +1,11 @@ --- -Order: 7 +Order: 8 Area: remote TOCTitle: SSH Tutorial PageTitle: Connect over SSH with Visual Studio Code ContentId: beb86509-a36f-4e3b-a32e-b3d8c3966dd7 MetaDescription: Connect over SSH with Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 --- # Remote development over SSH diff --git a/docs/remote/ssh.md b/docs/remote/ssh.md index 84e4403fad..76f7ce28c1 100644 --- a/docs/remote/ssh.md +++ b/docs/remote/ssh.md @@ -5,7 +5,7 @@ TOCTitle: SSH PageTitle: Developing on Remote Machines using SSH and Visual Studio Code ContentId: 42e65445-fb3b-4561-8730-bbd19769a160 MetaDescription: Developing on Remote Machines or VMs using Visual Studio Code Remote Development and SSH -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 --- # Remote Development using SSH diff --git a/docs/remote/troubleshooting.md b/docs/remote/troubleshooting.md index 3e0dcce9b2..cadb95d103 100644 --- a/docs/remote/troubleshooting.md +++ b/docs/remote/troubleshooting.md @@ -1,11 +1,11 @@ --- -Order: 15 +Order: 16 Area: remote TOCTitle: Tips and Tricks PageTitle: Visual Studio Code Remote Development Troubleshooting Tips and Tricks ContentId: 42e65445-fb3b-4561-8730-bbd19769a160 MetaDescription: Visual Studio Code Remote Development troubleshooting tips and tricks for SSH, Containers, and the Windows Subsystem for Linux (WSL) -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 --- # Remote Development Tips and Tricks diff --git a/docs/remote/tunnels.md b/docs/remote/tunnels.md new file mode 100644 index 0000000000..1f9bf7c4fe --- /dev/null +++ b/docs/remote/tunnels.md @@ -0,0 +1,116 @@ +--- +Order: 7 +Area: remote +TOCTitle: Tunnels +PageTitle: Remote Tunnels +ContentId: 5d33c1af-b4e6-4894-aae1-acf95ee3ffa8 +MetaDescription: Using the Visual Studio Code Remote Tunnels extension +DateApproved: 12/7/2022 +--- +# Developing with Remote Tunnels + +The Visual Studio Code [Remote - Tunnels](https://marketplace.visualstudio.com/items?itemName=ms-vscode.remote-server) extension lets you connect to a remote machine, like a desktop PC or virtual machine (VM), via a secure tunnel. You can connect to that machine from a VS Code client anywhere, without the requirement of SSH. + +Tunneling, also known as port forwarding, securely transmits data from one network to another. + +This can eliminate the need for source code to be on your VS Code client machine since the extension runs commands and other extensions directly on the remote machine. + +![Architecture](images/vscode-server/server-arch-latest.png) + +VS Code can provide a **local-quality development experience** - including full IntelliSense (completions), code navigation, and debugging - **regardless of where your code is hosted**. + +## Getting Started + +You have two paths to work with tunnels: + +* Run the `tunnel` command of the `code` [command-line interface (CLI}](/docs/editor/command-line.md#create-remote-tunnel). +* Enable tunneling through the VS Code Desktop UI. + +Both of these paths result in the same tunneling functionality – you can use whichever tooling works best for you. The CLI is a great option if you can't install the full VS Code Desktop on your remote machine. Using the VS Code Desktop UI is convenient if you're already doing some work in VS Code and would then like to enable tunneling for your current machine. + +We'll describe both paths in the sections below. + +## Using the 'code' CLI + +You may create and use tunnels through the `code` [CLI](/docs/editor/command-line.md). + +1. Install the `code` CLI on a remote machine you'd like to develop against from a VS Code client. The CLI establishes a tunnel between a VS Code client and your remote machine. + + The CLI is automatically built into VS Code Desktop – no additional setup required. + + Alternatively, you can grab the CLI through a [standalone install](https://code.visualstudio.com/#alt-downloads) on our download page, which is separate from a VS Code Desktop installation: + + ![VS Code download options with CLI highlighted](images/tunnels/tunneling-download.png) + + > **Note:** If you're using the standalone install, the commands in the following section will start with `./code` rather than `code`. + +2. Create a secure tunnel with the `tunnel` command: + + ```bash + code tunnel + ``` + + This command downloads and starts the VS Code Server on this machine and then creates a tunnel to it. + + >**Note:** You will be prompted to accept the server license terms when you first start a tunnel on a machine. You can also pass `--accept-server-license-terms` on the command line to avoid the prompt. + +3. This CLI will output a vscode.dev URL tied to this remote machine, such as `https://vscode.dev/tunnel//`. You can open this URL on a client of your choosing. + +4. When opening a vscode.dev URL for the first time on this client, you'll be prompted to log into your GitHub account at a `https://github.com/login/oauth/authorize...` URL. This authenticates you to the tunneling service to ensure you have access to the right set of remote machines. + +## Using the VS Code UI + +1. Open VS Code on the remote machine where you'd like to turn on tunnel access. + +2. In the VS Code Account menu, select the option to **Turn on Remote Tunnel Access**, as demonstrated in the image below. You may also open the Command Palette (`kbstyle(F1)`) in VS Code and run the command **Remote Tunnels: Turn on Remote Tunnel Access...**. + + ![Turn on Remote Tunnel Access via the VS Code Account menu](images/tunnels/tunnel-access.png) + +3. You'll be prompted to log into GitHub. Once you're logged in, a tunnel will start up on your current machine, and you'll be able to connect to this machine remotely. + + ![Prompt that remote tunnel access is enabled](images/tunnels/tunneling-enabled.png) + +4. In a client of your choice, you may open the vscode.dev link from the notification above and start coding! + +## Remote - Tunnels extension + +The vscode.dev instances you open through the `code` CLI or VS Code UI come with the Remote - Tunnels extension preinstalled. + +If you're already working in VS Code (desktop or web) and would like to connect to a remote tunnel, you can install and use the [Remote - Tunnels]((https://marketplace.visualstudio.com/items?itemName=ms-vscode.remote-server)) extension directly. Once you install the extension, open the Command Palette (`kbstyle(F1)`) and run the command **Remote Tunnels: Connect to Tunnel**. You'll be able to connect to any remote machines with an active tunnel. + +You can also view your remote machines in the Remote Explorer, which you may focus on through the command **Remote Explorer: Focus on Remote View**: + +![Remote Explorer view with Tunnels](images/tunnels/tunneling-remote-explorer.png) + +Like the other Remote Development extensions, the name of your remote machine will be listed in the lower left green remote indicator. Clicking on this indicator is another way to explore Remote Tunnels commands, along with options to close your remote connection or install VS Code Desktop. + +![VS Code remote indicator connected to a remote tunnel](images/vscode-server/remote-indicator-server.png) + +## Common questions + +### What is the relationship between the Remote Tunnels, VS Code Server, and Remote Development? + +Visual Studio Code [Remote Development](/docs/remote/remote-overview.md) allows you to use a container, remote machine, or the Windows Subsystem for Linux (WSL) as a full-featured development environment. + +Remote Development lets your local VS Code installation transparently interact with source code and runtime environments on other machines (whether virtual or physical) by moving the execution of certain commands to a "remote server", the VS Code Server. The VS Code Server is quickly installed by VS Code when you connect to a remote endpoint and can host extensions that interact directly with the remote workspace, machine, and file system. + +We've released this VS Code Server backend component as a service you can run yourself (which you may read more about in [its documentation](/docs/remote/vscode-server.md)), rather than it only being solely installed and managed by the Remote Development extensions. + +Accessing the VS Code Server involves a few components: + +* The VS Code Server: Backend server that makes VS Code remote experiences possible. +* Remote - Tunnels extension: Extension that facilitates the connection to the remote machine, where you have an instance of the server running. + +### As an extension author, what do I need to do? + +The VS Code extension API abstracts away local/remote details so most extensions will work without modification. However, given extensions can use any node module or runtime they want, there are situations where adjustments may need to be made. We recommend you test your extension to be sure that no updates are required. See [Supporting Remote Development](/api/advanced-topics/remote-extensions.md) for details. + +### Can multiple users or clients access the same remote instance simultaneously? + +No, an instance of the server is designed to be accessed by one user or client at a time. + +### How do I remove a tunnel or machine? + +If you'd like to stop a tunnel you're running via the CLI, you may use `kbstyle(Ctrl + C)` to end the active tunnel. If you've enabled tunneling through the VS Code UI, you can run the command **Remote Tunnels: Turn of Remote Tunnel Access...** in VS Code. + +You can remove a machine's association with tunneling by running `code tunnel unregister` on that machine. You can also open any VS Code client, select the Remote Explorer view, right-click on the machine you'd like to remove, and select **unregister**. diff --git a/docs/remote/vscode-server.md b/docs/remote/vscode-server.md index beefb9a531..09bf08517e 100644 --- a/docs/remote/vscode-server.md +++ b/docs/remote/vscode-server.md @@ -5,36 +5,34 @@ TOCTitle: VS Code Server PageTitle: Visual Studio Code Server ContentId: d750ab6d-82c2-4e64-8fbb-7888e1374381 MetaDescription: Using Visual Studio Code Server -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 --- # Visual Studio Code Server -The Visual Studio Code Server is a service you can run on a remote development machine, like your desktop PC or a virtual machine (VM). It allows you to securely connect to that remote machine from anywhere through a vscode.dev URL, without the requirement of SSH. +The Visual Studio Code Server is a service you can run on a remote development machine, like your desktop PC or a virtual machine (VM). It allows you to securely connect to that remote machine from anywhere through a local VS Code client, without the requirement of SSH. ## What is the VS Code Server? In VS Code, we want users to seamlessly leverage the environments that make them the most productive. The [VS Code Remote Development extensions](/docs/remote/remote-overview.md) allow you to work in the Windows Subsystem for Linux (WSL), remote machines via SSH, and dev containers directly from VS Code. These extensions install a server on the remote environment, allowing local VS Code to smoothly interact with remote source code and runtimes. -We are now providing a standalone "VS Code Server," which is a service built off the same underlying server used by the remote extensions, plus some additional functionality, like an interactive CLI and facilitating secure connections to vscode.dev. +We now provide a standalone "VS Code Server," which is a service built off the same underlying server used by the remote extensions, plus some additional functionality, like an interactive CLI and facilitating secure connections to vscode.dev. ![vscode.dev connected to the VS Code Server](images/vscode-server/server-connected.png) -### A preview of a larger journey - -The VS Code Server is currently a private preview. In this early preview, the `code-server` CLI is distinct from the `code` CLI [you use today](/docs/editor/command-line.md#launching-from-command-line) to launch the desktop VS Code, to install extensions, and more (run `code -h` from the terminal to review the possible commands). +## Architecture -This is just the first step along the path towards a fully unified `code` CLI that lets you manage both the desktop and the server. +We want to provide a unified VS Code experience no matter how you use the editor, whether it's local or remote, in the desktop or in the browser. -## Architecture +Access to the VS Code Server is built in to the existing [`code` CLI](/docs/editor/command-line.md#launching-from-command-line). -The VS Code Server's CLI establishes a tunnel between a VS Code client (vscode.dev) and your remote machine. Tunneling, also known as port forwarding, securely transmits data from one network to another. +The CLI establishes a tunnel between a VS Code client and your remote machine. Tunneling, also known as port forwarding, securely transmits data from one network to another. -![The VS Code Server architecture](images/vscode-server/server-arch.png) +![The VS Code Server architecture](images/vscode-server/server-arch-latest.png) The VS Code Server experience includes a few components: -* The VS Code Server: Backend server that makes VS Code remote experiences possible, plus a CLI that makes it easy to install, update, manage, and connect to the server. -* Remote Tunnels extension: Automatically loaded in your local VS Code client, it facilitates the connection to the remote machine. +* The VS Code Server: Backend server that makes VS Code remote experiences possible. +* [Remote - Tunnels extension](/docs/remote/tunnels.md): Automatically loaded in your local VS Code client, it facilitates the connection to the remote machine. ## Scenarios @@ -44,125 +42,46 @@ The VS Code Server allows you to use VS Code in new ways, such as: * Developing on a machine that doesn't support the installation of VS Code desktop, such as an iPad / tablet or Chromebook. * Experiencing the client-side security benefit that all code can be executed in the browser sandbox. -Continue reading to learn how to get started with the VS Code Server. - -## Quick Start - -Here are step-by-step instructions to quickly get up and running: - -1. Install the VS Code Server on your remote machine. You can install and host it in a machine on-premises or in the cloud, as long as it meets the necessary [system requirements](/docs/remote/linux.md). - - There are different install commands for different architectures: - - **Linux or macOS:** - - ```bash - wget -O- https://aka.ms/install-vscode-server/setup.sh | sh - ``` - - **Windows (x64):** - - Run the following commands in a non-elevated PowerShell. You may need to restart your terminal for the PATH changes to apply. - - ```powershell - New-Item "$HOME\.vscode-server-launcher\bin" -ItemType "directory" -Force - Invoke-WebRequest "https://aka.ms/vscode-server-launcher/x86_64-pc-windows-msvc" -OutFile "$HOME\.vscode-server-launcher\bin\code-server.exe" - [Environment]::SetEnvironmentVariable("Path", [Environment]::GetEnvironmentVariable("Path", "User") + ";$HOME\.vscode-server-launcher\bin", "User") - ``` - - **Windows (Arm):** - - Run the following commands in a non-elevated PowerShell. You may need to restart your terminal for the PATH changes to apply. - - ```powershell - New-Item "$HOME\.vscode-server-launcher\bin" -ItemType "directory" -Force - Invoke-WebRequest "https://aka.ms/vscode-server-launcher/aarch64-pc-windows-msvc" -OutFile "$HOME\.vscode-server-launcher\bin\code-server.exe" - [Environment]::SetEnvironmentVariable("Path", [Environment]::GetEnvironmentVariable("Path", "User") + ";$HOME\.vscode-server-launcher\bin", "User") - ``` - -2. Start the VS Code Server by running the following in a remote terminal: - - ```bash - code-server - ``` - -3. Your remote machine will communicate with vscode.dev through a secure tunnel, which allows you to connect to your computer from vscode.dev, no matter what network you're on. - - You'll be provided a device code and URL to authenticate your GitHub account into the VS Code Server's secure tunneling service. - - ```bash - Please enter the code 7644-1186 on https://github.com/login/device - ``` - - Authenticate into the tunneling service by entering the device code at the provided auth URL. - -4. If this is your first time launching the VS Code Server on this remote machine, you'll be prompted to enter a machine name. The CLI will suggest a fun default "adjective-noun" name (examples shown below), which you can choose to accept too. - - ```bash - ? What would you like to call this machine? (elegant-pitta) > - ``` - -5. After authenticating and providing a machine name, the CLI spins up a server instance and generates a vscode.dev URL. To connect to your remote machine, you can open this URL on any device. - - > **Note:** You can also connect to your remote machine directly from vscode.dev: Open the Command Palette (`F1`) in vscode.dev and run the command **Remote Tunnels: Connect to Remote**. +## Getting Started -Congratulations, you've successfully installed and run the VS Code Server! The connection is fully established once you visit the generated vscode.dev link. Your remote machine's files should be present in the VS Code Explorer, and you can start coding against it from vscode.dev. +You can choose from two paths to enable tunneling, which are described in greater details in their respective docs content: +* [Run the `tunnel` command in the `code` CLI](./tunnels.md/#code-cli) +* [Enable tunneling through the VS Code UI](./tunnels.md/#vs-code-ui) ## Things to try ### Licensing and other commands -Upon first run of the VS Code Server, you'll be prompted to accept the terms of the license. You can view the license for the VS Code Server [here](https://aka.ms/vscode-server-license). +Upon first run of the VS Code Server, you'll be prompted with the terms of the license. You can view the license for the VS Code Server [here](https://aka.ms/vscode-server-license). ```bash -Do you accept the terms in the License Agreement (Y/n)? +* Visual Studio Code Server +* +* By using the software, you agree to +* the Visual Studio Code Server License Terms (https://aka.ms/vscode-server-license) and +* the Microsoft Privacy Statement (https://privacy.microsoft.com/en-US/privacystatement). ``` -You can explore the CLI's other commands by running `code-server -h`. One of the many things you can do is automatically accept the license, by launching with `--accept-server-license-terms`. +You can explore the CLI's other commands by running `code -h`, and specifically the tunneling commands by running `code tunnel -help`: -![The VS Code Server help commands](images/vscode-server/server-help.png) +![Output of tunnel help CLI command](images/vscode-server/tunnel-help.png) ### Extension commands -As with the VS Code Server's CLI, the Remote Tunnels extension in VS Code has additional commands you can explore by opening the Command Palette (`F1`) in VS Code and typing **Remote Tunnels**. Like the other Remote Development Extensions, the name of your remote machine will be listed in the lower left green remote indicator. Clicking on this indicator is another way to explore server commands, along with options to close your remote connection or install desktop VS Code. - -![VS Code remote indicator connected to a remote tunnel](images/vscode-server/remote-indicator-server.png) - -**Remote Tunnels: Connect to Remote...** allows you to connect to existing remote machines right from your local VS Code instance, rather than grabbing the vscode.dev link in the remote terminal. You can connect to a remote machine as long as the server is still running on it. - -![VS Code Command Palette with remote tunnels listed](images/vscode-server/remote-servers.png) - -You can also view your existing remote machines in the Remote Explorer view (which you can display with the command **View: Show Remote Explorer**). +As with the CLI, the VS Code Remote Tunnels extension has additional commands you can explore by opening the Command Palette (`F1`) in VS Code and typing **Remote Tunnels**. You may learn more in the [Remote Tunnels documentation](./tunnels.md). ## Telemetry -If you want to disable telemetry, you can pass in `--disable-telemetry` when launching the VS Code Server, `code-server serve --disable-telemetry`. Alternatively, if you would like to specify an initial telemetry level, such as only collecting errors, you can pass in `--telemetry-level` followed by the level (for example, `error`). +If you want to disable telemetry, you can pass in `--disable-telemetry` when launching the VS Code Server: `code tunnels --disable-telemetry`. Alternatively, if you would like to specify an initial telemetry level, such as only collecting errors, you can pass in `--telemetry-level` followed by the level (for example, `error`). -If telemetry is not disabled via the CLI, the VS Code Server will begin respecting the client telemetry settings (your telemetry setting in vscode.dev) upon successful connection. +If telemetry is not disabled via the CLI, the VS Code Server will begin respecting the client telemetry settings (your telemetry setting in vscode.dev or desktop) upon successful connection. ## Common Questions -### How can I get access to the VS Code Server? - -The VS Code Server is a private preview, so you'll need to request access through its [signup form](https://aka.ms/vscode-server-signup). It may take a few weeks to get access, and you'll receive an email once you have access and can start using it. - ### Is the VS Code Server designed for multiple users to access the same remote instance? No, an instance of the server is designed to be accessed by a single user. -### Can I host VS Code / the VS Code Server myself? - -In the quick start, we ran the VS Code Server with `code-server`, which generated a vscode.dev link connected to your remote machine. The connection was facilitated by the VS Code Server's secure tunneling service. You can achieve the same experience by running `code-server serve`. - -If your scenario has other requirements, such as needing to use a custom domain (not vscode.dev), or a security policy that blocks the tunneling service, you can use a different command to run the VS Code Server: `code-server serve-local`. - -This will allow you to host VS Code's web bits yourself. It will install the VS Code web UI on your remote machine and generate a localhost URL. - -We highly recommend using `serve` mode for most scenarios as it automatically addresses challenges that may be present with `serve-local`. For instance, there are as security considerations with `serve-local` like: - -* Don't use HTTP remotely: always use HTTPS. -* You may need to configure TLS / SSL on your remote machine. - ### Can I host the VS Code Server as a service? No, hosting it as a service is not allowed, as specified in the [VS Code Server license](https://aka.ms/vscode-server-license). @@ -186,39 +105,20 @@ Pure UI extensions are not supported when using a web-based instance of VS Code, While working in the browser, there are certain limitations and configuration steps to consider. You can read more about this in the [VS Code for the Web](/docs/editor/vscode-web.md#additional-browser-setup) documentation. -### Is there a limit to the number of remote machines I can connect to? - -Right now, you can only have 10 remote machines actively running the VS Code Server. If you'd like to connect to a new remote machine, and already have 10 others running, you'll need to stop the server on one of your other machines. - ### How can I keep the VS Code Server up-to-date? -You will get a notification in vscode.dev when you connect to your remote machine if an update is available, and you'll be able to update directly through this notification. - -### Will my app's ports be forwarded automatically? - -Beyond the automatic tunnel creation from your remote machine to vscode.dev, there is not additional port forwarding at this time. +You will get a notification in VS Code when you connect to your remote machine if an update is available, and you'll be able to update directly through this notification. ### I see an error about keyring storage. What should I do? Settings Sync requires authentication against a Settings Sync server. The corresponding secret is persisted on the server. This requires to set up a keyring on the server. When the keyring is not set up, the VS Code Server falls back to an in-memory secret stored on the server. In this case, secrets are only persisted during the lifetime of the server. -If you're using `serve-local` mode, you can run the following: - -```bash -# Get gnome-keyring -apt update && apt install -y gnome-keyring - -# Get the VS Code Server -# < Uncomment this line and replace it with an install command from above quick start > - -# Run a dbus session, which unlocks the gnome-keyring and runs the VS Code Server inside of it -dbus-run-session -- sh -c "(echo 'somecredstorepass' | gnome-keyring-daemon --unlock) && code-server serve-local --host 0.0.0.0" -``` +### Where can I provide feedback or report an issue? -### How do I uninstall the VS Code Server? +If you have any issues or feedback, please file an issue in the [VS Code Remote GitHub repo](https://github.com/microsoft/vscode-remote-release/issues). When filing an issue, include verbose logging, which you can enable by launching the VS Code Server with the `-v` flag: `code -v tunnel`. -Run `code-server uninstall`. +You may filter just for VS Code Server issues with the [`code-server` label](https://github.com/microsoft/vscode-remote-release/issues?q=is%3Aissue+is%3Aopen+label%3Acode-server). -### Where can I provide feedback or report an issue? +### Is there a limit to the number of remote machines I can connect to? -If you have any issues or feedback, please file an issue in the [VS Code Remote GitHub repo](https://github.com/microsoft/vscode-remote-release/issues). When filing an issue, include verbose logging, which you can enable by launching the VS Code Server with the `-v` flag: `server-launcher -v serve`. +Right now, you can have 10 remote machines registered with the VS Code Server. If you'd like to connect to a new remote machine, and already have 10 others registered, the CLI will pick a random unused tunnel and delete it. Please note this limit is subject to change. \ No newline at end of file diff --git a/docs/remote/wsl-tutorial.md b/docs/remote/wsl-tutorial.md index cddafa4bfc..d18b179d9a 100644 --- a/docs/remote/wsl-tutorial.md +++ b/docs/remote/wsl-tutorial.md @@ -1,11 +1,11 @@ --- -Order: 9 +Order: 10 Area: remote TOCTitle: WSL Tutorial PageTitle: Work in Windows Subsystem for Linux with Visual Studio Code ContentId: 44988826-46b8-498a-b1c9-f821378c2870 MetaDescription: Work in Windows Subsystem for Linux with Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 --- # Remote development in WSL diff --git a/docs/remote/wsl.md b/docs/remote/wsl.md index f282ffac4e..8c3a96be86 100644 --- a/docs/remote/wsl.md +++ b/docs/remote/wsl.md @@ -5,7 +5,7 @@ TOCTitle: Windows Subsystem for Linux PageTitle: Developing in the Windows Subsystem for Linux with Visual Studio Code ContentId: 79bcdbf9-d6a5-4e04-bbee-e7bb71f09f0a MetaDescription: Using Visual Studio Code Remote Development with the Windows Subsystem for Linux (WSL) -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 --- # Developing in WSL diff --git a/docs/setup/additional-components.md b/docs/setup/additional-components.md index 13acce67f9..b2a0f55e49 100644 --- a/docs/setup/additional-components.md +++ b/docs/setup/additional-components.md @@ -4,7 +4,7 @@ Area: setup TOCTitle: Additional Components ContentId: 243B79C2-819F-4257-B80D-2CD9CCB04C84 PageTitle: Setting up additional components to use with Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Setting up additional components to use with Visual Studio Code. --- # Additional components and tools diff --git a/docs/setup/enterprise.md b/docs/setup/enterprise.md index ac3248466e..2fe43cd312 100644 --- a/docs/setup/enterprise.md +++ b/docs/setup/enterprise.md @@ -4,7 +4,7 @@ Area: setup TOCTitle: Enterprise ContentId: 936ab8e0-3bbe-4842-bb17-ea314665c20a PageTitle: Visual Studio Code enterprise support -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Learn about Visual Studio Code's enterprise support features. --- diff --git a/docs/setup/linux.md b/docs/setup/linux.md index 2e5bd07afc..638f1c04fa 100644 --- a/docs/setup/linux.md +++ b/docs/setup/linux.md @@ -4,7 +4,7 @@ Area: setup TOCTitle: Linux ContentId: 7FDF94DB-3527-4296-BE1C-493495B89408 PageTitle: Running Visual Studio Code on Linux -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Get Visual Studio Code up and running on Linux. --- # Visual Studio Code on Linux diff --git a/docs/setup/mac.md b/docs/setup/mac.md index 720f9bedf1..453c0baa4c 100644 --- a/docs/setup/mac.md +++ b/docs/setup/mac.md @@ -4,7 +4,7 @@ Area: setup TOCTitle: macOS ContentId: EEADB50A-F5E3-41E9-89DA-35F165196691 PageTitle: Running Visual Studio Code on macOS -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Get Visual Studio Code up and running on Mac (macOS). --- # Visual Studio Code on macOS diff --git a/docs/setup/network.md b/docs/setup/network.md index 42c0ad621d..d925a6e5a8 100644 --- a/docs/setup/network.md +++ b/docs/setup/network.md @@ -4,7 +4,7 @@ Area: setup TOCTitle: Network ContentId: 84F36EDE-4D66-4A2E-B4D1-F020C73EB2AD PageTitle: Setup Visual Studio Code's Network Connection -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Setup VS Code's Network Connection. --- # Network Connections in Visual Studio Code diff --git a/docs/setup/raspberry-pi.md b/docs/setup/raspberry-pi.md index 28a8b29582..873a8ec56e 100644 --- a/docs/setup/raspberry-pi.md +++ b/docs/setup/raspberry-pi.md @@ -4,7 +4,7 @@ Area: setup TOCTitle: Raspberry Pi ContentId: E059E35A-8AD0-4D4A-9BE1-E23D45D75C1C PageTitle: Running Visual Studio Code on Raspberry Pi OS -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Get Visual Studio Code up and running on Raspberry Pi OS. --- # Visual Studio Code on Raspberry Pi diff --git a/docs/setup/setup-overview.md b/docs/setup/setup-overview.md index 7ee4d2662c..6a803246a1 100644 --- a/docs/setup/setup-overview.md +++ b/docs/setup/setup-overview.md @@ -4,7 +4,7 @@ Area: setup TOCTitle: Overview ContentId: FC5262F3-D91D-4665-A5D2-BCBCCF66E53A PageTitle: Setting up Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Get Visual Studio Code up and running. MetaSocialImage: quicksetup_QuickSetup.png --- diff --git a/docs/setup/uninstall.md b/docs/setup/uninstall.md index f2b84420da..6807a817b3 100644 --- a/docs/setup/uninstall.md +++ b/docs/setup/uninstall.md @@ -4,7 +4,7 @@ Area: setup TOCTitle: Uninstall ContentId: 435486d3-ad55-4a31-a087-d108f75ba669 PageTitle: Uninstall Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Uninstall Visual Studio Code and clean up. --- # Uninstall Visual Studio Code diff --git a/docs/setup/windows.md b/docs/setup/windows.md index 8dc9ccb8e1..c8cf6815cf 100644 --- a/docs/setup/windows.md +++ b/docs/setup/windows.md @@ -4,7 +4,7 @@ Area: setup TOCTitle: Windows ContentId: 4670C281-5761-46E6-8C46-10D523946FFB PageTitle: Running Visual Studio Code on Windows -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Get Visual Studio Code up and running on Windows --- # Visual Studio Code on Windows diff --git a/docs/sourcecontrol/faq.md b/docs/sourcecontrol/faq.md index 4ebf9a5a3f..85babe9bd2 100644 --- a/docs/sourcecontrol/faq.md +++ b/docs/sourcecontrol/faq.md @@ -5,7 +5,7 @@ TOCTitle: FAQ PageTitle: Source Control, Git & GitHub in VS Code Frequently Asked Questions ContentId: 431b4458-34c4-4aba-a0ee-eaddf7cd91a1 MetaDescription: Visual Studio Code's Frequently Asked Questions (FAQ) for Source Control, Git & GitHub in VS Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 --- # Source Control FAQ diff --git a/docs/sourcecontrol/github.md b/docs/sourcecontrol/github.md index 37b34daff3..ce48dab427 100644 --- a/docs/sourcecontrol/github.md +++ b/docs/sourcecontrol/github.md @@ -4,7 +4,7 @@ Area: sourcecontrol TOCTitle: Collaborate on GitHub ContentId: bd1be8cf-b745-4737-be48-db381ec3acc6 PageTitle: Collaborate on GitHub -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Working with GitHub Pull Requests and Issues in Visual Studio Code --- # Working with GitHub in VS Code diff --git a/docs/sourcecontrol/overview.md b/docs/sourcecontrol/overview.md index 5ecda7d109..96cf2f9729 100644 --- a/docs/sourcecontrol/overview.md +++ b/docs/sourcecontrol/overview.md @@ -4,7 +4,7 @@ Area: sourcecontrol TOCTitle: Overview ContentId: 7E22CCC0-2AB8-4729-A4C9-BE2B16853820 PageTitle: Source Control with Git in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Visual Studio Code source control management with integrated Git support. --- # Using Git source control in VS Code diff --git a/docs/supporting/faq.md b/docs/supporting/faq.md index 4927f78c0e..b0e0e727d0 100644 --- a/docs/supporting/faq.md +++ b/docs/supporting/faq.md @@ -2,7 +2,7 @@ TOCTitle: FAQ ContentId: E02F97FD-842B-4D27-B461-37DD18B2582E PageTitle: Visual Studio Code Frequently Asked Questions -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Visual Studio Code Frequently Asked Questions --- # Visual Studio Code FAQ diff --git a/docs/supporting/oss-extensions.md b/docs/supporting/oss-extensions.md index 5089b14297..611b4b07b6 100644 --- a/docs/supporting/oss-extensions.md +++ b/docs/supporting/oss-extensions.md @@ -3,7 +3,7 @@ Order: TOCTitle: Microsoft Extension Licenses ContentId: 661ad650-7bed-41f6-a62b-9eb1407010ab PageTitle: Microsoft Extension Licenses -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: List of Microsoft Extension Licenses --- # Microsoft Extension Licenses diff --git a/docs/supporting/requirements.md b/docs/supporting/requirements.md index f941683da5..b0c9abc116 100644 --- a/docs/supporting/requirements.md +++ b/docs/supporting/requirements.md @@ -3,7 +3,7 @@ Order: TOCTitle: Requirements ContentId: 1D4850EE-85E2-4152-81BE-FECAE62EA99E PageTitle: Requirements for Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Visual Studio Code hardware and platform (operating system) requirements. --- # Requirements for Visual Studio Code diff --git a/docs/supporting/troubleshoot-terminal-launch.md b/docs/supporting/troubleshoot-terminal-launch.md index 7f4b61ac1a..cb6129a96d 100644 --- a/docs/supporting/troubleshoot-terminal-launch.md +++ b/docs/supporting/troubleshoot-terminal-launch.md @@ -3,7 +3,7 @@ Order: TOCTitle: Troubleshoot Terminal Launch ContentId: c9dd7da5-2ad9-4862-bf24-2ed0fb65675e PageTitle: Troubleshoot Visual Studio Code Integrated Terminal launch failures -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Troubleshoot Visual Studio Code Integrated Terminal launch failures --- diff --git a/docs/terminal/advanced.md b/docs/terminal/advanced.md index 2f215b6494..b07ab05199 100644 --- a/docs/terminal/advanced.md +++ b/docs/terminal/advanced.md @@ -4,7 +4,7 @@ Area: terminal TOCTitle: Advanced ContentId: D458AFDC-C001-43FD-A4BB-9474767B2C04 PageTitle: Advanced Terminal Usage in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Visual Studio Code's integrated terminal has several advanced features. --- # Terminal Advanced diff --git a/docs/terminal/appearance.md b/docs/terminal/appearance.md index c05af64053..51c15edee9 100644 --- a/docs/terminal/appearance.md +++ b/docs/terminal/appearance.md @@ -4,7 +4,7 @@ Area: terminal TOCTitle: Appearance ContentId: F1AA7F3E-E078-4C02-B2DE-EC3F5F36F751 PageTitle: Terminal Appearance in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Visual Studio Code's integrated terminal allows customizing its appearance in various ways. --- # Terminal Appearance diff --git a/docs/terminal/basics.md b/docs/terminal/basics.md index 36f58e07f8..e44fa8d138 100644 --- a/docs/terminal/basics.md +++ b/docs/terminal/basics.md @@ -4,7 +4,7 @@ Area: terminal TOCTitle: Terminal Basics ContentId: 7B4DC928-2414-4FC7-9C76-E4A13D6675FE PageTitle: Integrated Terminal in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Visual Studio Code has an integrated terminal to enable working in your shell of choice without leaving the editor. --- # Terminal Basics diff --git a/docs/terminal/profiles.md b/docs/terminal/profiles.md index 252578de80..e279abd757 100644 --- a/docs/terminal/profiles.md +++ b/docs/terminal/profiles.md @@ -4,7 +4,7 @@ Area: terminal TOCTitle: Terminal Profiles ContentId: 1a9d76e8-9c8c-446e-974e-d71570e7d62a PageTitle: Terminal Profiles in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Visual Studio Code's integrated terminal allows configuring various profiles to make launching various shells easier. --- # Terminal Profiles diff --git a/docs/terminal/shell-integration.md b/docs/terminal/shell-integration.md index 991a6c006b..3769ce0ef4 100644 --- a/docs/terminal/shell-integration.md +++ b/docs/terminal/shell-integration.md @@ -4,7 +4,7 @@ Area: terminal TOCTitle: Shell Integration ContentId: a6a1652b-c0d8-4054-a2da-feb915eef2cc PageTitle: Terminal Shell Integration in Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Visual Studio Code's embedded terminal can integrate with some shells to enhance the capabilities of the terminal. --- diff --git a/docs/typescript/typescript-compiling.md b/docs/typescript/typescript-compiling.md index 7a85284403..6fcb23de0a 100644 --- a/docs/typescript/typescript-compiling.md +++ b/docs/typescript/typescript-compiling.md @@ -4,7 +4,7 @@ Area: typescript TOCTitle: Compiling ContentId: 59543856-da91-4a0d-9a98-9d5f2bf70c71 PageTitle: TypeScript Compiling with Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Learn about TypeScript compiling with Visual Studio Code. --- # Compiling TypeScript diff --git a/docs/typescript/typescript-debugging.md b/docs/typescript/typescript-debugging.md index 7503dc8505..92d947fee0 100644 --- a/docs/typescript/typescript-debugging.md +++ b/docs/typescript/typescript-debugging.md @@ -4,7 +4,7 @@ Area: typescript TOCTitle: Debugging ContentId: 19c60eb6-662b-444a-92f6-009642cc1e5b PageTitle: TypeScript debugging with Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: TypeScript debugging with Visual Studio Code. MetaSocialImage: images/typescript-tutorial/Languages_typescript.png --- diff --git a/docs/typescript/typescript-editing.md b/docs/typescript/typescript-editing.md index bea027e1ed..f26ed198c0 100644 --- a/docs/typescript/typescript-editing.md +++ b/docs/typescript/typescript-editing.md @@ -4,7 +4,7 @@ Area: typescript TOCTitle: Editing ContentId: db5139eb-9623-4d0b-8180-8b495e2b8b06 PageTitle: TypeScript editing with Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Learn about TypeScript editing with Visual Studio Code. --- # Editing TypeScript diff --git a/docs/typescript/typescript-refactoring.md b/docs/typescript/typescript-refactoring.md index 7344dff0df..30b52d2cc9 100644 --- a/docs/typescript/typescript-refactoring.md +++ b/docs/typescript/typescript-refactoring.md @@ -4,7 +4,7 @@ Area: typescript TOCTitle: Refactoring ContentId: ff7a9f28-26b2-4ac6-8c16-1a16182bb6ca PageTitle: TypeScript refactoring with Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Learn about TypeScript refactorings supported by Visual Studio Code. --- # Refactoring TypeScript diff --git a/docs/typescript/typescript-tutorial.md b/docs/typescript/typescript-tutorial.md index 9969f844e0..e3db00e134 100644 --- a/docs/typescript/typescript-tutorial.md +++ b/docs/typescript/typescript-tutorial.md @@ -4,7 +4,7 @@ Area: typescript TOCTitle: Tutorial ContentId: cb4f3742-733c-49d8-96db-d4bf8403bf64 PageTitle: TypeScript tutorial with Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: TypeScript tutorial with Visual Studio Code. MetaSocialImage: images/typescript-tutorial/Languages_typescript.png --- diff --git a/learn/overview.md b/learn/overview.md index ecb1e15ac7..51d3ce5e98 100644 --- a/learn/overview.md +++ b/learn/overview.md @@ -1,7 +1,7 @@ --- ContentId: f71d4b81-8361-48ee-82c0-48f69ec0d72e PageTitle: Get Started with Visual Studio Code -DateApproved: 11/2/2022 +DateApproved: 12/7/2022 MetaDescription: Get Started with Visual Studio Code --- # Learn to code with Visual Studio Code diff --git a/release-notes/images/1_74/audio-cues-dropdown.png b/release-notes/images/1_74/audio-cues-dropdown.png new file mode 100644 index 0000000000..d00ea99b71 --- /dev/null +++ b/release-notes/images/1_74/audio-cues-dropdown.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e29465c227210c139f24e8a862113193b68f9631e76fa61d05a1320bc610749d +size 61996 diff --git a/release-notes/images/1_74/exception-breakpoints.gif b/release-notes/images/1_74/exception-breakpoints.gif index 1036b7cbc8..a5f2a6826b 100644 --- a/release-notes/images/1_74/exception-breakpoints.gif +++ b/release-notes/images/1_74/exception-breakpoints.gif @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:b0b785598624221d9605b475dda9e1bf9636b4df675c6ba262f40c948cbd0dad -size 167631 +oid sha256:e7305e07f0f2f23b84e528d37e12796fa5b41f431e8cc5cf440d0d3fbb0a1d60 +size 142721 diff --git a/release-notes/images/1_74/hide-view-badge.gif b/release-notes/images/1_74/hide-view-badge.gif index 7fffdc9fcb..4cab8cabd1 100644 --- a/release-notes/images/1_74/hide-view-badge.gif +++ b/release-notes/images/1_74/hide-view-badge.gif @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:34fbc5845366f1ad338145ff8fc8048b36a278ddfbdaf8ced05f356a84ad1fbc -size 281769 +oid sha256:eefe2190f38f43499ccf564b399f7dc12c675a102e9be17de432fae1e828e46c +size 134383 diff --git a/release-notes/images/1_74/profile-export.gif b/release-notes/images/1_74/profile-export.gif index ea31888042..aa92e625ef 100644 --- a/release-notes/images/1_74/profile-export.gif +++ b/release-notes/images/1_74/profile-export.gif @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:bd06e0e0c6608b8f1e8b4a7ff68889f98ebf5de368783946fdd692e33e033026 -size 1553014 +oid sha256:33bdecbca03a25bd66fa4715aa6ea98785209b92caecedd118f35d3249d620f9 +size 1065154 diff --git a/release-notes/images/1_74/profile-import.gif b/release-notes/images/1_74/profile-import.gif index e1818b21e4..5d3962e3f5 100644 --- a/release-notes/images/1_74/profile-import.gif +++ b/release-notes/images/1_74/profile-import.gif @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:4e884f7854191b81cd89947e5fe48621a3ce78e6fb28d9ba4184e95eb0138d59 -size 2839562 +oid sha256:944a5feb6b801fef4f8e8f422d49da4f13f5f6c07bd33f5b15631a7c358658b7 +size 2167839 diff --git a/release-notes/images/1_74/release-highlights.png b/release-notes/images/1_74/release-highlights.png index bc9aede413..6bcfb75ef3 100644 --- a/release-notes/images/1_74/release-highlights.png +++ b/release-notes/images/1_74/release-highlights.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:5d87a236025018efbbdda46cec4863d306aa5ada41a81e7a4ed172cca086e73e -size 39539 +oid sha256:ed270e22d0f1678367d6ba1bb6552e508420530ec86a15dcf34e6e1f35c3a99d +size 40132 diff --git a/release-notes/images/1_74/scm-action-button.png b/release-notes/images/1_74/scm-action-button.png index 50a886e9dc..777c5ddef9 100644 --- a/release-notes/images/1_74/scm-action-button.png +++ b/release-notes/images/1_74/scm-action-button.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:5ce60473067e86c46dd7c4c25a1fd69ae1029a97c1d0e06d2367a59675909474 -size 361976 +oid sha256:fb4ea34bf8fa9f75428308ca2322568e3ed54f7205cb8e8ccb4cfa96659905d9 +size 122459 diff --git a/release-notes/v1_74.md b/release-notes/v1_74.md index 8e8e131228..4fa853c6b8 100644 --- a/release-notes/v1_74.md +++ b/release-notes/v1_74.md @@ -1,10 +1,10 @@ --- -Order: +Order: 83 TOCTitle: November 2022 PageTitle: Visual Studio Code November 2022 MetaDescription: Learn what is new in the Visual Studio Code November 2022 Release (1.74) MetaSocialImage: 1_74/release-highlights.png -Date: 2022-12-8 +Date: 2022-12-7 DownloadVersion: 1.74.0 --- # November 2022 (version 1.74) @@ -32,12 +32,16 @@ Welcome to the November 2022 release of Visual Studio Code. There are many updat ### Audio cues for notebook execution -We've added audio cues to play when notebook cells finish executing. The cue is different to indicate whether the cell ran successfully or failed. +There are now [audio cues](https://code.visualstudio.com/docs/editor/accessibility#_audio-cues) for when notebook cells finish running. The cue is different to indicate whether the cell ran successfully or failed. ### Audio cues for diff review mode In a diff editor, when **Go to Next Difference** is triggered, a specific audio cue will play to indicate whether the cursor is on an inserted or deleted line. +If you are curious about the available audio cues, you can hear them via the **Help: List Audio Cues** dropdown. + +![List Audio Cues dropdown](images/1_74/audio-cues-dropdown.png) + ### Keyboard-navigable Settings editor indicators, hovers, and links The indicators, hovers, and links in the Settings editor are now navigable by keyboard. The styling of some of the links have also been adjusted for better consistency across the Settings editor. @@ -52,9 +56,9 @@ _Theme: [Light Pink](https://marketplace.visualstudio.com/items?itemName=mgwg.li ### Custom Explorer autoreveal logic -The highly upvoted issue [Allow to set explorer.autoReveal per specific folder](https://github.com/microsoft/vscode/issues/87956) has been fixed by the introduction of a new setting `explorer.autoRevealExclude`. This setting let you configure which files get autorevealed in the Explorer if the autorevealing is enabled (`explorer.autoReveal` default `true`). The setting uses [glob patterns](https://code.visualstudio.com/docs/editor/codebasics#_advanced-search-options) for excluding files and similar to `files.exclude` also supports sibling matching via when clauses. +The highly upvoted [issue #87956](https://github.com/microsoft/vscode/issues/87956) ("Allow to set explorer.autoReveal per specific folder") has been fixed by the introduction of a new setting `explorer.autoRevealExclude`. This setting lets you configure which files get autorevealed in the Explorer if the autorevealing is enabled (`explorer.autoReveal`, default `true`). The `autoRevealExclude` setting uses [glob patterns](https://code.visualstudio.com/docs/editor/codebasics#_advanced-search-options) for excluding files and similar to `files.exclude`, also supports sibling matching via when clauses. -The default values exclude node and bower modules: +The default value excludes node and bower modules: ```json { @@ -67,7 +71,7 @@ The default values exclude node and bower modules: ### Hide badges per view container -Similar to how you were able to hide view containers by right-clicking the view container, we've now introduced the ability to hide the badges often indicating a number, icon, or progress on the container. +Similar to how you were able to hide view containers by right-clicking the view container, you can now hide the badge on the container (displayed in the Activity bar, Panel, and Secondary Side bar). Badges often display a number, icon, or progress indicator for a specific view container, for example, the number of pending changes for the Source Control view. ![A context menu is triggered on the Source Control view showing a Hide Badge entry. This is then selected and the blue number one badge disappears. Triggering the context menu again shows a Show Badge entry which brings the blue badge number one badge back.](images/1_74/hide-view-badge.gif) @@ -78,25 +82,25 @@ This release ships some improvements and bug-fixes for the merge editor. Highlig * Undo/Redo now tracks the handled state of conflicts. * **Ignore** actions in the input views can be used to accept the base version instead of the **Mark as handled** action in the result view. * Changes that are equal on both sides are now automatically resolved. -* Extensions that provide `git blame` functionality now work in the incoming, current and base editor. +* Extensions that provide `git blame` functionality now work in the incoming, current, and base editors. ### Install an extension located on disk -You can now install an extension that is located on a local disk drive by using **Developer: Install Extension from Location...** command. +You can now install an extension that is located on a local disk drive by using **Developer: Install Extension from Location...** command. The command will open the platform folder dialog to select the location of the extension's `.vsix` file. ## Editor ### New word break option for CJK characters -A setting called `editor.wordBreak` can now be used to avoid inserting wrapping points after CJK characters. When configured with `keepAll`, the wrapping algorithms will try to keep text after CJK characters on the same line. This setting doesn't have any effect on characters from other scripts. +A setting called `editor.wordBreak` can now be used to avoid inserting wrapping points after [CJK characters](https://en.wikipedia.org/wiki/CJK_characters). When configured with `keepAll`, the wrapping algorithms will try to keep text after CJK characters on the same line. This setting doesn't have any effect on characters from other scripts. ### New font setting for OpenType fonts -Some newer fonts, which support OpenType font variations, support tweaking certain axes, like the font weight axis, to achieve font weights which are not configurable via the `font-weight` CSS property. In CSS, this is achieved with the `font-variation-settings` property. If you use such a font, you can now configure `editor.fontVariations` to `true` which will result in VS Code using the `"wght"` display axis for setting the font weight. If your font supports other axes, it is also possible to configure them directly, for example by setting `"editor.fontVariations": "'ital' 0.5"`. +Some newer fonts, which support [OpenType](https://learn.microsoft.com/typography/opentype) font variations, support tuning certain axes, like the font weight axis, to achieve font weights that are not configurable via the `font-weight` CSS property. In CSS, this is achieved with the `font-variation-settings` property. If you use such a font, you can now configure `editor.fontVariations` to `true`, which will result in VS Code using the `"wght"` display axis for setting the font weight. If your font supports other axes, it is also possible to configure them directly, for example by setting `"editor.fontVariations": "'ital' 0.5"`. ### New indent size setting -There is a new setting called `editor.indentSize` that allows to dissociate the indent size (the number of spaces that make up an indent) from the tab size (the number of spaces that are used to render a tab character). This is useful when dealing with files that use mixed tabs and spaces indentations and can be exercised only when using manual indentation configuration. +There is a new setting called `editor.indentSize` that allows to dissociate the indent size (the number of spaces that make up an indent) from the tab size (the number of spaces that are used to render a Tab character). This is useful when dealing with files that use mixed tabs and spaces indentations and can be exercised only when using manual indentation configuration. Below is an example configuration: @@ -113,23 +117,23 @@ The command **Accept Next Word Of Inline Suggestion** (`editor.action.inlineSugg ## Source Control -### Manage unsafe git repositories +### Manage unsafe Git repositories -VS Code uses `git.exe` for executing all git operations. Starting with Git [2.35.2](https://github.blog/2022-04-18-highlights-from-git-2-36/#stricter-repository-ownership-checks), users are prevented from running git operations in a repository that is in a folder that owned by a user other than the current user as the repository is deemed to be potentially unsafe. +VS Code uses `git.exe` for executing all Git operations. Starting with Git [2.35.2](https://github.blog/2022-04-18-highlights-from-git-2-36/#stricter-repository-ownership-checks), users are prevented from running Git operations in a repository that is in a folder owned by a user other than the current user, as the repository is deemed to be potentially unsafe. -Starting with this release, if one tries to open such a potentially unsafe repository, VS Code will show a welcome view in the Source Control view as well as an error notification. Both the welcome view, and the notification expose the **Manage Unsafe Repositories** command that enables user to review the list of potentially unsafe repositories, mark them as safe, and open them. The **Manage Unsafe Repositories** command is also available in the Command Palette. Marking a repository as safe will add the repository location to the `safe.directory` [git configuration](https://git-scm.com/docs/git-config#Documentation/git-config.txt-safedirectory). +Starting with this release, if you try to open such a potentially unsafe repository, VS Code will show a welcome view in the Source Control view as well as an error notification. Both the welcome view, and the notification expose the **Manage Unsafe Repositories** command that lets you review the list of potentially unsafe repositories, mark them as safe, and open them. The **Manage Unsafe Repositories** command is also available in the Command Palette. Marking a repository as safe will add the repository location to the `safe.directory` [git configuration](https://git-scm.com/docs/git-config#Documentation/git-config.txt-safedirectory). ### Optimistic user-interface updates -After executing a git operation, a set of git commands (for example, `git status`) are executed to update the data model before the Source Control view is updated. There are scenarios in which running these commands can take several seconds to complete (ex: working with large monorepos), resulting in a delay before the Source Control view is refreshed. +After executing a Git operation, a set of `git` commands (for example, `git status`) are executed to update the data model before the Source Control view is updated. There are scenarios in which running these commands can take several seconds to complete (for example, when working with large monorepos), resulting in a delay before the Source Control view is refreshed. -This milestone we have made changes so that the Source Control view is optimistically updated for some of the git operations (stage, un-stage, discard changes, and commit) before `git status` completes resulting in a snappier Source Control view. +This milestone we have made changes so that the Source Control view is optimistically updated for some of the Git operations (stage, unstage, discard changes, and commit) before `git status` completes, resulting in a snappier Source Control view. The new capability is enabled by default but it can be disabled using `git.optimisticUpdate: false`. ### Commit action button polish -This milestone we have polished the **Commit** action button so that when executing a secondary commit command (ex: "Commit & Sync"), the action button label correctly reflects the command being executed. The **Commit** action button will also show an animation indicating progress. +When the **Commit** action button is executing a secondary commit command (for example, **Commit & Sync**), the button label now correctly reflects the command being executed. The **Commit** button also shows an animation indicating progress. ## Terminal @@ -147,15 +151,15 @@ The **Run Task** and **Configure Tasks** commands appear in the terminal dropdow ## Remote Development -[Remote Tunnels](https://code.visualstudio.com/docs/remote/tunnels) is now available as a preview feature on VS Code stable. Remote tunnels allow you to securely access your machine with VS Code from any device, anywhere. To enable remote tunnel access, you can **either**: +[Remote Tunnels](https://code.visualstudio.com/docs/remote/tunnels) is now available as a preview feature on VS Code Stable. Remote tunnels allow you to securely access your machine with VS Code from any device, anywhere. To enable remote tunnel access, you can **either**: * Choose **Turn on Remote Tunnel Access** from the Account menu or Command Palette. * Run `code tunnel` from a machine with VS Code installed and on the PATH. * [Download the new VS Code CLI](https://code.visualstudio.com/#alt-downloads) and run `./code tunnel`. -Once tunnel access is turned on, you can connect to the machine from any device using [vscode.dev](https://vscode.dev), or using the Remote Tunnels extensions from VS Code desktop. +Once tunnel access is turned on, you can connect to the machine from any device using [vscode.dev](https://vscode.dev), or using the [Remote - Tunnels](https://marketplace.visualstudio.com/items?itemName=ms-vscode.remote-server) extension from within VS Code Desktop. -To find out more, check out our [blog post announcing the feature](https://code.visualstudio.com/blogs/2022/12/07/remote-event-better) or the [remote tunnel documentation](https://code.visualstudio.com/docs/remote/tunnels). +To find out more, check out our [blog post announcing the feature](https://code.visualstudio.com/blogs/2022/12/07/remote-even-better) or the [Remote Tunnels](https://code.visualstudio.com/docs/remote/tunnels) documentation.