Indicate presence of development flag file in library data

[per1234]

Describe the request

The Arduino Library Specification includes a flag file which indicates whether the library is under development by the user:

https://arduino.github.io/arduino-cli/dev/library-specification/#development-flag-file

In order to prevent confusion resulting from inadvertent edits to what are expected to be "known good" sketches documenting library usage. The Arduino IDE treats the example sketches of libraries as read-only by default. In this state, the IDE user can not save the example in place inside the library.

Some library developers prefer to use Arduino IDE for the development of the example sketches of their library. This will be best accomplished by editing the examples in place in the installed library. The read-only restriction would prevent that use case. For this reason, Arduino IDE 1.x lifts the read-only restriction when the library contains a development flag file (arduino/Arduino#2619).

Arduino CLI should indicate the presence of a development flag file in the library data it provides via the cc.arduino.cli.commands.v1.Library gRPC message and the lib list --format json command.

🙂 This information will allow addition of support for development of library examples and other applications for the flag file to Arduino IDE 2.x and other development tools in an efficient and best practices manner.

Describe the current behavior

The useful established feature that allows Arduino IDE 1.x to be used for development of library examples is not available in Arduino IDE 2.x.

Arduino CLI does not provide any information about the presence of the development flag file. Without this information, the only way to implement such a feature in Arduino IDE 2.x and other development tools based on Arduino CLI would be to add code to detect the file, which is not in keeping with the ideal division of tasks between the tools.

Arduino CLI version

b759820

Operating system

All

Operating system version

Any

Additional context

Companion request for Arduino IDE 2.x: arduino/arduino-ide#936

Issue checklist

• I searched for previous requests in the issue tracker
• I verified the feature was still missing when using the latest nightly build
• My request contains all necessary details