Edit: Add further code actions for editing and documenting code #1724

umpox · 2023-11-13T16:57:55Z

Description

This PR:

Adds 3 new code actions
Document code action
- Shown on documentable nodes (declarations, properties, functions, etc)
- Only supported in JS/TS right now. Issue to add more languages as a follow up: Document Code Action: Improve language support #1764
Edit code action
- Shown whenever there is a user selection
- Opens the edit instruction input so the user can type how they want the code to be edited
Generate code action
- Shown whenever there is no selection and the current line is empty
- Opens the edit instruction input so the user can type what they want to generate

Document Code Action

Only shows when on a documentable symbol. Determined via Tree Sitter

CodeActionDocument.mov

Edit Code Action

Only shows when there is an active selection

CodeActionEdit.mov

Generate Code Action

Only shows when there is no selection and the current line is empty.

CodeActionGenerate.mov

Test plan

Trigger code actions on:

Symbols that could be documented
Selections in a document
Empty lines with no selections

valerybugakov

Got language blocks leaking into the document when using the "generate" action:

Filepath: vscode/src/logged-rerank.ts
Prompt: function that outputs ASCII art to the console with a cat image

valerybugakov

The "document" action removed the interface field a couple of times after adding a comment. For example, here, I asked it to document the triggerKind property:

Filepath: src/completions/get-inline-completions.ts
Property: InlineCompletionsParams['triggerKind']

valerybugakov

The "edit" action most worked as expected, but the results show that the LLM has a poor understanding of the surrounding code. The UX is awesome. I'd love to use it with a smarter model and better context. Noob q: what model do we use for quick actions?

valerybugakov

Love the new actions! Especially "document" and "generate" ones. Going to use them locally and report issues in Slack 🙌

valerybugakov · 2023-11-17T06:37:21Z

vscode/src/code-actions/document.ts

+    public static readonly providedCodeActionKinds = [vscode.CodeActionKind.RefactorRewrite]
+
+    public provideCodeActions(document: vscode.TextDocument, range: vscode.Range): vscode.CodeAction[] {
+        const [documentableNode] = execQueryWrapper(document, range.start, 'getDocumentableNode')


@umpox, let me know if you noticed any confusing parts about our tree-sitter setup 🙂

This is super cool! Can we add it as an option for the commands/custom commands? Think it'd be helpful with the /explain and /test commands!!!

@valerybugakov The tests are great and the SDK is super easy to use and build from.

I found it helpful to take the contents from a page at https://learnxinyminutes.com/ and then put it into this playground when writing the queries. Covers quite a lot of cases.

@abeatrix Maybe, do you have any ideas? I think we could possibly use this with the scope expansion too, e.g. expanding to nearest function etc if we want more control over different scenarios.

I think we don't make this available for custom commands yet, it's quite hard to write these queries so not sure if anyone will want to integrate them with a custom command. Possibly there's future work to integrate pre-written ones though, like useNearestFunctionAsSelection or something

I found it helpful to take the contents from a page at https://learnxinyminutes.com/

TIL, thanks for sharing! I've been asking GPT-4 to generate a file with all syntax constructs, but using the website you shared is a bit more reliable 😛

abeatrix

Found some issues with the code actions, but love the idea in general! Curious to know why we need a different prompt and action for the Documentation Code Action instead of using the existing one?

Document Code Lens

Break the code and the undo button does not work

Screen.Recording.2023-11-17.at.6.24.07.AM.mov

Undo button always remove the last line that it did not line

Issue unrelated to this PR but related to the feature 😅

Screen.Recording.2023-11-17.at.6.21.29.AM.mov

Retry Code Lens breaks the code before applying new changes

Screen.Recording.2023-11-17.at.6.15.04.AM.mov

abeatrix · 2023-11-17T14:40:26Z

vscode/src/code-actions/edit.ts

+        selection?: vscode.Selection
+    ): vscode.CodeAction {
+        const action = new vscode.CodeAction(displayText, vscode.CodeActionKind.RefactorRewrite)
+        const source = 'code-action'


What do you think about adding the type of action to the end of source, e.g. code-action:generate, code-action:edit so we can create a dashboard for each code action usages?

Yep good idea

umpox · 2023-11-22T14:45:26Z

@abeatrix Thanks for reporting the "undo" bugs! I took a look and everything you mentioned was related to weird "undo" logic we had.

The problem was that we were incorrectly using the selectionRange when appending or prepending new code to the target range. Our code assumed that any edits that happened immediately before or after the target range, was completely unrelated - so it wouldn't include this in the edit, or in the code lens or diff.

For fixups we do care about appending or prepending, so I've updated this logic to support expanding the range if there is a partial overlap (change.range.end === selectionRange.start or change.range.start === selectionRange.end).

This also has the benefit of improving the diff highlighting for the /doc output, as previously we mostly ignored this.

abeatrix · 2023-11-22T16:40:20Z

Thanks for working on this!

Confirmed the following are fixed

Document Code Lense
Undo button always remove the last line that it did not line
Retry Code Lens breaks the code before applying new changes

Screen.Recording.2023-11-22.at.8.31.22.AM.mov

There are some issues with theDocument Code Lensewhere the generated doc string will replace the current line of text, and the undo button will remove the last line of the current range:

Screen.Recording.2023-11-22.at.8.37.37.AM.mov

umpox · 2023-11-23T13:59:53Z

@abeatrix Can't replicate the issue with the line being removed 🤔 Please could you output the logs if you see it again?

The only things I can think are:

Maybe the formatter you use has different behavior to mine
The LLM had a moment and produced some weird output

Going to update this with main and merge this (aware you're on PTO until next week) to avoid long lived branches. Further work to imrpove the response reliablity is related to this issue #1790

PTO & following up on LLM response reliability in #1790

umpox mentioned this pull request Nov 13, 2023

PRD: [VSC] Edit command #1658

Closed

umpox self-assigned this Nov 13, 2023

umpox force-pushed the tr/better-fix-context branch from 5279070 to b73235a Compare November 14, 2023 11:06

Base automatically changed from tr/better-fix-context to main November 14, 2023 11:21

umpox force-pushed the tr/add-further-code-actions branch 2 times, most recently from 4ca05bf to 60f800b Compare November 15, 2023 10:16

umpox changed the base branch from main to vb/move-tree-sitter-out-of-completions November 15, 2023 14:07

valerybugakov force-pushed the vb/move-tree-sitter-out-of-completions branch from 8772cfa to eb05429 Compare November 16, 2023 02:41

Base automatically changed from vb/move-tree-sitter-out-of-completions to main November 16, 2023 02:44

umpox added 7 commits November 16, 2023 08:44

Add further code actions for editing and documenting

2a6efed

query

3733241

stuff

df9e1d9

Use TS query

843c4fd

keep rerank

7b75a84

Add generate code action

a147294

handle non empty lines

c20632c

umpox force-pushed the tr/add-further-code-actions branch from 567e763 to c20632c Compare November 16, 2023 08:45

umpox added 2 commits November 16, 2023 08:49

more

7451660

use instruction

cbf5619

umpox mentioned this pull request Nov 16, 2023

Document Code Action: Improve language support #1764

Closed

umpox marked this pull request as ready for review November 16, 2023 10:03

umpox requested review from a team, philipp-spiess, olafurpg and valerybugakov November 16, 2023 10:04

valerybugakov reviewed Nov 17, 2023

View reviewed changes

valerybugakov approved these changes Nov 17, 2023

View reviewed changes

abeatrix previously requested changes Nov 17, 2023

View reviewed changes

abeatrix reviewed Nov 17, 2023

View reviewed changes

umpox added 9 commits November 20, 2023 14:14

use correct insert mode

2628679

Fix range expansion for insertMode

aae4fc6

possisbly adjust the range

2d1f012

hmm

94e374a

revert

1e531c0

revert

cbcf571

Merge branch 'main' into tr/add-further-code-actions

0782377

support range affix for fixups

ee3dd6b

clean

b58609e

umpox requested a review from abeatrix November 22, 2023 14:45

add code action type to source

7313e83

Merge branch 'main' into tr/add-further-code-actions

bdf23bc

changelog

95d5b8d

umpox enabled auto-merge (squash) November 23, 2023 14:13

umpox merged commit 4a38ea5 into main Nov 23, 2023
14 checks passed

umpox deleted the tr/add-further-code-actions branch November 23, 2023 14:31

umpox mentioned this pull request Nov 27, 2023

Diagnostic quickfix menu shows no "Ask Cody to fix" option #1545

Closed

umpox assigned umpox and unassigned umpox Nov 30, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Edit: Add further code actions for editing and documenting code #1724

Edit: Add further code actions for editing and documenting code #1724

umpox commented Nov 13, 2023 •

edited

Loading

valerybugakov left a comment •

edited

Loading

valerybugakov left a comment

valerybugakov left a comment

valerybugakov left a comment

valerybugakov Nov 17, 2023

valerybugakov Nov 17, 2023

abeatrix Nov 17, 2023

umpox Nov 20, 2023

umpox Nov 20, 2023

valerybugakov Nov 20, 2023

abeatrix left a comment •

edited

Loading

abeatrix Nov 17, 2023

umpox Nov 20, 2023

umpox commented Nov 22, 2023

abeatrix commented Nov 22, 2023

umpox commented Nov 23, 2023

Edit: Add further code actions for editing and documenting code #1724

Edit: Add further code actions for editing and documenting code #1724

Conversation

umpox commented Nov 13, 2023 • edited Loading

Description

Document Code Action

Edit Code Action

Generate Code Action

Test plan

valerybugakov left a comment • edited Loading

Choose a reason for hiding this comment

valerybugakov left a comment

Choose a reason for hiding this comment

valerybugakov left a comment

Choose a reason for hiding this comment

valerybugakov left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abeatrix left a comment • edited Loading

Choose a reason for hiding this comment

Document Code Lens

Undo button always remove the last line that it did not line

Retry Code Lens breaks the code before applying new changes

Choose a reason for hiding this comment

Choose a reason for hiding this comment

umpox commented Nov 22, 2023

abeatrix commented Nov 22, 2023

umpox commented Nov 23, 2023

umpox commented Nov 13, 2023 •

edited

Loading

valerybugakov left a comment •

edited

Loading

abeatrix left a comment •

edited

Loading