Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/crwsolutions/sourcedepend
https://github.com/crwsolutions/sourcedepend
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/crwsolutions/sourcedepend
- Owner: crwsolutions
- License: mit
- Created: 2022-09-19T18:06:14.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-07-15T09:50:01.000Z (5 months ago)
- Last Synced: 2024-09-15T20:59:42.303Z (3 months ago)
- Language: C#
- Size: 68.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- RSCG_Examples - https://github.com/crwsolutions/sourcedepend
README
# Source Depend
Simply tag members with a `[Dependency]` attribute and those will be added to the constructor, saving you from manual coding the constructor. Example:
```csharp
public partial class ExampleService
{
[Dependency]
private readonly IRepository repository;
// Etc...
}
```
A C# source generator focused on dependency injection (DI).
[](https://www.nuget.org/packages/sourcedepend/)
[](https://github.com/crwsolutions/sourcedepend/blob/master/LICENSE.txt)
### Version history
- v1.0 Handle more complex scenarios':
+ class without namespace should not write a namespace.
+ repeat type arguments of generics.
+ repeat base constructor parameter if necessary.
+ (added unit tests).
- v0.4\. Added null-checks.
- v0.3\. Complete Rewrite: reorganized the code.
+ allow one level of inheritance.
- v0.2\. Complete rewrite from ISourceGenerator to IIncrementalGenerator, this should boost performance
+ keep sealed and accessibility intact.
- v0.1\. First implementation.
## How to use it
Install it and add the attribute to the fields or properties you want be set in your constructor, like so:
```csharp
public partial class ExampleService
{
[Dependency]
private readonly AnotherService anotherService;
[Dependency]
AnotherService Prop { get; }
}
```
### Alternative assignment
It is also possible that the generated assignment is to an alternative property:
```csharp
public partial class ExampleService
{
[Dependency(nameof(BindingContext))]
AnotherService ViewModel => BindingContext as AnotherService;
}
```
### Inheritance
And it is possible to inherit from a base implementation that also uses the **\[Dependency\]** attribute:
```csharp
internal partial class BaseExampleService
{
[Dependency]
private readonly IForBaseService _someBaseService;
}
internal partial class ExampleService : BaseExampleService
{
}
```
### Add construction work
Because your constructor is highjacked, there are the alternative methods PreConstruct/PostConstruct to do your construction work:
```csharp
public partial class ExampleService
{
[Dependency]
private readonly AnotherService anotherService;
///This method will be called before the generated assignments
partial void PreConstruct()
{
Initialize()
}
///This method will be called after the generated assignments
partial void PostConstruct() => anotherService.ConstructValue = "Hello from post-construct!";
}
```
These samples give the following combined generated code:
```csharp
//
#pragma warning disable
#nullable enable
namespace ConsoleApp
{
///
public partial class ExampleService
{
public ExampleService(ConsoleApp.IAnotherService anotherService, ConsoleApp.AnotherService prop, ConsoleApp.AnotherService viewModel, ConsoleApp.IForBaseService someBaseService) : base(someBaseService)
{
#if NET6_0_OR_GREATER
ArgumentNullException.ThrowIfNull(anotherService);
ArgumentNullException.ThrowIfNull(prop);
ArgumentNullException.ThrowIfNull(viewModel);
#endif
PreConstruct();
this.anotherService = anotherService;
Prop = prop;
BindingContext = viewModel;
PostConstruct();
}
partial void PreConstruct();
partial void PostConstruct();
}
}
//
#pragma warning disable
#nullable enable
namespace ConsoleApp
{
///
internal partial class BaseExampleService
{
public BaseExampleService(ConsoleApp.IForBaseService someBaseService)
{
#if NET6_0_OR_GREATER
ArgumentNullException.ThrowIfNull(someBaseService);
#endif
PreConstruct();
this._someBaseService = someBaseService;
PostConstruct();
}
partial void PreConstruct();
partial void PostConstruct();
}
}
```
## Installing
The package is available [on NuGet](https://www.nuget.org/packages/sourcedepend).
To install from the command line:
```shell
dotnet add package sourcedepend
```
Or use the Package Manager in Visual Studio.
## Contributing
The main supported IDE for development is Visual Studio 2019.
Questions, comments, bug reports, and pull requests are all welcome.
Bug reports that include steps to reproduce (including code) are
preferred. Even better, make them in the form of pull requests.
## Maintainers/Core team
Contributors can be found at the [contributors](https://github.com/crwsolutions/sourcedepend/graphs/contributors) page on Github.
## License
This software is open source, licensed under the MIT License.
See [LICENSE](https://github.com/crwsolutions/sourcedepend/blob/master/LICENSE) for details.
Check out the terms of the license before you contribute, fork, copy or do anything
with the code. If you decide to contribute you agree to grant copyright of all your contribution to this project and agree to
mention clearly if do not agree to these terms. Your work will be licensed with the project at MIT, along the rest of the code.