Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kekyo/compat
Totally makes compatibility layer for .NET platforms.
https://github.com/kekyo/compat
compatibility dotnet
Last synced: 14 days ago
JSON representation
Totally makes compatibility layer for .NET platforms.
- Host: GitHub
- URL: https://github.com/kekyo/compat
- Owner: kekyo
- License: apache-2.0
- Created: 2022-12-20T07:22:41.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-17T00:48:01.000Z (12 months ago)
- Last Synced: 2024-05-01T12:49:44.176Z (7 months ago)
- Topics: compatibility, dotnet
- Language: C#
- Homepage:
- Size: 186 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Compat
Compat - Totally makes compatibility layer for .NET platforms.
[](https://www.repostatus.org/#wip)
## NuGet
| Package | NuGet |
|:---------|:---------------------------------------------------------------------------------------------------------------------|
| Compat | [](https://www.nuget.org/packages/Compat) |
----
## What is this?
* TODO: Still under construction...
Totally makes compatibility layer for .NET platforms.
For examples:
```csharp
// Undefined in net35:
if (string.IsNullOrWhitespace("ABC"))
{
}
// Use Compat and use StringEx instead:
if (StringEx.IsNullOrWhitespace("ABC"))
{
}
```
```csharp
// Undefined in most .NET Frameworks without using Compat.
// (Zip operator simple overload)
var zipped = left.Zip(right);
```
```csharp
// Undefined under net6.0 without using Compat.
// (WaitAsync method)
var zipped = this.CalculateAsync().WaitAsync(token);
```
```csharp
// Undefined TFM complex condition without using Compat.
// (ValueTask and ValueTask types)
public async ValueTask CalculateAsync()
{
// (Has ability of awaitable)
await this.RunOtherCalculationAsync();
}
```
----
## Target Platform
* .NET 7, 6, 5
* .NET Core 3.1, 3.0, 2.2, 2.1, 2.0
* .NET Standard 2.1, 2.0, 1.6, 1.3
* .NET Framework 4.8, 4.6.2, 4.6.1, 4.5.2, 4.5, 4.0, 3.5
----
## How to use
Install [Compat package.](https://nuget.org/Compat)
----
## Porting status
The list is not completed minor status.
|Members|Status|
|:----|:----|
|`System.ValueTuple`|Added 4 type argument versions.|
|`System.Threading.Tasks.Task`|`WaitAsync` methods.|
|`System.Threading.Tasks.TaskEx`|Ports with `AsyncBridge` and `Microsoft.Bcl.Async`. Added some lack members.|
|`System.Threading.Tasks.ValueTask`|Supported async method builders (async-awaitable)|
|String interpolation features|`FormattedString` and `DefaultInterpolatedStringHandler` types.|
|`System.Linq` operators|`Append`, `Prepend`, `TakeLast`, `SkipLast`, `Zip` and `ToHashSet` methods.|
Lack some `Task` members in earlier third-party library:
* `System.Threading.Tasks.TaskEx.FromException()` is not defined in third-party library.
* Use `Task.Factory.FromException()` instead.
* Mostly useful `From{...}` type method. So defined `Task.Factory.FromResult()` in near place.
* Mostly useful `CompletedTask` property. So defined `Task.Factory.CompletedTask()` method in near place.
----
## Tips
### Build .NET Framework assembly on Linux or others
When you want to build .NET Framework project in Linux and other non-Windows environment,
that package supports ability for referencing of .NET Framework assemblies:
```xml
```
### Completely hidden Compat assembly into your project
We suggest using [ILRepack.FullAuto](https://github.com/kekyo/ILRepack.FullAuto).
----
## Backports are welcome
Backport PRs are welcome. The following is our backporting policy:
* Basically, target under the `System` namespace of the BCL library.
* If a class, structure, or other type does not exist in the first place, define a new one.
* Use extended methods when porting instance methods.
* When porting instance properties or static members, define a type with `Ex` at the end and define members there.
* This is to conform to existing conventions, such as `TaskEx` for `Task`.
* If you refer to a third-party library, there must be no alternative to this library or it must be well known.
* Example: [AsyncBridge package](https://www.nuget.org/packages/AsyncBridge), which was a community-based pre-distribution in TPL.
* Example: [Microsoft.Bcl.Async package](https://www.nuget.org/packages/Microsoft.Bcl.Async), which provides backward compatibility of `Task` with .NET Framework 4.0.
* When referencing third-party libraries, do not generate unnecessary references.
* For example, `net6.0` is nearly up-to-date, and references to libraries should not be included when using `net6.0`. To achieve this, define the `PackageReference` to be excluded by `Condition`.
* Add the new TFM if it is to fill an incompatibility with a TFM that is not currently included.
* Do not include non-backporting any extensions.
* Write some kind of unit test. Of course, a comprehensive and exhaustive test code would be perfect.
----
## License
Apache-v2.
----
## History
* 0.3.0:
* Added `Unsafe` methods (partially).
* Adjusted ValueTask related package version dependency.
* 0.2.0:
* Added some LINQ operators.
* Added `Task.WaitAsync` methods.
* 0.1.0:
* Added `ValueTask`, `ValueTuple` and some minor members.
* Adjust dependencies.
* 0.0.1:
* Initial public release.