start odoo_ls_server with odools.toml settings

[ahmed-aly-aut]

How do I start the odoo_ls_server with my odools.toml config.
I am trying to integrate it well with neovim, but I want to check the logs and see what is loaded and what not.

Here is my odools.toml file.

[[config]]
name = "main"
odoo_path = "${workspaceFolder}/odoo"
addons_paths = [
    "${workspaceFolder}/odoo/odoo/addons",
    "${workspaceFolder}/odoo/addons",
    "${workspaceFolder}/enterprise",
    "${workspaceFolder}/custom-addons",
    "${workspaceFolder}/3rd-party-addons",
]
python_path = ".venv/bin/python"
additional_stubs = [
	"${workspaceFolder}/typeshed/stubs",
	"${workspaceFolder}/typeshed/stdlib",
	"${workspaceFolder}/.venv/lib/python3.12/site-packages/lxml-stubs",
]

Currently I have the problem that from odoo.addons.account_account is not recognized (no autocomplete), so enterprise modules are not recoginzed or any other module from the addons_paths

[fda-odoo]

I'm not sure to understand what you want to know, but here are some information:

• As you are writing the integration in neovim, you are responsible of starting the language server. On our other integration, we usually check if the current workspace contains a "manifest.py" file as trigger for the extension.
• To start odoo_ls_server, providing no argument will open the communication on stdio, that you should use. You can use --use-tcp if you want to switch to tcp connection, but that should be for debug usage only
• Having no autocompletion on from odoo.addons.account_account doesn't mean that odoo-ls is not loaded, as we don't provide autocompletion for import statements right now. You shloud rather try something like from odoo.addonds.a_wrong_module and check if there is a diagnostic on the import. You can type self.env["account.account"]. and see if you have autocompletion on the model name or on the attributes of the model.
• I guess you know it already, but do not hesitate to check our wiki, especially this page: https://github.com/odoo/odoo-ls/wiki/5.-Implement-a-custom-tool-with-the-server

Feel free to ask any question you should have

[ahmed-aly-aut]

sorry I meant from odoo.addons.account_accountant.models.account_move_line import AccountMoveLine as an Example

I am ussing a lot of typing in my code and this is just an example.

• Having no autocompletion on from odoo.addons.account_account doesn't mean that odoo-ls is not loaded, as we don't provide autocompletion for import statements right now.

Apperently the tool ty from astral-sh was providing me with an autocompletion and I thought it was from odools

[fda-odoo]

Ok! Did you manage to start OdooLS then? I'm not sure if you still have an issue or if it's working?
Did you check this repository too? https://github.com/odoo/odoo-neovim

[ahmed-aly-aut]

odools is working. neovim 0.11 has a native integration for lsp now.
here is my config for reference.

-- lsp/odools.lua

local capabilities = vim.lsp.protocol.make_client_capabilities()
capabilities.textDocument.completion.completionItem.documentationFormat = { "markdown", "plaintext" }
capabilities.textDocument.hover.contentFormat = { "markdown", "plaintext" }

capabilities.textDocument.completion.completionItem.snippetSupport = true

return {
    cmd = { "odoo_ls_server"}, -- odoo_ls_server is installed under ~/.local/bin/odoo_ls_server
    filetypes = {
        "python",
        "xml",
        "csv",
    },
    root_markers = {
        {
            "pyproject.toml",
            "odools.toml",
        },
        ".git",
    },
    capabilities = capabilities,
    settings = {
        Odoo = {
            selectedProfile = "main",
        },
    },
}

--lua/core/lsp.lua
local api, lsp = vim.api, vim.lsp
local diagnostic, keyset, autocmd = vim.diagnostic, vim.keymap.set, api.nvim_create_autocmd

-- Set up custom diagnostic signs for a better visual experience.
diagnostic.config({
    virtual_text = true, -- Show diagnostics inline
    update_in_insert = true,
    underline = true,
    severity_sort = true,
})

autocmd("LspAttach", {
    group = api.nvim_create_augroup("UserLspConfig", { clear = true }),
    callback = function(args)
        local bufnr = args.buf
        local client = assert(lsp.get_client_by_id(args.data.client_id))

        -- Enable native autocompletion.
        if client:supports_method("textDocument/completion") then
            lsp.completion.enable(true, client.id, bufnr, { autotrigger = true })
        end

        -- Set omnifunc for fallback completion with Ctrl-X Ctrl-O
        api.nvim_buf_set_option(bufnr, "omnifunc", "v:lua.vim.lsp.omnifunc")


        -- Core LSP Actions
        keyset('n', 'K', lsp.buf.hover, { buffer = bufnr, desc = 'LSP: Hover' })
        keyset('n', 'gd', lsp.buf.definition, { buffer = bufnr, desc = 'LSP: Go to Definition' })
        keyset('n', 'gD', lsp.buf.declaration, { buffer = bufnr, desc = 'LSP: Go to Declaration' })
        keyset('n', 'gr', lsp.buf.references, { buffer = bufnr, desc = 'LSP: Find References' })
        keyset('n', 'gi', lsp.buf.implementation, { buffer = bufnr, desc = 'LSP: Go to Implementation' })
        keyset('n', 'gt', lsp.buf.type_definition, { buffer = bufnr, desc = 'LSP: Go to Type Definition' })
        keyset('n', '<leader>ws', lsp.buf.workspace_symbol, { buffer = bufnr, desc = 'LSP: Workspace Symbols' })
        keyset('n', '<leader>ds', lsp.buf.document_symbol, { buffer = bufnr, desc = 'LSP: Document Symbols' })
        keyset('n', '<leader>sh', lsp.buf.signature_help, { buffer = bufnr, desc = 'LSP: Signature Help' })


        -- Renaming and Code Actions
        keyset('n', '<leader>rn', lsp.buf.rename, { buffer = bufnr, desc = 'LSP: Rename' })
        keyset({ 'n', 'v' }, '<leader>ca', lsp.buf.code_action, { buffer = bufnr, desc = 'LSP: Code Action' })

        -- Diagnostic navigation
        keyset('n', '<leader>dn', diagnostic.goto_next, { buffer = bufnr, desc = 'Diagnostic: Next' })
        keyset('n', '<leader>dp', diagnostic.goto_prev, { buffer = bufnr, desc = 'Diagnostic: Previous' })
        keyset('n', '<leader>de', diagnostic.open_float, { buffer = bufnr, desc = 'Diagnostic: Show Line Diagnostics' })

        -- Enable LSP-based folding
        if client:supports_method("textDocument/foldingRange") then
            vim.opt_local.foldmethod = "expr"
            vim.opt_local.foldexpr = "v:lua.vim.lsp.util.make_fold_expr()"
            vim.opt_local.foldenable = true
            keyset('n', 'za', vim.cmd.foldopen, { buffer = bufnr, desc = "Fold: Toggle" })
        end

        -- Enable semantic tokens if the server supports it
        if client:supports_method("textDocument/semanticTokens/full") then
            vim.lsp.semantic_tokens.start(bufnr, client.id)
        end
    end,
})

-- Auto-format on save
autocmd("BufWritePre", {
    group = api.nvim_create_augroup("LspFormatOnSave", { clear = true }),
    pattern = { "*.py", "*.lua", "*.xml", "*.csv" }, -- Add any other filetypes you want to auto-format
    callback = function()
        lsp.buf.format({ async = true })
    end,
})

vim.cmd("set completeopt+=noselect")

local function set_filetype(pattern, filetype)
    vim.api.nvim_create_autocmd({ "BufRead", "BufNewFile" }, {
        pattern = pattern,
        command = "set filetype=" .. filetype,
    })
end

-- Allow .yml files to be registerd as .yaml
set_filetype({ "docker-compose.yml" }, "yaml.docker-compose")
set_filetype({ "compose.yaml" }, "yaml.docker-compose")
set_filetype({ "compose.yml" }, "yaml.docker-compose")

-- Neovim will automatically load the configuration from the `lsp/` directory.
lsp.enable({
    "ruff",
    "lua_ls",
    "odools",
    "ty",
    "docker_language_server",
})

# odools.toml

[[config]]
name = "main"
odoo_path = "${workspaceFolder}/odoo"
addons_paths = [
    #"${workspaceFolder}/odoo/odoo/addons",
    #"${workspaceFolder}/odoo/addons",
    "${workspaceFolder}/enterprise",
    "${workspaceFolder}/custom-addons",
    "${workspaceFolder}/dp-apps",
    "${workspaceFolder}/3rd-party-addons",
]
python_path = ".venv/bin/python"
additional_stubs = [
	"${workspaceFolder}/typeshed",
]

# pyproject.toml
[tool.ty.environment]
python = "./.venv"
python-version = "3.12"
root = ["./odoo"]
typeshed = "./typeshed"

[tool.ty.rules]
unresolved-import = "ignore"

[tool.ruff]
fix = true
show-fixes = true
preview = true
target-version = "py312"
line-length = 120

[tool.ruff.lint.isort.sections]
"odoo" = ["odoo"]
"odoo-addons" = ["odoo.addons"]

[tool.ruff.lint.isort]
force-wrap-aliases = true
combine-as-imports = true
section-order = ["future", "standard-library", "third-party", "odoo", "odoo-addons", "first-party", "local-folder"]

[tool.ruff.lint.flake8-builtins]
builtins-ignorelist = ["zip", "id", "type"]

[tool.ruff.format]
quote-style = "double"
indent-style = "space"
docstring-code-format = true