7 ms·

I wrote a tool in Go to write Sequence Diagrams in Go

65 points by icemanx 3y ago

mevric 3y ago
Love the thought mentioned the warning section https://github.com/MrIceman/go-uml#warning---ai-not-welcome-here https://github.com/MrIceman/go-uml#warning---ai-not-welcome-...
- warent 3y ago
  I don't. It's fine making a personal choice to not use AI, but to go on to just openly insult anyone who uses AI is absurd and too far. Everyone is allowed their choices and we should respect that. The doom-whispering is not charming or insightful, good grief.
  - mevric 3y ago
    Agreed. I use AI to speed up my work and love the process of discovering new ideas. I was referring to the following line. "Just like people stopped walking because they commute by cars and trains, which caused an increase in obesity and illness"
    - tester457 3y ago
      If LLMs are transportation, here's to hoping we have a Netherlands like solution, with lots of bicycles and trains for longer distances, meaning lots of healthy people. Instead of "car-dependency" we should try to use LLMs as bicycles for the mind, still putting effort into every mental pedal.
    - IshKebab 3y ago
      But people didn't stop walking...
  - deleted 3y ago
    [deleted]
  - kitd 3y ago
    I didn't read any insult. I don't agree with the author but all I perceived was encouragement against using AI, not personal denigration for doing so.
  - robbywashere_ 3y ago
    This is a typical Ai-ist stance, us warm blooded norm-coders are absolutely sick of this rhetoric!
- cirrus3 3y ago
  It seemed pretty cringy to me
marcc 3y ago
The "AI Not Welcome Here" is interesting at the bottom of the Readme. https://github.com/MrIceman/go-uml#warning---ai-not-welcome-here https://github.com/MrIceman/go-uml#warning---ai-not-welcome-... This is a pretty hard stance to take when creating an OSS project. The author made an open source, MIT-licensed repo. Right now, the statement reads "I wrote this all myself". Does that mean the author is not willing to accept PRs? Or will we see something like a DCO that developers make an attestation that AI was not used in creating the change?
- lib-dev 3y ago
  > Right now, the statement reads "I wrote this all myself". He says, "all the code in this repository _that_ was written by me" was, if fact, hand-written by him rather than auto-generated by a tool like copilot. I read it as he is open to contributions and if you want to use AI that's allowed but he notes that he does not and he provides a rationale to boot. Fine by me.
zelphirkalt 3y ago
I do not see any different kinds of edges in the diagram. Is only one kind of message supported, or is perhaps the example not chosen to include all kinds of message/returns?
huydotnet 3y ago
There's an AI solution for this https://chatuml.com/ https://chatuml.com/ OK, I know the author are against AI, but just in case anyone want to see an AI solution.
- cle 3y ago
  The author explicitly discusses requirements: > You don't need to download any dependencies such as plantUML or Graphviz, which is what most of the tools out there require and what was also my motivation to start this project. go-uml is using a 2D graphics engine written 100% in Go https://github.com/fogleman/gg https://github.com/fogleman/gg This is not a solution for these requirements.
- fleur-de-lotus 3y ago
  Wait, they ask for your api key and they promise not to store it !
  - huydotnet 3y ago
    Other OpenAI-based projects does that too, and there's an option to not provide your API key as well https://chatuml.com/early-bird https://chatuml.com/early-bird
alecnotthompson 3y ago
According to author, they're either fat or have never ridden in a car.
Xeronate 3y ago
Nice work, but seems like WSD accomplishes the same with a nicer syntax and hosted interface https://www.websequencediagrams.com/ https://www.websequencediagrams.com/
umvi 3y ago
"Because of my own personal philosophy regarding technology and AI, all the code in this repository that was written by me - I wrote 100% on my own. There is and will be no usage of Github Co-Pilot or any other AI tool." As a developer that recently went to the dark side with co-pilot... all I can say is that from my perspective having used AI-augmented IDEs, arguments like this seem to me like a carpenter refusing to try power saws and power drills because craftsmanship will be lost compared to using handsaws and awls + hand drills. In my opinion, AI tools greatly enhance my craftsmanship by both saving me time and by suggesting solutions I didn't even know existed (most recent example being JS .every() and .some() - I was about to roll my own every/some equivalent with loops)
- CodeWriter23 3y ago
  That’s a flawed analogy, a power saw never suggests a cutting pattern while the very essence of what copilot/AI etc does is suggest coding patterns. Which may or may not be vetted. Typing manually vs auto-complete is a correct handsaw/power saw analogy.
  - apgwoz 3y ago
    Saws certainly can project a laser beam across the cutting surface, and don't get me started about AI powered CNC cuts. I mean, just the other day I found the words "WHY ARE YOU IGNORING ME?" CNC'd onto a piece of plywood I left in my shop. I didn't do that by hand.
  - umvi 3y ago
    In my experience copilot behaves more like a power tool than what you are suggesting. I know the cut that needs to be made, and copilot makes the cut faster than it would have taken me to make the cut myself via RTFM/google/stackoverflow.
- dimator 3y ago
  isn't it closer to "a carpenter refusing to offload the design of subassemblies to an alien whose understanding of carpentry is completely opaque"? although, i suppose, to your point, even an alien could introduce a skilled carpenter to a new table saw technique.
kerblang 3y ago
Nice idea. I think there's an error in the last diagram. The arrow pointing at User A should point at User B. (And look it's possible to say something other than blithering about AI controversy. The author doesn't like AI, get over it)
azubinski 3y ago
My respect to the author for the principled position.
pachico 3y ago
I use PlantUML every single day. It can be embedded in Markdown docs and even Confluence (which I hate but I'm forced to use). Diagram as Code is simply awesome. My only issue is how ugly it looks, even using themes. I wish an application managed to be a drop in replacement that looked like it wasn't drawn in MS Paint in 1996.
Veuxdo 3y ago
I'm a bit biased, but I feel diagrams-as-code should use a stateless, declarative language (like json or yaml) and not a programming language. Programming languages have so much functionality that just doesn't apply to the output you're generating. I guess the argument is "I already know Go" (or Python etc.). But you probably already know json (yaml), too. And if not, it won't take long to learn.
- taeric 3y ago
  Depends heavily on the diagram? I go farther, all told. I think any sort of diagram should almost certainly be process/pipeline based. Parts can be generated by a declarative markup, certainly. But you need a pipeline to "hand tune" things or you will end with diagrams that are clearly generated by a program. Fine for some things, sure. But there is a reason most of the diagrams that you remember the looks of were bespoke authored in a much more graphical environment.
  - smoyer 3y ago
    If this was used as a generator, you could include actual type names, godoc comments (on mouse over for smarter image formats), etc. In this case, it's the fact that the rest of the code could provide context.
- datadeft 3y ago
  Like D2? I love it. https://play.d2lang.com/ https://play.d2lang.com/
- sn9 3y ago
  I've used python for graphviz just because I wanted some looping for many-to-one or one-to-many relationships and the auto-complete that comes from anything with an LSP or Python mode. Honestly I'd use it just for the auto-complete. (Admittedly, I didn't look too hard for dedicated editing environments that could do it for DOT files specifically. I just wanted to make something real quick.)
- cle 3y ago
  There are times when it's very useful to have programmatic bindings for diagrams, I've used them multiple times when I want to create a diagram that represents the structure of some code, auto-generate a state machine diagram based on the code, etc. These are very handy because you don't need to keep documentation up-to-date.
maister 3y ago
> Warning - AI not welcome here > Because of my own personal philosophy regarding technology and AI, all the code in this repository that was written by me - I wrote 100% on my own. There is and will be no usage of Github Co-Pilot or any other AI tool. I became a software developer because of my passion for our craft - Software Engineering. I build this tool because I enjoy programming. Every single line of code you'll read in this repo, that was written by me, is produced first in my mind and then manifested into reality through my hands. I encourage any contributor to follow the same principle, though I can't and don't want to put any restrictions on this. Just like people stopped walking because they commute by cars and trains, which caused an increase in obesity and illness, I believe that the massive usage of AI will cause people to stop thinking and using their minds and the resulting havoc is unthinkable. AI Gatekeeping... What a time to be alive!

65 points by icemanx 3y ago

Love the thought mentioned the warning section https://github.com/MrIceman/go-uml#warning---ai-not-welcome-here https://github.com/MrIceman/go-uml#warning---ai-not-welcome-...

warent 3y ago
I don't. It's fine making a personal choice to not use AI, but to go on to just openly insult anyone who uses AI is absurd and too far. Everyone is allowed their choices and we should respect that. The doom-whispering is not charming or insightful, good grief.
- mevric 3y ago
  Agreed. I use AI to speed up my work and love the process of discovering new ideas. I was referring to the following line. "Just like people stopped walking because they commute by cars and trains, which caused an increase in obesity and illness"
  - tester457 3y ago
    If LLMs are transportation, here's to hoping we have a Netherlands like solution, with lots of bicycles and trains for longer distances, meaning lots of healthy people. Instead of "car-dependency" we should try to use LLMs as bicycles for the mind, still putting effort into every mental pedal.
  - IshKebab 3y ago
    But people didn't stop walking...
- deleted 3y ago
  [deleted]
- kitd 3y ago
  I didn't read any insult. I don't agree with the author but all I perceived was encouragement against using AI, not personal denigration for doing so.
- robbywashere_ 3y ago
  This is a typical Ai-ist stance, us warm blooded norm-coders are absolutely sick of this rhetoric!
cirrus3 3y ago
It seemed pretty cringy to me

marcc 3y ago

The "AI Not Welcome Here" is interesting at the bottom of the Readme. https://github.com/MrIceman/go-uml#warning---ai-not-welcome-here https://github.com/MrIceman/go-uml#warning---ai-not-welcome-... This is a pretty hard stance to take when creating an OSS project. The author made an open source, MIT-licensed repo. Right now, the statement reads "I wrote this all myself". Does that mean the author is not willing to accept PRs? Or will we see something like a DCO that developers make an attestation that AI was not used in creating the change?

lib-dev 3y ago
> Right now, the statement reads "I wrote this all myself". He says, "all the code in this repository _that_ was written by me" was, if fact, hand-written by him rather than auto-generated by a tool like copilot. I read it as he is open to contributions and if you want to use AI that's allowed but he notes that he does not and he provides a rationale to boot. Fine by me.

zelphirkalt 3y ago

I do not see any different kinds of edges in the diagram. Is only one kind of message supported, or is perhaps the example not chosen to include all kinds of message/returns?

huydotnet 3y ago

There's an AI solution for this https://chatuml.com/ https://chatuml.com/ OK, I know the author are against AI, but just in case anyone want to see an AI solution.

cle 3y ago
The author explicitly discusses requirements: > You don't need to download any dependencies such as plantUML or Graphviz, which is what most of the tools out there require and what was also my motivation to start this project. go-uml is using a 2D graphics engine written 100% in Go https://github.com/fogleman/gg https://github.com/fogleman/gg This is not a solution for these requirements.
fleur-de-lotus 3y ago
Wait, they ask for your api key and they promise not to store it !
- huydotnet 3y ago
  Other OpenAI-based projects does that too, and there's an option to not provide your API key as well https://chatuml.com/early-bird https://chatuml.com/early-bird

alecnotthompson 3y ago

According to author, they're either fat or have never ridden in a car.

Xeronate 3y ago

Nice work, but seems like WSD accomplishes the same with a nicer syntax and hosted interface https://www.websequencediagrams.com/ https://www.websequencediagrams.com/

umvi 3y ago

"Because of my own personal philosophy regarding technology and AI, all the code in this repository that was written by me - I wrote 100% on my own. There is and will be no usage of Github Co-Pilot or any other AI tool." As a developer that recently went to the dark side with co-pilot... all I can say is that from my perspective having used AI-augmented IDEs, arguments like this seem to me like a carpenter refusing to try power saws and power drills because craftsmanship will be lost compared to using handsaws and awls + hand drills. In my opinion, AI tools greatly enhance my craftsmanship by both saving me time and by suggesting solutions I didn't even know existed (most recent example being JS .every() and .some() - I was about to roll my own every/some equivalent with loops)

CodeWriter23 3y ago
That’s a flawed analogy, a power saw never suggests a cutting pattern while the very essence of what copilot/AI etc does is suggest coding patterns. Which may or may not be vetted. Typing manually vs auto-complete is a correct handsaw/power saw analogy.
- apgwoz 3y ago
  Saws certainly can project a laser beam across the cutting surface, and don't get me started about AI powered CNC cuts. I mean, just the other day I found the words "WHY ARE YOU IGNORING ME?" CNC'd onto a piece of plywood I left in my shop. I didn't do that by hand.
- umvi 3y ago
  In my experience copilot behaves more like a power tool than what you are suggesting. I know the cut that needs to be made, and copilot makes the cut faster than it would have taken me to make the cut myself via RTFM/google/stackoverflow.
dimator 3y ago
isn't it closer to "a carpenter refusing to offload the design of subassemblies to an alien whose understanding of carpentry is completely opaque"? although, i suppose, to your point, even an alien could introduce a skilled carpenter to a new table saw technique.

kerblang 3y ago

Nice idea. I think there's an error in the last diagram. The arrow pointing at User A should point at User B. (And look it's possible to say something other than blithering about AI controversy. The author doesn't like AI, get over it)

azubinski 3y ago

My respect to the author for the principled position.

pachico 3y ago

I use PlantUML every single day. It can be embedded in Markdown docs and even Confluence (which I hate but I'm forced to use). Diagram as Code is simply awesome. My only issue is how ugly it looks, even using themes. I wish an application managed to be a drop in replacement that looked like it wasn't drawn in MS Paint in 1996.

Veuxdo 3y ago

I'm a bit biased, but I feel diagrams-as-code should use a stateless, declarative language (like json or yaml) and not a programming language. Programming languages have so much functionality that just doesn't apply to the output you're generating. I guess the argument is "I already know Go" (or Python etc.). But you probably already know json (yaml), too. And if not, it won't take long to learn.

taeric 3y ago
Depends heavily on the diagram? I go farther, all told. I think any sort of diagram should almost certainly be process/pipeline based. Parts can be generated by a declarative markup, certainly. But you need a pipeline to "hand tune" things or you will end with diagrams that are clearly generated by a program. Fine for some things, sure. But there is a reason most of the diagrams that you remember the looks of were bespoke authored in a much more graphical environment.
- smoyer 3y ago
  If this was used as a generator, you could include actual type names, godoc comments (on mouse over for smarter image formats), etc. In this case, it's the fact that the rest of the code could provide context.
datadeft 3y ago
Like D2? I love it. https://play.d2lang.com/ https://play.d2lang.com/
sn9 3y ago
I've used python for graphviz just because I wanted some looping for many-to-one or one-to-many relationships and the auto-complete that comes from anything with an LSP or Python mode. Honestly I'd use it just for the auto-complete. (Admittedly, I didn't look too hard for dedicated editing environments that could do it for DOT files specifically. I just wanted to make something real quick.)
cle 3y ago
There are times when it's very useful to have programmatic bindings for diagrams, I've used them multiple times when I want to create a diagram that represents the structure of some code, auto-generate a state machine diagram based on the code, etc. These are very handy because you don't need to keep documentation up-to-date.

maister 3y ago

> Warning - AI not welcome here > Because of my own personal philosophy regarding technology and AI, all the code in this repository that was written by me - I wrote 100% on my own. There is and will be no usage of Github Co-Pilot or any other AI tool. I became a software developer because of my passion for our craft - Software Engineering. I build this tool because I enjoy programming. Every single line of code you'll read in this repo, that was written by me, is produced first in my mind and then manifested into reality through my hands. I encourage any contributor to follow the same principle, though I can't and don't want to put any restrictions on this. Just like people stopped walking because they commute by cars and trains, which caused an increase in obesity and illness, I believe that the massive usage of AI will cause people to stop thinking and using their minds and the resulting havoc is unthinkable. AI Gatekeeping... What a time to be alive!