OneWare.OmniSharp.Extensions.LanguageClient 1.0.2

C# Language Server Protocol

This is an implementation of the Language Server Protocol written entirely in C# for .NET.

OneWare fork

This fork is published on NuGet under the OneWare. prefix, built against .NET 10 with full LSP 3.17/3.18 coverage.

Assembly names and the strong name key remain identical to upstream. Starting with 1.0.2, the request contracts are repository-owned MIT code instead of an external mediator dependency. This is a binary breaking change: recompile applications and plugins against the new packages, and upgrade the entire package closure together. Protocol model namespaces and wire formats remain unchanged.

<PackageReference Include="OneWare.OmniSharp.Extensions.LanguageClient" Version="1.0.2" />
<PackageReference Include="OneWare.OmniSharp.Extensions.LanguageProtocol" Version="1.0.2" />

Target frameworks: netstandard2.0, netstandard2.1, net8.0, net10.0.

Releasing

Push a v* tag (or run the release workflow manually) and .github/workflows/release.yml builds, tests, packs and pushes to nuget.org. It requires a NUGET_API_SECRET repository secret.

git tag v1.0.0 && git push origin v1.0.0

Getting Started

1. git clone
2. run build.ps1 / build.sh
3. ...
4. Profit

Concepts

JSON-RPC

We have an implementation of JSON-RPC designed to implement the JSON-RPC as correctly as possible.

For more information about using the JsonRpcServer on it's own here.

Request dispatch

OmniSharp.Extensions.JsonRpc.Dispatching contains the repository-owned IRequest<TResponse>, IRequestHandler<TRequest, TResponse>, Unit, IPipelineBehavior<TRequest, TResponse> and IRequestDispatcher contracts. The implementation is original code under this repository's MIT license; it does not copy, embed, downgrade or depend on MediatR.

For custom models, handlers or pipelines, replace using MediatR; with using OmniSharp.Extensions.JsonRpc.Dispatching;. Handler methods retain their existing Task<TResponse> Handle(TRequest, CancellationToken) signature; notifications return Task<Unit>. Replace direct IMediator injection with IRequestDispatcher if you used the routing dispatcher. This dispatcher only supports protocol requests (including notifications as unit-response requests), not general-purpose publish, streaming, pre/post-processors or exception-handler registrations. Custom behaviors still register through Services.AddTransient(typeof(IPipelineBehavior<,>), typeof(MyBehavior<,>)).

Routing selects the descriptor's handler within a separate DI scope for each invocation. Behaviors execute in registration order, outermost first, and may short-circuit dispatch. next() retains the current cancellation token; next(token) replaces it for downstream behaviors and the handler. Exceptions and cancellation propagate to the existing JSON-RPC/LSP/DAP routing logic. Only type adapters are cached, so handlers and scoped dependencies are never shared across requests. Source generators use the same contracts, including the new Unit type.

To validate a local build before publishing:

dotnet pack src/Client/Client.csproj -c Release -p:OneWarePackageVersion=1.0.2 -o ./artifacts/nuget
# Pack JsonRpc.Generators, JsonRpc, Protocol, Shared and Server to the same directory as well.
dotnet restore path/to/Consumer.csproj --source ./artifacts/nuget --source https://api.nuget.org/v3/index.json

Microsoft.Extensions.*

We re-use some of the common packages used by .NET Core.

• Microsoft.Extensions.Configuration for common configuration
• Microsoft.Extensions.DependencyInjection for common Dependency Injection abstractions
• Microsoft.Extensions.Logging for logging.

Language Server Protocol

We strive to ensure that we implement all the types, request and notifications that are defined by the Language Server Protocol. Sometimes this is difficult due to the nature of LSP TypeScript upbringing, but the goal is 100% conformance with the protocol itself.

For more information about using the LanguageClient / LanguageServer on it's own here.

Debug Adapter Protocol

We strive to ensure that we implement all the types, events and requests that are defined by the Debug Adapter Protocol.

For more information about using the DebugAdapterClient / DebugAdapterServer on it's own here.

Status

Azure Pipelines	GitHub Actions

Package	NuGet
OmniSharp.Extensions.DebugAdapter
OmniSharp.Extensions.DebugAdapter.Client
OmniSharp.Extensions.DebugAdapter.Proposals
OmniSharp.Extensions.DebugAdapter.Server
OmniSharp.Extensions.DebugAdapter.Shared
OmniSharp.Extensions.DebugAdapter.Testing
OmniSharp.Extensions.JsonRpc
OmniSharp.Extensions.JsonRpc.Generators
OmniSharp.Extensions.JsonRpc.Testing
OmniSharp.Extensions.LanguageClient
OmniSharp.Extensions.LanguageProtocol
OmniSharp.Extensions.LanguageProtocol.Proposals
OmniSharp.Extensions.LanguageProtocol.Testing
OmniSharp.Extensions.LanguageServer
OmniSharp.Extensions.LanguageServer.Shared

License

Copyright © .NET Foundation, and contributors.

OmniSharp is provided as-is under the MIT license. For more information see LICENSE.

Code of Conduct

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information see the .NET Foundation Code of Conduct.

Contribution License Agreement

By signing the CLA, the community is free to use your contribution to .NET Foundation projects.

.NET Foundation

This project is supported by the .NET Foundation.