feat(config): add an optional pre_run_callback attribute to setup_project

Add args to callback

Add callback args to pre run callback

Update setup_project_documentation

Update docs to include information about args in callback

Update docs to be more accurate with what is exposed in callback

Author: JordanH-Apadmi

README.md

@@ -314,6 +314,8 @@ require('flutter-tools').setup_project({
       API_URL = 'https://dev.example.com/api',
       IS_DEV = true,
     },
+    pre_run_callback = nil, -- optional callback to run before the configuration
+    -- exposes a table containing name, target, flavor and device in the arguments
     dart_define_from_file = 'config.json' -- the path to a JSON configuration file
   },
   {

lua/flutter-tools/commands.lua

@@ -179,6 +179,17 @@ local function run(opts, project_conf)
 
     current_device = opts.device or get_device_from_args(args)
     ui.notify("Starting flutter project...")
+    if project_conf then
+      if project_conf.pre_run_callback then
+        local callback_args = {
+          name = project_conf.name,
+          target = project_conf.target,
+          flavor = project_conf.flavor,
+          device = project_conf.device,
+        }
+        project_conf.pre_run_callback(callback_args)
+      end
+    end
     runner = use_debugger_runner() and debugger_runner or job_runner
     runner:run(paths, args, lsp.get_lsp_root_dir(), on_run_data, on_run_exit)
   end)
@@ -432,8 +443,8 @@ function M.install()
         install_job = Job:new({
           command = cmd,
           args = args,
-        -- stylua: ignore
-        cwd = lsp.get_lsp_root_dir() --[[@as string]],
+          -- stylua: ignore
+          cwd = lsp.get_lsp_root_dir() --[[@as string]],
         })
         install_job:after_success(vim.schedule_wrap(function(j)
           ui.notify(utils.join(j:result()), nil, { timeout = notify_timeout })
@@ -463,8 +474,8 @@ function M.uninstall()
         uninstall_job = Job:new({
           command = cmd,
           args = args,
-        -- stylua: ignore
-        cwd = lsp.get_lsp_root_dir() --[[@as string]],
+          -- stylua: ignore
+          cwd = lsp.get_lsp_root_dir() --[[@as string]],
         })
         uninstall_job:after_success(vim.schedule_wrap(function(j)
           ui.notify(utils.join(j:result()), nil, { timeout = notify_timeout })

lua/flutter-tools/config.lua

@@ -6,6 +6,7 @@ local utils = lazy.require("flutter-tools.utils") ---@module "flutter-tools.util
 ---@class flutter.ProjectConfig
 ---@field name string?
 ---@field device string
+---@field pre_run_callback fun(opts: {string: string})
 ---@field flavor string
 ---@field target string
 ---@field dart_define {[string]: string}
@@ -62,6 +63,7 @@ M.debug_levels = {
 local config = {
   flutter_path = nil,
   flutter_lookup_cmd = get_default_lookup(),
+  pre_run_callback = nil,
   root_patterns = { ".git", "pubspec.yaml" },
   fvm = false,
   widget_guides = {