GitLab

The introductory sentence of the documentation homepage is the first thing the user may see when discovering Arduino
CLI. For this reason, it's important for it to quickly and clearly convey what Arduino CLI is. Toward that goal, the
following changes are made:

- Use more understandable terms
- Rearrange features list in the order of typical usage (install dependencies, compile, upload)

The previous mention of spaces as one of the characters allowed in library and sketch folder names was a copy/paste
error originating in the allowed characters in library.properties `name` properties. This specific part of the `name`
property specification doesn't apply to folder names. The reason it is allowed in the `name` property is because that
value is "sanitized" before being used by Library Manager for the library installation folder name by replacing all
spaces with underscores.

When a boards platform uses an outdated `recipe.ar.pattern`, Arduino CLI displays a helpful message:

Unable to cache built core, please tell foo:bar@1.2.3 maintainers to follow http://goo.gl/QdCUjo

That short link points to the old Arduino Platform Specification page in the arduino/Arduino repository's wiki. The
platform specification has since been moved to the arduino/arduino-cli repository.

Even though the old page provides a
link to the new location, this message uses an anchor to direct the developer to the relevant section of the
specification. When they follow the link from the old page, they will simply end up at the top of the specification and
may have a hard time finding the information that tells them how to fix the platform. Updating the link restores the
intended behavior.

When the compiled size of a sketch exceeds the available flash or RAM on the board, the error message includes a link to
a troubleshooting guide:

Sketch uses 16110 bytes (112%) of program storage space. Maximum is 14336 bytes.
Global variables use 685 bytes (66%) of dynamic memory, leaving 339 bytes for local variables. Maximum is 1024 bytes.
Sketch too big; see http://www.arduino.cc/en/Guide/Troubleshooting#size for tips on reducing it.

http://www.arduino.cc/en/Guide/Troubleshooting was recently replaced with the Arduino Help Center. Even though that URL
redirects to the Help Center, it only goes to the home page, leaving the user to hunt for the relevant article.

* Change lib search command to use fuzzy search

* Change core search command to use fuzzy search

* Avoid splitting search arguments when doing fuzzy search

* Check ranking when running fuzzy search

* Some other enhancements to fuzzy search

* Fix duplicated results in lib search command

* Make archive validation error messages friendlier

* change behaviour a little + fix tests

* librariesindex: Fix nil pointer. Refs #1176

Let the library index return the latest known version,
if a library without a version is found.
Signed-off-by: Ruben Jenster <r.jenster@drachenfels.de>

* Remove logging statement from FindLibraryUpdate.
Signed-off-by: Ruben Jenster <r.jenster@drachenfels.de>

* Add a small comment to the lib.Version nil check.
Signed-off-by: Ruben Jenster <r.jenster@drachenfels.de>

* Fix some commands failing when an installed library has invalid version

* [skip changelog] Add integration tests
Co-authored-by: Ruben Jenster <r.jenster@drachenfels.de>

* Added flag to disable check for sketch foldername

This is required to keep backward compatibility for arduino-builder that
doesn't enforce this check.

* Added missing source doc

* Changed module sketch_test -> sketch

* Fixed test

* Return the detected sketch as part of the error

Setting that flags return all installed and installable platforms,
including installed manually by the user in their Sketchbook hardware
folder.

* Do not try to export binaries if --only-compilation-database is set

otherwise an empty "build/fqbn/..." folder is created if "always-export-binaries"
option is set via config file.

* slightly simplify function call

* [skip changelog] Add integration test
Co-authored-by: Silvano Cerza <silvanocerza@gmail.com>

* [skip changelog] Fix platform loading legacy tests

* [skip changelog] Moved local.txt files used for testing

* Fix loading of sketches with folder and main file mismatched casing

* [skip changelog] Fix legacy tests

* Fix gRPC interface function to merge configs

This fix adds the possibility to set empty values with the Merge gRPC
function, previously they would have been ignored.

Because of this change I had also to modify the GetValue() function
since it would first check if the value was set using the
Viper.InConfig() function that wouldn't check for values set with
Viper.Set().

* [skip changelog] Add clearer example to client_example

* [skip changelog] Simplified some code and enhance a test

The current release process uses git to get the tag at the current
commit. It might happen that are are multiple tags when calling that
command, in cases the rc and the final release are done on the same
commit, that would make the build process to fail.

This fixes that issue by taking only one tag.

* Compile command now works with sketches containing .pde files

* Upload command now works with sketches and builds from .pde files

* Archive command now works with sketches containing .pde files

* [skip changelog] Add test to verify debug command works with pde sketches

* Fix lib examples not showing sketches with .pde files

* [skip changelog] Remove duplicated code and enhance tests

* Always report buildpath (even in case of build failed)

* Always write a correct compilation database

Even if the Contents field is empty.

* Skip dependency detection if library is fully precompiled

Precompiled bits of a library should not depend on any link time dependency (we cannot assure ABI stability).
Fixes https://github.com/arduino/ArduinoCore-mbed/issues/119

* Add output when skipping deps detection for precompiled libs
Co-authored-by: Silvano Cerza <silvanocerza@gmail.com>

* [skip changelog] Ditch goreleaser in favor of a new release process

* [skip changelog] Fix version output test

* [skip changelog] Fix some workflows issues

* [skip changelog] Fix panic when running integration tests

* [skip changelog] Remove extra chars from package name prefix

* Fix lib list --all not returning library includes in json output

* [skip changelog] Enhance integration test

* Add gRPC interface function to write settings to file

* Add example of gRPC config write

Previously installing from a zip file would extract the content directly
into the user library folder, this could have caused problem if the zip
file wasn't structured correctly.

To handle this we now extract to a temp directory to verify that the zip
is structured correctly and to infer the name of the library being
installed. If everything is fine we then copy it over to the user
library folder to finalize the installation.

Installing from a git repository has been enhanced too, after
cloning the repository to the user library folder we delete the .git
folder to make it a plain folder. Cloning should be faster too since we
now clone using depth of one commit to avoid downloading useless files.

Both when installing from a zip file or from a git repository we delete
the installed library folder if one with the same name is already
installed.

* Fix lib install with git url

* Better git url handling

* Precompiled libraries: only select a folder if it contains files

* Restore precompiled tests

* slightly refactored directoryContainsFile function

* [skip changelog] Fix compile tests

* [skip changelog] Fix compile test
Co-authored-by: Cristian Maglie <c.maglie@arduino.cc>
Co-authored-by: Silvano Cerza <silvanocerza@gmail.com>

Previously overwriting a file will not truncate it, so if the download
size was less than the file size already on disk then the resulting file
will end up with a "corrupted" piece at the end.

* Don't archive preexisting archives if commandline is too long

Fixes https://github.com/arduino-libraries/ArduinoIoTCloud/runs/1693000682?check_suite_focus=true#step:7:277
Should revert https://github.com/arduino-libraries/ArduinoIoTCloud/pull/222

* Added test
Co-authored-by: Cristian Maglie <c.maglie@arduino.cc>