dev: Add script for setting up local dev environment

Author: kristijanhusak

.github/workflows/tests.yml

@@ -21,7 +21,7 @@ jobs:
           token: ${{ secrets.GITHUB_TOKEN }}
           version: latest
             # CLI arguments
-          args: --check lua/ tests/
+          args: make lint
   tests:
     strategy:
       fail-fast: false

CONTRIBUTING.md

@@ -15,6 +15,14 @@ If you're reporting a `core` feature, please be sure to provide a link that desc
 
 If you spot something missing in our [docs](DOCS.md), don't hesitate making a PR. The [wiki](https://github.com/nvim-orgmode/orgmode/wiki) can be edited freely.
 
+## Local dev
+
+Requirements:
+- [StyLua](https://github.com/JohnnyMorganz/StyLua) - For formatting
+
+To set up local development, run `make setup_dev`. This will add a pre-commit hook that will auto format all files before committing them.
+You can always manually format all files with `make format` command
+
 ## Code
 
 You can take a look at our [feature completeness](https://github.com/nvim-orgmode/orgmode/wiki/Feature-Completeness) list and see if any of the missing features catch your interest.
@@ -36,13 +44,6 @@ spec you want to test. Example:
 make test FILE=./tests/plenary/api/api_spec.lua
 ```
 
-### Formatting
-
-Formatting is done via [StyLua](https://github.com/JohnnyMorganz/StyLua). To format everything run:
-```
-make format
-```
-
 ### Parser
 
 Parsing is done via builtin treesitter parser and the [tree-sitter-org](https://github.com/milisims/tree-sitter-org) grammar.

Makefile

@@ -6,5 +6,9 @@ docs:
 	md2vim -desc "*orgmode* *orgmode.nvim*\n* NOTE: This file is autogenerated from DOCS.md file" DOCS.md doc/orgmode.txt
 api_docs:
 	nvim --headless --clean -u ./scripts/gendoc.lua
+setup_dev:
+	cp ./scripts/pre-commit-hook.sh ./.git/hooks/pre-commit && chmod +x ./.git/hooks/pre-commit
+lint:
+	stylua --check lua/ tests/
 format:
 	stylua lua/ tests/

scripts/pre-commit-hook.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+# Run `make format` to format files
+make format
+
+# Add only modified files to the staging area
+git diff --cached --name-only --diff-filter=ACMRTUXB | xargs git add
+
+# Continue with the commit
+exit 0