Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ta-tikoma/php.easy.nvim
Helperfor simplify work with PHP - projects
https://github.com/ta-tikoma/php.easy.nvim
Last synced: 20 days ago
JSON representation
Helperfor simplify work with PHP - projects
- Host: GitHub
- URL: https://github.com/ta-tikoma/php.easy.nvim
- Owner: ta-tikoma
- Created: 2023-04-08T14:00:06.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-10T06:39:15.000Z (about 2 months ago)
- Last Synced: 2024-10-03T10:59:18.199Z (about 1 month ago)
- Language: Lua
- Size: 23.4 KB
- Stars: 15
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-neovim - ta-tikoma/php.easy.nvim - Methods of assistance in PHP development: create classes, constants, methods, properties; simple copying and deleting of an entity. (Programming Languages Support / PHP)
README
# Php Easy NVim
A few functions for make work with PHP 7.4 (or more) projects easy and quickly.
## Install
### With [lazy.nvim](https://github.com/folke/lazy.nvim/):
```lua
{
'ta-tikoma/php.easy.nvim',
config = true,
keys = {
{'-#', 'PHPEasyAttribute', ft = 'php'},
{'-b', 'PHPEasyDocBlock', ft = 'php'},
{'-r', 'PHPEasyReplica', ft = 'php'},
{'-c', 'PHPEasyCopy', ft = 'php'},
{'-d', 'PHPEasyDelete', ft = 'php'},
{'-uu', 'PHPEasyRemoveUnusedUses', ft = 'php'},
{'-e', 'PHPEasyExtends', ft = 'php'},
{'-i', 'PHPEasyImplements', ft = 'php'},
{'--i', 'PHPEasyInitInterface', ft = 'php'},
{'--c', 'PHPEasyInitClass', ft = 'php'},
{'--ac', 'PHPEasyInitAbstractClass', ft = 'php'},
{'--t', 'PHPEasyInitTrait', ft = 'php'},
{'--e', 'PHPEasyInitEnum', ft = 'php'},
{'-c', 'PHPEasyAppendConstant', ft = 'php', mode = {'n', 'v'}},
{'-p', 'PHPEasyAppendProperty', ft = 'php', mode = {'n', 'v'}},
{'-m', 'PHPEasyAppendMethod', ft = 'php', mode = {'n', 'v'}},
{'__', 'PHPEasyAppendConstruct', ft = 'php'},
{'_i', 'PHPEasyAppendInvoke', ft = 'php'},
{'-a', 'PHPEasyAppendArgument', ft = 'php'},
}
},
```
#### If you want to use better append engine
```lua
{
'ta-tikoma/php.easy.nvim',
dependencies = {
'L3MON4D3/LuaSnip',
},
opts = {
onAppend = {
engine = 'LuaSnip'
}
},
keys = {
...
}
},
```
## Features
| Example Key Binding | Function | Description |
| --- | --- | --- |
| **Any** | | function or property or constant |
| `-y` | `PHPEasyCopy` | **Y**ank (copy) *any* under cursor |
| `-r` | `PHPEasyReplica` | **R**eplica *any*: Copy under cursor, paste after current and trigger rename function |
| `-d` | `PHPEasyDelete` | **D**elete *any* under cursor |
| `-b` | `PHPEasyDocBlock` | PhpDoc**B**lock for *any* or class or variable |
| `-#` | `PHPEasyAttribute` | Add **\#**\[Attribute\] for *any* or class |
| **Append** | | |
| `-c` | `PHPEasyAppendConstant` | Append **c**onstant |
| `-p` | `PHPEasyAppendProperty` | Append **p**roperty |
| `-m` | `PHPEasyAppendMethod` | Append **m**ethod |
| `-t` | `PHPEasyAppendTrait` | Append **t**ait |
| `-__` | `PHPEasyAppendConstruct` | Append **__**construct |
| `-_i` | `PHPEasyAppendInvoke` | Append _**_i**nvoke |
| `-a` | `PHPEasyAppendArgument` | Append new **a**rgument in current function |
| **Objects** | | |
| `-uu` | `PHPEasyRemoveUnusedUses` | Remove **u**nused **u**ses from current file, if you use lsp: [intelephense](https://intelephense.com/) |
| `-e` | `PHPEasyExtends` | **E**xtends current class |
| `-i` | `PHPEasyImplements` | **I**mplements current class |
| `--c` | `PHPEasyInitClass` | **I**nitialize **c**lass in current file |
| `--ac` | `PHPEasyInitAbstractClass` | **I**nitialize **a**bstract **c**lass in current file |
| `--i` | `PHPEasyInitInterface` | **I**nitialize **i**nterface in current file |
| `--t` | `PHPEasyInitTrait` | **I**nitialize **t**rait in current file |
| `--e` | `PHPEasyInitEnum` | **I**nitialize **e**num in current file |
## Configuration
```lua
{
regex = { -- regex for parse php file
tab = ' ',
startTab = '^' .. tab,
visibility = startTab .. '\\(public\\|protected\\|private\\|\\)\\s\\{1}',
static = '\\(static\\s\\|\\)',
readonly = '\\(readonly\\s\\|\\)',
constant = visibility .. 'const ',
property = visibility .. static .. readonly .. '\\(?*\\w\\+\\s\\|\\)\\$',
method = visibility .. static .. 'function',
construct = method .. ' __construct(',
methodEnd = startTab .. '}',
comment = startTab .. '\\/',
commentMiddle = startTab .. '\\*',
commentEnd = startTab .. '\\s\\*',
any = startTab .. '[p}]\\{1}',
variable = '\\(' .. tab .. '\\)\\+\\$\\w\\+\\s\\{1}=\\s\\{1}',
object = '^\\(final class\\|abstract class\\|class\\|interface\\|trait\\|enum\\)\\s\\{1}',
},
onSave = { -- on save php file action
removeUnusedUses = true -- remove unused uses (then use lsp: intelephense)
},
onAppend = { -- on append entity
engine = 'defalut' -- how to insert template. 'default' - just string, 'LuaSinp' - via 'L3MON4D3/LuaSnip'
}
}
```
## Examples
### Init
#### Init trait `--t`
#### Init interface `--i`
#### Init abstract class `--ac`
#### Init class `--c`
### Add doc block `-b`
#### Class
#### Constant
#### Property
#### Method
#### Variable
