nRF Connect for VS Code messes up environment variables

[JonasJ]

Hi,

I have an environment variable with newlines and that is messed up by the VS Code extension. It seems that the extension tries to parse and rewrite the whole environment for some unknown reason. I have the following variables defined among others.

BASH_FUNC_ml%%=() { module ml "$@"
}
BASH_FUNC_which%%=() { ( alias;
 eval ${which_declare} ) | /usr/bin/which --tty-only --read-alias --read-functions --show-tilde --show-dot $@
}

When I build inside VS Code i get the following in the terminal.

[301/301] Generating zephyr/merged.hex
/bin/sh: ml: line 1: syntax error: unexpected end of file
/bin/sh: error importing function definition for `ml'
/bin/sh: which: line 1: syntax error: unexpected end of file
/bin/sh: error importing function definition for `which'

nRF Connect SDK extension for VS Code, v2022.7.242.

Why does the extension rewrite my environment in the first place?

Sigurd Hellesvik Thanks for reminding me to post this issue here.

[Håkon Alseth]

Hi,

 

Could you elaborate a bit on where these env vars are located and how you're opening vscode?

If you open vscode from the terminal where you have everything setup, it should also inherit your whole environment. Could you try this? ie. run this from terminal: code /path/to/ncs

 

Kind regards,

Håkon

[JonasJ]

Hi,

VS Code correctly inherits the environment variables, no issue there. If you try to build a project using nRF Connect SDK Extension I get the errors in my post.

I assume this is because the nRF extension for VS Code reads the existing env variables but can't handle those that have newline (\n) in them and thus creates a broken env when launching the terminal to run west build.

Thanks.

[Håkon Alseth]

Hi,

 

I am trying to recreate this on my end, but I'll need some added info about your setup to be able to do this.

Which distro are you using?

Can you elaborate on how and where you place this particular env variable?

Does this issue occur when compiling any example, or is it a specific one?

 

Kind regards,

Håkon

[JonasJ]

Hi,

You can test this you self by sourcing the following file in a shell and launch vscode after that. You should see an error similar to my report.

foo_bar() {
    echo "This is a function in bash"
}

export -f foo_bar

I'm running Fedora 36 and it doesn't matter which project I build.

[Håkon Alseth]

Hi,

 

Yes, I can confirm that there can be issues with local environment on different linux distro's, as we mainly target ubuntu.

I have made the nrf VScode team aware of your issue, and it will be evaluated for future improvements.

 

As a workaround, can you try to check for $NRF_CONNECT_VSCODE to work around this issue?

More details can be found here in our documentation: https://nrfconnect.github.io/vscode-nrf-connect/connect/west.html#controlling-the-west-environment

 

Kind regards,

Håkon