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

Added PlantUmlDiagrams package and PlantUmlConnection dependency #6946

Merged
merged 2 commits into from
Mar 23, 2018

Conversation

evandrocoan
Copy link
Contributor

@evandrocoan evandrocoan commented Feb 13, 2018

I forked https://github.com/jvantuyl/sublime_diagram_plugin to https://github.com/evandrocoan/PlantUmlDiagrams adding a server dependency https://github.com/evandrocoan/PlantUmlConnection and rewrote the whole git history removing all the java binary files which have been added, reducing the repository size from 22.49 MB to 204 KB. So, now I cannot open a pull request to the original author because git points out:

jvantuyl:master and evandroforks:master are entirely different commit histories.

If @jvantuyl would like to receive such changes, he would have to override his master branch with mine. If he do not like that, I would like to add this as an another package under a new name. Otherwise I can close this pull request.

On this fork I already manually merged the pull request from @overlord pending for his repository:

  1. #47 - support [png, svg, txt, utxt, latex] output image formats jvantuyl/sublime_diagram_plugin#59 support [png, svg, txt, utxt, latex] output image formats

I also fix jvantuyl/sublime_diagram_plugin#60 (Error Processing Diagram) the default example not compiling, also adding to output the error message from the Plantuml software.

This version now first attempts to contact the webserver accordingly to the new settings:

    // valid values:
    // 'png'              generate images using PNG format
    // 'svg'              generate images using SVG format
    // 'txt'              generate images with ASCII art
    // 'utxt'             generate images with ASCII art using Unicode characters
    // 'latex'            generate images using LaTeX/Tikz format
    // 'latex:nopreamble' generate images using LaTeX/Tikz format without preamble
    //
    // These formats are also supported by plantUml, but they need some
    // prerequisite to be installed... PlantUml return_code = 1 on invocation:
    // 'pdf' generate images using PDF format
    // 'vdx' generate images using VDX format
    // 'eps' generate images using EPS format
    "output_format": "png",

    // It will first try to use the server, because is much more faster than
    // calling directly the jar. If you would like to run a local server,
    // you can install it from: https://github.com/plantuml/plantuml-server
    "plantuml_server": "http://www.plantuml.com/plantuml/",

    // The full path to the plantuml.jar file
    "jar_file": "C:/Users/plantuml.jar",

Copy link
Collaborator

@packagecontrol-bot packagecontrol-bot left a comment

Choose a reason for hiding this comment

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

Automated testing result: ERROR

Repo link: PlantUmlDiagrams
Results help

Packages added:
  - PlantUmlDiagrams

Processing package "PlantUmlDiagrams"
  - ERROR: Error downloading repository. HTTP error 404 downloading https://api.github.com/repos/evandrocoan/PlantUmlDiagrams.

@evandrocoan evandrocoan reopened this Feb 13, 2018
Copy link
Collaborator

@packagecontrol-bot packagecontrol-bot left a comment

Choose a reason for hiding this comment

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

Automated testing result: ERROR

Repo link: PlantUmlDiagrams
Results help

Packages added:
  - PlantUmlDiagrams

Processing package "PlantUmlDiagrams"
  - ERROR: No valid semver tags found at https://github.com/evandrocoan/PlantUmlDiagrams/tags for the package "PlantUmlDiagrams".

@evandrocoan evandrocoan reopened this Feb 13, 2018
Copy link
Collaborator

@packagecontrol-bot packagecontrol-bot left a comment

Choose a reason for hiding this comment

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

Automated testing result: WARNING

Repo link: PlantUmlDiagrams
Results help

Packages added:
  - PlantUmlDiagrams

Processing package "PlantUmlDiagrams"
  - WARNING: '.no-sublime-package' is defined. Please verify that it is *really* necessary

@evandrocoan evandrocoan reopened this Feb 13, 2018
Copy link
Collaborator

@packagecontrol-bot packagecontrol-bot left a comment

Choose a reason for hiding this comment

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

Automated testing result: SUCCESS

Repo link: PlantUmlDiagrams

Packages added:
  - PlantUmlDiagrams

Processing package "PlantUmlDiagrams"
  - All checks passed

@FichteFoll
Copy link
Collaborator

@jvantuyl re-submitted their package in #6970. Can you guys fill me in on the current situation here?

@FichteFoll FichteFoll mentioned this pull request Mar 19, 2018
@jvantuyl
Copy link
Contributor

@FichteFoll Long story short, there was a hard fork because the two projects are really trying to do different things. Diagram aims to support any diagram-generating package we can include and has a plug-in architecture for that. It also is designed to be self-contained and not leak information to third parties in its default configuration.

PlantUmlDiagram is a hard fork. Rewriting the history to cut out bundled binaries has made merges impractical. It also has shifted to PlantUml only and many of the changes are slowly removing the plug-in architecture that was there. Finally, it requires an outside server to operate rather than bundling everything.

In terms of a feature comparison, Diagram vs PlantUmlDiagram:

  • supports multiple viewers on different platforms vs more opinionated on viewers (which is less of a big deal with Sublime 3)
  • has framework for multiple types of diagrams vs PlantUML only
  • self contained vs requires upstream server
  • runs disconnected vs requires internet connection (by default) / requires setting up a PlantUML server
  • does not consume third-party resources by default vs does consume third-party resources by default
  • bundles an often older-than-the-newest version vs gets newest version from third-party (by default)
  • never sends any of your diagram code off of your machine vs sends your diagram code to third-parties by default

I really consider them to be separate products, with separate goals, optimized for different use cases. We share patches where convenient, but they're firmly diverged with firmly different feature sets. While there is significant overlap, I wouldn't say they're much worse than the overlap you find in some of the PEP8 linters and the like.

@evandrocoan
Copy link
Contributor Author

evandrocoan commented Mar 22, 2018 via email

@FichteFoll
Copy link
Collaborator

Thanks, @jvantuyl. That explanation was insanely useful.

@FichteFoll
Copy link
Collaborator

@evandrocoan could you fix the merge conflict, please?

Copy link
Collaborator

@packagecontrol-bot packagecontrol-bot left a comment

Choose a reason for hiding this comment

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

Automated testing result: SUCCESS

Repo link: PlantUmlDiagrams

Packages added:
  - PlantUmlDiagrams

Processing package "PlantUmlDiagrams"
  - All checks passed

Copy link
Collaborator

@packagecontrol-bot packagecontrol-bot left a comment

Choose a reason for hiding this comment

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

Automated testing result: SUCCESS

Repo link: PlantUmlDiagrams

Packages added:
  - PlantUmlDiagrams

Processing package "PlantUmlDiagrams"
  - All checks passed

Copy link
Collaborator

@packagecontrol-bot packagecontrol-bot left a comment

Choose a reason for hiding this comment

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

Automated testing result: SUCCESS

Repo link: PlantUmlDiagrams

Packages added:
  - PlantUmlDiagrams

Processing package "PlantUmlDiagrams"
  - All checks passed

@FichteFoll FichteFoll merged commit a9c0c77 into wbond:master Mar 23, 2018
@evandrocoan evandrocoan deleted the plantuml_diagrams branch March 23, 2018 03:25
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.

Error Processing Diagram
4 participants