synapse/scripts-dev/config-lint.sh

#!/usr/bin/env bash
# Find linting errors in Synapse's default config file.
# Exits with 0 if there are no problems, or another code otherwise.

# cd to the root of the repository
cd "$(dirname "$0")/.." || exit

# Restore backup of sample config upon script exit
trap "mv docs/sample_config.yaml.bak docs/sample_config.yaml" EXIT

# Fix non-lowercase true/false values
sed -i.bak -E "s/: +True/: true/g; s/: +False/: false/g;" docs/sample_config.yaml

# Check if anything changed
diff docs/sample_config.yaml docs/sample_config.yaml.bak
Use interpreter from $PATH instead of absolute paths in various scripts using /usr/bin/env (#9689) On NixOS, `bash` isn't under `/bin/bash` but rather in some directory in `$PATH`. Locally, I've been patching those scripts to make them work. `/usr/bin/env` seems to be the only [portable way](https://unix.stackexchange.com/questions/29608/why-is-it-better-to-use-usr-bin-env-name-instead-of-path-to-name-as-my) to use binaries from the PATH as interpreters. Signed-off-by: Quentin Gliech <quentingliech@gmail.com> 2021-03-25 19:53:54 +03:00			`#!/usr/bin/env bash`
Add config linting script that checks for bool casing (#6203) 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. 2019-10-23 15:22:54 +03:00			`# Find linting errors in Synapse's default config file.`
			`# Exits with 0 if there are no problems, or another code otherwise.`

Prevent the config-lint script erroring out on any sample_config changes (#9562) I noticed that I'd occasionally have `scripts-dev/lint.sh` fail when messing about with config options in my PR. The script calls `scripts-dev/config-lint.sh`, which attempts some validation on the sample config. It does this by using `sed` to edit the sample_config, and then seeing if the file changed using `git diff`. The problem is: if you changed the sample_config as part of your commit, this script will error regardless. This PR attempts to change the check so that existing, unstaged changes to the sample_config will not cause the script to report an invalid file. 2021-03-09 14:11:42 +03:00			`# cd to the root of the repository`
Fix Shellcheck SC2006: Use $(...) notation Use $(...) notation instead of legacy backticked `...`. https://github.com/koalaman/shellcheck/wiki/SC2006 Signed-off-by: Dan Callahan <danc@element.io> 2021-10-23 01:07:23 +03:00			`cd "$(dirname "$0")/.." \|\| exit`
Prevent the config-lint script erroring out on any sample_config changes (#9562) I noticed that I'd occasionally have `scripts-dev/lint.sh` fail when messing about with config options in my PR. The script calls `scripts-dev/config-lint.sh`, which attempts some validation on the sample config. It does this by using `sed` to edit the sample_config, and then seeing if the file changed using `git diff`. The problem is: if you changed the sample_config as part of your commit, this script will error regardless. This PR attempts to change the check so that existing, unstaged changes to the sample_config will not cause the script to report an invalid file. 2021-03-09 14:11:42 +03:00
			`# Restore backup of sample config upon script exit`
			`trap "mv docs/sample_config.yaml.bak docs/sample_config.yaml" EXIT`

Add config linting script that checks for bool casing (#6203) 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. 2019-10-23 15:22:54 +03:00			`# Fix non-lowercase true/false values`
Use BSD-compatible in-place editing for sed. (#6887) 2020-02-12 15:02:19 +03:00			`sed -i.bak -E "s/: +True/: true/g; s/: +False/: false/g;" docs/sample_config.yaml`
Add config linting script that checks for bool casing (#6203) 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. 2019-10-23 15:22:54 +03:00
			`# Check if anything changed`
Prevent the config-lint script erroring out on any sample_config changes (#9562) I noticed that I'd occasionally have `scripts-dev/lint.sh` fail when messing about with config options in my PR. The script calls `scripts-dev/config-lint.sh`, which attempts some validation on the sample config. It does this by using `sed` to edit the sample_config, and then seeing if the file changed using `git diff`. The problem is: if you changed the sample_config as part of your commit, this script will error regardless. This PR attempts to change the check so that existing, unstaged changes to the sample_config will not cause the script to report an invalid file. 2021-03-09 14:11:42 +03:00			`diff docs/sample_config.yaml docs/sample_config.yaml.bak`