Skip to content

Commit 6a3e6cf

Browse files
committed
Strip trailing whitespace and add a formatting check for it
1 parent bf01959 commit 6a3e6cf

File tree

4 files changed

+52
-12
lines changed

4 files changed

+52
-12
lines changed

ci/github/lecture/index.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -236,10 +236,10 @@ <h1>Resources</h1>
236236
</section>
237237
</div>
238238
</div>
239-
<script src="../../../reveal.js/dist/reveal.js"></script>
240-
<script src="../../../reveal.js/plugin/notes/notes.js"></script>
241-
<script src="../../../reveal.js/plugin/markdown/markdown.js"></script>
242-
<script src="../../../reveal.js/plugin/highlight/highlight.js"></script>
239+
<script src="../../../reveal.js/dist/reveal.js"></script>
240+
<script src="../../../reveal.js/plugin/notes/notes.js"></script>
241+
<script src="../../../reveal.js/plugin/markdown/markdown.js"></script>
242+
<script src="../../../reveal.js/plugin/highlight/highlight.js"></script>
243243
<script src="../../../reveal-init.js"></script>
244244
</body>
245245
</html>

ci/intro-to-git/lecture/index.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -338,10 +338,10 @@ <h1>Resources</h1>
338338
</section>
339339
</div>
340340
</div>
341-
<script src="../../../reveal.js/dist/reveal.js"></script>
342-
<script src="../../../reveal.js/plugin/notes/notes.js"></script>
343-
<script src="../../../reveal.js/plugin/markdown/markdown.js"></script>
344-
<script src="../../../reveal.js/plugin/highlight/highlight.js"></script>
341+
<script src="../../../reveal.js/dist/reveal.js"></script>
342+
<script src="../../../reveal.js/plugin/notes/notes.js"></script>
343+
<script src="../../../reveal.js/plugin/markdown/markdown.js"></script>
344+
<script src="../../../reveal.js/plugin/highlight/highlight.js"></script>
345345
<script src="../../../reveal-init.js"></script>
346346
</body>
347347
</html>

ci/intro-to-real-time-software/lecture/index.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -216,10 +216,10 @@ <h1>Resources</h1>
216216
</section>
217217
</div>
218218
</div>
219-
<script src="../../../reveal.js/dist/reveal.js"></script>
220-
<script src="../../../reveal.js/plugin/notes/notes.js"></script>
221-
<script src="../../../reveal.js/plugin/markdown/markdown.js"></script>
222-
<script src="../../../reveal.js/plugin/highlight/highlight.js"></script>
219+
<script src="../../../reveal.js/dist/reveal.js"></script>
220+
<script src="../../../reveal.js/plugin/notes/notes.js"></script>
221+
<script src="../../../reveal.js/plugin/markdown/markdown.js"></script>
222+
<script src="../../../reveal.js/plugin/highlight/highlight.js"></script>
223223
<script src="../../../reveal-init.js"></script>
224224
</body>
225225
</html>

format.py

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,44 @@
55
import subprocess
66

77

8+
def get_linesep(lines):
9+
"""Returns string containing autodetected line separator for file.
10+
11+
Keyword arguments:
12+
lines -- file contents string
13+
"""
14+
# Find potential line separator
15+
pos = lines.find("\n")
16+
17+
# If a newline character was found and the character preceding it is a
18+
# carriage return, assume CRLF line endings. LF line endings are assumed
19+
# for empty files.
20+
if pos > 0 and lines[pos - 1] == "\r":
21+
return "\r\n"
22+
else:
23+
return "\n"
24+
25+
26+
def strip_trailing_whitespace(filename):
27+
"""Removes trailing whitespace from the file.
28+
29+
Keyword arguments:
30+
filename -- name of file to strip
31+
"""
32+
with open(filename) as input:
33+
lines = input.read()
34+
linesep = get_linesep(lines)
35+
36+
output = ""
37+
for line in lines.splitlines():
38+
line = line[: len(line)].rstrip()
39+
output += line + linesep
40+
41+
if lines != output:
42+
with open(filename, "wb") as file:
43+
file.write(output.encode())
44+
45+
846
def main():
947
# Format HTML
1048
files = [
@@ -34,6 +72,7 @@ def main():
3472
f,
3573
]
3674
)
75+
strip_trailing_whitespace(f)
3776

3877
# Format Python
3978
files = [
@@ -44,6 +83,7 @@ def main():
4483
]
4584
for f in files:
4685
subprocess.check_output(["python3", "-m", "black", "-q", f])
86+
strip_trailing_whitespace(f)
4787

4888

4989
if __name__ == "__main__":

0 commit comments

Comments
 (0)