Skip to main content
coc.nvim logococ.nvim
Back to Extensions Directory
coc.nvim fallback icon

@yaegassy/coc-laravel

yaegassy

Laravel extension for coc.nvim

Installation CommandVim prompt
:CocInstall @yaegassy/coc-laravel
GitHub owner
yaegassy
Version
v0.7.18
Requirements
coc ^0.0.80
License
MIT
Repository
GitHub
npm latest published 2024-01-13Registry checked 2026-08-23Registry summary

Published Package Summary

coc-laravel

Laravel extension for coc.nvim.

Install

CocInstall:

:CocInstall @yaegassy/coc-laravel

scoped packages

vim-plug:

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
    • Livewire completion (Also compatible with Livewire v3!)
      • Livewire tag completion | DEMO
      • Livewire action completion | DEMO
      • Livewire event completion | DEMO
      • Livewire property completion | DEMO
      • Livewire directive completion | DEMO
    • 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
      • PHP Class completion | DEMO
      • PHP Static Class completion (Static class members and constants, e.g. DateTime::|) | DEMO
      • PHP Object Member completion (e.g. $obj->|) | DEMO
      • PHP Variable completion | DEMO
      • PHP Constant completion | DESCRIPTION
      • PHP Keyword completion | DESCRIPTION
    • Directive completion | DEMO
    • Config completion | DEMO
    • Env completion | DEMO
    • Validation completion | DEMO
    • Route completion | DEMO
    • View completion | DEMO
    • Middleware completion | DEMO
    • Guard completion | DEMO
    • Translation completion | DEMO
    • Method directive parameter completion | DEMO
    • View reference variable completion | DEMO
    • Eloquent model field completion | DEMO
    • Misc
  • Definitions
    • View definition | DEMO
      • [PHP -> Blade] Definition jump to the Blade template specified by the view() function.
    • Blade View definition | DEMO
      • [Blade -> Blade] Jump to the Blade template specified by the @extends and @include directives.
    • Component definition | DEMO
      • [Blade -> PHP or Blade] Jump to the component file. Both class components and anonymous components are supported.
    • Livewire tag definition | DEMO
      • [Blade -> PHP or Blade] Jump to the livewire file. Both livewire class and blade template are supported.
    • Livewire directive definition | DEMO
      • [Blade -> PHP or Blade] Jump to the livewire file. Both livewire class and blade template are supported.
  • References
    • laravel.view.findAllReferences command | DEMO
      • [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
      • [PHP -> Blade] Reference to a PHP file that uses the same template in the view function.
  • Hovers
    • ComponentTag Hover | DEMO
  • Diagnostics
    • Missing component validation | DEMO
    • Method directive parameter validation | DEMO
    • [TODO]
      • Diagnostic features will be added as we come up with useful ones, based on projects already analyzed.
  • CodeActions
    • Create blade component | DEMO
    • Fix method directive parameter | DEMO
    • [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 in order to utilize this feature.

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

or

  • :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:

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

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

CodeActions

Example key mapping (Code Action related):

nmap <silent> ga <Plug>(coc-codeaction-line)
nmap <silent> <leader>ac <Plug>(coc-codeaction-cursor)

Actions:

  • Create blade component
  • Fix method directive parameter

Recommended coc-extensions for php

Inspired Projects

Thanks

License

MIT

This extension is built with create-coc-extension

Read the complete README
  • Laravel extension for coc.nvim
Activation Events
  • onLanguage:php
  • onLanguage:blade
Developer Resources

Want to build, test, or contribute to coc.nvim extensions? Explore our official SDK and testing toolkits.

Open Developer Guide

Version History

This published npm package does not include a history.md or changelog.md file. Browse its npm versions or repository releases for available release information.