Skip to content

dropbox/AppExplorer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

May 2, 2024
dde232c · May 2, 2024

History

36 Commits
Sep 18, 2023
May 2, 2024
May 2, 2024
Sep 18, 2023
Sep 18, 2023
Sep 27, 2023
Sep 18, 2023
Sep 18, 2023
Oct 16, 2023
May 2, 2024
May 2, 2024
May 2, 2024
Oct 6, 2023
Sep 18, 2023

Repository files navigation

AppExplorer

This is the AppExplorer VSCode extension that helps create documentation hosted in Miro.

Features

AppExplorer: Create Card

  • Identifies the symbol under the cursor
  • Locates where it's defined and attaches a card to it

AppExplorer: Attach Card to Code

  • Attaches the currently selected card to a symbol in the code

Requirements

This extension requires Miro and to enable the AppExplorer addon.

Download the latest app-explorer-*.vsix from https://github.com/dropbox/AppExplorer/tags. I'm not distributing it in the VSCode market because it's only useful with Miro, with that Miro added installed. I've already gone through the process to get it approved withing Dropbox

# This assumes you only have 1 version downloaded
code --install-extension app-explorer-*.vsix

Contributing

If you want to work directly on AppExplorer you need to globally install @vscode/vsce.

npm install -g @vscode/vsce

This extension operates by opening a webserver on http://localhost:50505/. This is the URL that the Miro extension will load in the background to connect with VSCode. The code in the /public folder is NOT configured to run through a transpiler, so it's JavaScript with TypeScript/DocBlock annotations. It's better than nothing, but it doesn't provide the safety of a real TypeScript file.

If you open the project and press F5 or run the command Debug: Start Debugging, it will launch a temporary VSCode running the extension. I don't think this process accounts for the /public folder though.

I'll usually just build and reinstall with this:

rm *.vsix; vsce pack; code --install-extension app-explorer-0.0.*.vsix
  1. Rebuild and install
  2. Refresh Miro
  3. Refresh VSCode

If you don't refresh Miro, you can get a mix of old /public/miro.js code along with newer changes in src.

Known Issues

  • The project is very incomplete at this stage

Release Notes

  • 0.0.5 - Code Navigation
    • Selecting a single card in Miro will bring you to the code
    • Clicking App Explorer (# cards) on the status bar lets you QuickPick a card
      • Miro will move to show yoy the cards as you search
      • Choosing a card will select it in Miro
        • Selecting the card will also navigate to the code.
    • All cards on the board use Miro's native linking feature for permalinks.
    • If you have a card selected in miro, you can AppExplorer: Attach Card to Code to reattach it to a symbol you're looking at.