feat: add forge fmt editor-agnostic rules

Author: nksazonov

.editorconfig

@@ -0,0 +1,18 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.sol]
+indent_style = space
+indent_size = 4
+max_line_length = 120
+# Forge formatter typically puts opening braces on the same line:
+curly_bracket_next_line = false
+# Space after control statements like if, for, while:
+spaces_around_operators = true
+spaces_around_brackets = false
+indent_brace_style = K&R

.githooks/pre-commit

@@ -0,0 +1,15 @@
+#!/bin/sh
+
+# Format all staged Solidity files using forge fmt
+staged_sol_files=$(git diff --cached --name-only --diff-filter=ACMR | grep "\.sol$" || true)
+
+if [ -n "$staged_sol_files" ]; then
+  echo "Formatting Solidity files with forge fmt..."
+  # Format all staged Solidity files
+  forge fmt $staged_sol_files
+  
+  # Add the formatted files back to the staging area
+  git add $staged_sol_files
+fi
+
+exit 0

.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+  "makefile.configureOnOpen": false,
+  "editor.formatOnSave": true,
+  "[solidity]": {
+    "editor.formatOnSave": true
+  },
+  "solidity.formatter": "forge"
+}

README.md

@@ -17,6 +17,48 @@ LiteVault Owner can change the Authorizer contract, which will enable a grace wi
 
 Authorizer contract that authorize withdrawal regardless of token and amount, but only outside of the time range specified on deployment.
 
+## Development Setup
+
+### Code Formatting
+
+This project uses `forge fmt` for consistent Solidity code formatting. We follow an editor-agnostic approach with additional convenience settings for VS Code users.
+
+#### Editor-Agnostic Formatting
+
+1. **Git Hooks**: The project includes pre-commit hooks that automatically format Solidity files using `forge fmt` before each commit.
+
+   To set up the pre-commit hook:
+
+   ```bash
+   # Configure git to use the hooks in the .githooks directory
+   git config core.hooksPath .githooks
+   ```
+
+2. **EditorConfig**: The project includes an `.editorconfig` file with basic formatting rules that many editors support.
+
+   To use these settings:
+
+   - Install an EditorConfig plugin for your editor if it doesn't have built-in support
+   - The plugin will automatically apply basic formatting rules (indentation, line endings, etc.)
+
+   More information about EditorConfig can be found at [https://editorconfig.org/](https://editorconfig.org/)
+
+#### VS Code-Specific Settings
+
+For VS Code users, additional settings are provided in `.vscode/settings.json` that:
+
+- Configure VS Code to use `forge fmt` automatically when saving Solidity files
+- Ensure consistent formatting directly in the editor
+
+These settings are optional and only apply to VS Code users. Other editors may need their own configuration to exactly match `forge fmt` behavior.
+
+#### Recommended Workflow
+
+The recommended workflow for all developers, regardless of editor:
+
+1. Use the pre-commit hooks to ensure consistent formatting in the repository
+2. If needed, run `forge fmt` manually before committing to see changes
+
 ## Deployment and interaction
 
 This repository uses Foundry toolchain for development, testing and deployment.