calva icon indicating copy to clipboard operation
calva copied to clipboard

Add basic REPL History search

Open mrkam2 opened this issue 1 year ago • 5 comments

What has changed?

This implements a very basic REPL History search.

Fixes #2175

My Calva PR Checklist

I have:

  • [x] Read How to Contribute.
  • [x] Directed this pull request at the dev branch. (Or have specific reasons to target some other branch.)
  • [x] Made sure I have changed the PR base branch, so that it is not published. (Sorry for the nagging.)
  • [x] Made sure there is an issue registered with a clear problem statement that this PR addresses, (created the issue if it was not present).
    • [ ] Updated the [Unreleased] entry in CHANGELOG.md, linking the issue(s) that the PR is addressing.
  • [ ] Figured if anything about the fix warrants tests on Mac/Linux/Windows/Remote/Whatever, and either tested it there if so, or mentioned it in the PR.
  • [ ] Added to or updated docs in this branch, if appropriate
  • [ ] Tests
    • [ ] Tested the particular change
    • [ ] Figured if the change might have some side effects and tested those as well.
  • [ ] Formatted all JavaScript and TypeScript code that was changed. (use the prettier extension or run npm run prettier-format)
  • [ ] Confirmed that there are no linter warnings or errors (use the eslint extension, run npm run eslint before creating your PR, or run npm run eslint-watch to eslint as you go).

Ping @pez, @bpringe, @corasaurus-hex, @Cyrik

mrkam2 avatar Apr 27 '24 00:04 mrkam2

Deploy Preview for calva-docs ready!

Name Link
Latest commit fcf8060b355e4019c6af5598e6472318c73ad25e
Latest deploy log https://app.netlify.com/sites/calva-docs/deploys/662c4205e3a4510008729c8d
Deploy Preview https://deploy-preview-2540--calva-docs.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar Apr 27 '24 00:04 netlify[bot]

This implementation is very basic. It is missing a few things:

  • iterating over several results having the same match,
  • highlighting the match.

I'm curious how you would've implemented these. ChatGPT suggests to use a custom view. Maybe that's what I'll try next. But so far I've compiled the version of the plugin to test with and want to see how much those issues would affect me.

mrkam2 avatar Apr 29 '24 23:04 mrkam2

I'm curious how you would've implemented these. ChatGPT suggests to use a custom view.

It's important that this is kept simple and low maintenance. I don't think anyone in the Calva team really uses the REPL Window much and we're not keen on building it out much more. I think that eventually we may replace it by something simpler alltogether.

I think I would try with a quickpick menu first. Building it from the full repl history. That would offload the search and match to VS Code. Joyride example:

(vscode/window.showQuickPick
 #js [#js {:label "(when-let [requires (resolve 'clojure.main/repl-requires)]\n(clojure.core/apply clojure.core/require @requires))"
           :detail "[clj] user"}
      #js {:label "(println 42)"
           :detail "[cljs] pez.pirate-lang"}])

This pops open a quickpick menu with the two items, showing the start of both. When the user types, any matching text will be highlighted in the menu and the menu will shrink to only the matchin items. It has limitations. Only the start of the text is shown, and if the match is outside the visible text, it will be invisible. But the menu will still shrink to only the matching items, so I think it is good enough and worth to try.

PEZ avatar Apr 30 '24 05:04 PEZ

I don't think anyone in the Calva team really uses the REPL Window much

Interesting. Do you refer to all Calva users or just some core members?

mrkam2 avatar Apr 30 '24 16:04 mrkam2

I don't think anyone in the Calva team really uses the REPL Window much

Interesting. Do you refer to all Calva users or just some core members?

I'm referring to the maintainers of Calva.

PEZ avatar Apr 30 '24 19:04 PEZ