Vim global variable check throws error in lua (neovim plugin development)

Question

I'm trying write a neovim plugin using lua, when checking if a variable exists, lua throws an error like: Undefined variable: g:my_var

Method 1:

local function open_bmax_term()
    if (vim.api.nvim_eval("g:my_var")) then
        print('has the last buff')
    else
        print('has no the last buff')
    end
end

Method 2:


local function open_bmax_term()
    if (vim.api.nvim_get_var("my_var")) then
        print('has the last buff')
    else
        print('has no the last buff')
    end
end

this is a similar function written in viml which does works: (this does not throw any error)

fun! OpenBmaxTerm()

    if exists("g:my_var")
        echo "has the last buff"
    
    else
        echo "has no the last buff"
    endif
endfun

any idea how to get this working in lua? I tried wrapping the condition inside a pcall which had an effect like making it always truthy.

Community · Accepted Answer · 2023-01-29 10:43:40Z

13

You can use the global g: dictionary via vim.g to reference your variable:

if vim.g.my_var == nil then
    print("g:my_var does not exist")
else
    print("g:my_var was set to "..vim.g.my_var)
end

You can reference :h lua-vim-variables to see other global Vim dictionaries that are available as well!

edited Jan 29, 2023 at 10:43

CommunityBot

11 silver badge

answered Jan 12, 2021 at 7:07

andrewk

4413 silver badges6 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Gang Liang Over a year ago

This method is not correct: a global variable can take a value of false, then the checking condition is invalid.

andrewk Over a year ago

Updated the condition to be an explicit nil check.

DarkWiiPlayer · Accepted Answer · 2022-09-20 08:18:15Z

9

vim.api.nvim_eval("g:my_var") just evaluates a vimscript expression, so accessing a non-existent variable would error just like in vimscript. Have you tried vim.api.nvim_eval('exists("g:my_var")') instead?

Edit: Using vim.g as @andrewk suggested is probably the better solution as using the dedicated API is more elegant than evaluating strings of vim script.

edited Sep 20, 2022 at 8:18

answered Dec 21, 2020 at 5:44

DarkWiiPlayer

7,0843 gold badges26 silver badges43 bronze badges

1 Comment

Bmax Over a year ago

hi thanks, this worked, it returned 0 or 1 depending on the status, i can use that in the condition

Collectives™ on Stack Overflow

Vim global variable check throws error in lua (neovim plugin development)

2 Answers 2

2 Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related