Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yaegassy/coc-laravel

Laravel extension for coc.nvim
https://github.com/yaegassy/coc-laravel

blade coc coc-extensions coc-laravel coc-nvim laravel laravel-blade neovim php vim

Last synced: 2 days ago
JSON representation

Laravel extension for coc.nvim

Host: GitHub
URL: https://github.com/yaegassy/coc-laravel
Owner: yaegassy
License: mit
Created: 2023-07-14T04:46:27.000Z (about 1 year ago)
Default Branch: master
Last Pushed: 2024-01-13T07:44:06.000Z (9 months ago)
Last Synced: 2024-09-18T12:14:45.239Z (15 days ago)
Topics: blade, coc, coc-extensions, coc-laravel, coc-nvim, laravel, laravel-blade, neovim, php, vim
Language: TypeScript
Homepage: https://www.npmjs.com/package/@yaegassy/coc-laravel
Size: 735 KB
Stars: 30
Watchers: 2
Forks: 2
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# coc-laravel

Laravel extension for [coc.nvim](https://github.com/neoclide/coc.nvim).

## Install

**CocInstall**:

```vim
:CocInstall @yaegassy/coc-laravel
```

> scoped packages

**vim-plug**:

```vim
Plug 'yaegassy/coc-laravel', {'do': 'yarn install --frozen-lockfile'}
```

## Features

**Note**:

This coc-extension executes `artisan` commands in the background for some features. Therefore, you must be able to run `PHP` in your environment.

---

This coc-extension will provide various completion features and more features for Laravel projects.

- Completions
- Component completion | [DEMO](https://github.com/yaegassy/coc-laravel/issues/1#issuecomment-1650935001)
- Livewire completion (Also compatible with Livewire `v3`!)
- Livewire tag completion | [DEMO](https://github.com/yaegassy/coc-laravel/issues/1#issuecomment-1658762452)
- Livewire action completion | [DEMO](https://github.com/yaegassy/coc-laravel/issues/1#issuecomment-1658765335)
- Livewire event completion | [DEMO](https://github.com/yaegassy/coc-laravel/issues/1#issuecomment-1658766120)
- Livewire property completion | [DEMO](https://github.com/yaegassy/coc-laravel/issues/1#issuecomment-1659497932)
- Livewire directive completion | [DEMO](https://github.com/yaegassy/coc-laravel/issues/1#issuecomment-1659296731)
- PHP completion in PHP-related region of Blade file
- **[NOTE]**: To use this feature, please execute the `laravel.stubs.download` command.
- PHP Function completion | [DEMO](https://github.com/yaegassy/coc-laravel/issues/1#issuecomment-1643359916)
- PHP Class completion | [DEMO](https://github.com/yaegassy/coc-laravel/issues/1#issuecomment-1671277304)
- PHP Static Class completion (Static class members and constants, e.g. `DateTime::|`) | [DEMO](https://github.com/yaegassy/coc-laravel/issues/1#issuecomment-1674415047)
- PHP Object Member completion (e.g. `$obj->|`) | [DEMO](https://github.com/yaegassy/coc-laravel/issues/1#issuecomment-1678240483)
- PHP Variable completion | [DEMO](https://github.com/yaegassy/coc-laravel/issues/1#issuecomment-1676733936)
- PHP Constant completion | [DESCRIPTION](https://github.com/yaegassy/coc-laravel/issues/1#issuecomment-1671281861)
- PHP Keyword completion | [DESCRIPTION](https://github.com/yaegassy/coc-laravel/issues/1#issuecomment-1671284071)
- Directive completion | [DEMO](https://github.com/yaegassy/coc-laravel/issues/1#issuecomment-1657000532)
- Config completion | [DEMO](https://github.com/yaegassy/coc-laravel/issues/1#issuecomment-1635266998)
- Env completion | [DEMO](https://github.com/yaegassy/coc-laravel/issues/1#issuecomment-1635267885)
- Validation completion | [DEMO](https://github.com/yaegassy/coc-laravel/issues/1#issuecomment-1635268664)
- Route completion | [DEMO](https://github.com/yaegassy/coc-laravel/issues/1#issuecomment-1635269933)
- View completion | [DEMO](https://github.com/yaegassy/coc-laravel/issues/1#issuecomment-1635271315)
- Middleware completion | [DEMO](https://github.com/yaegassy/coc-laravel/issues/1#issuecomment-1635271630)
- Guard completion | [DEMO](https://github.com/yaegassy/coc-laravel/issues/1#issuecomment-1635272378)
- Translation completion | [DEMO](https://github.com/yaegassy/coc-laravel/issues/1#issuecomment-1637244306)
- Method directive parameter completion | [DEMO](https://github.com/yaegassy/coc-laravel/issues/1#issuecomment-1647629965)
- View reference variable completion | [DEMO](https://github.com/yaegassy/coc-laravel/issues/1#issuecomment-1695541537)
- Eloquent model field completion | [DEMO](https://github.com/yaegassy/coc-laravel/issues/1#issuecomment-1692855711)
- Completion feature using `_ide_helper_models.php` file generated by [laravel-ide-helper](https://github.com/barryvdh/laravel-ide-helper)
- Misc
- Please install [coc-blade](https://github.com/yaegassy/coc-blade), it is implemented in [coc-blade](https://github.com/yaegassy/coc-blade)
- Definitions
- View definition | [DEMO](https://github.com/yaegassy/coc-laravel/issues/2#issuecomment-1644973067)
- [PHP -> Blade] Definition jump to the Blade template specified by the view() function.
- Blade View definition | [DEMO](https://github.com/yaegassy/coc-laravel/issues/2#issuecomment-1644973626)
- [Blade -> Blade] Jump to the Blade template specified by the `@extends` and `@include` directives.
- Component definition | [DEMO](https://github.com/yaegassy/coc-laravel/issues/2#issuecomment-1644974475)
- [Blade -> PHP or Blade] Jump to the component file. Both class components and anonymous components are supported.
- Livewire tag definition | [DEMO](https://github.com/yaegassy/coc-laravel/issues/2#issuecomment-1658759781)
- [Blade -> PHP or Blade] Jump to the livewire file. Both livewire class and blade template are supported.
- Livewire directive definition | [DEMO](https://github.com/yaegassy/coc-laravel/issues/2#issuecomment-1659297842)
- [Blade -> PHP or Blade] Jump to the livewire file. Both livewire class and blade template are supported.
- References
- `laravel.view.findAllReferences` command | [DEMO](https://github.com/yaegassy/coc-laravel/issues/3#issuecomment-1645929779)
- [Blade -> PHP] Show references to PHP files that use the current blade
file. Referenced directories are `routes`, `app/Http/Controllers`,
`app/View/Components`, `app/Http/Livewire` and `app/Livewire`.
- View reference | [DEMO](https://github.com/yaegassy/coc-laravel/issues/3#issuecomment-1645932674)
- [PHP -> Blade] Reference to a PHP file that uses the same template in the view function.
- Hovers
- ComponentTag Hover | [DEMO](https://github.com/yaegassy/coc-laravel/issues/4#issue-1816594130)
- Diagnostics
- Missing component validation | [DEMO](https://github.com/yaegassy/coc-laravel/issues/5#issuecomment-1657287255)
- Method directive parameter validation | [DEMO](https://github.com/yaegassy/coc-laravel/issues/5#issuecomment-1647636587)
- [TODO]
- Diagnostic features will be added as we come up with useful ones, based on projects already analyzed.
- CodeActions
- Create blade component | [DEMO](https://github.com/yaegassy/coc-laravel/issues/6#issuecomment-1657002340)
- Fix method directive parameter | [DEMO](https://github.com/yaegassy/coc-laravel/issues/6#issuecomment-1648914444)
- [TODO]
- CodeAction features will be added as we come up with useful ones, based on projects already analyzed.
- Artisan and Sail commands integration
- `laravel.artisan.run` command feature.
- `laravel.sailArtisan.run` command feature.

## [RECOMMENDED] Additional installation of "watchman"

`coc-laravel` uses the `workspace/didChangeWatchedFiles` notification to monitor files in the project.

In coc.nvim, it is recommended to install [watchman](https://facebook.github.io/watchman/) in order to utilize this feature.

- See:

If you have difficulty installing `watchman`, you can use `coc-laravel` without `watchman`, but you may not be able to immediately use IntelliSense with the newly added files.

In this case, please manually enter the following command.

- `:CocCommand laravel.project.restart`

- `:CocRestart`

## workspaceFolders

Depending on the project like mono repo or how Vim/Neovim is started, `workspaceFolders` may not be recognized correctly.

To make coc.nvim recognize `workspaceFolders` correctly, you can set `b:coc_root_patterns` in .vimrc/init.vim

**Example**:

```vim
au FileType php,blade let b:coc_root_patterns = ['.git', '.env', 'composer.json', 'artisan']
```

For more information, check this coc.nvim's wiki.

## Configuration options

- `laravel.enable`: Enable coc-laravel extension, default: `true`
- `laravel.environment.phpPath`: Path to PHP, you can use a custom version of PHP. If there is no setting, `php` of the execution environment will be used, default: `""`
- `laravel.project.excludeVendors`: List of target vendor directories to exclude during project analysis, e.g. `["fakerphp", "phpunit"]`, default: `[]`
- `laravel.project.startupMessageEnable`: Enable project startup messages, default: `true`
- `laravel.stubs.customVersion`: Specify the version of stubs to download with the `laravel.stubs.download` command. If not set, the `stubsVersion` defined in `package.json` will be used, default: `""`
- `laravel.stubs.useStubs`: List of stubs to be used, default: `["Core", "date", "standard"]`
- `laravel.completion.enable`: Enable all completion feature, default: `true`
- `laravel.completion.directiveEnable`: Enable directive completion, default: `true`
- `laravel.completion.directiveList`: List of directive used in directive completion, default: Omitted due to the large number of settings, See configuration in [package.json](/package.json)
- `laravel.completion.configEnable`: Enable config completion, default: `true`
- `laravel.completion.envEnable`: Enable env completion, default: true
- `laravel.completion.validationEnable`: Enable validation completion.
- `laravel.completion.routeEnable`: Enable route completion, default: `true`
- `laravel.completion.viewEnable`: Enable view completion, default: `true`
- `laravel.completion.middlewareEnable`: Enable middleware completion, default: `true`
- `laravel.completion.guardEnable`: Enable guard completion, default: `true`
- `laravel.completion.translationEnable`: Enable translation completion, default: `true`
- `laravel.completion.componentEnable`: Enable component completion, default: `true`
- `laravel.completion.phpFunctionEnable`: Enable php function completion, default: `true`
- `laravel.completion.phpFunction.stubsEnable`: Enable stubs in phpFunction completion, default: `true`
- `laravel.completion.phpFunction.vendorEnable`: Enable vendor in phpFunction completion, default: `true`
- `laravel.completion.phpClassEnable`: Enable php class completion, default: `true`
- `laravel.completion.phpClass.stubsEnable`: Enable stubs in phpClass completion, default: `true`
- `laravel.completion.phpClass.vendorEnable`: Enable vendor in phpClass completion, default: `true`
- `laravel.completion.phpConstantEnable`: Enable php constant completion, default: `true`
- `laravel.completion.phpConstant.stubsEnable`: Enable stubs in phpConstant completion, default: `true`
- `laravel.completion.phpConstant.vendorEnable`: Enable vendor in phpConstant completion, default: `true`
- `laravel.completion.phpStaticClassEnable`: Enable php static class completion, default: `true`
- `laravel.completion.phpObjectMemberEnable`: Enable php object member completion, default: `true`
- `laravel.completion.phpVariableEnable`: Enable php variable completion, default: `true`
- `laravel.completion.phpKeywordEnable`: Enable php keyword completion, default: `true`
- `laravel.completion.eloquentModelFieldEnable`: Enable eloquent model field completion, default: `true`
- `laravel.completion.viewReferenceVariableEnable`: Enable view reference variable completion, default: `true`
- `laravel.completion.methodParameterEnable`: Enable method parameter completion, default: `true`
- `laravel.completion.livewireEnable`: Enable livewire completion, default: `true`
- `laravel.livewire.wireClickAttributes`: List of click related action to be added to `wire:xxxx`, default: `["click", "click.prefetch"]`
- `laravel.livewire.wireModelAttributes`: List of model related action to be added to `wire:xxxx`, default: `["model", "model.debounce.100ms", "model.lazy", "model.defer"]`
- `laravel.livewire.wireEventAttributes`: List of browser events to be added to `wire:xxxx`. No need for `wire:model` or `wire:click`. default: Omitted due to the large number of settings, See configuration in [package.json](/package.json)
- `laravel.definition.enable`: Enable definition, default `true`
- `laravel.reference.enable`: Enable reference, default `true`
- `laravel.hover.enable`: Enable hover, default `true`
- `laravel.diagnostic.enable`: Enable diagnostic, default: `true`
- `laravel.codeAction.enable`: Enable code action, default: `true`
- `laravel.artisan.withoutArgumentsCommandList`: List of commands to quickly execute `laravel.artisan.run` or `laravel.sailArtisan.run` without prompting for arguments or options, e.g. `["route:list", "clear-compiled"]`, default: `[]`
- `laravel.artisan.enableSplitRight`: Use vertical belowright for artisan terminal window, default: `false`

## Commands

- `laravel.project.restart`: Run project restart
- `laravel.project.stats`: (Develop) Show project stats
- `laravel.project.finder`: (Develop) Run project finder
- `laravel.stubs.download`: Download stubs
- `laravel.stubs.version`: Show the version of stubs
- `laravel.artisan.run`: Run artisan command
- `laravel.sailArtisan.run`: Run sail artisan command
- `laravel.view.findAllReferences`: Find view file references
- `laravel.showOutput`: Show laravel output channel

## CodeActions

**Example key mapping (Code Action related)**:

```vim
nmap ga (coc-codeaction-line)
nmap ac (coc-codeaction-cursor)
```

**Actions**:

- `Create blade component`
- `Fix method directive parameter`

## Recommended coc-extensions for php

- [@yaegassy/coc-intelephense](https://github.com/yaegassy/coc-intelephense)
- [coc-blade](https://github.com/yaegassy/coc-blade)
- [@yaegassy/coc-phpstan](https://github.com/yaegassy/coc-phpstan)
- [coc-php-cs-fixer](https://github.com/yaegassy/coc-php-cs-fixer)
- [coc-psalm](https://github.com/yaegassy/coc-psalm)

## Inspired Projects

- [amir9480/vscode-laravel-extra-intellisense](https://github.com/amir9480/vscode-laravel-extra-intellisense) | (VSCode extension)
- [Laravel Idea](https://laravel-idea.com/) | (PhpStorm plugin)
- [haringsrob/laravel-dev-tools](https://github.com/haringsrob/laravel-dev-tools)
- and More...

## Thanks

- [glayzzle/php-parser](https://github.com/glayzzle/php-parser)
- [Stillat/blade-parser-typescript](https://github.com/Stillat/blade-parser-typescript)
- [JetBrains/phpstorm-stubs](https://github.com/JetBrains/phpstorm-stubs)
- [microsoft/vscode-html-languageservice](https://github.com/microsoft/vscode-html-languageservice)

## License

MIT

---

> This extension is built with [create-coc-extension](https://github.com/fannheyward/create-coc-extension)