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

AiderTest command #14

Merged
merged 5 commits into from
Sep 26, 2024
Merged

AiderTest command #14

merged 5 commits into from
Sep 26, 2024

Conversation

tsukimizake
Copy link
Contributor

@tsukimizake tsukimizake commented Sep 26, 2024

  • /test が便利そうだったので追加したり、commandにcompleteが欲しかったのでtestとついでにaddfileに設定したりしました

Summary by CodeRabbit

  • New Features

    • Introduced a new command test for setting prompts with completion options.
    • Enhanced command registration to support completion types for better user experience.
  • Bug Fixes

    • Streamlined command implementations by removing unnecessary parameters from the sendPromptWithInput method.

Copy link
Contributor

coderabbitai bot commented Sep 26, 2024

Walkthrough

The changes in this pull request enhance the command registration process in the main.ts file by introducing a new type, CompleteType, which defines completion options based on argument count. The command function is updated to include a complete parameter, allowing for specification of completion types. Additionally, several commands are modified to streamline their implementations, and a new command, test, is added to facilitate prompt setting with a specified completion type.

Changes

Files Change Summary
denops/aider/main.ts - Added CompleteType<T extends ArgCount>.
- Updated command function signature to include complete: CompleteType<argCount> = "".
- Updated addFile, addWeb, and ask commands to remove parameters from sendPromptWithInput.
- Introduced new test command with a completion type of shellcmd.

Possibly related PRs

  • Over engineered main #11: The changes in this PR also modify the main.ts file, specifically enhancing the command handling logic, which is closely related to the updates made in the main PR regarding command registration and the introduction of new types.

Suggested reviewers

  • nekowasabi

Poem

In the code where rabbits play,
New commands hop in, bright and gay.
With types that help us find our way,
Completion's here, hip-hip-hooray!
So let us code, let ideas bloom,
In our burrow, there's always room! 🐇✨


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@@ -97,12 +109,12 @@ export async function main(denops: Denops): Promise<void> {
await command("addWeb", "1", async (url: string) => {
const prompt = `/web ${url}`;
await v.r.set(denops, "q", prompt);
await denops.dispatcher.sendPromptWithInput(url);
await denops.dispatcher.sendPromptWithInput();
Copy link
Contributor Author

Choose a reason for hiding this comment

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

denops渡すべきっぽいところにurlとかquestionとか渡していて壊してたかと思いきや動いていて、
mainのsendPromptWithImputは引数を取らないので無視されていたっぽい

},
"[<f-args>]",
false,
"shellcmd",
Copy link
Contributor Author

@tsukimizake tsukimizake Sep 26, 2024

Choose a reason for hiding this comment

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

optionalな引数がだいぶ増えてしまったので1つのopts的なオブジェクト引数にまとめるやつを次やるとおもわれます

Copy link
Owner

Choose a reason for hiding this comment

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

オッスオッス

@@ -97,12 +109,12 @@ export async function main(denops: Denops): Promise<void> {
await command("addWeb", "1", async (url: string) => {
const prompt = `/web ${url}`;
await v.r.set(denops, "q", prompt);
Copy link
Contributor Author

@tsukimizake tsukimizake Sep 26, 2024

Choose a reason for hiding this comment

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

v.r.setしてからsendPromptWithImputするのはコード上に出ない状態ができてしまってつらいのでbuffer.sendPromptWithInput(denops, input) みたいにinputも渡して中でv.r.setする方がよさそう

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between f1eec80 and d80d08f.

📒 Files selected for processing (1)
  • denops/aider/main.ts (5 hunks)
🔇 Additional comments (6)
denops/aider/main.ts (6)

16-18: Type definition for 'CompleteType' is well-defined

The CompleteType generic type correctly maps ArgCount to the appropriate completion options, enhancing type safety and improving command completion functionality.


40-40: Addition of 'complete' parameter enhances command flexibility

Introducing the complete parameter to the command function allows specifying completion types, which improves user experience by providing appropriate command-line completions.


46-46: Correct construction of 'completePart' for command definition

The completePart variable is properly constructed to include the -complete option when a completion type is specified, ensuring commands have the correct completion behavior.


48-48: Command registration string correctly incorporates completion options

The command definition now includes completePart, rangePart, and other parameters, ensuring that commands are registered with the correct options and behaviors.


92-103: 'addFile' command enhanced with file path completion

The addFile command now specifies complete as "file", enabling filename completion when users invoke the command. This enhances usability by allowing users to easily select file paths.


145-156: Review security implications of 'test' command accepting shell commands

The new test command uses complete as "shellcmd", allowing shell command completion. Since it accepts user input and incorporates it into a prompt (/test ${cmd}), ensure that this input is handled safely downstream to prevent potential security vulnerabilities like command injection.

Run the following script to verify how /test prompts are processed and ensure user input is safely handled:

✅ Verification successful

Verified: 'test' command safely handles user input

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search the codebase for handling of '/test' prompts.

# Test: Ensure that '/test' commands are processed safely.
rg --type typescript '/test' -A 5 -B 5

Length of output: 73


Script:

#!/bin/bash
# Description: Search the codebase for handling of '/test' prompts in TypeScript files.

# Test: Ensure that '/test' commands are processed safely.
rg '/test' --include '\.ts$' --include '\.tsx$' -A 5 -B 5

Length of output: 499


Script:

#!/bin/bash
# Description: Search the codebase for handling of '/test' prompts in TypeScript files.

# Test: Ensure that '/test' commands are processed safely.
rg '/test' -g '*.ts' -g '*.tsx' -A 5 -B 5

Length of output: 1344


Script:

#!/bin/bash
# Description: Trace the handling of user input for the '/test' command to ensure safe processing.

# Search for all instances where 'sendPromptWithInput' is called to understand how user input is handled.
rg 'sendPromptWithInput' -g '*.ts' -A 10 -B 10

# Additionally, search for any shell command executions that might use the 'prompt' or 'cmd' variables.
rg 'exec|spawn|shell' -g '*.ts' -A 5 -B 5

Length of output: 7207

@@ -12,7 +12,10 @@ export async function main(denops: Denops): Promise<void> {
type ArgCount = "0" | "1" | "*";
type ImplType<T extends ArgCount> = T extends "0" ? (() => Promise<void>)
: T extends "1" ? ((arg: string) => Promise<void>)
: ((arg: string, arg2: string) => Promise<void>); // MEMO: 1つめの引数、2つめの引数という意味
: ((arg: string, arg2: string) => Promise<void>); // MEMO: ArgCountは*だが現状2つのみ対応している
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Translate inline comment to English for consistency

The inline comment is in Japanese: // MEMO: ArgCountは*だが現状2つのみ対応している. To maintain consistency and readability for all contributors, please translate code comments to English.

@@ -12,7 +12,10 @@ export async function main(denops: Denops): Promise<void> {
type ArgCount = "0" | "1" | "*";
type ImplType<T extends ArgCount> = T extends "0" ? (() => Promise<void>)
: T extends "1" ? ((arg: string) => Promise<void>)
: ((arg: string, arg2: string) => Promise<void>); // MEMO: 1つめの引数、2つめの引数という意味
: ((arg: string, arg2: string) => Promise<void>); // MEMO: 1つめの引数、2つめの引数という意味 ArgCountは*だが現状2つのみ対応している
Copy link
Owner

Choose a reason for hiding this comment

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

👍

},
"[<f-args>]",
false,
"shellcmd",
Copy link
Owner

Choose a reason for hiding this comment

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

オッスオッス

@nekowasabi
Copy link
Owner

@tsukimizake
アリシャス!

@nekowasabi nekowasabi merged commit 8c80049 into nekowasabi:main Sep 26, 2024
1 check passed
@coderabbitai coderabbitai bot mentioned this pull request Sep 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants