[feat] Render to INI-style formats #59

New Issue

adam · 2025-12-30T01:20:12+01:00

adam commented

2025-12-30 01:20:12 +01:00

Originally created by @moritztim on GitHub (Feb 13, 2024).

I know your bandwidth is limited, just putting it out there. I would love to see support for INI-like formats, such as systemd configuration files or even just plain ini files.

Here are the INI-style formats I can think of:

Microsoft INI, implemented in Question: Submit to CNCF (#149)
Freedesktop desktop entry
Freedesktop systemd config
Editorconfig

Feel free to suggest more and I'll add them to the list

Originally created by @moritztim on GitHub (Feb 13, 2024). I know your bandwidth is limited, just putting it out there. I would love to see support for INI-like formats, such as systemd configuration files or even just plain ini files. Here are the INI-style formats I can think of: - [x] [Microsoft INI](https://en.wikipedia.org/wiki/INI_file), implemented in #149 - [ ] [Freedesktop desktop entry](https://specifications.freedesktop.org/desktop-entry-spec/latest/) - [ ] [Freedesktop systemd config](https://www.freedesktop.org/software/systemd/man/latest/systemd.syntax.html) - [ ] [Editorconfig](https://spec.editorconfig.org) Feel free to suggest more and I'll add them to the list

adam added the help wanted label 2025-12-30 01:20:12 +01:00

adam commented

2025-12-30 01:20:13 +01:00

@holzensp commented on GitHub (Feb 13, 2024):

It's a totally legit ask. For other output formats, especially "simpler" ones, we recommend implementing them in Pkl itself. We did this with the TOML renderer, for example: https://github.com/apple/pkl-pantry/tree/main/packages/pkl.toml

Since bandwidth is indeed limited, you might want to have a go at it that way yourself; we're more than happy to support / review / etc. and since this can be written in Pkl itself, it doesn't require expertise about Pkl internals.

@holzensp commented on GitHub (Feb 13, 2024): It's a totally legit ask. For other output formats, especially "simpler" ones, we recommend implementing them in Pkl itself. We did this with the TOML renderer, for example: https://github.com/apple/pkl-pantry/tree/main/packages/pkl.toml Since bandwidth is indeed limited, you might want to have a go at it that way yourself; we're more than happy to support / review / etc. and since this can be written in Pkl itself, it doesn't require expertise about Pkl internals.

adam commented

2025-12-30 01:20:13 +01:00

@Madmegsox1 commented on GitHub (Feb 13, 2024):

Hi, ill have a look at starting to create a INIRenderer.

@Madmegsox1 commented on GitHub (Feb 13, 2024): Hi, ill have a look at starting to create a `INIRenderer`.

adam commented

2025-12-30 01:20:14 +01:00

@moritztim commented on GitHub (Feb 13, 2024):

since this can be written in Pkl itself, it doesn't require expertise about Pkl internals.

I love that
Unfortunately my bandwith is also limited 💀 but I might get into making some other renderers at a later point, sounds like a fun challenge

@moritztim commented on GitHub (Feb 13, 2024): > since this can be written in Pkl itself, it doesn't require expertise about Pkl internals. I love that Unfortunately my bandwith is also limited :skull: but I might get into making some other renderers at a later point, sounds like a fun challenge

adam commented

2025-12-30 01:20:14 +01:00

@Madmegsox1 commented on GitHub (Feb 13, 2024):

Its looking good so far the IniRenderer renders ini files in the correct structure just need to handle escape codes and correctly formatting (breakline after each nest) the ini file. Here is a look at what the test outputted.

int = 123
float = 1.23
bool = true
string = Pigeon
unicodeString = abc😀abc😎abc
multiLineString = have a
great
day
[map]
one = 123
two = 1.23
three = true
four = Pigeon
five = abc😀abc😎abc
six = have a
great
day
[map.seven]
name = Pigeon
[mapping]
one = 123
two = 1.23
three = true
four = Pigeon
five = abc😀abc😎abc
six = have a
great
day
[mapping.seven]
name = Pigeon
[typedObject]
name = Pigeon
age = 30
[typedObject.address]
street = Folsom St.
[container]
name = Pigeon
age = 30
[container.address]
street = Folsom St.

@Madmegsox1 commented on GitHub (Feb 13, 2024): Its looking good so far the `IniRenderer` renders ini files in the correct structure just need to handle escape codes and correctly formatting (breakline after each nest) the ini file. Here is a look at what the test outputted. ```ini int = 123 float = 1.23 bool = true string = Pigeon unicodeString = abc😀abc😎abc multiLineString = have a great day [map] one = 123 two = 1.23 three = true four = Pigeon five = abc😀abc😎abc six = have a great day [map.seven] name = Pigeon [mapping] one = 123 two = 1.23 three = true four = Pigeon five = abc😀abc😎abc six = have a great day [mapping.seven] name = Pigeon [typedObject] name = Pigeon age = 30 [typedObject.address] street = Folsom St. [container] name = Pigeon age = 30 [container.address] street = Folsom St. ```

adam commented

2025-12-30 01:20:15 +01:00

@Madmegsox1 commented on GitHub (Feb 14, 2024):

Its now outputting correctly and handles escape chars. Is there anywhere else i need to add the IniRenderer to?

@Madmegsox1 commented on GitHub (Feb 14, 2024): Its now outputting correctly and handles escape chars. Is there anywhere else i need to add the `IniRenderer` to?

adam commented

2025-12-30 01:20:15 +01:00

@bioball commented on GitHub (Feb 14, 2024):

Nice! Do you want to PR this? That will make it a little easier to iterate.

To add a new in-language renderer, you will need to create a new standard library module. To do that:

Create the stdlib module itself; stdlib/ini.pkl
Create a new class in org.pkl.core.runtime that extends StdlibModule, and add it to org.pkl.core.runtime.ModuleCache#getOrLoad (see the existing source code to look at what's currently already there).
Create a class RendererNodes in new package org.pkl.core.stdlib.ini (see the other stdlib packages that are in there for reference)

You will also need to add language snippet tests for this renderer, in pkl-core/src/test/files/LanguageSnippetTests/input/api/

@bioball commented on GitHub (Feb 14, 2024): Nice! Do you want to PR this? That will make it a little easier to iterate. To add a new in-language renderer, you will need to create a new standard library module. To do that: 1. Create the stdlib module itself; `stdlib/ini.pkl` 2. Create a new class in `org.pkl.core.runtime` that extends `StdlibModule`, and add it to `org.pkl.core.runtime.ModuleCache#getOrLoad` (see the existing source code to look at what's currently already there). 3. Create a `class RendererNodes` in new package `org.pkl.core.stdlib.ini` (see the other stdlib packages that are in there for reference) You will also need to add language snippet tests for this renderer, in pkl-core/src/test/files/LanguageSnippetTests/input/api/

adam commented

2025-12-30 01:20:15 +01:00

@moritztim commented on GitHub (Feb 14, 2024):

Also make sure that you follow the contribution guidelines

@moritztim commented on GitHub (Feb 14, 2024): Also make sure that you follow the [contribution guidelines](https://github.com/apple/pkl/blob/main/CONTRIBUTING.adoc)

adam commented

2025-12-30 01:20:15 +01:00

@Madmegsox1 commented on GitHub (Feb 14, 2024):

Created PR. Ill create the new in-language renderer soon and open another PR.

Thank you for the help.

@Madmegsox1 commented on GitHub (Feb 14, 2024): Created PR. Ill create the new in-language renderer soon and open another PR. Thank you for the help.

adam referenced this issue

2025-12-30 01:21:39 +01:00

Feature Request: Add `hcl` format #161

Sign in to join this conversation.