Support custom libraries with portable version of Arduino

[raomin]

When running with a portable version of Adruino IDE, the custom libraries are put in:
--> arduino-1.8.10\portable\sketchbook\libraries
(and not in Documents\Arduino\libraries).

This PR replaces the hard coded ref to Documents\Arduino\libraries with a ref to _settings.sketchbookPath that works with the portable version and the installed one.

[hellyzh]

Please check to configure VS Code with Arduino settings for "arduino.path" as below, then the sample will get the correct custom Arduino libraries path. And the hard code one is default folder of downloaded libraries as well as the portable Arduino.
In Visual Studio Code, click File > Preferences > Settings, then click the Open Settings (JSON) icon in the upper-right corner of the Settings page.
"arduino.path": "C:\\Program Files (x86)\\Arduino"

[raomin]

Thanks for your feedback @hellyzh .

Maybe I didn't explain clearly, the problem is when you are using a portable version of Arduino IDE (regardless whether you use a portable version of VScode or not).

The purpose of installing Arduino as portable is to place it elsewhere than "C:\Program Files (x86)\Arduino" ; usually in user writable folder, eg C;\users\johndoe\arduino-1.8.10
In this setup, the sketchbook folder is C;\users\johndoe\arduino-1.8.10\sketchbook and the downloaded libs are in C;\users\johndoe\arduino-1.8.10\sketchbook\libraries
Yet the vscode-arduino plugin adds the standard "c:\user\johndoe\documents\arduino\libraries" which does not exists in this case.

More generally, if you move the sketchbook from the user Documents folder, the custom libraries folder is not included...

This patch points it to {arduino.sketchbook}\libraries which is always where Arduino would put it.

[raomin]

Please @dooriya , can you consider this PR?
I have students with portable version of Arduino and they cannot get their examples working because the custom libraries are not included. As they are beginners it's really not helpful for them.
TIA.

[hellyzh]

@raomin, the custom package tools location code should be updated to the same. Could you please also include the change in your PR?

[raomin]

Hi @hellyzh, I do not know what custom package tools location is.
I never encountered such folder or libraries Documents\Arduino\hardware\tools (and google neither), so I don't know what it refers to nor what it should point to in a generic approach.

Custom board libraries are already correctly handled per selected board here.

So I beleive the line could be removed. But, if you wish, I could replace
includePath.push(path.join(os.homedir(), "Documents", "Arduino", "hardware", "tools", "**"));
by this
includePath.push(path.join(this._settings.sketchbookPath, "hardware", "tools", "**"));

[hellyzh]

I suggest to keep it which will not break any other usage. So please do the replace as you mentioned.

[raomin]

Done! PR updated.

[raomin]

Hi!
Is there still something blocking this PR?
@dooriya ?

[dooriya]

Hi!
Is there still something blocking this PR?
@dooriya ?

The change looks good to me, approved :)
Sorry for the belated response.

[elektronikworkshop]

BTW: All this path fiddling will become obsolete anyways with the automagical c_cpp_properties.json configuration I'm currently working on. I have it working here and It's reaching beta for OSX and Linux in the next few days. Windows support will follow.

Progress can be followed here: #438 and especially here.

Regards
EW