feat(completion-hint): Add a hint prompting the user to add completion to the shell - #201
feat(completion-hint): Add a hint prompting the user to add completion to the shell#201mohammed-io wants to merge 10 commits into
Conversation
|
@codex review |
🦋 Changeset detectedLatest commit: b8275b3 The changes in this PR will be included in the next version bump. This PR includes changesets to release 6 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 0d603c704c
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| // yargs doesn't support fish shell completions yet until next release. | ||
| // Once https://github.com/yargs/yargs/pull/2569 is merged, remove this check. | ||
| if (shell?.includes("fish")) return; |
There was a problem hiding this comment.
With $SHELL=/usr/bin/fish, this return guarantees that a successful login prints no completion line, while the updated README says login prints the exact line for the user's shell and the changeset explicitly advertises a Fish completions file. Fish users therefore never receive the announced onboarding behavior; remove the Fish claim until yargs supports it, or generate a valid Fish completion and allow the hint through. The README is this repository's command-behavior reference.
AGENTS.md reference: AGENTS.md:L3-L5
Useful? React with 👍 / 👎.
|
@codex review |
|
Codex Review: Didn't find any major issues. Swish! Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
Co-authored-by: Jamie Barton <jamie@bunny.net>
|
Saw the conflicts, fixing them. |
|
Good to go @jamie-at-bunny . Let me know what else I can help with, I have good free time these days. Or if you have a vision in mind or a roadmap, I can work from there and help you shape it into reality. I am not a bunny.net customer, I will have to subscribe to know more about what's going on inside (it has no free tier AFAIK, so I will try to work around it) |
|
@mohammed-io looks great! I'll get this merged today. If you signup, I can give you some credit and extend the trial as a thanks for your contributions 😄 One the next areas are to:
|
Thank you! I will let you know about my account details when I sign up!
For 1. Would need more context. Since you are working on the MCP I can see how it goes after that. I will start with 4. it will give me a good taste on the DX of the cli and it gives me more context working on the others. How do you work normally? Should I create a github issue before start working? |
|
@mohammed-io feel free to open an issue for Yargs based Open an issue, and mention you'll work on it. Since it's mostly myself and @amir-at-bunny contributing to the CLI right now, we just mostly use internal Slack to discuss our ideas and then spike a PR to take forward. But I won't be touching examples, so feel free to take that. Appreciate the contribution 🫶 |
3 participants
Context
After discussing on #162 we have decided to add the completions suggestion as the hint for the user shell.
I went with the simplest solution. It meant to support the 3 major shells (bash, zsh, and fish) however,
yargsdoesn't supportfishat the moment until yargs/yargs#2569 is merged and released. So, I added the support forfishanyway, but with a check to not show the completion onfishshell and a comment to remove the check after that PR is merged.@jamie-at-bunny WDYT?