zardoz89 / ftldoc

FreeMarker template language (FTL) HTML documentation generator

Hey! 👋

---

✨ I'm a Full-Stack Developer working in Madrid, Spain. I mainly work with Java for backend, and JavaScript (and HTML&CSS/SCSS) for frontend. Sometimes I do other stuff for fun in C, Dlang and other languages.

• 🏳️‍🌈♠ My Pronouns: Any
• 📫 How to reach me: https://linktr.ee/fantasmitaasex
• 🍑 Hobbies : 🔭 Astronomy, 🤖 sci-fi, 🚂 trains, 💾 retrocomputing, playing 👾 videogames & 🎲 boardgames, 🪄 RPG (D&D mainly)

My GitHub Stats

ftldoc's Issues

If there is multiple freemarkerFile entries pointing to the same file, the FTL it's procesed multiples times

Giving multiple entries to the same FTL file, the file it's procesed multiple times and generates multiple entries on the file list.

Switch to semantic versioning

https://semver.org/

Given a version number MAJOR.MINOR.PATCH, increment the:

MAJOR version when you make incompatible API changes,
MINOR version when you add functionality in a backwards compatible manner, and
PATCH version when you make backwards compatible bug fixes.

Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

Study supporting markdown inside comments

Study supporting markdown inside comments

Other languages (DLang for example), has begun to support Markdown inside his document processor, and allows to make links, listsn, including images, etc... less verbose.

Empathize the actual file on the file list

Empathize (should it on bold text) the actual file on the file list , so it's more easy to see what is the actual file.

Support repeated annotations

Actually, having the same annotation repeated (ie two @author for example) override the previous. It should list the repeated values.

For example :

<#--
    @author Foo
    @author Baz
-->

Only shows Author Baz.

This happens, because when finds a @ annotation, stored it directly on the output map. Instead, should store it on a list (and the formatting templates should expect to be a sequence of values), so could list repeated annotations.

List and support global defined variables

Actually, any global variable defined on a FTL file, its'n listed. Global vars on the root of a FTL file, should be listed, and if have a FTLDoc comment, show the information of that FTLDoc.

Support on default templates of IntelliJ annotations

https://www.jetbrains.com/help/idea/template-data-languages.html#special-comments

Comment	Description
@Implicitly included	Any FreeMarker file that starts with this comment is included into all files that are in the same module or its dependencies. Use such a dedicated comments file to define IDE-specific comments, so that they do not pollute your template files.
@ftlvariable	Defines a variable. For example, the following comment declares a variable named foo of type String, visible only in the specified file: <#-- @ftlvariable name="foo" type="java.lang.String" file="path/to/file" -->
@ftlroot	Defines the path relative to which import and include directives are resolved. The path is specified relative to any of the directories in the current FTL file's package. Paths inside JARs are also supported, for example: <#-- @ftlroot "path/to.jar!/path/inside/jar" -->

TemplatesLoader and Freemaker procesing engine, should be separated of the input freemarker files

TemplatesLoader and Freemaker processing engine, should be separated of the input freemarker files, because :

• Could be clash of names
• An user could try to user a old compatibility freemarker version that it's no compatible with the default templates.

Categorize file list

If a project have many FTL files, a plane list of files could be hard to follow. Categorizing the files by path should help.

For example :

• \foo\bar\lib\globals.ftl
• \foo\bar\lib\lib.ftl
• \foo\bar\components\grid.ftl
• \foo\bar\components\input.ftl

Should generate a file list like this :

lib\
globals.ftl
lib.ftl

components\
grid.ftl
input.ftl