microsoft/vscode-docs

Public documentation for Visual Studio Code

vscode-docs's Issues

Disable CSS Linting

From @cfjedimaster on December 16, 2015 19:59

I'm working on an extension that supports CSSLint. While you can disable VSC's linting of JS files (https://code.visualstudio.com/docs/languages/javascript#_javascript-linters-eslint-jshint), you can't disable VSC's CSS linting.

Copied from original issue: microsoft/vscode#1392

[email protected]

[email protected]

Minimize code

This would be a nice feature.

Unknown option listed in ES6 Support docs

In the "ES6 Support" section of the Languages --> JavaScript docs, there's mention of a javescript.validate._surpressSuperWithoutSuperTypeError option. This doesn't seem to exist.

Windows setup tip for running from console on git bash incorrect

Hi,

I believe this used to just work - but with 10.6:

In a git bash terminal for instance, running "code ." does not work - you need to run "code.cmd ." This is not an issue in a windows command prompt.

The docs should indicate this, since I'd guess a lot of will be in alternative terminals.

Does Visual Studio Code include npm?

The office add-in page claims VSCode includes npm.

https://code.visualstudio.com/Docs/runtimes/office

However I can't seem to find it in my install. I don't have node.js installed.

From the link:

Prerequisites

To run the Yeoman Office Add-in generator, you need a few things:

• NPM (Visual Studio Code includes this)

Dead link to docs/extensionAPI/vscode-api.md

This file https://github.com/Microsoft/vscode-docs/blob/master/docs/extensionAPI/overview.md
links to this: https://github.com/Microsoft/vscode-docs/blob/master/docs/extensionAPI/vscode-api.md

So there is no API documentation currently available.

How to run Visual Studio Code

I have installed visual studio code on mac but I do not know how to run the code. Could you tell me how to do it? My email address is [email protected]. Thanks.

Documentation issue for Extensions, LanguageServer

Moving issue microsoft/vscode#93 from @cfjedimaster to vscode-docs:

On this page, https://code.visualstudio.com/docs/extensions/example-language-server, debugging the server is described like so:

"Since the server is started by the LanguageClient running the extension we need to attach a debugger to the running server. To do so switch to the VS Code instance containing the server code and press F5. This will attach the debugger to the server. Use the normal Debug View to interact with the running server."

I've tried this multiple times now and every time I do, the server fails to debug. I get this error:

cannot connect to runtime process (timeout after 5000ms)

Command Palette instructions missing for dnu restore

In the RUNTIMES --> ASP.NET 5 doc, the "Scaffolding your first Application" section mentions executing the dnu restore command from the terminal. Is it worth mentioning that an alternative to this approach is to execute the command from Command Palette using the dnx: Restore Packages option?

How to integrate the visual studio code with TFS?

How to config the setting for integrating the visual studio code with TFS?

[0.9.0] debug: update launch.json

We need to update comments in launch.json on https://code.visualstudio.com/Docs/editor/debugging
Updated comments can be found in launchConfigSample.json in our repo

Add API commands to doc

Since lately we have a way to annotate commands and to collect and bump that information. The next step is to add this info to the doc on code.visualstudio.com. I would propose the 'Extensibility reference' sections.

Since, the command doc is dynamic the product needs to be started and a generator command must be fun. I have added this to my keybindings.json file

    {
        "key": "cmd+j cmd+j",
        "command": "_generateCommandsDocumentation"
    }

When invoked, it will print this to the console:

`vscode.executeWorkspaceSymbolProvider` - Execute all workspace symbol provider.

* _query_ 
* _(returns)_ A promise that resolves to an array of SymbolInformation-instances.


`vscode.executeDefinitionProvider` - Execute all definition provider.

* _uri_ Uri of a text document
* _position_ Position of a symbol
* _(returns)_ A promise that resolves to an array of Location-instances.


`vscode.executeHoverProvider` - Execute all definition provider.

* _uri_ Uri of a text document
* _position_ Position of a symbol
* _(returns)_ A promise that resolves to an array of Hover-instances.


`vscode.executeDocumentHighlights` - Execute document highlight provider.

* _uri_ Uri of a text document
* _position_ Position in a text document
* _(returns)_ A promise that resolves to an array of DocumentHighlight-instances.


`vscode.executeReferenceProvider` - Execute reference provider.

* _uri_ Uri of a text document
* _position_ Position in a text document
* _(returns)_ A promise that resolves to an array of Location-instances.


`vscode.executeDocumentRenameProvider` - Execute rename provider.

* _uri_ Uri of a text document
* _position_ Position in a text document
* _newName_ The new symbol name
* _(returns)_ A promise that resolves to a WorkspaceEdit.


`vscode.executeSignatureHelpProvider` - Execute signature help provider.

* _uri_ Uri of a text document
* _position_ Position in a text document
* _(returns)_ A promise that resolves to SignatureHelp.


`vscode.executeDocumentSymbolProvider` - Execute document symbol provider.

* _uri_ Uri of a text document
* _(returns)_ A promise that resolves to an array of SymbolInformation-instances.


`vscode.executeCompletionItemProvider` - Execute completion item provider.

* _uri_ Uri of a text document
* _position_ Position in a text document
* _(returns)_ A promise that resolves to an array of CompletionItem-instances.


`vscode.executeCodeActionProvider` - Execute code action provider.

* _uri_ Uri of a text document
* _range_ Range in a text document
* _(returns)_ A promise that resolves to an array of CompletionItem-instances.


`vscode.executeCodeLensProvider` - Execute completion item provider.

* _uri_ Uri of a text document
* _(returns)_ A promise that resolves to an array of Commands.


`vscode.executeFormatDocumentProvider` - Execute document format provider.

* _uri_ Uri of a text document
* _options_ Formatting options
* _(returns)_ A promise that resolves to an array of TextEdits.


`vscode.executeFormatRangeProvider` - Execute range format provider.

* _uri_ Uri of a text document
* _range_ Range in a text document
* _options_ Formatting options
* _(returns)_ A promise that resolves to an array of TextEdits.


`vscode.executeFormatOnTypeProvider` - Execute document format provider.

* _uri_ Uri of a text document
* _position_ Position in a text document
* _ch_ Character that got typed
* _options_ Formatting options
* _(returns)_ A promise that resolves to an array of TextEdits.


`editor.action.showReferences` - Show references at a position in a file

* _uri_ The text document in which to show references
* _position_ The position at which to show
* _locations_ An array of locations.

Edit button available for page with dynamic content

docs/extensionAPI/vscode-api has an edit button, but it seems that the page is actually defined in this template which is just a dynamically populated {{ Content }} block meaning it is not editable.

This also means that when contributors find bugs such as #88 they cannot contribute fixes.

Add copyable hyperlink to each header

Popular documentation like reactjs and asp.net add links to each of their headers. This is useful for referencing to a specific part of our documentation.

[0.9.0] update markdown preview screenshot

Can we update the screenshot on https://code.visualstudio.com/Docs/languages/markdown with latest version? We did quite some CSS polish to make sure it looks good especially when you have embedded code.

vscode.extensions.getConfigurationMemento() does not exist

The contribution points documentation refers to vscode.extensions.getConfigurationMemento() which doesn't appear to exist. The Go extension instead uses vscode.workspace.getConfiguration('go'), is that the correct alternative?

Receive event when vscode quit

I'm developing an extension, is there a way to receive an event when vscode quit?

Unauthorized 401

Im getting this error when trying to create a new publisher:

vsce create-publisher bialikover
Publisher human-friendly name: (bialikover) Adan G Galvan Gonzalez
Personal Access Token: ****************************************************

Error: Failed Request: Unauthorized(401) - https://marketplace.visualstudio.com/_apis/gallery

Tried creating a new token and also with quotes (") in publisher name : "bialikover" and friendly name: "Adan G Galvan Gonzalez"

Markdown to HTML conversion issue on the docs/tools/vscecli.md page of the official website

Hi,

The docs/tools/vscecli.md file does not seems to be rendered correctly on the official website: https://code.visualstudio.com/docs/tools/vscecli

The <publisher> parts of the vsce create-publisher <publisher> and vsce login <publisher> commands are missing.

From what I've understood, <publisher> seems to be interpreted as an HTML tag during the conversion from Markdown.

Here is the HTML output I have with Chrome:

<code>vsce create-publisher <publisher>
</publisher></code>

https://code.visualstudio.com/docs/editor/codebasics not rendering Mac Cmd properly

It's showing up as kbstyle(), e.g., "holding the Ctrl (Mac: kbstyle()) key".

Move "Extensions Gallery" under Customization header

It makes more sense to me to have Extensions Gallery in customization instead of Editor. Maybe I'm in the minority...

Extensions: Describe how to use async/await and the constraints

See microsoft/vscode#1556

Add a PHP section under Languages

Add the information from the release notes for how to setup PHP validation in there:

Language - PHP
VS Code is now using the official PHP linter (php -l) for PHP language diagnostics. VS Code will now stay current with PHP linter improvements.

There are two new settings to control the PHP linter:

php.validate.executablePath: points to the PHP executable on disk. Set this if the PHP executable is not on the system path.
php.validate.run: controls whether the validation is triggered on save (value: "onSave") or on type (value: "onType"). Default is on save.

docs/extensionAPI/vscode-api#_extensions has a misformed code block

The underlying markdown HTML is visible rather than the intended code-block output as shown below.

Error in the SASS/LESS -> CSS guide

From @malisbad on December 17, 2015 4:53

There is an error in your SCSS/LESS - > CSS guide. The task shouldn't have the ">" in the task runner (anymore?). If you follow the guide, it writes the compiled .css to the ">". If you remove it, it writes to "styles.css" correctly.

Copied from original issue: microsoft/vscode#1401

bug : the latest version do not suppot xml file

Add docs on how to test debug adapters in a CI environment

In the mock-debug adapter for example is a test folder included with a dummy mocha test. But how can one actually test VS Code extensions and debug adapters? Especially with something like Travis CI.

Getting more done in GitHub with ZenHub

Hola! @BinaryCodeTerrorr has created a ZenHub account for the Microsoft organization. ZenHub is the leading team collaboration and project management solution built for GitHub.

---

How do I use ZenHub?

To get set up with ZenHub, all you have to do is download the browser extension and log in with your GitHub account. Once you do, you’ll get access to ZenHub’s complete feature-set immediately.

What can ZenHub do?

ZenHub adds a series of enhancements directly inside the GitHub UI:

• Real-time, customizable task boards for GitHub issues;
• Burndown charts, estimates, and velocity tracking based on GitHub Milestones;
• Personal to-do lists and task prioritization;
• “+1” button for GitHub issues and comments;
• Drag-and-drop file sharing;
• Time-saving shortcuts like a quick repo switcher.

Add ZenHub to GitHub

Still curious? See more ZenHub features or read user reviews. This issue was written by your friendly ZenHub bot, posted by request from @BinaryCodeTerrorr.

Preprocessor support: Stylus

I was hoping to get support for Stylus

Thanks

Document the different options for integrating languages

In the documentation we currently only describe the language service server using a common language protocol integration approach. We should describe the different options and their tradeoffs:

• stateful language service server common protocol, examples: PowerShell, eslint, jshint, tsliint
• stateful language service server custom protocol with a client adapter, examples: TypeScript, OmniSharp
• stateless language service, spawn a CLI language tool per request, exampes: PHP, Go_, flow_

Behind the CLI interface Go and Flow use stateful 'demon' process.

"Edit on GitHub" links are broken

Page URL ---> https://code.visualstudio.com/docs/editor/setup
Incorrect Edit URL ---> https://github.com/Microsoft/vscode-docs/blob/master/editor/setup.md
Correct Edit URL ---> https://github.com/Microsoft/vscode-docs/blob/master/docs/editor/setup.md

TypeScript Docs are false

Hi,
Step 2 of https://code.visualstudio.com/docs/languages/typescript says:

Step 2: Create tasks.json
The next step is to set up the task configuration. To do this open the Command Palette with ⇧⌘P and type in Configure Task Runner, press Enter to select it.

Thats what I see :

Found a typo in docs of "Example - Integrating Debuggers"

First sentense: (language agnostic)
Should probably be (language diagnostic)
here: https://github.com/Microsoft/vscode-docs/blob/master/docs/extensions/example-debuggers.md

After upgrading to VS Code 0.9.2 on Linux (64) it still says 0.9.1 in Help About

I downloaded code from here: http://go.microsoft.com/fwlink/?LinkID=534108 or from here: https://code.visualstudio.com/Download (click on Linux 64). It says it's 0.9.1.

Thoughts?

The updates page should also provide access to previous releases

CC @joaomoreno @chrisdias
External users currently have no other means to get a previous version than to build it themeselves.

We should make previous versions available with the updates https://code.visualstudio.com/Updates.

Currently we have an informal wiki page, but it needs to be manually updated and it is already out of date

JSX support

Will be in future support for react?

"code" function for OSX Yosemite fails with syntax errors, max number of files for opening

On Yosemite 10.10.5, I followed instructions for setting up code in the Mac OS shell here, but get syntax errors.

ts (master?!) $ more ~/.bash_profile
if [ -f ~/.bashrc ]; then
   source ~/.bashrc
fi

# Setting PATH for Python 3.5
# The orginal version is saved in .bash_profile.pysave
PATH="/Library/Frameworks/Python.framework/Versions/3.5/bin:${PATH}"
export PATH

code () { VSCODE_CWD="$PWD" open -n -b "com.microsoft.VSCode" --args $* ;}
ts (master?!) $ source ~/.bash_profile
-bash: /Users/valvarez/.bash_profile: line 10: syntax error near unexpected token `('
-bash: /Users/valvarez/.bash_profile: line 10: `code () { VSCODE_CWD="$PWD" open -n -b "com.microsoft.VSCode" --args $* ;}'

Prefixing the definition with function makes it work:

~ $ more ~/.bash_profile
if [ -f ~/.bashrc ]; then
   source ~/.bashrc
fi

# Setting PATH for Python 3.5
# The orginal version is saved in .bash_profile.pysave
PATH="/Library/Frameworks/Python.framework/Versions/3.5/bin:${PATH}"
export PATH

function code () { VSCODE_CWD="$PWD" open -n -b "com.microsoft.VSCode" --args $*
 ;}
~ $ source ~/.bash_profile
~ $

code now opens new files as well as creates new ones if they don't exist, however, it only opens up a maximum of three files plus an optional directory.

ts (master?!) $ ls -l
total 40
-rw-r--r--  1 valvarez  TSI\Domain Users   91 Dec 14 22:03 app.js
-rw-r--r--  1 valvarez  TSI\Domain Users   92 Dec 14 19:50 app.ts
-rw-r--r--  1 valvarez  TSI\Domain Users    0 Dec 15 09:41 bar
-rw-r--r--  1 valvarez  TSI\Domain Users    0 Dec 15 09:41 baz
-rw-r--r--  1 valvarez  TSI\Domain Users   64 Dec 14 22:03 foo.js
-rw-r--r--  1 valvarez  TSI\Domain Users   54 Dec 14 19:42 foo.ts
-rw-r--r--  1 valvarez  TSI\Domain Users  104 Dec 14 22:03 jsconfig.json
ts (master?!) $ code bar baz app.ts
ts (master?!) $
ts (master?!) $ code ../vs-code foo bar ../vs-code/LICENSE.md

You'll have to trust me that these last step opens up a new editor with with the right files :).

That maximum limit is not in accordance with this documentation:

Sometimes you will want to open or create a file. If a file does not exist, we will create it for you:

code index.html style.css readme.md
Tip: You can have as many file names as you want separated by spaces.

I can submit a pull request with the fixed function definition, but should we denote the limit for the number of files code can open at once here?

Right margin line

I don't see editor setting like "right margin". I suppose, it is usual feature for any IDE. Am I missing something or it is really absent?

Code Snippet throws error after use "yo code"

I was trying to work with Snippet but I've got this message

Add the decorator sample to the list of samples

The table https://code.visualstudio.com/docs/tools/samples should include the decorator sample https://github.com/Microsoft/vscode-extension-samples/tree/master/decorator-sample

Bug in extensions documentation

There is a bug when viewing extensions api documentation. See here.

I tried to make a change in the code, but I can't figure out where the API content gets loaded (I am looking in vscode-api.template). An explanation of how that works would be great.

I am on a Macbook running Chrome 47.0.2526.106 (64-bit).

Add documentation for --disable-extensions

Pls add documentation about the new command line switch --disable-extensions to the code basics section.

For review pls check with @bpasero

Need a document on Code Navigation

suggest to write the authoritative document on code navigation in VS Code.

microsoft/vscode#1843

ESLint doc needs update for plugin story

The current docs say that you just have to add "eslint.enable": "true" to the settings file, but in the last release the built-in ESLint support was moved into a plugin that has to be installed.

Invalid sentence in ASP.NET 5 Runtime docs

In the "Projects and Project Selection" section of Runtimes --> ASP.NET 5, the following sentence needs to be rewritten:

"If you have multiple project.json files you can pick which one you want to use, looks down in the status bar."

What was it intended to say? In its current state, it makes no sense.

[0.9.0] mention new options to control window open and restore behavior

There are two new options window.reopenFolders and window.openInNewWindow to control startup behavior of vs code that should probably be mentioned in the docs on the https://code.visualstudio.com/Docs/editor/codebasics page.

The files.openInNewWindow setting controls if files should open in a new window instead of reusing an existing VS Code instance. By default, VS Code will
open a new window, e.g. when you double click on a file outside VS Code or open a file from the command line. Set this to false to reuse the last
active instance of VS Code and open files in there.

The files.reopenFolders setting tells VS Code how to restore the opened windows of your previous session. By default, VS Code will
reopen the last opened folder you worked on (setting: one). Change this setting to none to never reopen any folders and always start with an
empty VS Code instance. Change it to all to restore all folders you worked on. This will reopen all the windows with folders of your previous session.

Processing code open source?

Is the code that processes the docs open source? Is there a way to run a local instance of the docs to see how they'll look?

[0.9.0] debug: update debug console screenshot

Quite some polish went in the debug console. We need to update the screenshot

how to create binaries for node js modules

The only way to make this work for now is to include binaries for all four platforms of VS Code (Windows x86 and x64, Linux, OS X) in your extension and have code that dynamically loads the right one.

you said to include binaries. please tell how to create binaries for all the modules i have added.
I have created 2 extensions and now when i try to publish it doesnt work due to this thing. no module is published.
how to create binary ?