Skip to content

docs: route migration overview to analyzer subpage #1010

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vbreuss merged 1 commit into from
May 15, 2026
Merged

docs: route migration overview to analyzer subpage #1010

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 39 additions & 31 deletions Docs/pages/docs/migration-from-testableio/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,36 +15,44 @@ Pick **Testably.Abstractions** when you need a watcher, `SafeFileHandle`, multip

## How to migrate

The migration only affects your **test** projects.

### 1. Swap the package

```xml
<!-- Remove -->
<PackageReference Include="TestableIO.System.IO.Abstractions.TestingHelpers" />
<!-- Add -->
<PackageReference Include="Testably.Abstractions.Testing" />
```

### 2. Update the test code

```csharp
// Before (TestableIO)
var fileSystem = new MockFileSystem();
fileSystem.AddDirectory("some-directory");
fileSystem.AddFile("some-file.txt", new MockFileData("content"));

// After (Testably) - option A: imperative
var fileSystem = new MockFileSystem();
fileSystem.Directory.CreateDirectory("some-directory");
fileSystem.File.WriteAllText("some-file.txt", "content");

// After (Testably) - option B: fluent initialization
var fileSystem = new MockFileSystem();
fileSystem.Initialize()
.WithSubdirectory("some-directory")
.WithFile("some-file.txt").Which(f => f
.HasStringContent("content"));
```
The migration only affects your **test** projects. There are two paths — pick one.

### Automated (recommended)

The [`Testably.Abstractions.Migration`](./Migration/) analyzer rewrites the supported call sites for you. Install it alongside `Testably.Abstractions.Testing`, apply the code fix from your IDE or `dotnet format analyzers`, then uninstall it. Patterns it cannot rewrite safely are still reported so you can address them by hand — see the [analyzer page](./Migration/) for the full mapping table and recommended workflow.
Comment thread
vbreuss marked this conversation as resolved.

### Manual

If you'd rather not introduce a build-time analyzer, swap the package and rewrite the call sites yourself.

1. **Swap the package:**

```xml
<!-- Remove -->
<PackageReference Include="TestableIO.System.IO.Abstractions.TestingHelpers" />
<!-- Add -->
<PackageReference Include="Testably.Abstractions.Testing" />
```

2. **Update the test code:**

```csharp
// Before (TestableIO)
var fileSystem = new MockFileSystem();
fileSystem.AddDirectory("some-directory");
fileSystem.AddFile("some-file.txt", new MockFileData("content"));

// After (Testably) - option A: imperative
var fileSystem = new MockFileSystem();
fileSystem.Directory.CreateDirectory("some-directory");
fileSystem.File.WriteAllText("some-file.txt", "content");

// After (Testably) - option B: fluent initialization
var fileSystem = new MockFileSystem();
fileSystem.Initialize()
.WithSubdirectory("some-directory")
.WithFile("some-file.txt").Which(f => f
.HasStringContent("content"));
```

Production code keeps using `IFileSystem` exactly as before - no changes there.
Loading