tpl/transform: Add template func for TOML/JSON/YAML docs examples conversion

[bep]

Usage:

{{ "title = \"Hello World\"" | transform.Remarshal "json" | safeHTML }}

Fixes #4389

/cc @regisphilibert

[moorereason]

Serlify? Where did you come up with that? 😆

[bep]

Serlify? Where did you come up with that?

Here.

[bep]

Seriously, I welcome better suggestions (however I suspect this will be a classic. So TOML, JSON etc. are data serialization formats ... serlify). But this func is kind of a special purpose "Hugo docs func", but I guess others will pick up on it ...

[moorereason]

"This is primarily"

[moorereason]

"not a"

[bep]

@regisphilibert I will merge this into master some time during this weekend. It should work, but I want to test it a little. There may be some date issues that could be improved. Not sure.

[regisphilibert]

@bep Sure I'll try it once it's on master and will go back to the hugoDocs repo to add the toggling config shortcode issue where we'll talk more about front end.

Thanks a ton! You were super fast with this.

[bep]

Thanks a ton! You were super fast with this.

Yes, I have been annoyed by the "example situation" for a long time -- and if someone wants to do something about it, I will try to keep that momentum going ...

[kaushalmodi]

How about serialize, or remarshal (there's even a GitHub repo named that, that does exactly this - TOML/YAML/JSON conversion)?

[bep]

How about serialize, or remarshal

"remarshal" I kind of like, but ...

[regisphilibert]

I like that it ends with ...fy. Reminds of jsonify which everybody knows.

[kaushalmodi]

My take is that in jsonify, removing "ify", the "json" part makes sense, and similarly "markdown" + "ify" = markdownify. The same logic doesn't work here.. "serl" doesn't mean anything. If sticking to "-ify" is the aim, then may be.. serialify.

But then the question is.. is this process technically serialization/marshalling?

JSON, or TOML, or YAML, each of those is already marshalled, or converted from raw data into some sort of format, a spec, an object.

If we are converting among these formats, something like remarshall, reformat, transform (though, the library is also called the same) sounds more correct.

[vassudanagunta]

Add template func for TOML/JSON/YAML docs examples conversion

that does exactly this - TOML/YAML/JSON conversion)?

If we are converting

hint hint

[vassudanagunta]

Or if the package name will always be present:

{`{{ "title = \"Hello World\"" | transform.to "json" | safeHTML }}`, "{\n   \"title\": \"Hello World\"\n}\n"},

Or even:

{`{{ "title = \"Hello World\"" | transform.toJSON | safeHTML }}`, "{\n   \"title\": \"Hello World\"\n}\n"},

{`{{ "title = \"Hello World\"" | transform.toYAML | safeHTML }}`, "{\n   \"title\": \"Hello World\"\n}\n"},

{`{{ "title = \"Hello World\"" | transform.toTOML | safeHTML }}`, "{\n   \"title\": \"Hello World\"\n}\n"},

The latter works even if the package name is optional:

{`{{ "title = \"Hello World\"" | toJSON | safeHTML }}`, "{\n   \"title\": \"Hello World\"\n}\n"},

[bep]

@vassudanagunta thanks, but it needs to be one method so it can be (easy to) dynamically invoked.

[bep]

And the winner is @kaushalmodi

{{ "title = \"Hello World\"" | transform.Remarshal "json" | safeHTML }}

[github-actions]

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.