omnisharp-vscode/README.md

129 строки
7.4 KiB
Markdown
Исходник Обычный вид История

2016-02-18 18:01:23 +03:00
## C# for Visual Studio Code (powered by OmniSharp)
2015-12-03 13:25:00 +03:00
2016-08-29 19:55:56 +03:00
|Master|Release|
|:--:|:--:|
2016-08-29 19:55:56 +03:00
|[![Master Build Status](https://travis-ci.org/OmniSharp/omnisharp-vscode.svg?branch=master)](https://travis-ci.org/OmniSharp/omnisharp-vscode)|[![Release Build Status](https://travis-ci.org/OmniSharp/omnisharp-vscode.svg?branch=release)](https://travis-ci.org/OmniSharp/omnisharp-vscode)|
2016-03-24 05:27:19 +03:00
Welcome to the C# extension for Visual Studio Code! This preview provides the following features inside VS Code:
* Lightweight development tools for [.NET Core](https://dotnet.github.io).
* Great C# editing support, including Syntax Highlighting, IntelliSense, Go to Definition, Find All References, etc.
2016-05-18 21:45:27 +03:00
* Debugging support for .NET Core (CoreCLR). NOTE: Mono and Desktop CLR debugging is not supported.
2016-11-11 23:25:50 +03:00
* Support for project.json and csproj projects on Windows, macOS and Linux.
The C# extension is powered by [OmniSharp](https://github.com/OmniSharp/omnisharp-roslyn).
2016-11-15 01:43:27 +03:00
### Get Started Writing C# in VS Code
* [Documentation](https://code.visualstudio.com/docs/languages/csharp)
* [Video Tutorial compiling with .NET Core](https://channel9.msdn.com/Blogs/dotnet/Get-started-with-VS-Code-using-CSharp-and-NET-Core)
2016-11-20 17:49:28 +03:00
### What's New in 1.5.3
* Use value of `http.proxyStrictSSL` even when `http.proxy` is not set. ([#957](https://github.com/OmniSharp/omnisharp-vscode/issues/957))
2016-11-15 22:38:54 +03:00
### What's New in 1.5.2
* Ensure diagnostics are cleared in files when they are no longer needed. ([#858](https://github.com/OmniSharp/omnisharp-vscode/issues/858))
* Enqueue requests for diagnostics in visible editors when the extension starts up. ([#843](https://github.com/OmniSharp/omnisharp-vscode/issues/843))
* Provide fallback URLs for debugger downloads. ([#930](https://github.com/OmniSharp/omnisharp-vscode/issues/930))
2016-11-16 01:21:05 +03:00
* Properly require .NET Framework 4.6 in the OmniSharp.exe.config file to ensure that the user is displayed a dialog on Windows machines that don't have .NET Framework 4.6 installed. ([#937](https://github.com/OmniSharp/omnisharp-vscode/issues/937))
* Fix issue with installing on non-English installations of Windows. ([#938](https://github.com/OmniSharp/omnisharp-vscode/issues/938))
2016-11-15 22:38:54 +03:00
* Display platform information when acquiring runtime dependencies. ([#948](https://github.com/OmniSharp/omnisharp-vscode/issues/948))
2016-11-15 01:43:27 +03:00
### What's New in 1.5.1
* Fix to properly support `http.proxy` and `http.proxyStrictSSL` settings. ([#930](https://github.com/OmniSharp/omnisharp-vscode/issues/930))
2016-11-11 23:25:50 +03:00
### What's New in 1.5
2016-11-11 23:25:50 +03:00
#### Initial support for C# 7
2016-08-29 19:55:56 +03:00
2016-11-11 23:25:50 +03:00
* New C# 7 features like pattern-matching and tuples are now supported in VS Code editor. Note: To use tuples, you will need a reference to [this NuGet package](https://www.nuget.org/packages/System.ValueTuple).
#### Initial support for CSProj .NET Core Projects
* With the .NET Core SDK moving to embrace MSBuild and .csproj files over project.json, we've made sure the C# extension can handle the new format. This support is preliminary and there are still several features coming to smooth out the experience.
#### Broader OS Support for C# Code Editing
* This release dramatically changes the runtime that OmniSharp runs on, which allows it to be run an many more operating systems than before:
* Windows: OmniSharp runs on the installed .NET Framework. In addition, OmniSharp now runs on 32-bit Windows!
* macOS/Linux: OmniSharp runs on a custom embedded Mono runtime. Note: Mono does not need to be installed on the system for this to work.
2016-08-29 19:55:56 +03:00
#### Debugger
2016-11-11 23:25:50 +03:00
* Remote debugging is now supported for attach by using the `pipeTransport` launch.json option.
2016-11-11 23:37:10 +03:00
* Resolved issue with setting breakpoints when there are multple files with the same name (e.g. two 'Program.cs' files).
2016-11-11 23:25:50 +03:00
#### New Dependency Acquisition System
* This improves the acquisition and reliability of platform-specific OmniSharp and debugger dependencies.
2016-08-29 19:55:56 +03:00
#### New Settings
Several new settings have been added:
2016-11-11 23:25:50 +03:00
* `csharp.suppressDotnetRestoreNotification`: Suppress the notification window to perform a 'dotnet restore' when dependencies can't be resolved.
* `omnisharp.projectLoadTimeout`: The time Visual Studio Code will wait for the OmniSharp server to start. Time is expressed in seconds. _(Contributed by [@wjk](https://github.com/wjk))_
2016-08-29 19:55:56 +03:00
#### Colorizer
2016-11-11 23:25:50 +03:00
* A new unit testing framework for testing the colorizer grammer ([#742](https://github.com/OmniSharp/omnisharp-vscode/pull/742)) _(Contributed by [@ivanz](https://github.com/ivanz))_
2016-11-11 23:37:10 +03:00
* Single-line comments after preprocessor directives ([#762](https://github.com/OmniSharp/omnisharp-vscode/pull/762)) _(Contributed by [@damieng](https://github.com/damieng))_
2016-08-29 19:55:56 +03:00
#### Performance
2016-11-11 23:25:50 +03:00
* Major improvements have been made to editor performance. The communication with the OmniSharp server has been rewritten to allow long-running operations (such as gathering all errors and warnings) to queue while high priority operations (such as text buffer changes) run serially. ([#902](https://github.com/OmniSharp/omnisharp-vscode/pull/902)) _(Thanks to [@david-driscoll](https://github.com/david-driscoll) for his help with this change!)_
2016-08-29 19:55:56 +03:00
#### Other Improvements
2016-11-11 23:25:50 +03:00
* The prompt to generate assets for building and debugging can now be dismissed for a workspace permanently. In addition, a new `dotnet.generateAssets` command has been added to force regeneration of the assets. ([#635](https://github.com/OmniSharp/omnisharp-vscode/issues/635))
* Fix "running forever" issue for folder with multple .NET Core projects. ([#735](https://github.com/OmniSharp/omnisharp-vscode/issues/735)) _(Contributed by [@eamodio](https://github.com/eamodio))_
* `ctor` snippet is now more consistent with other code snippets. ([#849](https://github.com/OmniSharp/omnisharp-vscode/pull/849)) _(Contibuted by [@Eibx](https://github.com/Eibx))_
2016-11-11 23:37:10 +03:00
* Ampersands in file paths are now properly escaped on Windows ([#909](https://github.com/OmniSharp/omnisharp-vscode/pull/909)) _(Contributed by [@filipw](https://github.com/filipw))_
2016-11-11 23:25:50 +03:00
### Supported Operating Systems for Debugging
2016-07-20 21:10:11 +03:00
2016-11-11 23:25:50 +03:00
* Currently, the C# debugger supports the following operatings systems:
2016-07-20 21:10:11 +03:00
* Windows (64-bit only)
* macOS
2016-11-11 23:25:50 +03:00
* Ubuntu 14.04 / Linux Mint 17 / Linux Mint 18 / Elementary OS 0.3
* Ubuntu 16.04 / Elementary OS 0.4 / Arch
* Ubuntu 16.10
2016-07-20 21:10:11 +03:00
* Debian 8.2
* CentOS 7.1 / Oracle Linux 7
* Red Hat Enterprise Linux (RHEL)
* Fedora 23 / 24
* OpenSUSE 13 / 42
### Found a Bug?
Please file any issues at https://github.com/OmniSharp/omnisharp-vscode/issues.
### Debugging
The C# extension now supports basic debugging capabilities! See http://aka.ms/vscclrdebugger for details.
2015-12-07 11:37:18 +03:00
### Development
2016-05-18 00:56:20 +03:00
First install:
* Node.js (newer than 4.3.1)
* Npm (newer 2.14.12)
2016-09-23 23:44:17 +03:00
In case you get a *node-gyp* error [follow the instrutions here](https://github.com/nodejs/node-gyp/blob/master/README.md) to fix it. The *vscode-textmate* package pulls in a native node dependency and those instructions will set up the node build tool which deals with those.
2015-12-03 13:25:00 +03:00
To **run and develop** do the following:
2016-02-18 18:01:23 +03:00
* Run `npm i`
2016-11-11 23:25:50 +03:00
* Run `npm run compile`
2016-02-18 18:01:23 +03:00
* Open in Visual Studio Code (`code .`)
* *Optional:* run `tsc -w`, make code changes (on Windows, try `start node ".\node_modules\typescript\bin\tsc -w"`)
2016-08-29 19:55:56 +03:00
* Press <kbd>F5</kbd> to debug
To **test** do the following: `npm run test`
### License
The Microsoft C# extension is subject to [these license terms](RuntimeLicenses/license.txt).
The source code to this extension is available on [https://github.com/OmniSharp/omnisharp-vscode](https://github.com/OmniSharp/omnisharp-vscode) and licensed under the [MIT license](LICENSE.txt).