search

zeek / zeek-docs

Documentation for Zeek
https://docs.zeek.org
Other
50 stars 70 forks source link

management/full-config: no toml highlighting #228

Closed awelzel closed 11 months ago

awelzel commented 11 months ago

With Pygments 2.17, the TOML parser was rewritten[1, 2]. It now fails to parse and highlight the full-config.ini file. The key-only agent-testbox within [instances] makes the standard toml parsing barf, too. Flip to ini.

[1] https://pygments.org/docs/changelog/#version-2-17-0 [2] https://github.com/pygments/pygments/pull/2576

bbannier commented 11 months ago

Just wondering whether I am reading the Wikipedia article on the INI format correctly, INI does not usually have value-less entries, right? I am asking since if that's correct, maybe we should fix our format to e.g., make it easier to use libraries to generate such files (coming my experience of trying to read the non-standard multi-line strings in zkg.meta files).

Regardless, the file definitely isn't TOML (e.g., strings are not quoted).

bbannier commented 11 months ago

Left a :shipit:, but per my above comment, I think it would be great to use an INI format with less extensions (i.e., here: always require values). Could you put an issue for that onto our pile @awelzel?

timwoj commented 11 months ago

Regardless, the file definitely isn't TOML (e.g., strings are not quoted).

FWIW, our configuration files have never been completely TOML-compliant. They're TOML-ish, but not really TOML.

ckreibich commented 11 months ago

Hey thanks for fixing this — what a headache. Per my former comment in the code I was really just looking for something that does a decent job highlighting the file. It was always simple Python convenience that wins out here. If there's any doubt here what to use, then let's simply not highlight at all.

FWIW, our configuration files have never been completely TOML-compliant. They're TOML-ish, but not really TOML.

Yeah.