Merge pull request #245 from LauLauThom/precommit-hooks

Add precommit hooks

Author: simleo

.github/workflows/python-package.yml

@@ -5,14 +5,14 @@ name: Python package
 
 on:
   push:
-    branches: 
+    branches:
       - master
-      - dev 
+      - dev
       - windows
   pull_request:
-    branches: 
+    branches:
       - master
-      - dev 
+      - dev
 
 jobs:
   build:

.github/workflows/python-publish.yml

@@ -27,7 +27,7 @@ jobs:
       run: |
        ver=`python setup.py --version`
        tag="refs/tags/$ver"
-       if [[ "$tag" != $GITHUB_REF ]] 
+       if [[ "$tag" != $GITHUB_REF ]]
           then echo Tag $GITHUB_REF does not match $ver from setup.py >&2
           echo Please update rocrate/_version.py
           false
@@ -41,5 +41,5 @@ jobs:
         TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
         TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
       run: |
-        python setup.py sdist bdist_wheel        
+        python setup.py sdist bdist_wheel
         twine upload dist/*

.gitignore

@@ -101,7 +101,7 @@ ENV/
 .mypy_cache/
 .pytest_cache
 
-# vim 
+# vim
 *.swp
 
 # other

.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+repos:
+  - repo: https://github.com/PyCQA/flake8
+    rev: 7.3.0
+    hooks:
+      - id: flake8
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0  # Use the ref you want to point at
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-merge-conflict
+      - id: check-json
+      - id: check-yaml
+      - id: debug-statements

CITATION.cff

@@ -49,7 +49,7 @@ author:
   - family-names: Thomas
     given-names: Laurent
     orcid: https://orcid.org/0000-0001-7686-3249
-   
+
 title: "ro-crate-py"
 version: 0.14.2
 doi: 10.5281/zenodo.3956493

CONTRIBUTING.md

@@ -85,6 +85,23 @@ pip install flake8
 flake8 --exclude venv ./
 ```
 
+### Pre-commit hooks
+ro-crate-py comes with a configuration file for [pre-commit](https://github.com/pre-commit/pre-commit) `.pre-commit-config.yaml`.
+This configuration file defines so-called "hooks" which are executed upon each commit, to automatically format the code in the commited files according to the requirements defined for instance in the flake8 configuration file (e.g removing spaces from blank lines...).
+
+To benefit from these automated hooks, you need first to install the pre-commit package.
+`pip install pre-commit`
+
+The hooks should then be installed once for your local copy of the repository by running the following command in the root of the repo.
+`pre-commit install`
+
+Once installed the hooks will be executed each time a new commit is made, for the files being commited.
+If some checks failed or could not be fixed automatically, an error message will be shown and the commit will be aborted.
+
+While not recommended, you can bypass the hooks by passing the additional flag `--no-verify` to the `git commit` command.
+
+Some IDEs have plugins for precommit (e.g [here](https://marketplace.visualstudio.com/items?itemName=elagil.pre-commit-helper) for VSCode), which would for instance run the hooks for the currently opened file each time it is saved. The plugins typically pick up the configuration file automatically.
+
 ### Testing
 
 Testing is done with [pytest](https://pytest.org):

notebooks/ExploreSchemaOrg.ipynb

@@ -1170,4 +1170,3 @@
  "nbformat": 4,
  "nbformat_minor": 2
 }
-

notebooks/ROcrate-linked-data.ipynb

@@ -2775,4 +2775,3 @@
  "nbformat": 4,
  "nbformat_minor": 2
 }
-

notebooks/ROcrate-validation.ipynb

@@ -579,4 +579,3 @@
  "nbformat": 4,
  "nbformat_minor": 2
 }
-

notebooks/sample_data/clinvap/ro-crate-metadata.jsonld

@@ -150,4 +150,4 @@
       }
     }
   ]
-}
+}