Skip to content

Arduino CLI build tool dependencies are undocumented #1558

Closed
@nbourre

Description

@nbourre

Describe the problem

After following the instructions to compile Arduino IDE under Windows, I stumbled on this error after running yarn.

arduino-ide-extension: <<< Checked out c8ff042.
arduino-ide-extension: >>> Building the CLI...
arduino-ide-extension: 'task' is not recognized as an internal or external command,
arduino-ide-extension: operable program or batch file.
arduino-ide-extension: error Command failed with exit code 1.
arduino-ide-extension: info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
arduino-ide-extension: error Command failed with exit code 1.
arduino-ide-extension: info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
lerna ERR! yarn run prepare exited 1 in 'arduino-ide-extension'
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.

I'm unable to compile this project, even though I installed all the dependencies that are specified in the Development Guide:

https://github.com/arduino/arduino-ide/blob/main/docs/development.md

To reproduce

Call yarn in the Arduino IDE source code folder.

Expected behavior

The Development Guide provides instructions for installing all dependencies.

Arduino IDE version

Arduino IDE source code

Operating system

Windows

Operating system version

10.0.22623.741

Additional context

The fault occurs only when the Arduino CLI dependency is pinned to a non-release ref. In this case, the following tools are required:

  • Task
  • Go
  • Posix shell

In addition to documenting this information, it would be helpful if the script that invokes task first checked if the executable was available in the system path (similar to the shell which builtin) and if not printed a helpful error message explaining that user must install the dependency.


Issue checklist

  • I searched for previous reports in the issue tracker
  • I verified the problem still occurs when using the latest nightly build
  • My report contains all necessary details

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions