Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@ functions. The user can select which functions to trace. Functions can
be selected individually or by namespace. The recorded data can be
displayed, queried and profiled.

The whole loop in one take - trace some namespaces, run your code, then
explore the recorded call tree:

![Tracing a namespace, running the code and exploring the recorded call tree](doc/images/sayid-workflow.gif)

Sayid currently has three components:

* `sayid.core` and its supporting namespaces
Expand Down Expand Up @@ -358,6 +363,8 @@ is traced and recorded right now. The keybindings are also listed by buffer
below, and every list is available from within Emacs: press `h` in any
Sayid buffer to pop up the matching help buffer.

![The Sayid menu popped up under a Clojure buffer, showing the commands grouped by workflow](doc/images/sayid-menu.png)

API docs for the core namespaces are available on
[cljdoc](https://cljdoc.org/d/mx.cider/sayid/CURRENT).

Expand Down Expand Up @@ -388,8 +395,13 @@ API docs for the core namespaces are available on


The workspace opens in the `*sayid-tree*` buffer, a foldable tree built on
CIDER's `cider-tree-view`. Navigation and folding come from there; Sayid adds a
few actions on top:
CIDER's `cider-tree-view`. Every recorded call shows its arguments and its
return value (or the exception it threw):

![The Sayid workspace tree showing recorded calls with arguments, return values and a thrown exception](doc/images/sayid-workspace-tree.png)

Navigation and folding come from `cider-tree-view`; Sayid adds a few actions
on top:

TAB -- fold or unfold the call at point
RET, . -- jump to the call's source
Expand All @@ -415,6 +427,8 @@ tree in the `*sayid-traced*` buffer. `RET` on a function jumps to its source;
enable, disable and remove the trace at point, and `i`/`o` switch a function to
an inner or outer trace.

![The traced-functions view, a namespaces to functions tree](doc/images/sayid-traced.png)


In the `*sayid-pprint*` buffer, press `h` to pop up the help
buffer.
Expand Down
Binary file added doc/images/sayid-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/sayid-traced.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/sayid-workflow.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/sayid-workspace-tree.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading