Skip to content
This repository has been archived by the owner on Apr 1, 2020. It is now read-only.

Commit

Permalink
Fix #429 - Add documentation about language support + limitations (#432)
Browse files Browse the repository at this point in the history
* Update README

* Add TODO links

* Update table formatting

* Update table

* Experiment with markdown

* Experiment 2

* Add links
  • Loading branch information
extr0py authored May 2, 2017
1 parent 53e87aa commit 29e1d8c
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@
- [Code Completion](#code-completion)
- [Fuzzy Finder](#fuzzy-finder)
- [Quick Info](#quick-info)
- [Languages](#languages)
- [JavaScript and TypeScript](#javascript-and-typescript)
- [C#](c)
- [Configuration](#configuration)
- [Extensibility](#extensibility)
- [FAQ](#faq)
Expand Down Expand Up @@ -207,6 +210,38 @@ Leave the cursor hovering over an identifier.
- `oni.quickInfo.enabled` - If set to `true`, the Quick Info feature is enabled. (Default: `true`)
- `oni.quickInfo.delay` - Delay in milliseconds for the Quick Info window to show. (Default: `500`)

### Languages

#### JavaScript and TypeScript

_Configuration_

JavaScript and TypeScript support is enabled out-of-the-box using the [TypeScript Standalone Server](https://github.com/Microsoft/TypeScript/wiki/Standalone-Server-(tsserver)). No setup and configuration is necessary, however, you will get better results if you use a `tsconfig.json` or a `jsconfig.json` to structure your project.

_Supported Language features_

| Completion | Goto Definition | Formatting | Enhanced Syntax Highlighting | Quick Info | Signature Help | Live Evaluation | Debugging |
| --- | --- | --- | --- | --- | --- |--- | --- |
| Y | Y | Y | Y | Y | Y | Y | N |

#### C#

_Configuration_

C# completion uses the [OmniSharp Node Client](https://github.com/OmniSharp/omnisharp-node-client) which provides language capabilities for both .NET and Mono. For it to work correctly, you need to have a valid `.csproj` file with any dependent packages (ie, Nuget) installed. The project should also build and compile for the language service to work correctly.

> If you are using the .NET Core CLI, make sure to run `dotnet restore` on your project.
_Supported Language features_

| Completion | Goto Definition | Formatting | Enhanced Syntax Highlighting | Quick Info | Signature Help | Live Evaluation | Debugging |
| --- | --- | --- | --- | --- | --- |--- | --- |
| Y | Y | N | N | Y | N | N | N |

_Known Issues_

- On Windows, you must run Oni as an administrator the first time using the C# language service. This is tracked by issue [#423](https://github.com/extr0py/oni/issues/423).
- On all platforms, the C# language service takes time to start up, especially the first time as it is downloading the appropriate runtime environment. You can open up the developer tools (Help -> Developer Tools) to see the logging from the language service. [#424](https://github.com/extr0py/oni/issues/424) tracks making this logging more visible.

### Configuration

Expand Down

0 comments on commit 29e1d8c

Please sign in to comment.