haddock icon indicating copy to clipboard operation
haddock copied to clipboard

Published 20 hours ago • verified publisher icon haskell

QuickJump: Don't search for every keypress.

Open kolmodin opened this issue 6 years ago • 11 comments

When the search box gets updated, wait 150ms before searching.

kolmodin avatar Sep 08 '19 13:09 kolmodin

I see you that haddock-api/resources/html/package-lock.json was removed and haddock-api/resources/html/yarn.lock added. What is the reason for this?

Otherwise, this seems reasonable. Ideally, the UI would not be blocked while it searches, but that's a whole other problem.

harpocrates avatar Sep 09 '19 04:09 harpocrates

I switched from npm package manager to yarn package manager (which is built on top of npm). Yarn has several advantages over plain npm so the js community as a whole is moving towards yarn. They consume the same input files and work in a similar way but yarn is easier to use. They use different lock files and it's dangerous to keep both since they can have locked different package versions.

kolmodin avatar Sep 09 '19 14:09 kolmodin

And yes, the work should ideally not be done on the UI thread to start with. It could be done in a service worker, but that's future work :)

kolmodin avatar Sep 12 '19 10:09 kolmodin

Right, QuickJump could stand to have nicer API 😄. But this PR is a definite improvement, so let's get it merged!

I switched from npm package manager to yarn package manager (which is built on top of npm). Yarn has several advantages over plain npm so the js community as a whole is moving towards yarn. They consume the same input files and work in a similar way but yarn is easier to use. They use different lock files and it's dangerous to keep both since they can have locked different package versions.

Seems reasonable. Shouldn't the documentation here be updated to talk about yarn though?

harpocrates avatar Sep 28 '19 16:09 harpocrates

Oh, sure, I'll update the instructions. I've got a lot going on now, but I'll get to it shorly I hope.

kolmodin avatar Sep 29 '19 20:09 kolmodin

@mergifyio rebase

Kleidukos avatar Jun 06 '22 10:06 Kleidukos

@kolmodin Do you still want to work on this?

Kleidukos avatar Jun 06 '22 10:06 Kleidukos

rebase

✅ Branch has been successfully rebased

mergify[bot] avatar Jun 06 '22 10:06 mergify[bot]

No, sorry. Can someone take over, if this PR is still relevant?

kolmodin avatar Jun 06 '22 10:06 kolmodin

I have no idea if it's still relevant, you opened it before I took office. :)

I will mark it as draft.

Kleidukos avatar Jun 06 '22 10:06 Kleidukos

quickjump usually lags out the JS engine instantly if I apply it to esqueleto or persistent e.g., so I think this PR is still relevant, although I am wondering if it is doing something exceedingly inefficient and which could be improved instead?

lf- avatar Jun 16 '22 22:06 lf-

Hi, thank you for this PR, but Haddock now lives full-time in the GHC repository! Read more at https://discourse.haskell.org/t/haddock-now-lives-in-the-ghc-repository/9576.

Let me know if you feel it is still needed, and I'll migrate it. :)

Kleidukos avatar May 18 '24 12:05 Kleidukos