Skip to content

Commit d312121

Browse files
committed
docs(#3): add development setup instructions to README
Add Development section with: - Prerequisites (stylua, luacheck, pre-commit) - Setup instructions (pre-commit install) - Makefile targets reference table - Code style summary Closes #3 Signed-off-by: assagman <ahmetsercansagman@gmail.com>
1 parent e5c0cfc commit d312121

1 file changed

Lines changed: 41 additions & 0 deletions

File tree

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,47 @@ Shows:
211211
- Connection state (CONNECTED/INITIALIZING/DISCONNECTED)
212212
- Last error message (if any)
213213

214+
## Development
215+
216+
### Prerequisites
217+
218+
Install code quality tools:
219+
220+
```bash
221+
# macOS
222+
brew install stylua luacheck
223+
pip install pre-commit
224+
225+
# Or manually:
226+
# stylua: https://github.com/JohnnyMorganz/StyLua
227+
# luacheck: https://github.com/mpeterv/luacheck
228+
# pre-commit: https://pre-commit.com/
229+
```
230+
231+
### Setup
232+
233+
```bash
234+
# Install pre-commit hooks (runs stylua + luacheck on commit)
235+
make precommit-install
236+
```
237+
238+
### Makefile Targets
239+
240+
| Target | Description |
241+
|--------|-------------|
242+
| `make format` | Format Lua files with stylua |
243+
| `make format-check` | Check formatting (no changes) |
244+
| `make lint` | Run luacheck linter |
245+
| `make check` | Run format-check + lint |
246+
| `make precommit` | Run pre-commit on all files |
247+
248+
### Code Style
249+
250+
- **Formatter**: [StyLua](https://github.com/JohnnyMorganz/StyLua) - 2-space indent, double quotes
251+
- **Linter**: [luacheck](https://github.com/mpeterv/luacheck) - LuaJIT std, strict warnings
252+
253+
Configuration files: `.stylua.toml`, `.luacheckrc`
254+
214255
## License
215256

216257
MIT

0 commit comments

Comments
 (0)