From eebb0bd525973cddf7bb3033c392e1f9f71846da Mon Sep 17 00:00:00 2001 From: Greg Van Liew Date: Sat, 25 May 2019 10:43:50 -0700 Subject: [PATCH] edit pass on open-source and command-line as adjectives --- .../syntax-highlight-guide.md | 4 ++-- .../bundling-extension.md | 4 ++-- .../publishing-extension.md | 2 +- ...introducing-chrome-debugger-for-vs-code.md | 2 +- blogs/2016/04/14/vscode-1.0.md | 4 ++-- blogs/2016/06/27/common-language-protocol.md | 2 +- ...ebugging-for-vs-code-on-windows-and-mac.md | 2 +- blogs/2018/05/07/live-share-public-preview.md | 2 +- .../introducing-logpoints-and-auto-attach.md | 2 +- .../09/10/introducing-github-pullrequests.md | 4 ++-- .../09/12/engineering-with-azure-pipelines.md | 2 +- blogs/2018/12/04/rich-navigation.md | 2 +- docs/editor/command-line.md | 12 ++++++------ docs/editor/extension-gallery.md | 8 ++++---- docs/editor/tasks-v1.md | 4 ++-- docs/editor/userdefinedsnippets.md | 8 ++++---- docs/editor/versioncontrol.md | 2 +- docs/editor/whyvscode.md | 2 +- docs/getstarted/locales.md | 6 +++--- docs/getstarted/userinterface.md | 2 +- docs/languages/java.md | 2 +- docs/nodejs/nodejs-tutorial.md | 8 ++++---- docs/nodejs/reactjs-tutorial.md | 2 +- docs/python/linting.md | 2 +- docs/python/unit-testing.md | 2 +- docs/remote/faq.md | 2 +- docs/setup/network.md | 8 ++++---- docs/setup/windows.md | 2 +- docs/supporting/faq.md | 8 ++++---- release-notes/v0_3_0.md | 2 +- release-notes/v0_5_0.md | 8 ++++---- release-notes/v1_11.md | 2 +- release-notes/v1_15.md | 2 +- release-notes/v1_16.md | 4 ++-- release-notes/v1_19.md | 8 ++++---- release-notes/v1_26.md | 2 +- release-notes/v1_34.md | 4 ++-- release-notes/v1_9.md | 2 +- release-notes/vInsiders.md | 19 ------------------- tutorials/app-service-extension/create-app.md | 2 +- tutorials/nodejs-deployment/express.md | 2 +- 41 files changed, 75 insertions(+), 94 deletions(-) delete mode 100644 release-notes/vInsiders.md diff --git a/api/language-extensions/syntax-highlight-guide.md b/api/language-extensions/syntax-highlight-guide.md index 63278b625..7ee3bd1dc 100644 --- a/api/language-extensions/syntax-highlight-guide.md +++ b/api/language-extensions/syntax-highlight-guide.md @@ -192,13 +192,13 @@ Yaml grammars have the exact same structure as a json based grammar but allow yo ![A yaml grammar using multiline strings and comments](images/syntax-highlighting/yaml-grammar.png) -VS Code can only load json grammars, so yaml based grammars must be converted to json. The [`js-yaml` package](https://www.npmjs.com/package/js-yaml) and command line tool makes this easy. +VS Code can only load json grammars, so yaml based grammars must be converted to json. The [`js-yaml` package](https://www.npmjs.com/package/js-yaml) and command-line tool makes this easy. ```bash # Install js-yaml as a development only dependency in your extension $ npm install js-yaml --save-dev -# Use the command line tool to convert the yaml grammar to json +# Use the command-line tool to convert the yaml grammar to json $ npx js-yaml syntaxes/abc.tmLanguage.yaml > syntaxes/abc.tmLanguage.json ``` diff --git a/api/working-with-extensions/bundling-extension.md b/api/working-with-extensions/bundling-extension.md index 8411d3bc9..0d82a6c6e 100644 --- a/api/working-with-extensions/bundling-extension.md +++ b/api/working-with-extensions/bundling-extension.md @@ -15,7 +15,7 @@ For JavaScript, different bundlers are available. Popular ones are [rollup.js](h ## Using webpack -Webpack is a development tool that's available from [npm](https://www.npmjs.com). To acquire webpack and its command-line interface, open the terminal and type: +Webpack is a development tool that's available from [npm](https://www.npmjs.com). To acquire webpack and its command line interface, open the terminal and type: ```bash npm i --save-dev webpack webpack-cli @@ -81,7 +81,7 @@ In the sample above, the following are defined: ## Run webpack -With the `webpack.config.js` file created, webpack can be invoked. You can run webpack from the command-line but to reduce repetition, using npm scripts is helpful. +With the `webpack.config.js` file created, webpack can be invoked. You can run webpack from the command line but to reduce repetition, using npm scripts is helpful. Merge these entries into the `scripts` section in `package.json`: diff --git a/api/working-with-extensions/publishing-extension.md b/api/working-with-extensions/publishing-extension.md index 41b0299cd..a7740228c 100644 --- a/api/working-with-extensions/publishing-extension.md +++ b/api/working-with-extensions/publishing-extension.md @@ -19,7 +19,7 @@ This topics covers: ## vsce -[vsce](https://github.com/Microsoft/vsce), short for "Visual Studio Code Extensions", is a command line tool for packaging, publishing and managing VS Code extensions. +[vsce](https://github.com/Microsoft/vsce), short for "Visual Studio Code Extensions", is a command-line tool for packaging, publishing and managing VS Code extensions. ### Installation diff --git a/blogs/2016/02/23/introducing-chrome-debugger-for-vs-code.md b/blogs/2016/02/23/introducing-chrome-debugger-for-vs-code.md index f54a9c340..056c8e38f 100644 --- a/blogs/2016/02/23/introducing-chrome-debugger-for-vs-code.md +++ b/blogs/2016/02/23/introducing-chrome-debugger-for-vs-code.md @@ -51,7 +51,7 @@ In this first release, we support the following features: We believe there’s much to be done for front-end developers, as building for the web in the recent years has become incredibly complex. With our Chrome debugger, we are taking the first step towards a simpler web development workflow, where browsers and tooling from different vendors are able to work together, and building for the web feels more integrated. -We’ve released this extension on [GitHub](https://github.com/Microsoft/vscode-chrome-debug) as an MIT licensed open source project. It’s a work in progress, so see our issues page for known bugs – for example, we have a few issues around supporting all flavors of generated source maps. +We’ve released this extension on [GitHub](https://github.com/Microsoft/vscode-chrome-debug) as an MIT licensed open-source project. It’s a work in progress, so see our issues page for known bugs – for example, we have a few issues around supporting all flavors of generated source maps. For now we support Google Chrome, but we’re also looking at expanding our support to [Microsoft Edge](https://www.microsoft.com/en-us/windows/microsoft-edge) and other browsers. We really want your feedback and help to build an even better debugging experience. diff --git a/blogs/2016/04/14/vscode-1.0.md b/blogs/2016/04/14/vscode-1.0.md index 9ebb2ba5d..c874da939 100644 --- a/blogs/2016/04/14/vscode-1.0.md +++ b/blogs/2016/04/14/vscode-1.0.md @@ -43,13 +43,13 @@ Of course, to build the editor we needed a development tool. Developers know tha But we strived to go further. We wanted to build a native development tool that developers could install and use anywhere, for any source code. And, from our experience, we believed that it was important to not just have an editor, but one that could help developers accomplish their most common tasks: navigating code, debugging, and working with Git. And, so, Visual Studio Code was born. -Being built on web technologies made it easy to host the tool in a native cross-platform shell. We decided early on to use, and contribute to, a number of open source technologies – including GitHub’s great Electron shell, which combines web and native UI with a Node.js API. In just a few short months, we were able to release the [first preview](https://blogs.msdn.microsoft.com/somasegar/2015/04/29/introducing-visual-studio-code-visual-studio-2015-rc-application-insights-public-preview-and-net-core-preview-for-linux-and-ma) of Visual Studio Code at //build/ 2015. +Being built on web technologies made it easy to host the tool in a native cross-platform shell. We decided early on to use, and contribute to, a number of open-source technologies – including GitHub’s great Electron shell, which combines web and native UI with a Node.js API. In just a few short months, we were able to release the [first preview](https://blogs.msdn.microsoft.com/somasegar/2015/04/29/introducing-visual-studio-code-visual-studio-2015-rc-application-insights-public-preview-and-net-core-preview-for-linux-and-ma) of Visual Studio Code at //build/ 2015. The initial response to a code editor running on OS X, Windows, and Linux was overwhelmingly positive, even with two fundamental gaps in the offering – extensibility and open development. Keeping our principle of using VS Code the way our customers do, we decided that the best way to deliver a rich and stable API was to build VS Code using the same API we would expose to extension developers. In fact, the core language services for JavaScript and TypeScript are actually extensions that just happen to be bundled with the distribution. Today, we use VS Code to build and debug VS Code, its extensions, and Node-based services. The same rich TypeScript editing, navigation, and debugging experiences we enjoy when building VS Code are available to everyone developing an extension for VS Code. Six months after our initial preview release, we declared VS Code to be Beta quality at Connect(); 2015, with a full extensibility model, and support in the new Visual Studio Marketplace. -And at the same time, we open-sourced the VS Code [repository](https://github.com/Microsoft/vscode) and many of our own extensions, and moved to developing Visual Studio Code in the open. +And at the same time, we open sourced the VS Code [repository](https://github.com/Microsoft/vscode) and many of our own extensions, and moved to developing Visual Studio Code in the open. ![timeline graphic](timeline.png) diff --git a/blogs/2016/06/27/common-language-protocol.md b/blogs/2016/06/27/common-language-protocol.md index 97136e026..0b27ec1ee 100644 --- a/blogs/2016/06/27/common-language-protocol.md +++ b/blogs/2016/06/27/common-language-protocol.md @@ -46,7 +46,7 @@ It also enables a given language server to be implemented once and have differen ## Open Specification -The complete specification for this protocol is available in a [public GitHub repository](https://github.com/Microsoft/language-server-protocol), as is a [history of how the protocol has evolved](https://github.com/Microsoft/language-server-protocol/wiki/Protocol-History) to date. As it continues to be adopted by more languages and tools, we intend to support and evolve the protocol, along with partners like Red Hat, Codenvy, and others in the open source community. Anyone can ask questions, file issues, or submit pull requests on the repo, just like any other open source project. +The complete specification for this protocol is available in a [public GitHub repository](https://github.com/Microsoft/language-server-protocol), as is a [history of how the protocol has evolved](https://github.com/Microsoft/language-server-protocol/wiki/Protocol-History) to date. As it continues to be adopted by more languages and tools, we intend to support and evolve the protocol, along with partners like Red Hat, Codenvy, and others in the open-source community. Anyone can ask questions, file issues, or submit pull requests on the repo, just like any other open-source project. ## What's Next diff --git a/blogs/2016/08/22/introducing-ios-web-debugging-for-vs-code-on-windows-and-mac.md b/blogs/2016/08/22/introducing-ios-web-debugging-for-vs-code-on-windows-and-mac.md index f896c14a8..ea78cbcca 100644 --- a/blogs/2016/08/22/introducing-ios-web-debugging-for-vs-code-on-windows-and-mac.md +++ b/blogs/2016/08/22/introducing-ios-web-debugging-for-vs-code-on-windows-and-mac.md @@ -21,7 +21,7 @@ Debugging websites running on iOS devices is accessible only to a subset of deve ![Demo](ios-debugger-splash.png) -Our new iOS Web Debugger works quite similar to our Chrome debugger which we [introduced back in February](https://code.visualstudio.com/blogs/2016/02/23/introducing-chrome-debugger-for-vs-code). Under the hood, it’s the same debugger running inside VS Code, which is powered by our open source [vscode-chrome-debug-core](https://github.com/Microsoft/vscode-chrome-debug-core) library. To make the connection from our debugging library to the iOS device, we are leveraging two open source projects, [ios-webkit-debug-proxy](https://github.com/google/ios-webkit-debug-proxy) and [ios-webkit-debug-proxy-win32](https://github.com/artygus/ios-webkit-debug-proxy-win32), that enables communication with the iOS devices over USB through the WebKit Remote Debugging Protocol. The protocol is compatible with the Chrome Debugging Protocol for the script debugging APIs, and this means our debugger works without additional mapping logic. +Our new iOS Web Debugger works quite similar to our Chrome debugger which we [introduced back in February](https://code.visualstudio.com/blogs/2016/02/23/introducing-chrome-debugger-for-vs-code). Under the hood, it’s the same debugger running inside VS Code, which is powered by our open-source [vscode-chrome-debug-core](https://github.com/Microsoft/vscode-chrome-debug-core) library. To make the connection from our debugging library to the iOS device, we are leveraging two open-source projects, [ios-webkit-debug-proxy](https://github.com/google/ios-webkit-debug-proxy) and [ios-webkit-debug-proxy-win32](https://github.com/artygus/ios-webkit-debug-proxy-win32), that enables communication with the iOS devices over USB through the WebKit Remote Debugging Protocol. The protocol is compatible with the Chrome Debugging Protocol for the script debugging APIs, and this means our debugger works without additional mapping logic. ## Enabling easy local development through emulated port forwarding diff --git a/blogs/2018/05/07/live-share-public-preview.md b/blogs/2018/05/07/live-share-public-preview.md index c69ae7ca4..d77db1d9c 100644 --- a/blogs/2018/05/07/live-share-public-preview.md +++ b/blogs/2018/05/07/live-share-public-preview.md @@ -24,7 +24,7 @@ Whether you’re building a Python web app, a Go microservice, a React Native mo ## Shared Terminals -Modern development commonly makes use of command-line tools to perform tasks such as build and running unit tests. Because the command-line represents such a core component of the common developer workflow, it’s critical that participants within a Live Share session can use them, without requiring a separate tool. To further support your collaborative debugging sessions, and address one of our [top feature requests](https://github.com/MicrosoftDocs/live-share/issues/41), Live Share now allows hosts to share terminals with their guests. +Modern development commonly makes use of command-line tools to perform tasks such as build and running unit tests. Because the command line represents such a core component of the common developer workflow, it’s critical that participants within a Live Share session can use them, without requiring a separate tool. To further support your collaborative debugging sessions, and address one of our [top feature requests](https://github.com/MicrosoftDocs/live-share/issues/41), Live Share now allows hosts to share terminals with their guests. ![Shared terminal](shared-terminal.png) diff --git a/blogs/2018/07/12/introducing-logpoints-and-auto-attach.md b/blogs/2018/07/12/introducing-logpoints-and-auto-attach.md index b33f3cb96..54cbc5c7e 100644 --- a/blogs/2018/07/12/introducing-logpoints-and-auto-attach.md +++ b/blogs/2018/07/12/introducing-logpoints-and-auto-attach.md @@ -58,7 +58,7 @@ The value of [launch configurations](/docs/editor/debugging#_launch-configuratio However, when we talked to developers about how they were launching their applications, we saw a pattern and made one important observation: -**Observation**: Many developers who are using VS Code really love the Integrated Terminal and rely on command line tools to launch their applications. For many, it's a more natural workflow to run a command in the terminal followed by attaching the debugger from the editor. This is similar to opening DevTools after the browser has been launched. +**Observation**: Many developers who are using VS Code really love the Integrated Terminal and rely on command-line tools to launch their applications. For many, it's a more natural workflow to run a command in the terminal followed by attaching the debugger from the editor. This is similar to opening DevTools after the browser has been launched. This observation was key, and we realized that many users don't want a full "magical" launch experience in their editor. They want to keep their editor as the place to edit and debug source code and use the terminal to launch apps, run build scripts, etc. This is one of the reasons why we have an Integrated Terminal experience inside VS Code, as we believe a good functional UI should co-exist and integrate well with the terminal. diff --git a/blogs/2018/09/10/introducing-github-pullrequests.md b/blogs/2018/09/10/introducing-github-pullrequests.md index 08c3ea422..5076c6bd1 100644 --- a/blogs/2018/09/10/introducing-github-pullrequests.md +++ b/blogs/2018/09/10/introducing-github-pullrequests.md @@ -12,7 +12,7 @@ Author: Kenneth Auchenberg September 10, 2018 Kenneth Auchenberg, [@auchenberg](https://twitter.com/auchenberg) -Like many other open source projects, the [Visual Studio Code community collaborates](https://github.com/Microsoft/vscode) through [pull requests](https://github.com/Microsoft/vscode/pulls) to land fixes and new features. Starting this past spring, our team has been working to bring you a new integrated pull request experience so that you can collaborate, comment, review, and validate GitHub pull requests directly from within Visual Studio Code. +Like many other open-source projects, the [Visual Studio Code community collaborates](https://github.com/Microsoft/vscode) through [pull requests](https://github.com/Microsoft/vscode/pulls) to land fixes and new features. Starting this past spring, our team has been working to bring you a new integrated pull request experience so that you can collaborate, comment, review, and validate GitHub pull requests directly from within Visual Studio Code. Today, we are announcing the public preview of [GitHub Pull Requests for Visual Studio Code](https://aka.ms/vscodepr-download), closing a gap in the workflow that we and millions of engineers experience every day: The ability to review source code where it was written – inside the editor. @@ -26,7 +26,7 @@ The new GitHub Pull Requests extension is designed to help you review and manage - List and browse PRs from within Visual Studio Code. - Interact with PRs in-editor, including in-editor commenting with Markdown support. - Validate PRs from the editor with a new local `checkout and run` workflow for rich language features such as Go To Definition and IntelliSense. -- Terminal integration so that the Visual Studio Code UI and command line tools like `git` can co-exist. +- Terminal integration so that the Visual Studio Code UI and command-line tools like `git` can co-exist. ![overview](github_pr_overview.png) diff --git a/blogs/2018/09/12/engineering-with-azure-pipelines.md b/blogs/2018/09/12/engineering-with-azure-pipelines.md index 69aab42c1..f3b74615f 100644 --- a/blogs/2018/09/12/engineering-with-azure-pipelines.md +++ b/blogs/2018/09/12/engineering-with-azure-pipelines.md @@ -16,7 +16,7 @@ One of my responsibilities as a developer on the Visual Studio Code team is to m ## Visual Studio Code Engineering -Like any other open-source project, we need to have the right tooling and capabilities to receive, triage, and address as many code contributions as possible. This rings especially true in the developer tools universe, in which end users are developers themselves: they are a passionate, hard-working, and very effective group. As of this blog post, we have [148 open PRs as well as 3,482 closed ones](https://github.com/Microsoft/vscode/pulls), which sets an average of ~3 PRs/day given the 3-year project lifespan so far. It is important that we are well equipped for handling this scale of contributions, not only to keep the project development healthy but also to help give other open source projects an example of how to operate at this scale. Part of how we do this is by streamlining our workflow by [bringing the PR experience into the editor](/blogs/2018/09/10/introducing-github-pullrequests), but CI is the other important part of handling contributions at scale. +Like any other open-source project, we need to have the right tooling and capabilities to receive, triage, and address as many code contributions as possible. This rings especially true in the developer tools universe, in which end users are developers themselves: they are a passionate, hard-working, and very effective group. As of this blog post, we have [148 open PRs as well as 3,482 closed ones](https://github.com/Microsoft/vscode/pulls), which sets an average of ~3 PRs/day given the 3-year project lifespan so far. It is important that we are well equipped for handling this scale of contributions, not only to keep the project development healthy but also to help give other open-source projects an example of how to operate at this scale. Part of how we do this is by streamlining our workflow by [bringing the PR experience into the editor](/blogs/2018/09/10/introducing-github-pullrequests), but CI is the other important part of handling contributions at scale. Up until very recently, we relied on the OSS community's default choices for public continuous integration: [Travis CI](https://travis-ci.org/) for our Linux and macOS builds and [AppVeyor](https://www.appveyor.com/) for Windows. Additionally, we used [Coveralls](https://coveralls.io/) to provide detailed test coverage reports. These services provide quality reports for PRs and code branches on our public repository, as they automate [compilation](https://github.com/Microsoft/vscode/blob/master/build/lib/compilation.ts), run [code hygiene checks](https://github.com/Microsoft/vscode/blob/master/build/gulpfile.hygiene.js) and [execute several test](https://github.com/Microsoft/vscode/tree/master/test) suites, all of which is essential in order to maintain quality in a distributed team with lots of incoming contributions. This combination of services requires the understanding and maintenance of at least 3 different systems, each with its own special file formats, syntax, quirks, limitations, etc. diff --git a/blogs/2018/12/04/rich-navigation.md b/blogs/2018/12/04/rich-navigation.md index c50b70533..57366db8d 100644 --- a/blogs/2018/12/04/rich-navigation.md +++ b/blogs/2018/12/04/rich-navigation.md @@ -11,7 +11,7 @@ Author: Jonathan Carter December 4, 2018 Jonathan Carter, [@lostintangent](https://twitter.com/LostInTangent) -Pull requests are a critical collaboration tool for millions of developers every day, facilitating asynchronous code reviews and the distribution of knowledge amongst teams and open source communities. Because of this widespread utility and adoption, any advancement to the PR review workflow can have a significant impact on developer productivity, product quality and release velocity. +Pull requests are a critical collaboration tool for millions of developers every day, facilitating asynchronous code reviews and the distribution of knowledge amongst teams and open-source communities. Because of this widespread utility and adoption, any advancement to the PR review workflow can have a significant impact on developer productivity, product quality and release velocity. In September, along with GitHub, [we announced the GitHub Pull Requests extension](https://code.visualstudio.com/blogs/2018/09/10/introducing-github-pullrequests), which enabled developers to review source code in the same place they write it: inside their familiar and highly-customized editor. Today, we're excited to share a sneak peek of a new experience that will further enhance in-editor PR reviews with support for **rich, multi-repository code navigations**. diff --git a/docs/editor/command-line.md b/docs/editor/command-line.md index e638e5d7a..bc23f2ce8 100644 --- a/docs/editor/command-line.md +++ b/docs/editor/command-line.md @@ -3,17 +3,17 @@ Order: 15 Area: editor TOCTitle: Command Line ContentId: 8faef870-7a5f-4070-ad17-8ba791006912 -PageTitle: The Visual Studio Code Command Line Options +PageTitle: The Visual Studio Code command-line options DateApproved: 5/15/2019 -MetaDescription: Visual Studio Code command line options (switches). +MetaDescription: Visual Studio Code command-line options (switches). --- # Command Line Interface (CLI) -Visual Studio Code has a powerful command line interface that lets you control how you launch the editor. You can open files, install extensions, change the display language, and output diagnostics through command line options (switches). +Visual Studio Code has a powerful command line interface that lets you control how you launch the editor. You can open files, install extensions, change the display language, and output diagnostics through command-line options (switches). ![command line example](images/command-line/hero.png) -If you are looking for how to run command line tools inside VS Code, see the [Integrated Terminal](/docs/editor/integrated-terminal.md). +If you are looking for how to run command-line tools inside VS Code, see the [Integrated Terminal](/docs/editor/integrated-terminal.md). ## Launching from command line @@ -134,7 +134,7 @@ You can use the URL in applications such as browsers or file explorers that can Read on to find out about: -* [Integrated Terminal](/docs/editor/integrated-terminal.md) - Run command line tools from inside VS Code. +* [Integrated Terminal](/docs/editor/integrated-terminal.md) - Run command-line tools from inside VS Code. * [Basic Editing](/docs/editor/codebasics.md) - Learn the basics of the VS Code editor. * [Code Navigation](/docs/editor/editingevolved.md) - VS Code lets you quickly understand and move through your source code. @@ -148,7 +148,7 @@ On macOS, you need to manually run the **Shell Command: Install 'code' command i ### How do I get access to a command line (terminal) from within VS Code? -VS Code has an [Integrated Terminal](/docs/editor/integrated-terminal.md) where you can run command line tools from within VS Code. +VS Code has an [Integrated Terminal](/docs/editor/integrated-terminal.md) where you can run command-line tools from within VS Code. ### Can I specify the settings location for VS Code in order to have a portable version? diff --git a/docs/editor/extension-gallery.md b/docs/editor/extension-gallery.md index 45bc3c8e9..f774f68d1 100644 --- a/docs/editor/extension-gallery.md +++ b/docs/editor/extension-gallery.md @@ -75,7 +75,7 @@ If you know the exact identifier for an extension you're looking for, you can us ## Manage extensions -VS Code makes it very easy to manage your extensions. You can install, disable, update, and uninstall extensions through the Extensions view, the **Command Palette** (commands have the **Extensions:** prefix) or command line switches. +VS Code makes it very easy to manage your extensions. You can install, disable, update, and uninstall extensions through the Extensions view, the **Command Palette** (commands have the **Extensions:** prefix) or command-line switches. ### List installed extensions @@ -128,7 +128,7 @@ To dismiss a recommendation, click on the extension item to open the Details pan ## Configuring extensions -VS Code extensions may have very different configurations and requirements. Some extensions contribute [settings](/docs/getstarted/settings.md) to VS Code, which can be modified in the Settings editor. Other extensions may have their own configuration files. Extensions may also require installation and setup of additional components like compilers, debuggers, and command line tools. Consult the extension's README (visible in the Extensions view details page) or go to the extension page on the [VS Code Marketplace](https://marketplace.visualstudio.com/VSCode) (click on the extension name in the details page). Many extensions are open source and have a link to their repository on their Marketplace page. +VS Code extensions may have very different configurations and requirements. Some extensions contribute [settings](/docs/getstarted/settings.md) to VS Code, which can be modified in the Settings editor. Other extensions may have their own configuration files. Extensions may also require installation and setup of additional components like compilers, debuggers, and command-line tools. Consult the extension's README (visible in the Extensions view details page) or go to the extension page on the [VS Code Marketplace](https://marketplace.visualstudio.com/VSCode) (click on the extension name in the details page). Many extensions are open source and have a link to their repository on their Marketplace page. ## Command line extension management @@ -209,7 +209,7 @@ Tags may contain any string and are not provided by IntelliSense so review the M You can manually install a VS Code extension packaged in a `.vsix` file. Using the **Install from VSIX** command in the Extensions view command drop-down, or the **Extensions: Install from VSIX** command in the **Command Palette**, point to the `.vsix` file. -You can also install using the VS Code `--install-extension` command line switch providing the path to the `.vsix` file. +You can also install using the VS Code `--install-extension` command-line switch providing the path to the `.vsix` file. ``` code --install-extension myextension.vsix @@ -267,7 +267,7 @@ Extensions are installed in a per user extensions folder. Depending on your plat * **macOS** `~/.vscode/extensions` * **Linux** `~/.vscode/extensions` -You can change the location by launching VS Code with the `--extensions-dir ` command line [option](/docs/editor/command-line.md). +You can change the location by launching VS Code with the `--extensions-dir ` command-line [option](/docs/editor/command-line.md). ### Whenever I try to install any extension, I get a connect ETIMEDOUT error diff --git a/docs/editor/tasks-v1.md b/docs/editor/tasks-v1.md index 6d04d37f1..fd7f43026 100644 --- a/docs/editor/tasks-v1.md +++ b/docs/editor/tasks-v1.md @@ -75,11 +75,11 @@ To see the exact command VS Code is running, you can enable the `echoCommand` se ![tasks echoCommand](images/tasks/tasks-echoCommand.png) ->**Note:** VS Code ships with predefined `tasks.json` templates to run npm, MSBuild, Maven and other command line tools. A great way to learn about tasks is to review these templates and see which tools or task runners are similar to other tools you may be using. +>**Note:** VS Code ships with predefined `tasks.json` templates to run npm, MSBuild, Maven and other command-line tools. A great way to learn about tasks is to review these templates and see which tools or task runners are similar to other tools you may be using. ## command and tasks[] -`tasks.json` takes a single `command` value which can be a task runner like gulp or grunt or any command line tool like a compiler or linter. By default, the `command` will show up in the **Tasks: Run Task** drop-down list. +`tasks.json` takes a single `command` value which can be a task runner like gulp or grunt or any command-line tool like a compiler or linter. By default, the `command` will show up in the **Tasks: Run Task** drop-down list. You can also define multiple tasks in a `tasks` array in order to pass different arguments or use different settings when the `command` is run. diff --git a/docs/editor/userdefinedsnippets.md b/docs/editor/userdefinedsnippets.md index faf6ff575..3a3b20c58 100644 --- a/docs/editor/userdefinedsnippets.md +++ b/docs/editor/userdefinedsnippets.md @@ -60,7 +60,7 @@ The example above has two placeholders, `${1:array}` and `${2:element}`. You can ### Snippet filenames -The file type and name define if a snippet is global or specific to a language. Snippets stored in a JSON file that is named after a [language identifier](/docs/languages/identifiers.md) (`.json`) are language specific. For example, JavaScript-only snippets go in a `javascript.json` file. +The file type and name define if a snippet is global or specific to a language. Snippets stored in a JSON file that is named after a [language identifier](/docs/languages/identifiers.md) (`.json`) are language-specific. For example, JavaScript-only snippets go in a `javascript.json` file. ### Global snippets @@ -99,7 +99,7 @@ Placeholders are tabstops with values, like `${1:foo}`. The placeholder text wil ### Choice -Placeholders can have choices as values. The syntax is a comma separated enumeration of values, enclosed with the pipe-character, for example `${1|one,two,three|}`. When the snippet is inserted and the placeholder selected, choices will prompt the user to pick one of the values. +Placeholders can have choices as values. The syntax is a comma-separated enumeration of values, enclosed with the pipe-character, for example `${1|one,two,three|}`. When the snippet is inserted and the placeholder selected, choices will prompt the user to pick one of the values. ### Variables @@ -195,7 +195,7 @@ Example | Output | Explanation ### Grammar -Below is the EBNF ([extended Backus-Naur form](https://en.wikipedia.org/wiki/Extended_Backus-Naur_form)) for snippets. With `\` (backslash), you can escape `$`, `}` and `\`. Within choice elements, the backslash also escapes comma and pipe characters. +Below is the EBNF ([extended Backus-Naur form](https://en.wikipedia.org/wiki/Extended_Backus-Naur_form)) for snippets. With `\` (backslash), you can escape `$`, `}`, and `\`. Within choice elements, the backslash also escapes comma and pipe characters. ``` any ::= tabstop | placeholder | choice | variable | text @@ -241,7 +241,7 @@ You can create custom [keybindings](/docs/getstarted/keybindings.md) to insert s The keybinding will invoke the **Insert Snippet** command but instead of prompting you to select a snippet, it will insert the provided snippet. You define the custom [keybinding](/docs/getstarted/keybindings.md) as usual with a keyboard shortcut, command id, and optional [when clause context](/docs/getstarted/keybindings.md#when-clause-contexts) for when the keyboard shortcut is enabled. -Also, instead of using the `snippet` argument value to define your snippet inline, you can reference an existing snippet by using the `langId` and `name` arguments : +Also, instead of using the `snippet` argument value to define your snippet inline, you can reference an existing snippet by using the `langId` and `name` arguments: ```json { diff --git a/docs/editor/versioncontrol.md b/docs/editor/versioncontrol.md index 434756733..5c81ecd62 100644 --- a/docs/editor/versioncontrol.md +++ b/docs/editor/versioncontrol.md @@ -205,7 +205,7 @@ Visual Studio Code also supports pull request workflows through [extensions](/do ### I initialized my repo but the actions in the `...` menu are all grayed out -To **push, pull, and sync** you need to have a Git origin set up. You can get the required URL from the repo host. Once you have that URL, you need to add it to the Git settings by running a couple of command line actions. For example: +To **push, pull, and sync** you need to have a Git origin set up. You can get the required URL from the repository host. Once you have that URL, you need to add it to the Git settings by running a couple of command-line actions. For example: ```bash > git remote add origin https://github.com//.git diff --git a/docs/editor/whyvscode.md b/docs/editor/whyvscode.md index ddd78ff23..a331a4607 100644 --- a/docs/editor/whyvscode.md +++ b/docs/editor/whyvscode.md @@ -31,7 +31,7 @@ VS Code also integrates with build and scripting tools to perform common tasks m ## Make it your own -Customize every feature to your liking and install any number of third-party extensions. While most scenarios work "out of the box" with no configuration, VS Code also grows with you, and we encourage you to optimize your experience to suit your unique needs. VS Code is an open source project so you can also contribute to the growing and vibrant community on GitHub. +Customize every feature to your liking and install any number of third-party extensions. While most scenarios work "out of the box" with no configuration, VS Code also grows with you, and we encourage you to optimize your experience to suit your unique needs. VS Code is an open-source project so you can also contribute to the growing and vibrant community on GitHub. ## Built with love for the Web diff --git a/docs/getstarted/locales.md b/docs/getstarted/locales.md index a422d86b0..44516a5f3 100644 --- a/docs/getstarted/locales.md +++ b/docs/getstarted/locales.md @@ -69,15 +69,15 @@ You can have multiple Language Packs installed and select the current display la ## Setting the Language -If you want to use a specific language for a VS Code session, you can use the command line switch `--locale` to specify a locale when you launch VS Code. +If you want to use a specific language for a VS Code session, you can use the command-line switch `--locale` to specify a locale when you launch VS Code. -Below is an example of using the `--locale` command line switch to set the VS Code display language to French: +Below is an example of using the `--locale` command-line switch to set the VS Code display language to French: ```bash code . --locale=fr ``` -**Note**: You must have the appropriate Language Pack installed for the language you specify with the command line switch. If the matching Language Pack is not installed, VS Code will display English. +**Note**: You must have the appropriate Language Pack installed for the language you specify with the command-line switch. If the matching Language Pack is not installed, VS Code will display English. ## Common questions diff --git a/docs/getstarted/userinterface.md b/docs/getstarted/userinterface.md index 87f0180fb..af1b455f4 100644 --- a/docs/getstarted/userinterface.md +++ b/docs/getstarted/userinterface.md @@ -344,7 +344,7 @@ The settings `window.openFoldersInNewWindow` and `window.openFilesInNewWindow` a If configured to be `default`, we will make the best guess about reusing a window or not based on the context from where the open request was made. Flip this to `on` or `off` to always behave the same. For example, if you feel that picking a file or folder from the **File** menu should always open into a new window, set this to `on`. -Note: There can still be cases where this setting is ignored (for example, when using the `-new-window` or `-reuse-window` command line option). +Note: There can still be cases where this setting is ignored (for example, when using the `-new-window` or `-reuse-window` command-line option). The `window.restoreWindows` setting tells VS Code how to restore the opened windows of your previous session. By default, VS Code will reopen the last opened window you worked on (setting: `one`). Change this setting to `none` to never reopen any windows and always start with an empty VS Code instance. Change it to `all` to restore all windows you worked on during your previous session or `folders` to only restore windows that had folders opened. diff --git a/docs/languages/java.md b/docs/languages/java.md index b9102d21f..82d49970c 100644 --- a/docs/languages/java.md +++ b/docs/languages/java.md @@ -11,7 +11,7 @@ MetaDescription: Learn about Visual Studio Code editor features (code completion The Java support in Visual Studio Code is provided through a wide range of [extensions](/docs/editor/extension-gallery.md). By installing extensions, you can have a lightweight and performant code editor which also supports popular Java development tools. VS Code provides essential language features such as code completion, refactoring, linting, formatting, and code snippets along with convenient debugging and unit test support. VS Code can also integrate tooling and frameworks such as Maven, Tomcat, Jetty, and Spring Boot. Leveraging the power of Visual Studio Code, Java developers get an excellent tool for both quick code editing and also the full debugging and testing cycle. It's a great choice for your Java work if you're looking for a tool which: -- Is fast and lightweight, free, and open-source +- Is fast and lightweight, free, and open source - Supports multiple, or all the programming language you use - Helps start your Java journey without installing and learning a complex IDE - Provides great microservices support including popular framework, container tooling and cloud integration diff --git a/docs/nodejs/nodejs-tutorial.md b/docs/nodejs/nodejs-tutorial.md index f0132d11f..0e0f2d8e4 100644 --- a/docs/nodejs/nodejs-tutorial.md +++ b/docs/nodejs/nodejs-tutorial.md @@ -14,7 +14,7 @@ MetaSocialImage: images/nodejs/runtimes_node.png Visual Studio Code has support for the JavaScript and TypeScript languages out-of-the-box as well as Node.js debugging. However, to run a Node.js application, you will need to install the Node.js runtime on your machine. -To get started in this walkthrough, [install Node.js for your platform](https://nodejs.org/en/download/). The Node Package Manager is included in the Node.js distribution. You'll need to open a new terminal (command prompt) for the `node` and `npm` command line tools to be on your PATH. +To get started in this walkthrough, [install Node.js for your platform](https://nodejs.org/en/download/). The Node Package Manager is included in the Node.js distribution. You'll need to open a new terminal (command prompt) for the `node` and `npm` command-line tools to be on your PATH. >**Linux**: There are specific Node.js packages available for the various flavors of Linux. See [Installing Node.js via package manager](https://nodejs.org/en/download/package-manager) to find the Node.js package and installation instructions tailored to your version of Linux. @@ -73,13 +73,13 @@ You should see "Hello World" output to the terminal and then Node.js returns. ### Integrated Terminal -VS Code has an [integrated terminal](/docs/editor/integrated-terminal.md) which you can use to run shell commands. You can run Node.js directly from there and avoid switching out of VS Code while running command line tools. +VS Code has an [integrated terminal](/docs/editor/integrated-terminal.md) which you can use to run shell commands. You can run Node.js directly from there and avoid switching out of VS Code while running command-line tools. **View** > **Terminal** (`kb(workbench.action.terminal.toggleTerminal)` with the backtick character) will open the integrated terminal and you can run `node app.js` there: ![integrated terminal](images/nodejs/integrated-terminal.png) -For this walkthrough, you can use either an external terminal or the VS Code integrated terminal for running the command line tools. +For this walkthrough, you can use either an external terminal or the VS Code integrated terminal for running the command-line tools. ### Debugging Hello World @@ -103,7 +103,7 @@ Now that you've seen VS Code in action with "Hello World", the next section show ## An Express application -[Express](https://expressjs.com/) is a very popular application framework for building and running Node.js applications. You can scaffold (create) a new Express application using the Express Generator tool. The Express Generator is shipped as an npm module and installed by using the npm command line tool `npm`. +[Express](https://expressjs.com/) is a very popular application framework for building and running Node.js applications. You can scaffold (create) a new Express application using the Express Generator tool. The Express Generator is shipped as an npm module and installed by using the npm command-line tool `npm`. >**Tip:** To test that you've got `npm` correctly installed on your computer, type `npm --help` from a terminal and you should see the usage documentation. diff --git a/docs/nodejs/reactjs-tutorial.md b/docs/nodejs/reactjs-tutorial.md index f662eb22e..4092483ce 100644 --- a/docs/nodejs/reactjs-tutorial.md +++ b/docs/nodejs/reactjs-tutorial.md @@ -173,7 +173,7 @@ Try making a small error in your React source code and you'll see a red squiggle Linters can provide more sophisticated analysis, enforcing coding conventions and detecting anti-patterns. A popular JavaScript linter is [ESLint](https://eslint.org/). ESLint, when combined with the ESLint VS Code [extension](https://marketplace.visualstudio.com/items/dbaeumer.vscode-eslint), provides a great in-product linting experience. -First, install the ESLint command line tool: +First, install the ESLint command-line tool: ```bash npm install -g eslint diff --git a/docs/python/linting.md b/docs/python/linting.md index 4ba738347..dc32c507b 100644 --- a/docs/python/linting.md +++ b/docs/python/linting.md @@ -124,7 +124,7 @@ For the complete list of Pylint messages, see [readable-pylint-messages](https:/ ### Command-line arguments and configuration files -See [Pylint command line arguments](https://pylint.readthedocs.io/en/latest/user_guide/run.html#command-line-options) for general switches. Command-line arguments can be used to load Pylint plugins, such as the plugin for Django: +See [Pylint command-line arguments](https://pylint.readthedocs.io/en/latest/user_guide/run.html#command-line-options) for general switches. Command-line arguments can be used to load Pylint plugins, such as the plugin for Django: ```json "python.linting.pylintArgs": ["--load-plugins", "pylint_django"] diff --git a/docs/python/unit-testing.md b/docs/python/unit-testing.md index 698020c3e..ebafe2b0d 100644 --- a/docs/python/unit-testing.md +++ b/docs/python/unit-testing.md @@ -293,7 +293,7 @@ See [unittest command-line interface](https://docs.python.org/3/library/unittest | --- | --- | --- | | pyTestEnabled | `false` | Specifies whether PyTest is enabled as the test framework. All other frameworks should be disabled. | | pyTestPath | `"pytest"` | Path to PyTest. Use a full path if PyTest is located outside the current environment. | -| pyTestArgs | `[]` | Arguments to pass to PyTest, where each element that's separated by a space is a separate item in the list. See [PyTest command line options](https://docs.pytest.org/en/latest/customize.html#command-line-options-and-configuration-file-settings). | +| pyTestArgs | `[]` | Arguments to pass to PyTest, where each element that's separated by a space is a separate item in the list. See [PyTest command-line options](https://docs.pytest.org/en/latest/customize.html#command-line-options-and-configuration-file-settings). | You can also configure pytest using a `pytest.ini` file as described on [PyTest Configuration](https://docs.pytest.org/en/latest/customize.html). diff --git a/docs/remote/faq.md b/docs/remote/faq.md index 9bcba16ed..e184c2a77 100644 --- a/docs/remote/faq.md +++ b/docs/remote/faq.md @@ -129,7 +129,7 @@ You can find the licenses for the VS Code Remote Development extensions here: * [Remote-WSL License](https://marketplace.visualstudio.com/items/ms-vscode-remote.remote-wsl/license) * [Remote-Containers License](https://marketplace.visualstudio.com/items/ms-vscode-remote.remote-containers/license) -### Why aren't the Remote Development extensions or their components open-source? +### Why aren't the Remote Development extensions or their components open source? The Visual Studio Code Remote Development extensions and their related components use an [open planning, issue, and feature request process](https://aka.ms/vscode-remote/feedback), but are not currently open source. The extensions share source code which is also used in fully managed remote development services like [those announced at //build 2019](https://aka.ms/vsfutures). Given that these services also support other proprietary products (for example Visual Studio IDE), the extensions are available under a Microsoft pre-release license like other service-based, cross-product extensions such as [Visual Studio IntelliCode](https://marketplace.visualstudio.com/items/VisualStudioExptTeam.vscodeintellicode/license) and [Visual Studio Live Share](https://marketplace.visualstudio.com/items/MS-vsliveshare.vsliveshare-pack/license) were during their preview periods. diff --git a/docs/setup/network.md b/docs/setup/network.md index 180114750..af504e5a1 100644 --- a/docs/setup/network.md +++ b/docs/setup/network.md @@ -43,7 +43,7 @@ VS Code has exactly the same proxy server support as Google Chromium. Here's a s This means that your proxy settings should be picked up automatically. -Otherwise, you can use the following command line arguments to control your proxy settings: +Otherwise, you can use the following command-line arguments to control your proxy settings: ```bash # Disable proxy @@ -59,7 +59,7 @@ Otherwise, you can use the following command line arguments to control your prox --proxy-bypass-list=(|)[:][;...] ``` -[Click here](https://www.chromium.org/developers/design-documents/network-settings) to know more about these command line arguments. +[Click here](https://www.chromium.org/developers/design-documents/network-settings) to know more about these command-line arguments. ### Authenticated proxies @@ -85,8 +85,8 @@ Note that SOCKS5 proxy authentication support isn't implemented yet; you can fol Often HTTPS proxies rewrite SSL certificates of the incoming requests. Chromium was designed to reject responses which are signed by certificates which it doesn't trust. If you hit any SSL trust issues, there are a few options available for you: * Since Chromium simply uses the OS's certificate trust infrastructure, the preferred option is to add your proxy's certificate to your OS's trust chain. [Click here](https://www.chromium.org/Home/chromium-security/root-ca-policy) to read more about the Root Certificate Policy in Chromium. -* If your proxy runs in `localhost`, you can always try the [`--allow-insecure-localhost`](https://peter.sh/experiments/chromium-command-line-switches/#allow-insecure-localhost) command line flag. -* If all else fails, you can tell VS Code to ignore all certificate errors using the [`--ignore-certificate-errors`](https://peter.sh/experiments/chromium-command-line-switches/#ignore-certificate-errors) command line flag. **Warning:** This is **dangerous** and **not recommended**, since it opens the door to security issues. +* If your proxy runs in `localhost`, you can always try the [`--allow-insecure-localhost`](https://peter.sh/experiments/chromium-command-line-switches/#allow-insecure-localhost) command-line flag. +* If all else fails, you can tell VS Code to ignore all certificate errors using the [`--ignore-certificate-errors`](https://peter.sh/experiments/chromium-command-line-switches/#ignore-certificate-errors) command-line flag. **Warning:** This is **dangerous** and **not recommended**, since it opens the door to security issues. ## Legacy proxy server support diff --git a/docs/setup/windows.md b/docs/setup/windows.md index efbce34a8..6d1a15081 100644 --- a/docs/setup/windows.md +++ b/docs/setup/windows.md @@ -51,7 +51,7 @@ Once you have installed VS Code, these topics will help you learn more about VS ### What command-line arguments are supported by the Windows Setup? VS Code uses [Inno Setup](http://www.jrsoftware.org/isinfo.php) to create its setup package -for Windows. Thus, all the [Inno Setup command line switches](http://www.jrsoftware.org/ishelp/index.php?topic=setupcmdline) are available for use. +for Windows. Thus, all the [Inno Setup command-line switches](http://www.jrsoftware.org/ishelp/index.php?topic=setupcmdline) are available for use. Additionally, you can prevent the Setup from launching VS Code after completion with `/mergetasks=!runcode`. diff --git a/docs/supporting/faq.md b/docs/supporting/faq.md index 165b8a66e..d79a53c0f 100644 --- a/docs/supporting/faq.md +++ b/docs/supporting/faq.md @@ -65,7 +65,7 @@ You can find the VS Code licenses, third party notices and [Chromium](https://ww ### Why does Visual Studio Code have a different license than the vscode GitHub repository? -To learn why Visual Studio Code, the product, has a different license than vscode, the open source [GitHub repository](https://github.com/microsoft/vscode), see [issue #60](https://github.com/Microsoft/vscode/issues/60#issuecomment-161792005) for a detailed explanation. +To learn why Visual Studio Code, the product, has a different license than vscode, the open-source [GitHub repository](https://github.com/microsoft/vscode), see [issue #60](https://github.com/Microsoft/vscode/issues/60#issuecomment-161792005) for a detailed explanation. ### What is the difference between the `vscode` repository and the Microsoft Visual Studio Code distribution? @@ -77,11 +77,11 @@ See the [Visual Studio Code and 'Code - OSS' Differences](https://github.com/mic ### What does "Built on Open Source" mean? -[Microsoft Visual Studio Code](https://code.visualstudio.com) is a [Microsoft licensed](https://code.visualstudio.com/License/) distribution of ['Code - OSS'](https://github.com/Microsoft/vscode) that includes Microsoft proprietary assets (such as icons) and features (Visual Studio Marketplace integration, small aspects of enabling Remote Development). While these distribution additions make up a very small percentage of the overall distribution code base, it is more accurate to say that Visual Studio Code is "built" on open source, rather than "is" open source, because of these differences. More information on what each distribution includes can be found in the [Visual Studio Code and 'Code - OSS' Differences](https://github.com/microsoft/vscode/wiki/Distro-Diffs) article. +[Microsoft Visual Studio Code](https://code.visualstudio.com) is a [Microsoft licensed](https://code.visualstudio.com/License/) distribution of ['Code - OSS'](https://github.com/Microsoft/vscode) that includes Microsoft proprietary assets (such as icons) and features (Visual Studio Marketplace integration, small aspects of enabling Remote Development). While these additions make up a very small percentage of the overall distribution code base, it is more accurate to say that Visual Studio Code is "built" on open source, rather than "is" open source, because of these differences. More information on what each distribution includes can be found in the [Visual Studio Code and 'Code - OSS' Differences](https://github.com/microsoft/vscode/wiki/Distro-Diffs) article. ## Are all Visual Studio Code extensions open source? -Extension authors are free to choose a license that fits their business needs. While many extension authors have opted to release their source code under an open source license, some extensions like [Wallaby.js](https://marketplace.visualstudio.com/items?itemName=WallabyJs.wallaby-vscode), [Google Cloud Code](https://marketplace.visualstudio.com/items?itemName=GoogleCloudTools.cloudcode), and the [VS Code Remote Development](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack) extensions use proprietary licenses. +Extension authors are free to choose a license that fits their business needs. While many extension authors have opted to release their source code under an open-source license, some extensions like [Wallaby.js](https://marketplace.visualstudio.com/items?itemName=WallabyJs.wallaby-vscode), [Google Cloud Code](https://marketplace.visualstudio.com/items?itemName=GoogleCloudTools.cloudcode), and the [VS Code Remote Development](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack) extensions use proprietary licenses. At Microsoft, we open source our extensions whenever possible. However, reliance on existing proprietary source code or libraries, source code that crosses into Microsoft licensed tools (Visual Studio) or services, and business model differences across the entirety of Microsoft will result in some extensions using a proprietary license. You can find a list of Microsoft contributed Visual Studio Code extensions and their licenses in the [Microsoft Extension Licenses](/docs/supporting/oss-extensions.md) article. @@ -103,7 +103,7 @@ When you open a folder, VS Code will search for typical project files to offer y ## VS Code is blank? -The Electron shell used by Visual Studio Code has trouble with some GPU (graphics processing unit) hardware acceleration. If VS Code is displaying a blank (empty) main window, you can try disabling GPU acceleration when launching VS Code by adding the Electron `--disable-gpu` command line switch. +The Electron shell used by Visual Studio Code has trouble with some GPU (graphics processing unit) hardware acceleration. If VS Code is displaying a blank (empty) main window, you can try disabling GPU acceleration when launching VS Code by adding the Electron `--disable-gpu` command-line switch. ```bash code --disable-gpu diff --git a/release-notes/v0_3_0.md b/release-notes/v0_3_0.md index 70074febd..c88972f13 100644 --- a/release-notes/v0_3_0.md +++ b/release-notes/v0_3_0.md @@ -81,7 +81,7 @@ To improve readability, you can now control how long lines are wrapped and inden ![WrappingIndent set to indent](images/0_3_0/WrappingIndentIndent.png) ## Debugging -In launch configurations, you can now use the `runtimeArgs` attribute. This is useful if you need to pass command line arguments to Node or Mono (not to the program being debugged). +In launch configurations, you can now use the `runtimeArgs` attribute. This is useful if you need to pass command-line arguments to Node or Mono (not to the program being debugged). Starting a debug session on Linux now opens a terminal with support for input/output. diff --git a/release-notes/v0_5_0.md b/release-notes/v0_5_0.md index 2928a91b8..6d3ef4573 100644 --- a/release-notes/v0_5_0.md +++ b/release-notes/v0_5_0.md @@ -26,11 +26,11 @@ New file-based enhancements make it easier to link VS Code into your workflow wi >**Note:** In the Editor Options section below, we show how you can hide derived resources in the Explorer, update the size of the Working Files area and exclude files from Search. -**New command line options: -r and -g** +**New command-line options: -r and -g** -* The `-r` (or `--reuse-window`) command line option forces opening a file or folder in the last active window. This is useful in cases where you want to quickly send a file from the command line into your workspace, without having to manage new windows each time. This also works with files that don't exist - VS Code will simply open a new file as dirty in the last active window. +* The `-r` (or `--reuse-window`) command-line option forces opening a file or folder in the last active window. This is useful in cases where you want to quickly send a file from the command line into your workspace, without having to manage new windows each time. This also works with files that don't exist - VS Code will simply open a new file as dirty in the last active window. -* The `-g` (or `--goto`) command line option lets you open files at a specific line and column number. This is useful if you're using another tool in your workflow and want VS Code to open an exact position within a file.
The syntax is:
`code -g file1:: file2:: file3::`
The `column` value is optional. As shown in the example, you can open multiple files in a single VS Code instance using the desired line and column position. Note that `"-g"` switch is mandatory for this feature, since `:` is a valid character in file names on some operating systems.
+* The `-g` (or `--goto`) command-line option lets you open files at a specific line and column number. This is useful if you're using another tool in your workflow and want VS Code to open an exact position within a file.
The syntax is:
`code -g file1:: file2:: file3::`
The `column` value is optional. As shown in the example, you can open multiple files in a single VS Code instance using the desired line and column position. Note that `"-g"` switch is mandatory for this feature, since `:` is a valid character in file names on some operating systems.
Here's how to open a file to line 10, column 17:
`code -g c:\mycode\HelloWorld.ts:10:17`
>**Tip:** If you combine `-r` and `-g` you can configure an external tool to open files on a specific line and column into your running VS Code instance! This was a popular request from the Unity user base. @@ -39,7 +39,7 @@ Here's how to open a file to line 10, column 17:
`code -g c:\mycode\HelloWor When you pass multiple file paths to VS Code, they will all open in the same instance now. If some of the paths point to files that don't exist, VS Code will open new files as dirty. -When you pass in command line arguments for the path to a folder, and also a file name, VS Code will open both the folder and file in a single VS Code instance. Previously we would open two (or more) VS Code instances. The usage case is that you want to open a specific file in a folder while still opening the folder in the side bar. +When you pass in command-line arguments for the path to a folder, and also a file name, VS Code will open both the folder and file in a single VS Code instance. Previously we would open two (or more) VS Code instances. The usage case is that you want to open a specific file in a folder while still opening the folder in the side bar. Note that you can use absolute paths or relative paths for the folder argument and the file argument. If you use a relative path for the file argument, it is relative to where you start VS Code (not relative to the folder argument). diff --git a/release-notes/v1_11.md b/release-notes/v1_11.md index 55cfe910b..676d71a16 100644 --- a/release-notes/v1_11.md +++ b/release-notes/v1_11.md @@ -409,7 +409,7 @@ In a collaboration with the Visual Studio Marketplace, we've increased the size ### Startup profiling for everyone -We have added a new command line option that allows you to profile the startup of VS Code. Run code like this `code --prof-startup` and it will create profiles for the main and renderer process. These profiles are stored in your home directory and we encourage you to share them with us. Often performance out in the wild is vastly different from our machines and getting more insights from you will help us improve VS Code. +We have added a new command-line option that allows you to profile the startup of VS Code. Run code like this `code --prof-startup` and it will create profiles for the main and renderer process. These profiles are stored in your home directory and we encourage you to share them with us. Often performance out in the wild is vastly different from our machines and getting more insights from you will help us improve VS Code. ### Coming Soon: Support for community localization diff --git a/release-notes/v1_15.md b/release-notes/v1_15.md index 2c781fd3a..3fb517843 100644 --- a/release-notes/v1_15.md +++ b/release-notes/v1_15.md @@ -159,7 +159,7 @@ There is a new setting `window.closeWhenEmpty` to control if the window (instanc ### Improved --wait support -VS Code can be configured as the editor for external programs such as Git (see our [documentation](https://code.visualstudio.com/docs/editor/versioncontrol#_vs-code-as-git-editor) ). For that purpose, the `--wait` command line argument is used to keep the VS Code instance open until the external program is closed. In this release, we re-implemented this feature to work around some known issues. +VS Code can be configured as the editor for external programs such as Git (see our [documentation](https://code.visualstudio.com/docs/editor/versioncontrol#_vs-code-as-git-editor) ). For that purpose, the `--wait` command-line argument is used to keep the VS Code instance open until the external program is closed. In this release, we re-implemented this feature to work around some known issues. First of all, we will now remember which instance was opened with `--wait` and properly wait for that instance to close. This fixes annoying issues when `--wait` is used while VS Code is already running as well as when you open a first instance and then more windows afterwards without closing the first window. In addition, on macOS where closing a window typically does not quit the application, we are now also returning control to the process that started the instance once it gets closed. diff --git a/release-notes/v1_16.md b/release-notes/v1_16.md index a41ebdfa8..321e69135 100644 --- a/release-notes/v1_16.md +++ b/release-notes/v1_16.md @@ -378,7 +378,7 @@ We expanded the ways to create a multi-root workspace in VS Code. **Command line** -There is a new command line argument `--add`. Use it to add folders on the command line to the currently active window. The new folder argument should be provided as a path. This works for an empty workspace, a single-folder workspace, as well as an existing multi-root workspace. +There is a new command-line argument `--add`. Use it to add folders on the command line to the currently active window. The new folder argument should be provided as a path. This works for an empty workspace, a single-folder workspace, as well as an existing multi-root workspace. If you provide multiple folders to open from the command line, we used to open each folder in a separate window. Now, we automatically create a workspace for you and open all folders into a single window. @@ -501,7 +501,7 @@ Contributions to `vscode`: * [David McKay (@rawkode)](https://github.com/rawkode): Added oxford comma and fixed macOS spelling [PR #30912](https://github.com/Microsoft/vscode/pull/30912) * [Ron Buckton (@rbuckton)](https://github.com/rbuckton): Update Promise definition [PR #30268](https://github.com/Microsoft/vscode/pull/30268) * [Robert Pethick (@RobPethick)](https://github.com/RobPethick): Add publishsettings to list of xml file types [PR #32641](https://github.com/Microsoft/vscode/pull/32641) -* [Adrian (@Sakerdot)](https://github.com/Sakerdot): Modifying report issues url to include command line options and smarter extensions table [PR #33225](https://github.com/Microsoft/vscode/pull/33225) +* [Adrian (@Sakerdot)](https://github.com/Sakerdot): Modifying report issues url to include command-line options and smarter extensions table [PR #33225](https://github.com/Microsoft/vscode/pull/33225) * [Nikolai Vavilov (@seishun)](https://github.com/seishun): Use r+ with truncation when saving existing files [PR #31733](https://github.com/Microsoft/vscode/pull/31733) * [Ryan Stringham (@stringham)](https://github.com/stringham): Keep undo history even when file changes outside Code. [PR #29655](https://github.com/Microsoft/vscode/pull/29655) * [J.R. Maingat (@tagniam)](https://github.com/tagniam): Fix grammar for update alert [PR #32814](https://github.com/Microsoft/vscode/pull/32814) diff --git a/release-notes/v1_19.md b/release-notes/v1_19.md index 9840f3262..435921471 100644 --- a/release-notes/v1_19.md +++ b/release-notes/v1_19.md @@ -84,7 +84,7 @@ VS Code supports following log levels: * `trace` * `off` -By default, VS Code is configured with `info` level and logs `info` and the levels above (`warn`, `error`, `critical`). You can change the log level using the command line argument `--log`. +By default, VS Code is configured with `info` level and logs `info` and the levels above (`warn`, `error`, `critical`). You can change the log level using the command-line argument `--log`. ```bash --log @@ -93,9 +93,9 @@ By default, VS Code is configured with `info` level and logs `info` and the leve You can also turn off logging using the option `--log off`. -### --status command line option +### --status command-line option -A new command line argument was added which prints some useful VS Code diagnostics information to the terminal. You can share this information with us in GitHub issues and we will have a better understanding of the state of VS Code at the time of the issue. +A new command-line argument was added which prints some useful VS Code diagnostics information to the terminal. You can share this information with us in GitHub issues and we will have a better understanding of the state of VS Code at the time of the issue. Run `code --status` from the command line while another instance of VS Code is running and, after collecting status, you will see a display like this: @@ -105,7 +105,7 @@ The output includes information about the environment, all running processes, an ### VS Code process view -As a by-product of the new VS Code command line option `--status`, we created an experimental extension [vscode-processes](https://github.com/weinand/vscode-processes) that shows all child processes of VS Code in a custom view and dynamically updates as processes come and go. To better understand the role of those processes, the extension analyses the process arguments and labels the processes accordingly. The extension's CPU load and memory consumption is also shown in parentheses. +As a by-product of the new VS Code command-line option `--status`, we created an experimental extension [vscode-processes](https://github.com/weinand/vscode-processes) that shows all child processes of VS Code in a custom view and dynamically updates as processes come and go. To better understand the role of those processes, the extension analyses the process arguments and labels the processes accordingly. The extension's CPU load and memory consumption is also shown in parentheses. ![Process View](images/1_19/vscode-processes.gif) diff --git a/release-notes/v1_26.md b/release-notes/v1_26.md index e2b12af58..6c8ffb773 100644 --- a/release-notes/v1_26.md +++ b/release-notes/v1_26.md @@ -112,7 +112,7 @@ You can now run an npm script in a `package.json` file from the hover as shown b ### Opening folder URIs -You can now open an URI as a folder in VS Code, if there is an extension contributing a `FileSystemProvider` for that URI. We introduced a new command line argument `--folder-uri` to do this. +You can now open an URI as a folder in VS Code, if there is an extension contributing a `FileSystemProvider` for that URI. We introduced a new command-line argument `--folder-uri` to do this. The following CLI command opens the VS Code GitHub repository as a folder, if you have [RemoteHub](https://marketplace.visualstudio.com/items?itemName=eamodio.remotehub) extension installed. diff --git a/release-notes/v1_34.md b/release-notes/v1_34.md index ae8bc6fe5..cff87a91a 100644 --- a/release-notes/v1_34.md +++ b/release-notes/v1_34.md @@ -99,7 +99,7 @@ Other improvements include reduced memory usage and import path completion. You In this milestone, we've added support for debugging more than one extension at a time. This is useful if you are developing a set of tightly coupled or interdependent extensions. -Previously this feature was only surfaced via the command-line interface of VS Code, now the argument `--extensionDevelopmentPath` can be specified more than once. Typically `--extensionDevelopmentPath` is used in the launch configuration of an extension. When developing more than one extension, we recommend combining the individual extension projects into a multi-folder workspace and create a new launch configuration (stored in the workspace `.code-workspace` file) that uses multiple `--extensionDevelopmentPath` arguments for the individual extensions. +Previously this feature was only surfaced via the command line interface of VS Code, now the argument `--extensionDevelopmentPath` can be specified more than once. Typically `--extensionDevelopmentPath` is used in the launch configuration of an extension. When developing more than one extension, we recommend combining the individual extension projects into a multi-folder workspace and create a new launch configuration (stored in the workspace `.code-workspace` file) that uses multiple `--extensionDevelopmentPath` arguments for the individual extensions. Here is an example workspace `.code-workspace` file with two extensions, `hello1` and `hello2`, and a single launch configuration for both extensions: @@ -248,7 +248,7 @@ Contributions to `vscode`: * [Muhammed Emin TİFTİKÇİ (@jaqra)](https://github.com/jaqra): Added title case transformation command called 'Transform to Title Case'. [PR #70990](https://github.com/microsoft/vscode/pull/70990) * [Jimi (Dimitris) Charalampidis (@JimiC)](https://github.com/JimiC): [themes] Fix explorer arrows notification on reload [PR #71855](https://github.com/microsoft/vscode/pull/71855) * [Jon Bockhorst (@jmbockhorst)](https://github.com/jmbockhorst) - * Fixed command line args with leading zeros [PR #71581](https://github.com/microsoft/vscode/pull/71581) + * Fixed command-line args with leading zeros [PR #71581](https://github.com/microsoft/vscode/pull/71581) * Fixed explorer modified sort order not working in some cases [PR #72501](https://github.com/microsoft/vscode/pull/72501) * [Johannes Wikman (@jwikman)](https://github.com/jwikman): FindInFiles converted to command and accepting arguments [PR #71626](https://github.com/microsoft/vscode/pull/71626) * [Jiaxun Wei (@LeuisKen)](https://github.com/LeuisKen): fix #72187 [PR #72194](https://github.com/microsoft/vscode/pull/72194) diff --git a/release-notes/v1_9.md b/release-notes/v1_9.md index e2400e164..6140fb035 100644 --- a/release-notes/v1_9.md +++ b/release-notes/v1_9.md @@ -144,7 +144,7 @@ When VS Code is already running and you open a new file or folder, it decides wh If configured to be `default`, VS Code still makes the best guess about reusing a window based on the context of the open request. Change the settings to either `on` or `off` if you want always want the same behavior. For example, if you always want a new window when picking a file or folder from the **File** menu, set this to `on`. -Note: There can still be cases where this setting is ignored (for example, when using the `-new-window` or `-reuse-window` command line option). +Note: There can still be cases where this setting is ignored (for example, when using the `-new-window` or `-reuse-window` command-line option). ### Control the dimensions of new windows diff --git a/release-notes/vInsiders.md b/release-notes/vInsiders.md deleted file mode 100644 index cf509b5da..000000000 --- a/release-notes/vInsiders.md +++ /dev/null @@ -1,19 +0,0 @@ -# May 2017 (version 1.13) - -## Insiders Release - -Welcome to the Insiders build. These are the preliminary notes for the May 1.13 release of Visual Studio Code. As we get closer to the release date, you'll see details below about new features and important fixes. - -Until the May release notes are available, you can still track our progress: - -* **[Commit Log](https://github.com/Microsoft/vscode/commits/master)** - GitHub commits to the vscode open source repository. -* **[Closed bugs](https://github.com/Microsoft/vscode/issues?q=is%3Aissue+label%3Abug+milestone%3A%22May+2017%22+is%3Aclosed)** - Resolved bugs in the April milestone. -* **[Closed feature requests](https://github.com/Microsoft/vscode/issues?q=is%3Aissue+milestone%3A%22May+2017%22+is%3Aclosed+label%3Afeature-request)** - Implemented feature requests. - -We really appreciate people taking a look at our new features as soon as they are ready so check back here often and learn what's new to try out. - -If you find issues or have suggestions, you can enter them in the VS Code repository on [GitHub](https://github.com/Microsoft/vscode/issues). - - - - diff --git a/tutorials/app-service-extension/create-app.md b/tutorials/app-service-extension/create-app.md index cc83e67aa..43a187511 100644 --- a/tutorials/app-service-extension/create-app.md +++ b/tutorials/app-service-extension/create-app.md @@ -15,7 +15,7 @@ Next, create a simple Node.js application that can be deployed to the Cloud. Thi ## Install the Express generator [Express](https://www.expressjs.com) is an extremely popular framework for building and running Node.js applications. You can scaffold (create) a new -Express application using the [Express Generator](https://expressjs.com/en/starter/generator.html) tool. The Express Generator is shipped as an npm module and installed by using the npm command line tool `npm`. +Express application using the [Express Generator](https://expressjs.com/en/starter/generator.html) tool. The Express Generator is shipped as an npm module and installed by using the npm command-line tool `npm`. ```bash $ npm install -g express-generator diff --git a/tutorials/nodejs-deployment/express.md b/tutorials/nodejs-deployment/express.md index 04080abf5..3d0e6bf9b 100644 --- a/tutorials/nodejs-deployment/express.md +++ b/tutorials/nodejs-deployment/express.md @@ -16,7 +16,7 @@ In this step, you will create a very simple Node.js application that can be depl ## Install the Express Generator -[Express](https://www.expressjs.com) is a very popular framework for building and running Node.js applications. You can scaffold (create) a new Express application using the [Express Generator](https://expressjs.com/en/starter/generator.html) tool. The Express Generator is shipped as an npm module and installed by using the npm command line tool `npm`. +[Express](https://www.expressjs.com) is a very popular framework for building and running Node.js applications. You can scaffold (create) a new Express application using the [Express Generator](https://expressjs.com/en/starter/generator.html) tool. The Express Generator is shipped as an npm module and installed by using the npm command-line tool `npm`. ```bash $ npm install -g express-generator