Merge pull request #83 from adalessa/2.1

2.1

Author: adalessa

README.md

@@ -135,7 +135,7 @@ You can run `shell` as tinker will open a new terminal
 
 ## Plugin specific
 `Laravel cache:clear` purge the cache clears the cache for commands.
-`Laravel commands` shows the list of artisan commands and executes it.
+`Laravel artisan` shows the list of artisan commands and executes it.
 `Laravel routes` show the list of routes and goes to the implementation.
 `Laravel related` show the list of model related classes, includes observers, policy and relations and goes to the implementation.
 `Laravel test:watch` runs the application tests and keep monitoring the changes
@@ -144,6 +144,13 @@ You can run `shell` as tinker will open a new terminal
 `Laravel recipes` There are some recipes like installing ide helper and running the model and eloquent command. and to install doctrine dbal
 `Laravel health` trigger the neovim command `:checkhealth laravel`
 
+## User commands
+Is normal that you may want to define custom commands for example you don't want
+to always have to add the flag `--seed` to migrate but don't want to overwrite the default artisan command
+for that you can define custom commands for the different executables and have them list for you
+check [config](./lua/laravel/config/user_commands.lua) to see an example you can acces them from the command `:LaravelMyCommands` or from `:Laravel commands`
+
+
 ## Lua API
 ### Telescope
 One of the things you may want to change are actions or styles or something related to telescope

lua/laravel/api/init.lua

@@ -54,7 +54,7 @@ function M.is_composer_package_install(package)
   return M.sync("composer", { "info", package }):successful()
 end
 
-function M.php_execute(code)
+function M.tinker_execute(code)
   return M.sync("artisan", { "tinker", "--execute", "echo " .. code })
 end
 

lua/laravel/app/config.lua

@@ -0,0 +1,27 @@
+local api = require "laravel.api"
+
+local cache = {}
+
+local M = {}
+
+--- Get value from app config
+---@param name string
+function M.get(name)
+  if cache[name] then
+    return cache[name]
+  end
+
+  local response = api.tinker_execute(string.format('json_encode(config("%s"))', name))
+  if response:failed() then
+    vim.notify(response:prettyErrors(), vim.log.levels.ERROR)
+    return nil
+  end
+
+  local conf = vim.fn.json_decode(response:first())
+
+  cache[name] = conf
+
+  return conf
+end
+
+return M

lua/laravel/config/default.lua

@@ -1,3 +1,23 @@
+---@class NullLsFeature
+---@field enable boolean
+
+---@class RouteInfoFeature
+---@field enable boolean
+---@field position string
+
+---@class LaravelFeatures
+---@field null_ls NullLsFeature
+---@field route_info RouteInfoFeature
+
+---@class LaravelOptions
+---@field lsp_server string
+---@field register_user_commands boolean
+---@field features LaravelFeatures
+---@field ui LaravelOptionsUI
+---@field commands_options table
+---@field environments LaravelOptionsEnvironments
+---@field user_commands table
+---@field resources table
 return {
   lsp_server = "phpactor",
   register_user_commands = true,
@@ -13,5 +33,6 @@ return {
   ui = require "laravel.config.ui",
   commands_options = require "laravel.config.command_options",
   environments = require "laravel.config.environments",
+  user_commands = require "laravel.config.user_commands",
   resources = require "laravel.config.resources",
 }

lua/laravel/config/environments.lua

@@ -1,3 +1,17 @@
+---@class EnvironmentCondition
+---@field file_exists string[]|nil
+---@field executable string[]|nil
+
+---@class LaravelEnvironmentConfig
+---@field name string
+---@field condition EnvironmentCondition
+---@field commands table|nil
+
+---@class LaravelOptionsEnvironments
+---@field env_variable string
+---@field auto_dicover boolean
+---@field default string
+---@field definitions LaravelEnvironmentConfig[]
 return {
   env_variable = "NVIM_LARAVEL_ENV",
   auto_dicover = true,

lua/laravel/config/init.lua

@@ -1,6 +1,6 @@
 local M = {}
 
----@class LaravelOptions
+---@type LaravelOptions
 M.defaults = require "laravel.config.default"
 
 --- @type LaravelOptions

lua/laravel/config/resources.lua

@@ -1,36 +1,16 @@
--- each element represent a command that after execution should open a file
--- if the return is a string is use as directory to search file.
--- if the return is a function will call and expects the result to be an string
 return {
-  ["make:cast"] = "app/Casts",
-  ["make:channel"] = "app/Broadcasting",
-  ["make:command"] = "app/Console/Commands",
-  ["make:component"] = "app/View/Components",
-  ["make:controller"] = "app/Http/Controllers",
-  ["make:event"] = "app/Events",
-  ["make:exception"] = "app/Exceptions",
-  ["make:factory"] = function(name)
-    return string.format("database/factories/%sFactory.php", name)
-  end,
-  ["make:job"] = "app/Jobs",
-  ["make:listener"] = "app/Listeners",
-  ["make:mail"] = "app/Mail",
-  ["make:middleware"] = "app/Http/Middleware",
-  ["make:migration"] = function(name)
-    return vim.fn.systemlist(string.format("fd %s.php", name))[1]
-  end,
-  ["make:model"] = "app/Models",
-  ["make:notification"] = "app/Notifications",
-  ["make:observer"] = "app/Observers",
-  ["make:policy"] = "app/Policies",
-  ["make:provider"] = "app/Providers",
-  ["make:request"] = "app/Http/Requests",
-  ["make:resource"] = "app/Http/Resources",
-  ["make:rule"] = "app/Rules",
-  ["make:scope"] = "app/Models/Scopes",
-  ["make:seeder"] = "database/seeders",
-  ["make:test"] = "tests/Feature",
-  ["make:view"] = function(name)
-    return "resources/views/" .. name:gsub("%.", "/") .. ".blade.php"
-  end,
+  ["Controllers"] = "app/Http/Controllers",
+  ["Livewire"] = "app/Livewire",
+  ["Models"] = "app/Models",
+  ["Views"] = "resources/views",
+  ["Migrations"] = "database/migrations",
+  ["Providers"] = "app/Providers",
+  ["Components"] = "app/View/Components",
+  ["Routes"] = "routes",
+  ["Factories"] = "database/factories",
+  ["Seeders"] = "database/seeders",
+  ["Configs"] = "config",
+  ["FeatureTest"] = "tests/Feature",
+  ["UnitTest"] = "tests/Unit",
+  ["Requests"] = "app/Http/Requests",
 }

lua/laravel/config/ui.lua

@@ -1,3 +1,18 @@
+---@class NuiOptions
+---@field enter boolean
+---@field relative string
+---@field position string|table
+---@field size string|table
+---@field buf_options table
+---@field win_options table
+
+---@class LaravelOptionsUINui
+---@field split NuiOptions
+---@field popup NuiOptions
+
+---@class LaravelOptionsUI
+---@field default string
+---@field nui_opts LaravelOptionsUINui
 return {
   default = "split",
   nui_opts = {

lua/laravel/config/user_commands.lua

@@ -0,0 +1,24 @@
+return {
+  artisan = {
+    ["db:fresh"] = {
+      cmd = { "migrate:fresh", "--seed" },
+      desc = "Re-creates the db and seed's it",
+    },
+  },
+  npm = {
+    build = {
+      cmd = { "run", "build" },
+      desc = "Builds the javascript assets",
+    },
+    dev = {
+      cmd = { "run", "dev" },
+      desc = "Builds the javascript assets",
+    },
+  },
+  composer = {
+    autoload = {
+      cmd = { "dump-autoload" },
+      desc = "Dumps the composer autoload",
+    },
+  },
+}

lua/laravel/environment/init.lua

@@ -30,10 +30,7 @@ local function resolve()
   if opts.env_variable then
     local env_opts = find_env_by_name(get_env(opts.env_variable), opts.definitions)
     if env_opts then
-      local env = Environment:new(env_opts)
-      if env:check() then
-        return env
-      end
+      return Environment:new(env_opts)
     end
   end
 
@@ -71,6 +68,7 @@ function M.setup()
     return
   end
 
+  require("laravel.treesitter").setup()
   user_commands.setup()
 
   if config.options.features.route_info.enable then
@@ -80,6 +78,8 @@ function M.setup()
   if config.options.features.null_ls.enable then
     require("laravel.null_ls").setup()
   end
+
+  require("laravel.luasnip").setup()
 end
 
 ---@param name string