AutoInterface - GitLite

KO | EN

gitlite — search

#javascript #python #react #ai #typescript #golang #machine-learning #rust #deep-learning #linux #java #awesome #pytorch #ios

AutoInterface

(★ 88)

C# interface-to-member source generator

파일 탐색기

최종 버전 다운로드 (.zip)

- - codeql-analysis.yml
  - dotnet-core.yml
  - nuget.yml
- - Experiments.cs
- AutoInterfaceSample.csproj
- mytemplate.scriban
- Program.cs
- AutoInterfaceSampleNetStandard.csproj
- TestRecord.cs
- AutoInterfaceAttribute.cs
- AutoInterfaceTargets.cs
- AutoInterfaceTemplateAttribute.cs
- BeaKona.AutoInterfaceAttributes.csproj
- MemberMatchTypes.cs
- - launchSettings.json
- - EventModel.cs
  - IEventModel.cs
  - IIndexerModel.cs
  - ILocalExpressionModel.cs
  - ILocalPropertyExpressionModel.cs
  - IMethodModel.cs
  - IndexerModel.cs
  - IPropertyModel.cs
  - IRootModel.cs
  - MethodModel.cs
  - ModelLoader.cs
  - PartialEventModel.cs
  - PartialIndexerModel.cs
  - PartialMethodModel.cs
  - PartialPropertyModel.cs
  - PartialTemplate.cs
  - PropertyModel.cs
  - StandaloneModel.cs
  - TemplateDefinition.cs
  - TemplatedSourceGenerator.cs
- AliasRegistry.cs
- AnalyzerReleases.Shipped.md
- AnalyzerReleases.Unshipped.md
- AttributeDataWithTarget.cs
- AutoInterfaceRecord.cs
- AutoInterfaceResource.Designer.cs
- AutoInterfaceResource.resx
- AutoInterfaceSourceGenerator.cs
- BeaKona.AutoInterfaceGenerator.csproj
- ComparerBySignature.cs
- CompilationExtensions.cs
- CSharpCodeTextWriter.cs
- DiagnosticInfo.cs
- Diagnostics.cs
- Globals.cs
- Helpers.cs
- ICodeTextWriter.cs
- IDictionaryExtensions.cs
- IEnumerableExtensions.cs
- IMemberInfo.cs
- INamedTypeSymbolExtensions.cs
- INamespaceSymbolExtensions.cs
- IsExternalInit.cs
- ISourceTextGenerator.cs
- ITypeSymbolExtensions.cs
- ScopeInfo.cs
- SemanticFacts.cs
- SourceBuilder.cs
- SourceBuilderOptions.cs
- TypeRegistry.cs
- Interfaces.cs
- TestInterfaces.csproj
- Interfaces.cs
- NotNullWhenAttribute.cs
- TestInterfacesNetStandard.csproj
.editorconfig
.gitignore
AutoInterface.sln
LICENSE
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# AutoInterface

C# [Source Generator](https://github.com/dotnet/roslyn/blob/master/docs/features/source-generators.md) which redirects all interface-calls to one or more backing members. Source code can be generated for a `class`, `record`, or `struct`. It can be generated automatically or by a custom template ([scriban](https://github.com/scriban/scriban), liquid).
<br />

Manually written source:

```csharp
interface IPrintable
{
   void Print();
}

public partial class Person : IPrintable
{
   [BeaKona.AutoInterface]
   private readonly IPrintable aspect1 = new PersonPrinterV1();
}
```

Auto-generated accompanying source:

```csharp
partial class Person
{
   void IPrintable.Print() => this.aspect1.Print();
}
```
<br />

## Ad-hoc adapter pattern

In this example `PersonPrinterV1` does not implement `IPrintable` but does have all members that are required by that interface.

Manually written source:

```csharp
interface IPrintable
{
   void Print();
}

class PersonPrinterV1
{
   void Print() { ... }
}

public partial class Person
{
   [BeaKona.AutoInterface(typeof(IPrintable))]
   private readonly PersonPrinterV1 aspect1 = new PersonPrinterV1();
}
```

Auto-generated accompanying source:

```csharp
partial class Person : IPrintable
{
   void IPrintable.Print() => this.aspect1.Print();
}
```
<br />

## Generate code from a template

Manually written source:

```csharp
interface IPrintable
{
   void Print();
}

public partial class Person : IPrintable
{
   // add file mytemplate.scriban in your VS project
   // and set it's build action to: 'C# analyzer additional file'
   [BeaKona.AutoInterface(TemplateFileName = "mytemplate.scriban")]
   private readonly IPrintable? aspect1 = null;
}
```

Auto-generated accompanying source:

```csharp
partial class Person
{
   ..generated from file..
}
```
<br />

## Partial template

Partial template can be defined inline (from string) or from file.

Manually written source:

```csharp
interface IPrintable
{
   int Length { get; }
   int Count { get; }
   void Print1();
   void Print2();
}

public partial class Person : IPrintable
{
   private void LogDebug(string name) { }

[BeaKona.AutoInterface]
   [BeaKona.AutoInterfaceTemplate(BeaKona.AutoInterfaceTargets.PropertyGetter,
        Filter = "Length", Language = "scriban", Body = "return 1;")]
   [BeaKona.AutoInterfaceTemplate(BeaKona.AutoInterfaceTargets.Method,
        Filter = "Print(\\d)?", Body="LogDebug(nameof({{interface}}.{{name}})); {{expression}};")]
   private readonly IPrintable? aspect1 = new PrinterV1();
}
```

Auto-generated accompanying source:

```csharp
partial class Person
{
   int IPrintable.Length
   {
      return 1;
   }
   
   int IPrintable.Count => this.aspect1!.Count;

void IPrintable.Print1()
   {
       LogDebug(nameof(IPrintable.Print1));
       this.aspect1!.Print1();
   }

void IPrintable.Print2()
   {
       LogDebug(nameof(IPrintable.Print2));
       this.aspect1!.Print2();
   }
}
```

<br />

Other examples can be found in [wiki](https://github.com/beakona/AutoInterface/wiki/Examples).

<br />
---

![.NET Core](https://github.com/beakona/AutoInterface/workflows/.NET%20Core/badge.svg)
[![NuGet](https://img.shields.io/nuget/v/BeaKona.AutoInterfaceGenerator)](https://www.nuget.org/packages/BeaKona.AutoInterfaceGenerator)