Allow to close files in certain folders

[msujew]

Motivation

Closes #866
Closes #831

Change description

When adding a widget to the tracker we first try to see whether it is contained in one of our ignoreFolders (.vscode, .theia and src so far). If it is, we allow it to stay closable.

Reviewer checklist

• PR addresses a single concern.
• The PR has no duplicates (please search among the Pull Requests before creating one)
• PR title and description are properly filled.
• Docs have been added / updated (for bug fixes / features)

[AlbyIanna]

Works for me! Thanks! 🐸

[per1234]

As I see additional folders added selectively to the exclusion, it occurs to me it may be better to go at this from the other direction: by simply making the root of the sketch folder the "non-closable" area, with any files from subfolders always being closable.

That will provide symmetry with the sketch files that are opened by default and avoid the poor user experience of being able to open an additional file via the Sketchbook view (when "☐ Show files inside Sketches" is enabled), but then not being allowed to close it again.

For example, the Arduino Sketch Specification provides a data subfolder "to add additional files to the sketch, which will not be compiled". Since these will not be part of the sketch program by definition, there is no reason we should force the user to keep the tab open.

[AlbyIanna]

@per1234 that makes sense. @msujew do you think you can tackle this as Per suggested?

[msujew]

@per1234 Thanks for the input, I've updated the code to only prevent file from closing which are direct children of the sketch directory. As far as I could see in the sketch spec this seems to be the intended behavior. Or does it only apply to *.ino files?

[per1234]

I've updated the code to only prevent file from closing which are direct children of the sketch directory.

Very nice. Thanks!

As far as I could see in the sketch spec this seems to be the intended behavior. Or does it only apply to *.ino files?

The established behavior from Arduino IDE 1.x is that all the sketch code files from the root of the sketch folder are opened when you load the sketch and are not closable. That is done according to the following file extensions:

• .ino
• .pde
• .cpp
• .c
• .h
• .hh
• .hpp
• .S

The most important is the .ino files. The reason is that the Arduino build system has the somewhat non-obvious behavior of concatenating all the .ino files of the sketch together in a specific order before compiling. This allows the sketch developer to split larger programs up into manageable parts without having to dive into the confusing subject of translation units.

By loading all the .ino files when opening a sketch and avoiding their closure, the IDE communicates to the user intuitively that all the files are being compiled and also which order they will be concatenated in.

Since they are more likely to be used by advanced users, it probably isn't so essential to avoid the closure of the code files with other extensions, but they do all become part of the sketch program so I think it is reasonable. The src subfolder offers the sketch developer a solution if there are sketch files that don't need to be prominently visible to the user (e.g., the hundreds of files of the Marlin 3D printer firmware sketch).

When it comes to the non-code "additional" file extensions (.adoc, .json, .md) we are in uncharted territory because it has never before been possible to open these file types in the Arduino IDE. It would probably be worth considering whether these should be made closable, but that is not in scope for this PR.

[kittaakos]

Follow up: #977