mirror of
https://github.com/element-hq/synapse.git
synced 2024-11-22 17:46:08 +03:00
31c5382d7a
The lists of source directories to lint between `tox.ini` and `lint.sh` became out of sync. This PR tightens them up and adds some comments reminding any future readers to keep the list in sync.
98 lines
2.4 KiB
Bash
Executable file
98 lines
2.4 KiB
Bash
Executable file
#!/bin/bash
|
|
#
|
|
# Runs linting scripts over the local Synapse checkout
|
|
# isort - sorts import statements
|
|
# black - opinionated code formatter
|
|
# flake8 - lints and finds mistakes
|
|
|
|
set -e
|
|
|
|
usage() {
|
|
echo
|
|
echo "Usage: $0 [-h] [-d] [paths...]"
|
|
echo
|
|
echo "-d"
|
|
echo " Lint files that have changed since the last git commit."
|
|
echo
|
|
echo " If paths are provided and this option is set, both provided paths and those"
|
|
echo " that have changed since the last commit will be linted."
|
|
echo
|
|
echo " If no paths are provided and this option is not set, all files will be linted."
|
|
echo
|
|
echo " Note that paths with a file extension that is not '.py' will be excluded."
|
|
echo "-h"
|
|
echo " Display this help text."
|
|
}
|
|
|
|
USING_DIFF=0
|
|
files=()
|
|
|
|
while getopts ":dh" opt; do
|
|
case $opt in
|
|
d)
|
|
USING_DIFF=1
|
|
;;
|
|
h)
|
|
usage
|
|
exit
|
|
;;
|
|
\?)
|
|
echo "ERROR: Invalid option: -$OPTARG" >&2
|
|
usage
|
|
exit
|
|
;;
|
|
esac
|
|
done
|
|
|
|
# Strip any options from the command line arguments now that
|
|
# we've finished processing them
|
|
shift "$((OPTIND-1))"
|
|
|
|
if [ $USING_DIFF -eq 1 ]; then
|
|
# Check both staged and non-staged changes
|
|
for path in $(git diff HEAD --name-only); do
|
|
filename=$(basename "$path")
|
|
file_extension="${filename##*.}"
|
|
|
|
# If an extension is present, and it's something other than 'py',
|
|
# then ignore this file
|
|
if [[ -n ${file_extension+x} && $file_extension != "py" ]]; then
|
|
continue
|
|
fi
|
|
|
|
# Append this path to our list of files to lint
|
|
files+=("$path")
|
|
done
|
|
fi
|
|
|
|
# Append any remaining arguments as files to lint
|
|
files+=("$@")
|
|
|
|
if [[ $USING_DIFF -eq 1 ]]; then
|
|
# If we were asked to lint changed files, and no paths were found as a result...
|
|
if [ ${#files[@]} -eq 0 ]; then
|
|
# Then print and exit
|
|
echo "No files found to lint."
|
|
exit 0
|
|
fi
|
|
else
|
|
# If we were not asked to lint changed files, and no paths were found as a result,
|
|
# then lint everything!
|
|
if [[ -z ${files+x} ]]; then
|
|
# Lint all source code files and directories
|
|
# Note: this list aims the mirror the one in tox.ini
|
|
files=("synapse" "docker" "tests" "scripts-dev" "scripts" "contrib" "synctl" "setup.py" "synmark" "stubs" ".buildkite")
|
|
fi
|
|
fi
|
|
|
|
echo "Linting these paths: ${files[*]}"
|
|
echo
|
|
|
|
# Print out the commands being run
|
|
set -x
|
|
|
|
isort "${files[@]}"
|
|
python3 -m black "${files[@]}"
|
|
./scripts-dev/config-lint.sh
|
|
flake8 "${files[@]}"
|
|
mypy
|