search

aisk / pick

create curses based interactive selection list in the terminal
MIT License
721 stars 60 forks source link

added `position` argument so `pick` doesn't clear the screen every time #95

Closed Cornelius-Figgle closed 4 months ago

Cornelius-Figgle commented 1 year ago

94 #50

I have added the position argument to the pick module, so that a specific write-point can be provided. This means that pick won't clear the screen when running in an existing curses window

position is a dictionary with the keys y0 and x0, which correspond to the y and x locations respectively. Default position is the same as previously, now written as {"y0": 1, "x0": 1}

Forked repo here

y_, _ = screen.getyx()
answer, _ = pick(
    ['Yes', 'No'], 
    f'\nIs This Path Correct? \t{path}',
    screen=screen,
    position={'y0': y_, 'x0': 0}
)

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

Walkthrough

The update introduces an optional position parameter that allows setting the initial write position in a curses application when using pick. This enhancement provides more control over user interaction and cursor placement, improving the overall user experience.

Changes

File Path Change Summary
README.md Added an optional position parameter for setting initial write position in pick.
example/position.py Introduces functionality for selecting a programming language using a UI.
src/pick/__init__.py Added Position namedtuple, updated Picker class methods to handle position.

🐰✨ In the code where the cursor blinks, A new spot to start, what do you think? With a hop and a skip, set the position, Now picking choices with new precision! 🌟🐇

Recent Review Details **Configuration used: CodeRabbit UI**
Commits Files that changed from the base of the PR and between 1c08d5fb56edd941040183102f8cf0d9c6c8c3bd and 887af619dacfdceae2e2baf1e95067f74334b85f.
Files selected for processing (1) * README.md (1 hunks)
--- Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
aisk commented 4 months ago

Hi, I think this change looks good to me, but before merge, we need to resolve the conflicts.

Cornelius-Figgle commented 4 months ago

Is that something for me or you to do? If it's me, how?

aisk commented 4 months ago

You can execute git fetch && git merge in this branch, and if you are using a modern editor like VSCode, you can resolve the conflict when you open the __init__.py in it.

Otherwise, you can edit the file as normal file, and edit it by hand, to make it as what it expected to commit. After that, just running git add <the file and git commit && git push.

Last way is click the Resolve conficts button bellow. but it lacks of context, I only recomented use it unless you have confident.

Cornelius-Figgle commented 4 months ago

You can execute git fetch && git merge in this branch

Did this, nothing happened other than the normal output like with git pull

Otherwise, you can edit the file as normal file, and edit it by hand, to make it as what it expected to commit

I went to edit the file and it looked the same as what I had committed? I didn't change anything so there's nothing to push back

Do I use GitHub's Resolve conflicts now then? Or have I done something wrong... I apologise for my inadequacy 😅

aisk commented 4 months ago

You can have a try to use the Resolve conficts button. It will append a new commit to your branch, so please be sure to check and test the code locally after use it.

Cornelius-Figgle commented 4 months ago

done :)

aisk commented 4 months ago

Thank you for your contribution, merged!