Add config linting script that checks for bool casing

[anoadragon453]

Add a linting script that enforces all boolean values in the default config be lowercase.

This has annoyed me for a while so I decided to fix it.

Pipelines repo PR: matrix-org/pipelines#12 Not necessary anymore.

[richvdh]

great idea, couple of tweaks though

[richvdh]

it might be simpler just to grep for the incorrect formats, rather than try to correct them?

[anoadragon453]

I considered this at first, but I wanted to be able to add this to scripts-dev/lint.sh which could get run in a pre-commit hook for instance.

[richvdh]

I'm not quite sure that follows... lint.sh doesn't correct for incorrect imports or pep8 failures, it just complains if they are wrong.

There might be value in having a script to correct the problems, but given how often it's likely to be a problem versus the added complexity of this script, I don't think it's worthwhile?

[richvdh]

1. why do we require a #
2. some of the groups are redundant:

Suggested change

	sed -i -E "s/(#.*): +True(.*)/\1: true\2/g; s/(#.*): +False(.*)/\1: false\2/g;" synapse/config/*.py
	sed -i -E "s/(#.*): +True/\1: true/g; s/(#.*): +False/\1: false/g;" synapse/config/*.py

[anoadragon453]

The code can contain false positives without the hash, such as docstrings:

synapse/synapse/config/logger.py

Line 199 in b617864

use_worker_options (bool): True to use the 'worker_log_config' option

[richvdh]

ahhh. we should probably run it on the sample config rather than attempt to match only the config bits within synapse/config.

old

[richvdh]

I think it's worth noting that your script has missed

synapse/docs/sample_config.yaml

Line 414 in 0155478

enabled: False

.

[anoadragon453]

I think it's worth noting that your script has missed

synapse/docs/sample_config.yaml

Line 414 in 0155478

enabled: False

.

Yep, had to fix this case manually. I've also switched it so that the script just fixes the sample config instead of your code. I also changed the git diff to only check the sample config, so that it doesn't print out any changes you've made otherwise.

old

[richvdh]

lgtm then