stateful / vscode-marquee

💡 The missing VS Code homescreen that helps you to stay organized with minimal context switches
https://marquee.stateful.com/
MIT License
101 stars 15 forks source link

Runme Widget #248

Closed christian-bromann closed 1 year ago

christian-bromann commented 1 year ago

This pull request implements a new widget to promote Runme. It comes with the following states:

User has Runme not installed

Screenshot 2023-03-06 at 18 54 44

Clicking on Add to VS Code will open this link vscode://stateful.runme?command=setup&fileToOpen=https://gist.githubusercontent.com/christian-bromann/df97ce3dace21564ffdf1900400ec099/raw/0a9b29c979d61e17032c855b04dbc4f5b962f847/ThankYou.md which basically will prompt the install procedure for Run with Runme.

No Runme Files are found

createrunme

If no markdown files are found in the workspace, the widget will ask whether the user wants to create one. If the link is click, it runs the Runme command runme.new.

Open Runme Files

openrunme

On click on the list item, the widget will run the runme.openAsRunmeNotebook command. There is a file listener registered so every markdown file added to the workspace or removed will have an impact on the list and automatically updates it.


@sourishkrout @admc please let me know if the widget fills the requirements. If functionality wise we are happy with the state I can wrap up the work adding unit/e2e tests.

vercel[bot] commented 1 year ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment | Name | Status | Preview | Comments | Updated | | :--- | :----- | :------ | :------- | :------ | | **vscode-marquee** | ⬜️ Ignored ([Inspect](https://vercel.com/stateful/vscode-marquee/GgxtH8z49WmJ91gdbNNSjchnEmnz)) | [Visit Preview](https://vscode-marquee-git-cb-runme-widget-stateful.vercel.app) | | Mar 9, 2023 at 1:09AM (UTC) |
admc commented 1 year ago

Looking good! Couple thoughts:

Otherwise the workflow seems right on. 👍

christian-bromann commented 1 year ago
  • The runme files list uses quite a lot of space, i'd probably want it condensed to one line each, maybe small runme icon, filename and then a truncated grayed out path, also maybe grouped if there are many in one directory?

I condensed it a bit. I would still keep it on two lines because it better guarantees that users can see the full directory path. I was looking into grouping by directory but it is generally less likely that many markdowns are in the same directory. What do you think about this version:

listcompact

  • Runnable Markdowns

Modified widget title.

  • "Download for integrated Marquee support" makes me think of leaving VS Code and downloading something, maybe "Install native VS Code support for Runme" or something?

Updated:

Screenshot 2023-03-07 at 14 47 44

Let me know what you think!?

admc commented 1 year ago

LGTM 👍