Support for custom libraries when using sketch.yaml

[dmohns]

Describe the request

In a project I am currently using different "kind" of libraries.

1. Versioned libraries available in via Arduino Library Manager
2. Non-versioned libraries available via their source code on Github
3. Non-versioned libraries available via their source code in local subfolder folder of my project (zipped or raw)

To ease collaboration on the project I would like to use a Project Sketch File and provide a set of dependencies that are confirmed working.

Unfortunately, the Project Sketch File only seem to support 1. (versioned libraries available in Arduino Library Manager). Scope of this request is to add functionality to supply Github and local folder libraries to the libraries: attribute on sketch.yaml (in some fashion).

Describe the current behavior

Currently, I have been able to compile my project using

arduino-cli compile --fqbn "<FQBN>" --libraries=Library/

However, if I tried to use --profile and --libraries the compile command fails

You cannot use the --libraries flag while compiling with a profile.

Arduino CLI version

arduino-cli Version: nightly-20230329 Commit: b69ed33 Date: 2023-03-29T01:34:59Z

Operating system

macOS

Operating system version

12.6.3

Additional context

Additional requests

• Support for custom libraries when using sketch.yaml #2133 (comment)
• Support for custom libraries when using sketch.yaml #2133 (comment)
• Support for custom libraries when using sketch.yaml #2133 (comment)
• Detect libraries in Sketch Folder #2763
• https://arduino.stackexchange.com/questions/17802/is-it-possible-to-package-a-sketch-with-dependent-libraries-for-cross-platform-c
• https://forum.arduino.cc/t/local-libraries/1259854/20

Related

• arduino-cli should provide "environments" #108
• https://stackoverflow.com/questions/4705790/keeping-all-libraries-in-the-arduino-sketch-directory

Issue checklist

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

[dmohns]

Yeah, just to clarify, this issue is about making sketch.yaml spec more flexible to support libraries from other sources than Arduino Library Manager.

One way that is backwards compatible would be

profiles:
  <PROFILE_NAME>:
    ....
    libraries:
      - <LIB_NAME> (<LIB_VERSION>)

to allow <LIB_VERSION> to be <LIB_VERSION_OR_URL> and take the form of VCS and local urls, for example

profiles:
  my_profile:
    ....
    libraries:
      - ArduinoIoTCloud (1.0.2)
      - HelloWorld (https://github.com/username/HelloWorld.git#v2.13)
      - HelloWorld2 (file://./libraries/HelloWorld2.zip)

Note: Above is just an example. There are other ways to implements this as well, like changing the schema of libraries to be a list of dicts rather list of strings. This would be more powerful and flexible but not be backwards compatible.