Add pre-commit config for additional linting checks

Author: jakewilliami

.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace

README.md

@@ -23,6 +23,29 @@ true
 
 The origin of this project comes from [`julia#38841`](https://github.com/JuliaLang/julia/issues/38841).
 
+## Development
+
+Ensure you have both [UV](https://github.com/astral-sh/uv) and [Just](https://github.com/casey/just).
+
+To run unit tests, simply run:
+
+```commandline
+$ just test
+# ...
+```
+
+We use UV to conveniently run pre-commit:
+
+```commandline
+$ just fmt
+```
+
+In order to commit, you will want to ensure pre-commits are installed:
+
+```commandline
+$ uvx pre-commit install
+```
+
 ## Citation
 
 If your research depends on HiddenFiles.jl, please consider giving us a formal citation: [`citation.bib`](./citation.bib).

justfile

@@ -33,20 +33,18 @@ run run_file:
     julia --project={{project_dir}} {{run_file}}
 
 # Generate documentation
-[group: 'ci']
 docs: (instantiate-dev docs_dir)
     julia --project={{docs_dir}} {{docs_mk_file}}
 
 # Benchmark performance
-[group: 'ci']
 bench: (instantiate-dev bench_dir)
     julia --project={{bench_dir}} {{bench_file}}
 
 # Check formatting with blue style
-[group: 'ci']
 fmt: install-formatter
     # https://github.com/invenia/BlueStyle
     julia --project=@JuliaFormatter -e 'using JuliaFormatter; format("{{project_dir}}", style=BlueStyle())'
+    uvx pre-commit run --all-files
 
 # Install JuliaFormatter
 [private]
@@ -61,4 +59,3 @@ instantiate:
 [private]
 instantiate-dev dev_project_dir:
     julia --project={{dev_project_dir}} -e '{{dev_instantiate_code}}'
-