P3Model.Parser
0.4.0-preview01
Prefix Reserved
See the version list below for details.
dotnet add package P3Model.Parser --version 0.4.0-preview01
NuGet\Install-Package P3Model.Parser -Version 0.4.0-preview01
<PackageReference Include="P3Model.Parser" Version="0.4.0-preview01" />
paket add P3Model.Parser --version 0.4.0-preview01
#r "nuget: P3Model.Parser, 0.4.0-preview01"
// Install P3Model.Parser as a Cake Addin
#addin nuget:?package=P3Model.Parser&version=0.4.0-preview01&prerelease
// Install P3Model.Parser as a Cake Tool
#tool nuget:?package=P3Model.Parser&version=0.4.0-preview01&prerelease
P3 Model Parser
P3 Model Parser is a tool that generate documentation from C# source code enriched with metadata like: annotations and JSON or Markdown files.
Usage
- Create console application.
- Add P3Model.Parser package.
- Configure Parser in
Program.cs
like that:await P3 .Product(product => product .UseName("YOUR_SYSTEM_NAME")) .Repositories(repositories => repositories .Use("REPOSITORY_PATH")) .Analyzers(analyzers => analyzers .UseDefaults(options => options .TreatNamespacesAsDomainModules(namespaces => namespaces .RemoveNamespacePart("PART_TO_REMOVE")))) .OutputFormat(formatters => formatters .UseMermaid(options => options .Directory("MERMAID_OUTPUT_PATH") .UseDefaultPages()) .UseJson(options => options .File("JSON_OUTPUT_PATH"))) .LogLevel(LogEventLevel.Verbose) .Analyze();
- Run
- Run parser from command line or your IDE.
- Integrate Parser with your CI pipeline to update documentation on every commit.
Here is example with GitHub Action:name: Generate P3 documentation on: push: branches: - main jobs: generate-p3-docs: runs-on: ubuntu-latest permissions: contents: write steps: - name: Checkout repository uses: actions/checkout@v4 - name: Restore packages run: dotnet restore - name: Run P3 Parser run: dotnet run --project Docs/P3/DocsGenerator/DocsGenerator.csproj - name: Add, Commit & Push changes uses: stefanzweifel/git-auto-commit-action@v5 with: commit_message: "P3 docs updated"
P3 Model project
P3 Model is a tool to automatically generate documentation from your source code.
Generated documentation is based on information already present in the code and additional metadata added with annotations and JSON or Markdown files.
Each technology like .net or Java has its own tooling. This library is a part of .net tooling.
If you'd like to find more information about P3 Model check project's main repository.
Contribution
If you'd like to contribute check project's main repository.
License
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net6.0
- DotNetExtensions (>= 1.0.0)
- Humanizer.Core (>= 2.14.1)
- Microsoft.CodeAnalysis (>= 4.9.2)
- Microsoft.CodeAnalysis.Common (>= 4.9.2)
- Microsoft.CodeAnalysis.CSharp.Workspaces (>= 4.9.2)
- Microsoft.CodeAnalysis.Workspaces.Common (>= 4.9.2)
- Microsoft.CodeAnalysis.Workspaces.MSBuild (>= 4.9.2)
- P3Model.Annotations (>= 0.4.0-preview01)
- P3Model.Parser.CodeAnalysis.Abstractions (>= 1.0.0)
- P3Model.Parser.ModelSyntax (>= 1.0.0)
- P3Model.Parser.OutputFormatting (>= 1.0.0)
- P3Model.Parser.OutputFormatting.Json (>= 1.0.0)
- Serilog (>= 3.1.1)
- Serilog.Sinks.Console (>= 5.0.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories (1)
Showing the top 1 popular GitHub repositories that depend on P3Model.Parser:
Repository | Stars |
---|---|
itlibrium/DDD-starter-dotnet
Sample implementation and comparison of various approaches to building DDD applications. Useful as a baseline to quickly start a DDD dot net project.
|
Version | Downloads | Last updated |
---|---|---|
0.4.0 | 84 | 5/18/2024 |
0.4.0-preview02 | 74 | 5/14/2024 |
0.4.0-preview01 | 63 | 5/11/2024 |
0.3.0-preview11 | 56 | 2/15/2024 |
0.3.0-preview10 | 56 | 2/14/2024 |
0.3.0-preview09 | 50 | 2/14/2024 |
0.3.0-preview07 | 73 | 1/26/2024 |
0.3.0-preview06 | 45 | 1/26/2024 |
0.3.0-preview05 | 46 | 1/26/2024 |
0.3.0-preview04 | 43 | 1/26/2024 |
0.3.0-preview03 | 50 | 1/25/2024 |
0.3.0-preview01 | 43 | 1/25/2024 |
0.2.1 | 150 | 1/3/2024 |
0.2.0 | 82 | 12/19/2023 |
0.2.0-preview03 | 102 | 12/13/2023 |
0.2.0-preview02 | 178 | 12/1/2023 |
0.2.0-preview01 | 104 | 11/28/2023 |
0.1.0-preview9 | 90 | 11/25/2023 |
0.1.0-preview8 | 126 | 9/25/2023 |
0.1.0-preview7 | 85 | 9/25/2023 |
0.1.0-preview6 | 107 | 9/7/2023 |
0.1.0-preview5 | 99 | 9/5/2023 |
0.1.0-preview4 | 130 | 7/21/2023 |
0.1.0-preview3 | 110 | 7/13/2023 |
0.1.0-preview2 | 99 | 7/11/2023 |
0.1.0-preview1 | 100 | 7/11/2023 |
annotations refactored