summary refs log tree commit diff
diff options
context:
space:
mode:
authorAndrew Morgan <1342360+anoadragon453@users.noreply.github.com>2020-07-27 17:26:50 -0700
committerGitHub <noreply@github.com>2020-07-28 01:26:50 +0100
commitc4ce0da6fee5c03de9364f08922d4cb8fd3e1705 (patch)
treec837ba24485f77a4dafb01721688416c191ad4d5
parentConvert the remaining media repo code to async / await. (#7947) (diff)
downloadsynapse-c4ce0da6fee5c03de9364f08922d4cb8fd3e1705.tar.xz
Add script for finding files with unix line terminators (#7965)
This PRs adds a script to check for unix-line terminators in the repo. It will be used to address https://github.com/matrix-org/synapse/issues/7943 by adding the check to CI.

I've changed the original script slightly as proposed in https://github.com/matrix-org/pipelines/pull/81#discussion_r460580664
-rw-r--r--changelog.d/7965.misc1
-rwxr-xr-xscripts-dev/check_line_terminators.sh31
2 files changed, 32 insertions, 0 deletions
diff --git a/changelog.d/7965.misc b/changelog.d/7965.misc
new file mode 100644

index 0000000000..ee9f1a7114 --- /dev/null +++ b/changelog.d/7965.misc
@@ -0,0 +1 @@ +Add a script to detect source code files using non-unix line terminators. \ No newline at end of file diff --git a/scripts-dev/check_line_terminators.sh b/scripts-dev/check_line_terminators.sh new file mode 100755
index 0000000000..0f430e8397 --- /dev/null +++ b/scripts-dev/check_line_terminators.sh
@@ -0,0 +1,31 @@ +#!/bin/bash +# +# Copyright 2020 The Matrix.org Foundation C.I.C. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# This script checks that line terminators in all repository files (excluding +# those in the .git directory) feature unix line terminators. +# +# Usage: +# +# ./check_line_terminators.sh +# +# The script will emit exit code 1 if any files that do not use unix line +# terminators are found, 0 otherwise. + +# cd to the root of the repository +cd `dirname $0`/.. + +# Find and print files with non-unix line terminators +find . -path './.git/*' -prune -o -type f -print0 | xargs -0 grep -I -l $'\r$' && ( echo 'found files with CRLF line endings'; exit 1 )