added setup() function to platformio module to have userconfiguration such as lsp

Author: anurag3301

README.md

@@ -53,6 +53,14 @@ return {
 
 #### Usage `:h PlatformIO`
 
+### Configuration
+```lua
+require('platformio').setup({
+    lsp = "ccls" --default: ccls, other option: clangd
+                 -- If you pick clangd, it also creates compile_commands.json
+})
+```
+
 ### Lazy loading
 
 It's possible to lazy load the plugin using Lazy.nvim, this will load the plugins only when it is needed, to enable lazy loading, add this plugin spec to your config.

lua/platformio/init.lua

@@ -0,0 +1,27 @@
+local M = {}
+
+local default_config = {
+    lsp = 'ccls',
+}
+
+M.config = vim.deepcopy(default_config)
+
+function M.setup(user_config)
+    local valid_keys = {
+        lsp = true,
+    }
+    for key, _ in pairs(user_config or {}) do
+        if not valid_keys[key] then
+            local error_message = string.format(
+                "Invalid configuration key: '%s'\n%s",
+                key,
+                debug.traceback("Stack trace:")
+            )
+            vim.api.nvim_err_writeln(error_message)
+            return
+        end
+    end
+    M.config = vim.tbl_deep_extend('force', default_config, user_config or {})
+end
+
+return M

lua/platformio/pioinit.lua

@@ -2,13 +2,14 @@ local M = {}
 
 local pickers = require 'telescope.pickers'
 local finders = require 'telescope.finders'
-local conf = require('telescope.config').values
+local telescope_conf = require('telescope.config').values
 local actions = require 'telescope.actions'
 local action_state = require 'telescope.actions.state'
 local entry_display = require 'telescope.pickers.entry_display'
 local make_entry = require 'telescope.make_entry'
 local utils = require 'platformio.utils'
 local previewers = require 'telescope.previewers'
+local config = require('platformio').config
 
 local boardentry_maker = function(opts)
   local displayer = entry_display.create {
@@ -61,12 +62,13 @@ local function pick_framework(board_details)
             .. ' --project-option "framework='
             .. selected_framework
             .. '"'
+            .. (config.lsp == "clangd" and " && pio run -t compiledb " or "")
             .. utils.extra
           utils.ToggleTerminal(command, 'float')
         end)
         return true
       end,
-      sorter = conf.generic_sorter(opts),
+      sorter = telescope_conf.generic_sorter(opts),
     })
     :find()
 end
@@ -103,7 +105,7 @@ local function pick_board(json_data)
           end, 0)
         end,
       },
-      sorter = conf.generic_sorter(opts),
+      sorter = telescope_conf.generic_sorter(opts),
     })
     :find()
 end

plugin/platformio.lua

@@ -5,7 +5,7 @@
 -- *: Any number of arguments (including none).
 -- +: At least one argument.
 -- -1: Zero or one argument (like ?, explicitly).
-
+local platformio = require('platformio')
 
 -- Pioinit
 vim.api.nvim_create_user_command('Pioinit', function()