lib list
and lib examples
use incorrect library name
#1577
Labels
conclusion: duplicate
Has already been submitted
topic: code
Related to content of the project itself
type: imperfection
Perceived defect in any part of project
Bug Report
The name of an Arduino library is defined by the
name
property of itslibrary.properties
metadata file.This is the sole unique identifier for the library, which is used in the
LIBRARY_NAME
argument of thearduino-cli lib
commands. However, two of the commands instead use the library's folder name for the library name instead of its real name.Current behavior
The following demonstration uses the "Arduino SigFox for MKRFox1200" library, the name of which is defined here:
https://github.com/arduino-libraries/SigFox/blob/1.0.4/library.properties#L1
This library was selected because the spaces in the name cause the "normalized" Library Manager installation folder name (
Arduino_SigFox_for_MKRFox1200
) to be different from the library name.Notice that in all cases except
lib list
andlib examples
, the library name is "Arduino SigFox for MKRFox1200", while that correct name is not recognized when used in the library name argument of the final two commands.Expected behavior
Libraries are always referred to by the correct name, consistently from one command to another.
Environment
Additional context
There is one case where the library folder name determines the library name: the "1.0 format" or "legacy" libraries that do not have a
library.properties
metadata file:https://arduino.github.io/arduino-cli/dev/library-specification/#old-library-format-pre-15
The name field value is sometimes referred to as the "real name" or "fancy name".
The text was updated successfully, but these errors were encountered: