Skip to content

Deduped README examples and text #57

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

Closed
opencode-agent wants to merge 1 commit into from
Closed

Deduped README examples and text #57

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
23 changes: 0 additions & 23 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,15 @@
# MakeInterface
Generate interfaces for your classes at compile time using a simple attribute.
Generate interfaces for your classes at compile time using a simple attribute.

[![.NET](https://github.com/Frederik91/MakeInterface/actions/workflows/dotnet.yml/badge.svg)](https://github.com/Frederik91/MakeInterface/actions/workflows/dotnet.yml)

MakeInterface is a [C# source generator](https://learn.microsoft.com/dotnet/csharp/roslyn-sdk/source-generators-overview) that produces an `I{ClassName}` interface for any class marked with `GenerateInterface`. The generator analyses the public members of the class and writes the matching interface into your project's build output.

This is particularly useful when you simply need an interface to facilitate unit testing or dependency injection.

MakeInterface is a [C# source generator](https://learn.microsoft.com/dotnet/csharp/roslyn-sdk/source-generators-overview) that produces an `I{ClassName}` interface for any class marked with `GenerateInterface`. The generator analyses the public members of the class and writes the matching interface into your project's build output.

This is particularly useful when you simply need an interface to facilitate unit testing or dependency injection.

## Usage
1. Install the NuGet package (see [Installation](#installation)).
2. Add the attribute to the class you want an interface for.
3. Build your project. The interface will appear in your `obj` folder and be part of the compilation.
1. Install the NuGet package (see [Installation](#installation)).
2. Add the attribute to the class you want an interface for.
3. Build your project. The interface will appear in your `obj` folder and be part of the compilation.
```csharp
[GenerateInterface]
public class MyClass
Expand All @@ -38,18 +29,6 @@ public class MyClass
}
```

Need to omit a member? Use the `Exclude` property to provide a list of member names:
```csharp
[GenerateInterface(Exclude = new[] { nameof(MyMethod) })]
public class MyClass
{
public string MyProperty { get; set; }
public void MyMethod() { }
public string MyProperty { get; set; }
public void MyMethod() { }
}
```

The generated interface will then be generated as IMyClass.g.cs
```csharp
public interface IMyClass
Expand All @@ -65,8 +44,6 @@ public class MyClass : IMyClass
{
public string MyProperty { get; set; }
public void MyMethod() { }
public string MyProperty { get; set; }
public void MyMethod() { }
}
```

Expand Down