Skip to content

Remove support for --format yaml #2585

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
3 tasks done
cmaglie opened this issue Apr 29, 2024 · 2 comments · Fixed by #2587
Closed
3 tasks done

Remove support for --format yaml #2585

cmaglie opened this issue Apr 29, 2024 · 2 comments · Fixed by #2587
Assignees
Labels
conclusion: resolved Issue was resolved topic: CLI Related to the command line interface type: enhancement Proposed improvement

Comments

@cmaglie
Copy link
Member

cmaglie commented Apr 29, 2024

Describe the request

Remove support for output format yaml in the --format flag.

Rationale:

  • Support for YAML is not implemented in all commands, particularly commands with streaming output, or is poorly maintained/tested compared to the JSON output.
  • it complicates the code without any worthwhile benefit (especially outputting YAML requires specific struct-tagging or special libraries like sigs.k8s.io/yaml)

Describe the current behavior

N/A

Arduino CLI version

nightly

Operating system

N/A

Operating system version

N/A

Additional context

The original PR that introduced the feature is this one: #1600 but it seems that the requested feature was for another project using the feedback package as a library. This is no longer possible with the latest version of the Arduino CLI.

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
@cmaglie cmaglie added type: enhancement Proposed improvement topic: CLI Related to the command line interface labels Apr 29, 2024
@Xayton Xayton added this to the Arduino CLI v1.0.0 milestone Apr 30, 2024
@aliphys
Copy link

aliphys commented Apr 30, 2024

.yml files can be included alongside the sketch, which will act as sketch build profiles. This stores the platform and library versions in use, as described in https://arduino.github.io/arduino-cli/0.36/sketch-project-file/

  • Will this proposal deprecate the use of .yml files in this way? See this PR for example implementation involving the Arduino_UnifiedStorage library
  • If yes, then is there an alternative/recommended route to defining the sketch project file without .yml? Maybe with json instead?

Thanks!

@cmaglie
Copy link
Member Author

cmaglie commented Apr 30, 2024

Will this proposal deprecate the use of .yml files in this way?

No, sketch project files sketch.yml or configuration file arduino-cli.yaml will continue to work as always. This change request is relative ONLY to the --format yaml flag.

@per1234 per1234 added the conclusion: resolved Issue was resolved label May 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
conclusion: resolved Issue was resolved topic: CLI Related to the command line interface type: enhancement Proposed improvement
Projects
None yet
4 participants