chore: add pre-commit hooks (#511)

Author: korikuzma

.gitignore

@@ -8,3 +8,4 @@ pyproject.toml
 .python-version
 .idea/
 .DS_Store
+schema/*/build/

.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: check-added-large-files
+      - id: detect-private-key
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+  - repo: local
+    hooks:
+      - id: update-json-def-files
+        name: Update json and def files
+        entry: pre-commit-hooks/update-json-def-files.sh
+        language: system
+        files: ^schema/.*/.*-source.yaml$

.requirements.txt

@@ -7,4 +7,5 @@ ga4gh.gks.metaschema==0.3.0b8
 sphinx ~= 7.2
 sphinx-rtd-theme ~= 1.2
 jupyterlab
-notebook
+notebook
+pre-commit

README.md

@@ -44,6 +44,7 @@ Fork the repo at <https://github.com/ga4gh/vrs>.
     cd vrs
     make devready
     source venv/3.12/bin/activate
+    pre-commit install
 
 If you already cloned the repo, but forgot to include `--recurse-submodules` you can run:
 
@@ -58,6 +59,9 @@ To create the corresponding def and json files after making changes to the sourc
     cd schema
     make all
 
+> _Note: We have a custom pre-commit hook to run these commands after you stage a source
+> document_
+
 ## Contributing to the docs
 
 The VRS specification documentation is written in reStructuredText and located in [docs/source](docs/source/). Commits to this repo are built automatically at <https://vrs.ga4gh.org>.

pre-commit-hooks/update-json-def-files.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+REPO_ROOT=$(git rev-parse --show-toplevel)
+SCHEMA_DIR="$REPO_ROOT/schema"
+DIRS=$(find "$SCHEMA_DIR" -mindepth 1 -maxdepth 1 -type d | sort)
+
+for DIR in $DIRS; do
+  cd "$DIR" || exit 1
+
+  make_output=$(make all)
+
+  if [[ "$make_output" == "make: Nothing to be done for \`all\'." ]]; then
+    echo "No changes to source files in $DIR."
+  else
+    echo "Source files updated in $DIR, adding changes to commit."
+    git add $(git ls-files --modified json def)
+  fi
+done
+
+exit 0