Enable defining settings using comma-separated-values as lists

[paduszyk]

This is a proposal for a minor update in defining some settings.

Settings involving sequences of values (e.g. words to be ignored, files to be skipped) could be declared not as comma-separated strings, but as lists.

The idea particularly regards pyproject.toml, but could be potentially applicable to pre-commit hook as well.

Of course, I think we can all live with the way it's implemented now, but I guess using lists would make the codespell configuration more consistent with the remaining tools set up in the config files.

Anyway, the tool is great! I thank all the contributors for their efforts! 🙇🏻‍♂️ 👍🏻

[DimitriPapadopoulos]

Isn't this a duplicate of #2767?

[dalito]

I went from here to #2767 and learnt there that #2767 is for adding support for strings with comma separated items (all in one string). That PR is not trying to add the standard notation of the configuration formats for lists.

@paduszyk - Do you mean the below way of specification in this issue?

In pyproject.toml

[tool.codespell]
skip = [
  'bad.txt',
  'whatever.txt',
]
count = false

In setup.cfg

[codespell]
skip =
    bad.txt
    whatever.txt
count =

[DimitriPapadopoulos]

@dalito As far as the INI format of setup.cfg is concerned, I think there is a misunderstanding. Lists are always comma-separated in INI files. Your example is about multiline values which are already supported by configparser:

[Multiline Values]
chorus: I'm a lumberjack, and I'm okay
    I sleep all night and I work all day

As for having real lists in TOML files instead of comma-separated values, that does seem to be the issue at hand here, which I tried to address in f5355b9 - but tests don't pass so far.

[DimitriPapadopoulos]

In a different PR, I'll try to turn multiline values in config files into comma-separated values, since the documentation of configparser seems to imply such multiline values should be interpreted as lists::

extensions =
  enabled_extension
  another_extension
  #disabled_by_comment
  yet_another_extension