Plugin for Neovim to enhance the development experience of Laravel projects

The plugin supports different types of environment, like local, sail, docker compose and heard, and can be extended for your own need. To get you all the power and some flexibility the plugin will store your preferences in your machine per projects. By default will use base on your configurations the environments.default which on the plugin is local, this is just for initial opening and can be easily modified. You can change de default during the setup, and in case you need a different in the project just use :lua Laravel.commands.run("env:configure") to launch the environment selector, and in case you have a more complex configuration from the defaults you can run :lua Laravel.commands.run("env:configure:open") to open the json file and edit as you may need to map commands. An example could be change the name of the container in a particular project from the default app to what ever you may need. This gives you more control over the execution since the plugin relies on the real commands to gather information.

Ensure that you vendor folder is writeable since the plugin will create files there in order to execute code and cache it properly for improved speed.

• Artisan commands
• Routes
• User Commands, allow you to define your own quick actions
• Makes
• Resources, picker sort by common laravel resources like controlles migrations, etc.
• Related, on a model quickly go to relations of it.
• Composer
• History, the plugin stores the previously run commands to quicly re-run them.

• Model Info: Get the model information like database, table and fields, directly on the model
• Route Info: Get the URI, method and middlewares right on top of your controller function
• Composer Info: Get the exact version of the installed packages and if an update is available.

The plugin offers completion for several elements of the code like

• routes
• views (blade)
• config keys
• environment variables (from .env)
• model columns

The completion is written for cmp, and is register with the name laravel so it can be added to your config.

For blink you can use compat

laravel = {
    name = "laravel",
    module = "blink.compat.source",
    score_offset = 95, -- show at a higher priority than lsp
},

The plugin provides an action system like the lsp action, but only for laravel.

Tinker it's a great tool, the plugins provides a new way to interact with it. Using files .tinker on your project and a dedicated UI makes interact with Tinker a lot easier and fun.

Integration with laravel dump server

One of the ways to run your laravel environment is locally using artisan serve. For this type of user laravel now ships with a command in composer called dev If you are one of this users you can start the server directly from neovim. Maybe you would like the new Hub down below.

Hub is my solution to run different commands easily. using Laravel.commands.run("hub") will open the new ui and will default with common commands to run in the predefined environment. If you want to customize them you can use the Laravel.commands.run("env:configure:open") There you will see configuration for all you defined projects and you can edit the commands as you need. in th future can be improved the ui but as right now is a good use case since you are not expected to edit every time.

In order to have the best experience with laravel eloquent now the plugin can generate a custom class in the vendor folder with all the fields for the model and methods. Since this do not modified your model is enable by default, if you don't want that you can disable the property eloquent_generate_doc_blocks from the root of the plugin config. In some projects the generation can be big so recommended is to expand the lsp maxSize to the current 1MB.

 vim.lsp.config('intelephense', {
     ...
      settings = {
        intelephense = {
          files = {
            maxSize = 2000000,
          },
        },
      }

{
  {
    function()
      local ok, laravel_version = pcall(function()
        return Laravel.app("status"):get("laravel")
      end)
      if ok then
        return laravel_version
      end
    end,
    icon = { " ", color = { fg = "#F55247" } },
    cond = function()
      local ok, has_laravel_versions = pcall(function()
        return Laravel.app("status"):has("laravel")
      end)
      return ok and has_laravel_versions
    end,
  },
  {
    function()
      local ok, php_version = pcall(function()
        return Laravel.app("status"):get("php")
      end)
      if ok then
        return php_version
      end
      return nil
    end,
    icon = { " ", color = { fg = "#AEB2D5" } },
    cond = function()
      local ok, has_php_version = pcall(function()
        return Laravel.app("status"):has("php")
      end)
      return ok and has_php_version
    end,
  },
  {
    function()
      local ok, hostname = pcall(function()
        return Laravel.extensions.composer_dev.hostname()
      end)
      if ok then
        return hostname
      end
      return nil
    end,
    icon = { " ", color = { fg = "#8FBC8F" } },
    cond = function()
      local ok, is_running = pcall(function()
        return Laravel.extensions.composer_dev.isRunning()
      end)
      return ok and is_running
    end,
  },
  {
    function()
      local ok, unseen_records = pcall(function()
        return #(Laravel.extensions.dump_server.unseenRecords())
      end)

      if ok then
        return unseen_records
      end
      return 0
    end,
    icon = { "󰱧 ", color = { fg = "#FFCC66" } },
    cond = function()
      local ok, is_running = pcall(function()
        return Laravel.extensions.dump_server.isRunning()
      end)

      return ok and is_running
    end,
  },
}

Using Lazy.nvim

{
  "adalessa/laravel.nvim",
  dependencies = {
    "MunifTanjim/nui.nvim",
    "nvim-lua/plenary.nvim",
    "nvim-neotest/nvim-nio",
  },
  ft = { "php", "blade" },
  event = {
    "BufEnter composer.json",
  },
  keys = {
    { "<leader>ll", function() Laravel.pickers.laravel() end,              desc = "Laravel: Open Laravel Picker" },
    { "<c-g>",      function() Laravel.commands.run("view:finder") end,    desc = "Laravel: Open View Finder" },
    { "<leader>la", function() Laravel.pickers.artisan() end,              desc = "Laravel: Open Artisan Picker" },
    { "<leader>lt", function() Laravel.commands.run("actions") end,        desc = "Laravel: Open Actions Picker" },
    { "<leader>lr", function() Laravel.pickers.routes() end,               desc = "Laravel: Open Routes Picker" },
    { "<leader>lh", function() Laravel.run("artisan docs") end,            desc = "Laravel: Open Documentation" },
    { "<leader>lm", function() Laravel.pickers.make() end,                 desc = "Laravel: Open Make Picker" },
    { "<leader>lc", function() Laravel.pickers.commands() end,             desc = "Laravel: Open Commands Picker" },
    { "<leader>lo", function() Laravel.pickers.resources() end,            desc = "Laravel: Open Resources Picker" },
    { "<leader>lp", function() Laravel.commands.run("command_center") end, desc = "Laravel: Open Command Center" },
    { "<leader>lu", function() Laravel.commands.run("hub") end,            desc = "Laravel Artisan hub" },
    {
      "gf",
      function()
        local ok, res = pcall(function()
          if Laravel.app("gf").cursorOnResource() then
            return "<cmd>lua Laravel.commands.run('gf')<cr>"
          end
        end)
        if not ok or not res then
          return "gf"
        end
        return res
      end,
      expr = true,
      noremap = true,
    },
  },
  opts = {
    features = {
      pickers = {
        provider = "snacks", -- "snacks | telescope | fzf-lua | ui-select"
      },
    },
  },
}

The configuration is extense and recommend look here

I am Ariel I am a developer and also content creator (mostly in Spanish) if you would like to show some love leave a start into the plugin and subscribe to my Youtube if you want to show even more love you can support becoming a member on Youtube. But just leaving a like or letting me know that you like and enjoy the plugin is appreciated.

I am open to review pr if you have ideas or ways to improve the plugin would be great.