Merge pull request #2981 from Flameeyes/master

Set up basic integration with pre-commit.

Author: tannewt

.github/workflows/create_website_pr.yml

@@ -18,7 +18,7 @@ jobs:
         python-version: 3.8
     - name: Install deps
       run: |
-        pip install requests sh click 
+        pip install requests sh click
     - name: Versions
       run: |
         gcc --version

.github/workflows/pre-commit.yml

@@ -0,0 +1,24 @@
+# SPDX-FileCopyrightText: Copyright (c) 2019 Anthony Sottile
+#
+# SPDX-License-Identifier: MIT
+
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [master]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-python@v1
+    - name: set PY
+      run: echo "::set-env name=PY::$(python -c 'import hashlib, sys;print(hashlib.sha256(sys.version.encode()+sys.executable.encode()).hexdigest())')"
+    - uses: actions/cache@v1
+      with:
+        path: ~/.cache/pre-commit
+        key: pre-commit|${{ env.PY }}|${{ hashFiles('.pre-commit-config.yaml') }}
+    - uses: pre-commit/[email protected]

.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò
+#
+# SPDX-License-Identifier: Unlicense
+
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+        exclude: '^(tests/.*\.exp|tests/cmdline/.*|tests/.*/data/.*)'
+    -   id: trailing-whitespace
+        exclude: '^(tests/.*\.exp|tests/cmdline/.*|tests/.*/data/.*)'

BUILDING.md

@@ -1,7 +1,7 @@
 
 # Building CircuitPython
 
-Welcome to CircuitPython!  
+Welcome to CircuitPython!
 
 This document is a quick-start guide only.
 
@@ -28,7 +28,7 @@ This project has a bunch of git submodules.  You will need to update them regula
 As part of the build process, mpy-cross is needed to compile .py files into .mpy files.
 To compile (or recompile) mpy-cross:
 
-    make -C mpy-cross 
+    make -C mpy-cross
 
 # Building
 
@@ -68,7 +68,7 @@ A successful run will say something like
 
 # Debugging
 
-The easiest way to debug CircuitPython on hardware is with a JLink device, JLinkGDBServer, and an appropriate GDB.   
+The easiest way to debug CircuitPython on hardware is with a JLink device, JLinkGDBServer, and an appropriate GDB.
 Instructions can be found at https://learn.adafruit.com/debugging-the-samd21-with-gdb
 
 If using JLink, you'll need both the `JLinkGDBServer` and `arm-none-eabi-gdb` running.

CODE_OF_CONDUCT.md

@@ -1,3 +1,9 @@
+<!--
+SPDX-FileCopyrightText: 2014 Coraline Ada Ehmke
+SPDX-FileCopyrightText: 2019 Kattni Rembor for Adafruit Industries
+
+SPDX-License-Identifier: CC-BY-4.0
+-->
 # Adafruit Community Code of Conduct
 
 ## Our Pledge
@@ -43,7 +49,7 @@ Examples of unacceptable behavior by participants include:
 
 The goal of the standards and moderation guidelines outlined here is to build
 and maintain a respectful community. We ask that you don’t just aim to be
-"technically unimpeachable", but rather try to be your best self. 
+"technically unimpeachable", but rather try to be your best self.
 
 We value many things beyond technical expertise, including collaboration and
 supporting others within our community. Providing a positive experience for
@@ -74,9 +80,9 @@ You may report in the following ways:
 In any situation, you may send an email to <[email protected]>.
 
 On the Adafruit Discord, you may send an open message from any channel
-to all Community Moderators by tagging @community moderators. You may 
-also send an open message from any channel, or a direct message to 
-@kattni#1507, @tannewt#4653, @danh#1614, @cater#2442, 
+to all Community Moderators by tagging @community moderators. You may
+also send an open message from any channel, or a direct message to
+@kattni#1507, @tannewt#4653, @danh#1614, @cater#2442,
 @sommersoft#0222, @Mr. Certainly#0472 or @Andon#8175.
 
 Email and direct message reports will be kept confidential.

docs/README.md

@@ -34,10 +34,10 @@ All commands will, by default, run with `-E` (forces a rebuild from scratch of d
 
     # will turn OFF the force rebuild
     make html FORCE=
-    
+
     # will turn OFF the verbosity
     make html VERBOSE=
-    
+
     # will turn OFF the force rebuild and make it doubly verbose when running
     make html FORCE= VERBOSE="-v -v"