[FLOSS H1] build server check: only allow a-z, 0-9 and _ for file names

[markus2330]

We have inconsistent use of characters in file names, which always requires one to think which kind of separator is used in specific cases.

~e> find . -name '*-*' | wc -l
386
~e> find . -name '*_*' | wc -l
491
~e> find . -name '* *' | wc -l
0

As short time goal we should not introduce new variants (such as spaces, see #1613), as 1.0 goal I propose to unify it to a single variant.

[markus2330]

Latest results:

~e> find . -name '*-*' | grep -v "^./.git/" | wc -l                                                                                                                                                                                          
416
~e> find . -name '*_*' | grep -v "^./.git/" | wc -l                                                                                                                                                                                          
538

Ideally we would have a script that automatically renames everything based on conventions, in the same way we have it with clang-format. I'd prefer not to have to discuss about such conventions 😉

At the moment find . | grep -v '^[-_/.a-zA-Z0-9]*$' seems to be clean, we could add a check for this, see #160.

[markus2330]

The guideline now is find . -not -regex '[/.a-zA-Z0-9_-]*' should not find your file names. We should add a build server task to check this, #160.

[stale]

I mark this issue stale as it did not have any activity for one year. I'll close it in two weeks if no further activity occurs. If you want it to be alive again, ping the issue by writing a message here or create a new issue with the remainder of this issue.
Thank you for your contributions 💖

[max-thoma]

[FLOSS H1]

When I run find . | grep -v '^[-_/.a-zA-Z0-9]*$', I get this output.

./.idea/fileTemplates/includes/C File Header.h
./build/doc/html/functions_~.html
./build/doc/html/functions_func_~.html
./build/doc/html/org.libelektra.docset/Contents/Resources/Documents/functions_~.html
./build/doc/html/org.libelektra.docset/Contents/Resources/Documents/functions_func_~.html
./build/doc/man/man3elektra/std_hash_ kdb_Key _.3elektra

As far as I can tell these violations are only in the build directory, so I can confirm the guideline is not violated by the project.

[markus2330]

@muskater it is easier to do such verification in a clean clone.

I also tried the command, and ./.idea/fileTemplates/includes/C File Header.h seems to be an actual violation. Can you check if this name is required by idea? If yes, it is probably best to simply allow this file and add an exception to the check. (Ideally in a separated whitelist file tests/filenames.whitelist, like tests/linkchecker.whitelist.)

[max-thoma]

CLion requires the template name to be C File Header.h. I have tried many different ways to rename and or re-add the file. However, all of them failed and CLion complaint not being able to find the template.

Having a template for header files is definitely a nice addition. I agree, the best solution would be to have a separate allow list for these kind of corner cases.