mirror of
https://git.anonymousland.org/anonymousland/synapse.git
synced 2024-09-06 23:52:00 +00:00
Document lint.sh & allow application to specified files only (#6312)
This commit is contained in:
parent
ace947e8da
commit
befd58f47b
@ -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
|
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.
|
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,
|
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
|
and **never** mix cosmetic and functional changes in the same commit, as it
|
||||||
makes it horribly hard to review otherwise.
|
makes it horribly hard to review otherwise.
|
||||||
|
1
changelog.d/6312.misc
Normal file
1
changelog.d/6312.misc
Normal file
@ -0,0 +1 @@
|
|||||||
|
Document the use of `lint.sh` for code style enforcement & extend it to run on specified paths only.
|
@ -7,7 +7,15 @@
|
|||||||
|
|
||||||
set -e
|
set -e
|
||||||
|
|
||||||
isort -y -rc synapse tests scripts-dev scripts
|
if [ $# -ge 1 ]
|
||||||
flake8 synapse tests
|
then
|
||||||
python3 -m black synapse tests scripts-dev scripts
|
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
|
./scripts-dev/config-lint.sh
|
||||||
|
Loading…
Reference in New Issue
Block a user