Skip to content

Add support for json, adoc and md sketch files extensions #1235

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

Merged
merged 1 commit into from
Mar 25, 2021

Conversation

silvanocerza
Copy link
Contributor

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests
    before creating one)
  • The PR follows
    our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • UPGRADING.md has been updated with a migration guide (for breaking changes)
  • What kind of change does this PR introduce?

Enhances gRPC interface.

  • What is the current behavior?

LoadSketch gRPC interface function doesn't return Sketch files in the root folder that have .json, .adoc or .md extension.

  • What is the new behavior?

LoadSketch gRPC interface function now returns Sketch files in the root folder that have .json, .adoc or .md extension.
This only affects the gRPC interface.

Nope.

  • Other information:

None.


See how to contribute

@silvanocerza silvanocerza merged commit ac39429 into master Mar 25, 2021
@silvanocerza silvanocerza deleted the scerza/new-sketch-extensions branch March 25, 2021 13:55
@matthijskooijman
Copy link
Collaborator

The description for this PR says:

LoadSketch gRPC interface function now returns Sketch files in the root folder that have .json, .adoc or .md extension.

However, AFAICS this also returns such files in subdirectories. Is this intentional?

Also, what is the intended usecase here? To allow the user to edit/view adoc or md files when editing/viewing a sketch? How about json files? Is this intended for json data files in the sketch? Or for sketch.json? If the latter, should that maybe just that file be included and not all .json files (asking in relation to #1201, about breakage when a compilation_commands.json is present)?

This only affects the gRPC interface.

Is this really true? AFAICS it also causes these files to be copied into the build directory (or maybe that's a side effect of #1353?), which could influence the build, and can certainly influence performance.

@per1234
Copy link
Contributor

per1234 commented Sep 8, 2021

Or for sketch.json?

It is handy for the debug_custom.json file used to add support to the Arduino IDE 2.x debugger for non-CMSIS DAP compliant debuggers. The file must be added to the sketch.

@rsora rsora added the topic: gRPC Related to the gRPC interface label Sep 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: gRPC Related to the gRPC interface type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants