Keep comments from style files in generated files

[a666]

As you are probably well aware of, a part of the reason for picking TOML and YAML as configuration languages, is the ability to comment these files.

Problem

Nitpick parses its toml style files and strips the comments of the generated files, ence making the devs having to go to the source nitpick styles to know why a configuration option was set.

Example:

# flakehell.toml
["pyproject.toml".tool.flakehell.plugins]
# E203: See https://github.com/PyCQA/pycodestyle/issues/373
pycodestyle = ["+*", "-E203",]

Generated pyproject.toml:

# pyproject.toml
[tool.flakehell.plugins] 
pycodestyle = [ "+*", "-E203",]

Possible solution

Keep comments from the style files.

The alternative (that we currently use) is adding a

#flakehell.toml
[comments.flakehell]
pycodestyle = """
-E203: See https://github.com/PyCQA/pycodestyle/issues/373
"""

which makes us return to the dark ages of doing the same in the composer.json or package.json files, 😄 .

[andreoliwa]

Thanks for your suggestion, it's definitely useful. 🙂

I think this is possible indeed.
I don't remember exactly how sdispater/tomlkit identifies comments, if this is configurable or not...

A certain convention should be used though. In your example:

# Comment above a section belongs to the section
["pyproject.toml".tool.flakehell.plugins]
# Comment inside a section belongs to the value below:
pycodestyle = ["+*", "-E203",]

# Comments at the end of the file would be ignored because there is nothing below

[a666]

Could be.
What about multiline comments?

[andreoliwa]

What about multiline comments?

I would say to consider them as a block, a single comment, and copy all the lines.
This also depends on the implementation of tomlkit.