https://github.com/smdn/smdn.reflection.reversegenerating
.NET libraries and tools to reverse-generate C# code from type and member information using reflection
https://github.com/smdn/smdn.reflection.reversegenerating
api-documentation-tool api-list api-outliner csharp dotnet dotnet-library dotnet-tools msbuild-task nuget-package reflection reverse-generating
Last synced: 3 months ago
JSON representation
.NET libraries and tools to reverse-generate C# code from type and member information using reflection
- Host: GitHub
- URL: https://github.com/smdn/smdn.reflection.reversegenerating
- Owner: smdn
- License: mit
- Created: 2021-10-28T17:25:39.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-14T12:10:52.000Z (5 months ago)
- Last Synced: 2024-12-14T12:29:01.603Z (5 months ago)
- Topics: api-documentation-tool, api-list, api-outliner, csharp, dotnet, dotnet-library, dotnet-tools, msbuild-task, nuget-package, reflection, reverse-generating
- Language: C#
- Homepage: https://smdn.jp/works/libs/Smdn.Reflection.ReverseGenerating/
- Size: 1.42 MB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://github.com/smdn/Smdn.Reflection.ReverseGenerating/blob/main/LICENSE.txt)
[](https://github.com/smdn/Smdn.Reflection.ReverseGenerating/actions/workflows/test.yml)
[](https://github.com/smdn/Smdn.Reflection.ReverseGenerating/actions/workflows/codeql-analysis.yml)
This repository provides the libraries and tools to reverse-generate C# code that describes the type and member information, from the .NET assemblies.
By generating an API list from the library, the types and members provided by the library can be presented in C# code format. This allows you to present an outline of the library API to users in addition to explaining the API through text or sample code.
# Smdn.Reflection.ReverseGenerating.ListApi.MSBuild.Tasks
[](https://www.nuget.org/packages/Smdn.Reflection.ReverseGenerating.ListApi.MSBuild.Tasks/)
This package provides `GenerateApiList` MSBuild task.
## Usage
See [examples](examples/Smdn.Reflection.ReverseGenerating.ListApi.MSBuild.Tasks/) for details and more usage examples.
```xml
false
```
# Smdn.Reflection.ReverseGenerating.ListApi
[](https://www.nuget.org/packages/Smdn.Reflection.ReverseGenerating.ListApi/)
This package provides `list-api` command line tool.
## Installation
Use `dotnet tool` to install or update `list-api` command.
```sh
# install
dotnet tool install -g Smdn.Reflection.ReverseGenerating.ListApi
# update
dotnet tool update -g Smdn.Reflection.ReverseGenerating.ListApi
# install and update (specifies the target framework explicitly)
dotnet tool install --framework net8.0 -g Smdn.Reflection.ReverseGenerating.ListApi
dotnet tool update --framework net6.0 -g Smdn.Reflection.ReverseGenerating.ListApi
```
## Usage
```sh
# Generates the API list.
# The file 'Library-net8.0.apilist.cs' will be generated.
list-api Library/bin/Release/net8.0/Library.dll
# Generates the API list with loading the assembly in the reflection-only context.
list-api --load-reflection-only Library/bin/Release/net8.0/Library.dll
```
Type `list-api --help` to show usage about command line arguments and options.
If you are loading an assembly that targets a newer version than the runtime version that the `list-api` command targets, try running it with the [DOTNET_ROLL_FORWARD](https://learn.microsoft.com/dotnet/core/versions/selection) environment variable.
```sh
# Installs list-api targeting .NET 6.0
dotnet tool install --framework net6.0 -g Smdn.Reflection.ReverseGenerating.ListApi
# Uses runtime roll forwarding to load the assembly targeting .NET 8.0
DOTNET_ROLL_FORWARD=LatestMajor list-api Library/bin/Release/net8.0/Library.dll
```
## Limitations
This tool does not provide any options for code styles including spaces, indents, and new lines. Use `dotnet format` after generating to format such code styles.
# Smdn.Reflection.ReverseGenerating
[](https://www.nuget.org/packages/Smdn.Reflection.ReverseGenerating/)
This package provides APIs common to reverse generating. See [examples](examples/Smdn.Reflection.ReverseGenerating/) or [API list of Smdn.Reflection.ReverseGenerating](doc/api-list/Smdn.Reflection.ReverseGenerating/).
# Example of output
The files in [API list directory](/doc/api-list/) is generated using the artifacts of this repository.
# For contributers
Contributions are appreciated!
If there's a feature you would like to add or a bug you would like to fix, please read [Contribution guidelines](./CONTRIBUTING.md) and create an Issue or Pull Request.
IssueやPull Requestを送る際は、[Contribution guidelines](./CONTRIBUTING.md)をご覧頂ください。 可能なら英語が望ましいですが、日本語で構いません。