Skip to content

GitLab

A
arduino-cli
Switch branch/tag
  1. 27 Feb, 2023 2 commits
  3. 22 Feb, 2023 2 commits
  5. 21 Feb, 2023 1 commit
    • per1234's avatar
      [skip changelog] Remove comment that breaks gRPC documentation structure (#2080) · c73f7355
      per1234 authored 
      The "gPRC Reference" section of the documentation website is automatically generated from the code and comments in the
project's Protocol Buffers files. The documentation is automatically structured according to the structure of the
Protocol Buffers code using heading levels, and the documentation website uses these heading levels to generate a table
of contents to allow easy navigation of the documentation and an overview of its structure.

The generation happens in two steps:

Protocol Buffers -> Markdown -> HTML

A comment in a Protocol Buffers file included a decorative underline formed from a series of `-` characters. This
happens to be markup for an H2 heading in the Markup language. This caused an inadvertent creation of an inappropriate
heading named "BOOTSTRAP COMMANDS", which resulted in the documentation having the following incorrect structure:

- Protocol Documentation
  - [...]
  - cc/arduino/cli/commands/v1/board.proto
    - [...]
  - cc/arduino/cli/commands/v1/commands.proto
    - [...]
    - ArduinoCoreService
  - BOOTSTRAP COMMANDS
    - <List of cc.arduino.cli.commands.v1.ArduinoCoreService methods>
  - cc/arduino/cli/commands/v1/common.proto
    - [...]
  - [...]

Instead of the correct structure:

- Protocol Documentation
  - [...]
  - cc/arduino/cli/commands/v1/board.proto
    - [...]
  - cc/arduino/cli/commands/v1/commands.proto
    - [...]
    - ArduinoCoreService
      - <List of cc.arduino.cli.commands.v1.ArduinoCoreService methods>
  - cc/arduino/cli/commands/v1/common.proto
    - [...]
  - [...]

This could be corrected by removing only the pointless decorative comment, leaving the "BOOTSTRAP COMMANDS" comment, but
I don't see any value in that comment and it introduced unpleasant caps lock prose content into the documentation so I
removed it as well.
      c73f7355
  7. 20 Feb, 2023 3 commits
  9. 17 Feb, 2023 2 commits
  11. 13 Feb, 2023 2 commits
  13. 09 Feb, 2023 1 commit
  15. 08 Feb, 2023 2 commits
  17. 07 Feb, 2023 1 commit
  19. 06 Feb, 2023 1 commit
  21. 02 Feb, 2023 1 commit
  23. 01 Feb, 2023 2 commits
  25. 31 Jan, 2023 2 commits
  27. 30 Jan, 2023 2 commits
  29. 27 Jan, 2023 1 commit
    • Cristian Maglie's avatar
      [skip-changelog] refactoring: Fixing legacy pathnames (#2038) · 58c6bc3c
      Cristian Maglie authored 
      * Removed builderCtx.BuildCachePath

Because it creates a lot of confusion

* Removed useless assignment

* Do not store sketch build-path but generate it on demand

* Removed redundant SketchLocation field and related subroutines

* Replaced deprecated calls (from go linter)
      58c6bc3c
  31. 24 Jan, 2023 2 commits
  33. 19 Jan, 2023 2 commits
  35. 17 Jan, 2023 2 commits
  37. 16 Jan, 2023 1 commit
    • Cristian Maglie's avatar
      [breaking] Fixed a lot of `--format json` and, in general, how Arduino CLI... · b3e8f8a4
      Cristian Maglie authored 
      [breaking] Fixed a lot of `--format json` and, in general, how Arduino CLI output is handled (#2003)

* Added source code static-check to enforce `--format` output.

The first test run gives:

=== RUN   TestNoDirectOutputToStdOut
burnbootloader/burnbootloader.go:85:5: object `os.Stdout` should not be used in this package (use `feedback.*` instead)
burnbootloader/burnbootloader.go:85:16: object `os.Stderr` should not be used in this package (use `feedback.*` instead)
compile/compile.go:235:84: object `os.Stdout` should not be used in this package (use `feedback.*` instead)
compile/compile.go:235:95: object `os.Stderr` should not be used in this package (use `feedback.*` instead)
compile/compile.go:274:72: object `os.Stdout` should not be used in this package (use `feedback.*` instead)
compile/compile.go:274:83: object `os.Stderr` should not be used in this package (use `feedback.*` instead)
compile/compile.go:296:4: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
compile/compile.go:297:4: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
compile/compile.go:298:4: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
compile/compile.go:305:3: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
compile/compile.go:306:3: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
compile/compile.go:307:3: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
compile/compile.go:308:3: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
compile/compile.go:309:3: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
compile/compile.go:311:3: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
compile/compile.go:313:4: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
compile/compile.go:319:4: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
compile/compile.go:321:5: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
compile/compile.go:325:4: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
compile/compile.go:326:4: function `fmt.Print` should not be used in this package (use `feedback.*` instead)
completion/completion.go:58:34: object `os.Stdout` should not be used in this package (use `feedback.*` instead)
completion/completion.go:61:38: object `os.Stdout` should not be used in this package (use `feedback.*` instead)
completion/completion.go:63:32: object `os.Stdout` should not be used in this package (use `feedback.*` instead)
completion/completion.go:66:32: object `os.Stdout` should not be used in this package (use `feedback.*` instead)
completion/completion.go:68:38: object `os.Stdout` should not be used in this package (use `feedback.*` instead)
daemon/interceptors.go:29:19: object `os.Stdout` should not be used in this package (use `feedback.*` instead)
debug/debug.go:106:82: object `os.Stdout` should not be used in this package (use `feedback.*` instead)
monitor/term.go:38:9: object `os.Stdout` should not be used in this package (use `feedback.*` instead)
output/rpc_progress.go:115:4: function `fmt.Print` should not be used in this package (use `feedback.*` instead)
output/rpc_progress.go:117:5: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
output/rpc_progress.go:119:5: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
upload/upload.go:163:5: object `os.Stdout` should not be used in this package (use `feedback.*` instead)
upload/upload.go:163:16: object `os.Stderr` should not be used in this package (use `feedback.*` instead)
cli.go:215:4: function `fmt.Println` should not be used in this package (use `feedback.*` instead)
--- FAIL: TestNoDirectOutputToStdOut (0.01s)
FAIL
exit status 1
FAIL	github.com/arduino/arduino-cli/cli	0.019s

* Slightly improved naming/docs of OutputFormat enumeration

Also changed a condition in a more meaningful way.

* Removed `feedback.Feedback` since only the global instance is used

We may think of bringing it back again in the future if the global
instance will be removed in a major refactoring of the CLI.

* Moved `cli/output` package into `cli/feedback`

This is the better place where it belongs, and slighlty simplifies the
golang API.

* Print progress bar and task progess only on interactive terminals

* Use feedback functions to output task progress

* User-input functions are now moved into `feedback` package

* Fix user-input function

- Final "\n" is automatically printed when entering non-passwords (no
  need to do a Println()
- The final "\n" is included in the result of ReadBytes() so it will be
  removed.

* Added cmd to test feedback functions

* Better error message

* Removed unprotected print

* Removed useless response from Upload and UploadWithProgrammer

* VersionInfo now implements feedback.Result interface

* Added `feedback` support for direct streaming

When the Text format is selected the output is sent straigh to the
output stream, otherwise it is buffered and returned as a
`feedback.Result` to be used at the end of the job.

* Replace direct use of os.Stdout/Stderr in Upload command

* Implemented feedback.Fatal and FatalError

These functions outputs the error (also in machine-encoded if user
choose to do so) and at the same time exits with os.Exit().

This API is much more readable and provides a better meaning to the CLI
commands implementation.

* Added output buffers in error messages (if used)

* Removed direct access to stdio streams in monitor command

* Removed direct access to stdio streams in debug command

* Removed direct access to stdio streams in daemon command

* Removed direct access to stdio streams in burn-bootlodaer command

* Removed direct access to stdio streams in compile command

* Removed direct access to stdio streams in completion command

* compile: print platforms stats only if present

* Removed direct access to stdio streams in --dump-profile command

* Added feedback functions to report warnings

* Moved `errorcodes` into `feedback`

* Remove direct os.Stdin access from daemon command

* Removed redundant `cli/globals` package

This will help later to make the whole `cli` package internal.

* Made `cli` package internal

* updated docs

* Removed redundant logic in getter for stdio streams
Co-authored-by: default avatarper1234 <accounts@perglass.com>

* Internationalize more strings
Co-authored-by: default avatarper1234 <accounts@perglass.com>

* Spellcheck internal/cli/feedback/stdio.go
Co-authored-by: default avatarper1234 <accounts@perglass.com>

* Spellcheck internal/cli/feedback/feedback_cmd.go
Co-authored-by: default avatarper1234 <accounts@perglass.com>

* feedback: remove stray '\r' on Windows on interactive input

* Ban use of os.Exit from cli package

* Removed unused parameter in compile.Compile

* Non-interactive stream are always buffered

* Use direct streams where appropiate

* Compile outputs profile dump as part of the result

* Report saved warnings also when erroring out

* Print compile error and suggestions as part of the result

* Add trailing newline only if compiler has produced output

* FatalResult now outputs the error on stderr
Co-authored-by: default avatarper1234 <accounts@perglass.com>
      b3e8f8a4
  39. 12 Jan, 2023 2 commits
  41. 10 Jan, 2023 1 commit
    • Giuliano Panzironi's avatar
      Store all temporary files under a single folder (#2031) · 34762a6d
      Giuliano Panzironi authored 
      Fix #2028

Any temporary file will be persisted in a new dedicated folder named as "arduino" located in the OS-specific temporary directory, e.g.:
/tmp/
├── arduino
│   ├── arduino-core-cache
│   │   └── core_arduino_avr_uno_640aa5b4d646262327bbea65c3462b39.a
│   └── arduino-sketch-89E1544CF5F196B29E530BA6940B661F
│       ├── 06.ino.elf
│       ├── 06.ino.with_bootloader.bin
│       ├── build.options.json
│       ├── compile_commands.json
│       ├── core
│       │   ├── abi.cpp.d
[...]

This change is meant to make easier maintenance operations for both end-users and operating-systems.
Signed-off-by: default avatargiuliano <panzironi.giuliano@gmail.com>
      34762a6d
  43. 05 Jan, 2023 1 commit
  45. 04 Jan, 2023 1 commit
  47. 03 Jan, 2023 2 commits
  49. 21 Dec, 2022 1 commit