Update formatting script to use pre-commit and GitHub Actions

This commit is contained in:
Aaron Franke
2021-02-18 21:43:56 -05:00
parent f3a63a3f54
commit 528ac92b7b
6 changed files with 99 additions and 60 deletions

52
.github/workflows/file_format.py vendored Executable file
View File

@@ -0,0 +1,52 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
import sys
if len(sys.argv) < 2:
print("Invalid usage of file_format.py, it should be called with a path to one or multiple files.")
sys.exit(1)
BOM = b"\xef\xbb\xbf"
changed = []
invalid = []
for file in sys.argv[1:]:
try:
with open(file, "rt", encoding="utf-8") as f:
original = f.read()
except UnicodeDecodeError:
invalid.append(file)
continue
if original == "":
continue
EOL = "\r\n" if file.endswith((".csproj", ".sln", ".bat")) else "\n"
WANTS_BOM = file.endswith((".csproj", ".sln"))
revamp = EOL.join([line.rstrip("\n\r\t ") for line in original.splitlines(True)]).rstrip(EOL) + EOL
new_raw = revamp.encode(encoding="utf-8")
if not WANTS_BOM and new_raw.startswith(BOM):
new_raw = new_raw[len(BOM) :]
elif WANTS_BOM and not new_raw.startswith(BOM):
new_raw = BOM + new_raw
with open(file, "rb") as f:
old_raw = f.read()
if old_raw != new_raw:
changed.append(file)
with open(file, "wb") as f:
f.write(new_raw)
if changed:
for file in changed:
print(f"FIXED: {file}")
if invalid:
for file in invalid:
print(f"REQUIRES MANUAL CHANGES: {file}")
sys.exit(1)

24
.github/workflows/static_checks.yml vendored Normal file
View File

@@ -0,0 +1,24 @@
name: 📊 Static Checks
on: [push, pull_request]
concurrency:
group: ci-${{ github.actor }}-${{ github.head_ref || github.run_number }}-${{ github.ref }}-static
jobs:
static-checks:
name: Code style and file formatting
runs-on: ubuntu-24.04
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 2
- name: Install Python dependencies and general setup
run: |
git config diff.wsErrorHighlight all
- name: Style checks via pre-commit
uses: pre-commit/action@v3.0.1
with:
extra_args: --all-files