TODO Explorer

Content Type: Module
Categories: Extensions,Utility

Overview

TODO Explorer adds a dockable pane to Studio Pro that collects every TODO, FIXME and HACK annotation from your microflows and nanoflows, so notes left on the canvas no longer get lost across hundreds of documents.


Why

Studio Pro has no built-in overview of annotations. Developers leave notes like "TODO: validate input" or "FIXME: retry on timeout" directly in their logic, but finding them again means opening documents one by one. TODO Explorer gives you the full list in one place.


What it does

- Scans all microflows and nanoflows, including annotations inside loops

- Groups results by module and document, sorted by position on the canvas

- Opens the document with the annotation selected when you click an entry

- Filters by marker (TODO / FIXME / HACK) and by text

- Hides Marketplace modules by default, so you only see your own work

- Updates automatically while you edit; a Rescan button forces a full refresh

- Shows the first line of multi-line annotations, expandable to the full text

- Follows the Studio Pro light and dark theme


How to use

After importing the module, open Extensions > TODO Explorer. Markers are case-sensitive whole words, for example "TODO: validate input".


Limitations

Markers are fixed to TODO, FIXME and HACK. Domain model and workflow annotations are not scanned yet. The extension is built on the Studio Pro Web Extensibility API, which is still in beta.


Source code and issues: https://github.com/kucir98/todo-explorer

Documentation

Typical usage scenario

Developers leave notes such as "TODO: validate input" or "FIXME: retry on timeout" as annotations directly in microflows and nanoflows, but Studio Pro has no overview of them. Before a release, a code review or a handover, open TODO Explorer to see every open note in the app, grouped by module and document, and jump straight to each one.


Features and limitations

Features:

- Scans all microflows and nanoflows, including annotations inside loops

- Recognizes TODO, FIXME and HACK as case-sensitive whole words anywhere in the annotation text

- Groups results by module and document, sorted by position on the canvas

- Click an entry to open the document with the annotation selected; click a document to open it

- Filter by marker and by text; Marketplace modules are hidden by default

- Updates automatically while you edit; the Rescan button forces a full refresh

- Multi-line annotations show the first line and expand to the full text

Limitations:

- Markers are fixed to TODO, FIXME and HACK

- Domain model and workflow annotations are not scanned yet

- The first scan of a large app can take several seconds; later updates are incremental

- Built on the Studio Pro Web Extensibility API, which is still in beta


Dependencies

None.


Installation

1. Download the module from the Marketplace into your app (or import TodoExplorer.mxmodule via App Explorer > right-click the app > Import module package).

2. Open Extensions > TODO Explorer. The pane opens at the bottom, next to Errors and Console; you can move it like any other pane.

Requires Studio Pro 11.12.1 or later.


Configuration

No configuration is needed. Write annotations that contain a marker, for example "TODO: validate input" or "FIXME: handle empty list", and they appear in the pane.


Known bugs

None known. Report issues at https://github.com/kucir98/todo-explorer/issues


Frequently asked questions

Q: Why doesn't "todo" in lowercase show up?

A: Markers are case-sensitive to avoid false matches in ordinary text.

Q: Do I need to ship the module with my app?

A: The module only contains the Studio Pro extension; it adds nothing to your app at runtime.

Releases

Version: 0.1.0
Framework Version: 11.12.1
Release Notes:

Initial release.


TODO Explorer adds a dockable pane to Studio Pro that lists every TODO, FIXME and HACK annotation in your microflows and nanoflows, including annotations inside loops.


Features

- Tree grouped by module and document, sorted by position on the canvas

- Click an entry to open the microflow or nanoflow with the annotation selected

- Filter by marker (TODO / FIXME / HACK) and by text

- Marketplace modules hidden by default (toggle to include them)

- List updates automatically as you edit; Rescan button for a full refresh

- Multi-line annotations show the first line, expandable to the full text

- Follows the Studio Pro light/dark theme


Usage

Extensions > TODO Explorer. Markers are case-sensitive whole words, e.g. "TODO: validate input".


Requirements

Studio Pro 11.12.1 or later.


Known limitations

- Markers are fixed to TODO, FIXME and HACK (configurable markers planned)

- Domain model and workflow annotations are not scanned yet

- Built on the Studio Pro Web Extensibility API, which is still in beta


Source code, bug reports and feature requests: https://github.com/kucir98/todo-explorer