Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: Generate Mermaid HTML diagrammer from input assembly via ilspycmd #3324

Draft
wants to merge 28 commits into
base: master
Choose a base branch
from

Conversation

h0lg
Copy link

@h0lg h0lg commented Nov 8, 2024

In this PR I contribute https://github.com/h0lg/netAmermaid to ILSpy - building it into ILSpyX and making it accessible via ilspycmd as discussed in h0lg/netAmermaid#6 .

At the time of writing both the

  • dev loop for the C# bits in Visual Studio and
  • a separate one for the HTML/JS/CSS development in VsCode

are functional.

Still TO DO:

  • contribute the existing doco
  • write new dev doco to edit HTML/JS/CSS in VsCode and which tasks to run in which order there
  • renaming / rebranding: generated diagrammers still point to the old repo, use the original icon, are branded as netAmermaid

@h0lg h0lg marked this pull request as draft November 8, 2024 00:53
@christophwille
Copy link
Member

Regarding documentation - I would propose:

  • add a separate section in https://github.com/icsharpcode/ILSpy/tree/master/ICSharpCode.ILSpyCmd (README.md) "Diagramming" with common command line samples and basic usage. Reference the wiki for
  • Deep-dive "how-to-use" in the Wiki
  • Deep-dive "developers working on the feature" info can go in a README inside the MermaidDiagrammer folder (exclude from build, no images)

@christophwille
Copy link
Member

Some general notes

@h0lg
Copy link
Author

h0lg commented Nov 8, 2024

0_o wow. I never worked in a repo where you get punished that hard for simple committing. Is there another way I can apply these formattings, e.g. pre-push? This is poison to my flow.

@christophwille
Copy link
Member

@h0lg
Copy link
Author

h0lg commented Nov 8, 2024

I am using https://marketplace.visualstudio.com/items?itemName=mynkow.FormatdocumentonSave

If that's all the script does - I have an extension like that running as well. I also found https://github.com/icsharpcode/ILSpy/blob/master/BuildTools/format.bat which seems to work if I replace the bash path to match my environment.

@h0lg h0lg force-pushed the mermaid-diagrammer branch 4 times, most recently from f40934c to 96fcf14 Compare November 8, 2024 20:27
<img src="./html/netAmermaid.ico" align="right" title="" />

<!--TOC-->
- [What can it do for you and how?](#what-can-it-do-for-you-and-how)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That was my earlier reference of "end user documentation in the Wiki" - basically this document => Wiki.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got you. I understand you mean a new top-level page in https://github.com/icsharpcode/ILSpy/wiki

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes - maybe simply call it Diagramming

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've cleaned and split the doco up further

  • moving the ilspycmd examples into the ilspycmd Readme (after the help output) and
  • extracting the How does it work? chapter into a developer-facing readme
  • renaming the leftovers to Wiki.md (because that's where they'll go)

Should html/UsingDiagrammer.md remain a standalone page at this point (and if so, where should it go) or be merged into Wiki.md?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants