Skip to content

Commit 68d704d

Browse files
author
Claude
committed
Add: CLAUDE.md with project documentation
1 parent a693a45 commit 68d704d

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

CLAUDE.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Laravel Helper Plugin
2+
3+
## Useful Commands
4+
5+
### Git Commands
6+
- `git -C /home/gregg/Projects/neovim/plugins/laravel-helper status` - Check current status
7+
- `git -C /home/gregg/Projects/neovim/plugins/laravel-helper add .` - Stage all changes
8+
- `git -C /home/gregg/Projects/neovim/plugins/laravel-helper commit -m "message"` - Commit changes
9+
- `git -C /home/gregg/Projects/neovim/plugins/laravel-helper push` - Push changes
10+
11+
### Development Commands
12+
- `stylua lua/ -c` - Check Lua formatting
13+
- `stylua lua/` - Format Lua code
14+
- `luacheck lua/` - Run Lua linter
15+
- `nvim --headless -c "lua require('laravel-helper.test').run()"` - Run tests
16+
17+
## Codebase Information
18+
19+
### Config Options
20+
```lua
21+
require("laravel-helper").setup({
22+
-- Default Laravel environment
23+
env_file = ".env",
24+
25+
-- PHP executable path
26+
php_cmd = "php",
27+
28+
-- Artisan command path
29+
artisan_cmd = "artisan",
30+
31+
-- IDE Helper configuration
32+
ide_helper = {
33+
auto_generate = true, -- Generate IDE helpers on file save
34+
generate_on_save = true, -- Generate on file save
35+
show_notifications = true, -- Show notifications after generation
36+
},
37+
38+
-- Telescope integration
39+
telescope = {
40+
enable = true, -- Enable Telescope integration
41+
keymap = "<leader>la", -- Keymap to open Laravel actions
42+
}
43+
})
44+
```
45+
46+
### Project Structure
47+
- `lua/laravel-helper/init.lua` - Main plugin file
48+
- `lua/laravel-helper/ide-helper.lua` - IDE Helper integration
49+
- `lua/laravel-helper/artisan.lua` - Artisan command integration
50+
- `lua/laravel-helper/telescope.lua` - Telescope integration
51+
- `lua/laravel-helper/config.lua` - Configuration module
52+
- `lua/laravel-helper/utils.lua` - Utility functions
53+
- `lua/laravel-helper/test.lua` - Test framework
54+
55+
### Version Management
56+
- Current version: v0.4.2
57+
- Version file: `lua/laravel-helper/version.lua`

0 commit comments

Comments
 (0)