Support list of wordlists as a string

[grhm]

Allow the spelling_word_list_filename to be passed as a string, but still be a list filenames and treated as such

Fix for issue #169

[dhellmann]

So the syntax for the list is semi-Python, using the names without quotes separated by commas and wrapped in square brackets?

-D spelling_word_list_filename=[filename.txt,another-filename.txt]

How common do you think commas are in filenames? Could we use commas to separate the values and forego the brackets?

-D spelling_word_list_filename=filename.txt,another-filename.txt

That sort of syntax is pretty common in other tools I'm familiar with.

Other options would be to pass a directory name or glob pattern. Would either of those work for your use case?

[grhm]

I was trying to do as little as possible to not break things I haven't tested, so having square bracket around a list seemed kinda Pythony.

I'm not sure how common commas in file names are - and happy that foregoing the bracket and splitting on commas would work. If someone does have a comma in their filename, is fairly non-standard, and can be worked around by renaming the file.

A directory name or glob pattern wouldn't work in my case, as the "common" and "per-project" word lists end up in different locations.

[dhellmann]

I was trying to do as little as possible to not break things I haven't tested, so having square bracket around a list seemed kinda Pythony.

I'm not sure how common commas in file names are - and happy that foregoing the bracket and splitting on commas would work. If someone does have a comma in their filename, is fairly non-standard, and can be worked around by renaming the file.

Let's go ahead with that, then. Updating the docs in docs/source/customize.rst and adding an entry to docs/source/history.rst would be good additions to the parsing change. A unit test for get_wordlist_filename() would be good, since the logic is growing more complex.

Do you want to make the updates to this PR?

A directory name or glob pattern wouldn't work in my case, as the "common" and "per-project" word lists end up in different locations.

That makes sense. Someone can always rely on the shell to do the globbing for them, anyway.

[grhm]

Let's go ahead with that, then. Updating the docs in docs/source/customize.rst and adding an entry to docs/source/history.rst would be good additions to the parsing change. A unit test for get_wordlist_filename() would be good, since the logic is growing more complex.

Do you want to make the updates to this PR?

I've made changes to the rst files as requested - but have not added unit tests.
I've not sure how your unit tests work - happy for you to add them as you see fit.

[dhellmann]

Let's go ahead with that, then. Updating the docs in docs/source/customize.rst and adding an entry to docs/source/history.rst would be good additions to the parsing change. A unit test for get_wordlist_filename() would be good, since the logic is growing more complex.
Do you want to make the updates to this PR?

I've made changes to the rst files as requested - but have not added unit tests. I've not sure how your unit tests work - happy for you to add them as you see fit.

No problem, I'll add some tests.

[dhellmann]

Thanks!

[dhellmann]

I rebased this in #178