Git Product home page Git Product logo

Comments (3)

KlfJoat avatar KlfJoat commented on June 7, 2024

After painstakingly copying individual files from my live documentation to a clean repo, I have identified the bug. I have a repo I can post proving the issue.

For one, structurizr-lite seems to be parsing non-Markdown and non-AsciiDoc files.

I have a header file for another documentation generator. The file is named md-header (though my experiments prove the basename is irrelevant). Its contents can be simplified to...

<!-- Header template file I have laying around -->

When this file with no extension is present in my docs/ directory, structurizr-lite throws the error. As I understand FormatFinder.java and DefaultDocumentationImporter.java, files without extensions should not be parsed, but they are for me.

For completeness, the output of java --version for me is...

openjdk 17.0.9 2023-10-17
OpenJDK Runtime Environment (build 17.0.9+9-Ubuntu-123.10)
OpenJDK 64-Bit Server VM (build 17.0.9+9-Ubuntu-123.10, mixed mode, sharing)

This may also be a second bug, possibly related to structurizr/lite#44, which is that when structurizr-lite parses a file that has no MD/ADOC content, an inscrutable error message is provided. IMO it's definitely a usability bug. This troubleshooting would have been a lot easier if the parser could tell users which file tripped it up, and preferably why (no content).

from java.

KlfJoat avatar KlfJoat commented on June 7, 2024

Will you break the utter silence to share when the fix might make it to structurizr-lite?

from java.

simonbrowndotje avatar simonbrowndotje commented on June 7, 2024

I have no immediate plans for a release, but hopefully it will be later this month.

from java.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.