Skip to content
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

feat(arduino-cli): add completion spec #2231

Merged
merged 6 commits into from
Jan 19, 2024
Merged

feat(arduino-cli): add completion spec #2231

merged 6 commits into from
Jan 19, 2024

Conversation

lukejans
Copy link
Contributor

arduino-cli completion spec

  • arduino-cli documentation used for spec: link

Screenshot 2024-01-12 at 6 20 18 PM

@withfig-bot
Copy link
Collaborator

withfig-bot commented Jan 12, 2024

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@lukejans
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

@withfig-bot
Copy link
Collaborator

Overview

src/arduino-cli.ts:

Info:

@withfig-bot
Copy link
Collaborator

Hello @lukejans,
thank you very much for creating a Pull Request!
Here is a small checklist to get this PR merged as quickly as possible:

  • Do all subcommands / options which take arguments include the args property (args: {})?
  • Are all options modular? E.g. -a -u -x instead of -aux
  • Have all other checks passed?

Please add a 👍 as a reaction to this comment to show that you read this.

withfig-bot added a commit that referenced this pull request Jan 12, 2024
@mschrage
Copy link
Member

Hi @lukejans! Love this contribution, thanks for submitting - can you remove the yarn.lock file from this PR, so we can get this merged in?

src/arduino-cli.ts Outdated Show resolved Hide resolved
Copy link
Member

@grant0417 grant0417 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Spec looks good, one change I would suggest before merge is to remove all the example in description where it is the full CLI command. Left some comments as examples.

src/arduino-cli.ts Outdated Show resolved Hide resolved
src/arduino-cli.ts Outdated Show resolved Hide resolved
src/arduino-cli.ts Outdated Show resolved Hide resolved
src/arduino-cli.ts Show resolved Hide resolved
src/arduino-cli.ts Show resolved Hide resolved
src/arduino-cli.ts Outdated Show resolved Hide resolved
@lukejans lukejans requested a review from grant0417 January 19, 2024 20:32
Copy link
Member

@grant0417 grant0417 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@grant0417 grant0417 merged commit edf5db1 into withfig:master Jan 19, 2024
5 checks passed
@withfig withfig locked and limited conversation to collaborators Jan 19, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants