Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Give "not-ino" dummy file a more explanatory name #111

Open
per1234 opened this issue Jun 12, 2022 · 1 comment
Open

Give "not-ino" dummy file a more explanatory name #111

per1234 opened this issue Jun 12, 2022 · 1 comment
Assignees
Labels
topic: code Related to content of the project itself type: enhancement Proposed improvement

Comments

@per1234
Copy link
Contributor

per1234 commented Jun 12, 2022

Describe the current behavior

The "Problems" view lists problems from files outside the sketch under a dummy file named "not-ino".

https://github.com/arduino/arduino-language-server/blob/0.5.0-rc6/sourcemapper/ino.go#L31

I think this could be confusing to the users, especially since the problems themselves tend to be quite mysterious. I'm wondering if the location of these problems could be made more clear by using another name.

To reproduce

  1. Select Tools > Board > Arduino SAMD Boards (32-bits ARM Cortex-M0+) > Arduino MKRZERO from the Arduino IDE menus.
  2. Open the command palette (Ctrl+Shift+P).
  3. Select "Toggle Problems View"

Note that there is a "not-ino" file that contains some cryptic problems:

image.png

Describe the request

Consider other names to use in place of "not-ino". I don't know whether there is some convention for this sort of thing in language servers.

Possibilities:

  • non-sketch
  • external

Desktop

  • OS: Windows 10
  • IDE Version: 2.0.0-rc1-snapshot.767b09d
    Date: 2021-12-07T16:40:38.636Z
    CLI Version: 0.20.1 [abb21449]
  • Arduino Language Server version: 0.5.0-rc6

Additional context

Part of what made this confusing to me is that "ino" is the file extension for Arduino Programming Language files, but Arduino sketches can contain files of other programming languages that have other file extensions (.h, .cpp, .c, .S). So when I see "non-ino", it sounds like it means files with an extension other than .ino.

@per1234 per1234 added topic: code Related to content of the project itself type: enhancement Proposed improvement labels Jun 12, 2022
@per1234
Copy link
Contributor Author

per1234 commented Jun 12, 2022

The exact contents of the "Problems" view produced by the instructions above have changed since the time I wrote the issue (likely as a result of #92), but the instructions do still demonstrate the "non-ino" issue reported here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: code Related to content of the project itself type: enhancement Proposed improvement
Projects
None yet
Development

No branches or pull requests

2 participants