diff options
| author | Neil Pilgrim <github@kepier.clara.net> | 2019-11-01 03:52:20 -0700 |
|---|---|---|
| committer | Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> | 2019-11-01 10:52:20 +0000 |
| commit | befd58f47bab1b8337032d27a995e08c7dd93a83 (patch) | |
| tree | 165e051d848b4d70367b4fe80d37d65ac01572c0 | |
| parent | Depublish a room from the public rooms list when it is upgraded (#6232) (diff) | |
| download | synapse-befd58f47bab1b8337032d27a995e08c7dd93a83.tar.xz | |
Document lint.sh & allow application to specified files only (#6312)
| -rw-r--r-- | CONTRIBUTING.rst | 8 | ||||
| -rw-r--r-- | changelog.d/6312.misc | 1 | ||||
| -rwxr-xr-x | scripts-dev/lint.sh | 14 |
3 files changed, 20 insertions, 3 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index a71a4a696b..2fb3a95949 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -58,6 +58,14 @@ All Matrix projects have a well-defined code-style - and sometimes we've even got as far as documenting it... For instance, synapse's code style doc lives at https://github.com/matrix-org/synapse/tree/master/docs/code_style.md. +To facilitate meeting these criteria you can run ``scripts-dev/lint.sh`` +locally. Since this runs the tools listed in the above document, you'll need +python 3.6 and to install each tool. **Note that the script does not just +test/check, but also reformats code, so you may wish to ensure any new code is +committed first**. By default this script checks all files and can take some +time; if you alter only certain files, you might wish to specify paths as +arguments to reduce the run-time. + Please ensure your changes match the cosmetic style of the existing project, and **never** mix cosmetic and functional changes in the same commit, as it makes it horribly hard to review otherwise. diff --git a/changelog.d/6312.misc b/changelog.d/6312.misc new file mode 100644 index 0000000000..55e3e1654d --- /dev/null +++ b/changelog.d/6312.misc @@ -0,0 +1 @@ +Document the use of `lint.sh` for code style enforcement & extend it to run on specified paths only. diff --git a/scripts-dev/lint.sh b/scripts-dev/lint.sh index 02a2ca39e5..34c4854e11 100755 --- a/scripts-dev/lint.sh +++ b/scripts-dev/lint.sh @@ -7,7 +7,15 @@ set -e -isort -y -rc synapse tests scripts-dev scripts -flake8 synapse tests -python3 -m black synapse tests scripts-dev scripts +if [ $# -ge 1 ] +then + files=$* +else + files="synapse tests scripts-dev scripts" +fi + +echo "Linting these locations: $files" +isort -y -rc $files +flake8 $files +python3 -m black $files ./scripts-dev/config-lint.sh |