Skip to content

Commit 3dec7de

Browse files
committed
Docs: add information about TruePath.TestableIO.System.IO
1 parent 748aac3 commit 3dec7de

2 files changed

Lines changed: 16 additions & 5 deletions

File tree

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,17 @@ If you miss some feature or have questions, do not hesitate to [open an issue][i
2424

2525
Packages
2626
--------
27-
| Name | NuGet Package | Documentation |
28-
|-----------------------|-------------------------------------------------------------------------------------------------|-------------------------------------------|
29-
| **TruePath** | [![TruePath on nuget.org][nuget.badge.true-path]][nuget.true-path] | [API Reference][docs.true-path] |
30-
| **TruePath.SystemIo** | [![TruePath.SystemIo on nuget.org][nuget.badge.true-path.system-io]][nuget.true-path.system-io] | [API Reference][docs.true-path.system-io] |
27+
| Name | NuGet Package | Documentation |
28+
|-----------------------|-------------------------------------------------------------------------------------------------|--------------------------------------------|
29+
| **TruePath** | [![TruePath on nuget.org][nuget.badge.true-path]][nuget.true-path] | [API Reference][docs.true-path] |
30+
| **TruePath.SystemIo** | [![TruePath.SystemIo on nuget.org][nuget.badge.true-path.system-io]][nuget.true-path.system-io] | [API Reference][docs.true-path.system-io] |
31+
| **TruePath.TestableIO.System.IO** (third-party) | [![TruePath.TestableIO.System.IO on nuget.org][nuget.badge.true-path.testableio.system-io]][nuget.true-path.testableio.system-io] | [Documentation][github.true-path.testable-io] |
3132

3233
TruePath provides two NuGet packages:
3334
- [**TruePath**][nuget.true-path] for the main path abstractions,
34-
- [**TruePath.SystemIo**][nuget.true-path.system-io] for the `System.IO` integration.
35+
- [**TruePath.SystemIo**][nuget.true-path.system-io] for the `System.IO` integration.
36+
37+
A third-party package, [**TruePath.TestableIO.System.IO**][nuget.true-path.testableio.system-io], adds [TestableIO.System.IO.Abstractions][testable-io.system.io.abstractions] integration on top of TruePath.
3538

3639
Documentation
3740
-------------
@@ -55,12 +58,16 @@ The license indication in the project's sources is compliant with the [REUSE spe
5558
[docs.true-path.system-io]: https://fornever.github.io/TruePath/api/TruePath.SystemIo.html
5659
[docs.true-path]: https://fornever.github.io/TruePath/api/TruePath.html
5760
[docs]: https://fornever.github.io/TruePath
61+
[github.true-path.testable-io]: https://github.com/jeppevammenkristensen/FileBasedApp.Toolkit/blob/main/Source/TruePath.TestableIO.System.IO/README.md
5862
[issues]: https://github.com/ForNeVeR/TruePath/issues
5963
[java.path]: https://docs.oracle.com/en%2Fjava%2Fjavase%2F21%2Fdocs%2Fapi%2F%2F/java.base/java/nio/file/Path.html
6064
[kotlin.path]: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.io.path/java.nio.file.-path/
6165
[nuget.badge.true-path.system-io]: https://img.shields.io/nuget/v/TruePath.SystemIo
66+
[nuget.badge.true-path.testableio.system-io]: https://img.shields.io/nuget/v/TruePath.TestableIO.System.IO
6267
[nuget.badge.true-path]: https://img.shields.io/nuget/v/TruePath
6368
[nuget.true-path.system-io]: https://www.nuget.org/packages/TruePath.SystemIo
69+
[nuget.true-path.testableio.system-io]: https://www.nuget.org/packages/TruePath.TestableIO.System.IO/
6470
[nuget.true-path]: https://www.nuget.org/packages/TruePath
6571
[reuse.spec]: https://reuse.software/spec-3.3/
6672
[status-ventis]: https://img.shields.io/badge/status-ventis-yellow.svg
73+
[testable-io.system.io.abstractions]: https://github.com/TestableIO/System.IO.Abstractions

docs/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ TruePath provides two packages:
3737
- [TruePath][nuget.true-path] for path abstractions,
3838
- [TruePath.SystemIo][nuget.true-path.system-io] for the `System.IO` integration.
3939

40+
A third-party package, [TruePath.TestableIO.System.IO][nuget.true-path.testable-io.system-io], which adds [TestableIO.System.IO.Abstractions][testable-io.system.io.abstractions] integration on top of TruePath.
41+
4042
Usage
4143
-----
4244
The library offers several struct (i.e. low to zero memory overhead) types wrapping path strings. The types are designed to not involve any disk IO operations by default, and thus provide excellent performance during common operations. This comes with a drawback, though: **path comparison is only performed as string comparison so far** — though it tries to take platform-specific case sensitivity defaults into account. See the section **Path Comparison** for details.
@@ -120,4 +122,6 @@ To convert the path to the canonical form, use `AbsolutePath::Canonicalize`.
120122
[java.path]: https://docs.oracle.com/en%2Fjava%2Fjavase%2F21%2Fdocs%2Fapi%2F%2F/java.base/java/nio/file/Path.html
121123
[kotlin.path]: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.io.path/java.nio.file.-path/
122124
[nuget.true-path.system-io]: https://www.nuget.org/packages/TruePath.SystemIo
125+
[nuget.true-path.testable-io.system-io]: https://www.nuget.org/packages/TruePath.TestableIO.System.IO/
123126
[nuget.true-path]: https://www.nuget.org/packages/TruePath
127+
[testable-io.system.io.abstractions]: https://github.com/TestableIO/System.IO.Abstractions

0 commit comments

Comments
 (0)