symfony-goto.nvim

This plugin adds vim commands to go to different places in a Symfony project.
Here is the list of handled goto:

• webpack encore entrypoint
• route action

Get help with:

:help symfony-goto
" or
:help :SymfonyGoto

Setup

require('symfony-goto').setup()

Configuration

This is the full configuration with default values, no need to keep all of them.

require('symfony-goto').setup {
  -- configuration for :SymfonyGotoEncore command
  encore = {
    -- enable or not :SymfonyGotoEncore command
    enable = true,

    -- open the file event if it doesn't exist
    force_open = true,

    -- lua doesn't support regex, see: https://www.lua.org/pil/20.1.html
    -- This is used to replace encore entrypoint with its real path, it depends on webpack.config.js and Encore.addEntry
    -- example: encore_entry_link_tags('css/example') should open file assets/css/entrypoint/example.scss
    css_pattern = "s#^css#assets/css/entrypoint#",
    js_pattern = "s#^js#assets/js/entrypoint#",

    -- assets extension
    css_extension = ".scss",
    js_extension = ".js",
  },
  route = {
    -- enable or not :SymfonyGotoRoute command
    enable = true,

    route_file = "./var/cache/dev/url_generating_routes.php",
  }
}

Commands

Each commands are made to work without depending on the cursor position on the line.

:SymfonyGoto

Calls specific command depending on what's found on the current line.

---

:SymfonyGotoEncore

Goes to the entrypoint file of the encore statement. The :SymfonyGoto command checks if encore_entry is on the current line to call :SymfonyGotoEncore.
The line should match one of these:

{{ encore_entry_link_tags('css/example') }}
{{ encore_entry_script_tags('js/example') }}

---

:SymfonyGotoRoute

Goes to the corresponding controller action. The :SymfonyGoto command calls this command if no other handler was matched, as there can be multiple route generation methods.

This command also accepts one argument to go to a route from anywhere:

:SymfonyGotoRoute app_home

Mapping

There is no default mapping, either map each command:

nnoremap <leader>se <cmd>:SymfonyGotoEncore<cr>
nnoremap <leader>sr <cmd>:SymfonyGotoRoute<cr>

Or map the global command once:

nnoremap <leader>s <cmd>:SymfonyGoto<cr>

Todo

• handle more places:
  • translations
  • form properties
• composer PSR-4 for controller namespace