Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dotmorten/dotnetomdgenerator
A Roslyn-based cross-platform tool that generates an object model diagram from a set of C# source files or assemblies
https://github.com/dotmorten/dotnetomdgenerator
analyzer cross-platform csharp dotnet model-diagram object-model object-model-diagram roslyn tool
Last synced: 5 days ago
JSON representation
A Roslyn-based cross-platform tool that generates an object model diagram from a set of C# source files or assemblies
- Host: GitHub
- URL: https://github.com/dotmorten/dotnetomdgenerator
- Owner: dotMorten
- License: apache-2.0
- Created: 2018-03-19T22:49:55.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2022-04-05T16:34:03.000Z (over 2 years ago)
- Last Synced: 2024-10-13T14:44:00.183Z (23 days ago)
- Topics: analyzer, cross-platform, csharp, dotnet, model-diagram, object-model, object-model-diagram, roslyn, tool
- Language: C#
- Homepage:
- Size: 1000 KB
- Stars: 191
- Watchers: 13
- Forks: 19
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# .NET Object Model Diagram Generator
A cross-platform Roslyn-based tool that generates an object model diagram of a set of C# source files and/or .NET assemblies
## Sponsoring
If you like this library and use it a lot, consider sponsoring me. Anything helps and encourages me to keep going.
See here for details: https://github.com/sponsors/dotMorten
### Install
Run the following command from commandline (requires .NET Core 2.1 installed):
```
dotnet tool install --global dotMorten.OmdGenerator
```
### Usage:
```
generateomd /source=[source folder] /compareSource=[oldSourceFolder] /preprocessors=[defines] /format=[html|image] /showPrivate /showInternal
Required parameters:
source Specifies the folder of source files to include for the object model.
Separate with ; for multiple folders
or
assemblies Specifies a set of assemblies to include for the object model.
Separate with ; for multiple assemblies, or use wildcards
Optional parameters:
compareSource Specifies a folder of old source to compare and generate a diff model
This can be useful for finding API changes or compare branches
compareAssemblies Specifies a set of old assemblies to compare and generate a adiff model.
Separate with; for multiple assemblies, or use wildcards
format Format to generate:
'html' a single html output (html is default)
'md' for markdown you can copy-paste to for instance GitHub.
Specify multiple with a semicolon seperator, and use an output filename without extension
preprocessors Define a set of preprocessors values. Use ; to separate multiple
exclude Defines one or more strings that can't be part of the path Ie '*/Samples/*;*/UnitTests/*'
(use forward slash for folder separators)
regexfilter Defines a regular expression for filtering on full file names in the source
showPrivate Show private members (default is false)
showInternal Show internal members (default is false)
output Filename to write the output to (extension is optional, but exclude the extension if you specify multiple formats)
```
### NuGet
As an alternative you can also reference a [NuGet package](https://www.nuget.org/packages/dotMorten.OmdGenerator/) to your class library, and set up a post-build script to generate an Object Model Diagram HTML file:
```
Install-Package dotMorten.OmdGenerator
```
Add the following to your project:
```xml
```
An example of a generated output for all of .NET Core can be found [here](http://www.sharpgis.net/Tests/corefx.html).
It can also be used to compare two folders (for instance two separate branches) and only show changes to the API. [Here's an example of .NET CoreFX v2.0 vs Master](http://www.sharpgis.net/Tests/corefx_new.html).
[](http://www.sharpgis.net/Tests/corefx.html)
### Examples
Generate OMD for .NET Core FX source code, and ignore ref and test folders:
```
generateomd /source=c:\github\dotnet\corefx\src /exclude="*/ref/*;*/tests/*;*/perftests/*"
```
Compare .NET CoreFX Master with v2.0.0 repo branches directly from their Github zipped downloads:
```
generateomd /source=https://github.com/dotnet/corefx/archive/master.zip /compareSource=https://github.com/dotnet/corefx/archive/release/2.0.0.zip /exclude="*/ref/*;*/tests/*;*/perftests/*"
```
What's new in Xamarin.Forms? Compare assemblies from the nuget cache:
```
generateomd /assemblies=%USERPROFILE%\.nuget\packages\xamarin.forms\3.3.0.912540\lib\netstandard2.0\*.dll /compareAsssemblies=%USERPROFILE%\.nuget\packages\xamarin.forms\3.2.0.871581\lib\netstandard2.0\*.dll
```