Advising System

[jaidetree]

Provides a system to wrap or define advisable functions that can be overwritten later. See #72 for intended use case.

Can solve a number of open PRs by allowing us to wrap some of the internals to support advising. Then users can customize the behaviors by adding advice to their liking. This helps us reduce the number of config settings we need to include for personal preferences.

For example:

We can make the main modal.fnl alert function advisable, then users can add advice to override it so that it displays on all monitors at the same time.

The work here depends on the testing work in #106.

Usage example:

(import-macros {: defn
                : defadvice} :lib.advice.macros)

(defn original-fn
      [x y z]
      "docstr"
      "Hi")

(original-fn)
;; => "Hi"

(defadvice advice-fn
           [x y z]
           :override original-fn
           "Overrides original-fn"
           "over-it")

(original-fn)
;; => "over-it"

Closes #101
Closes #72

Test Results and feature list:

Credits

Big thanks to @Grazfather for getting a first draft out I could iterate on. We also paired a few weeks back and traded knowledge around this which helped a lot.

[jaidetree]

Added a couple extra APIs for tracking advice, among refining the implementation, as well as completing the documentation.

Latest draft may be found https://github.com/agzam/spacehammer/blob/d100cb5368f20679cd48699b73333ab599440b34/docs/advice.org.

[jaidetree]

Received some feedback from Grazfather, and ambridsall in the doom emacs discord. Updated the advice docs and caught a mismatch in the after behavior https://github.com/agzam/spacehammer/blob/6fb8e1c5d678c4d6d5641a55a6748dcc2ac1395d/docs/advice.org.

[jaidetree]

More doc updates from discord feedback https://github.com/agzam/spacehammer/blob/93e17f9558af9697f448833ad732a463fcec1b0e/docs/advice.org

[jaidetree]

Unit testing was merged so this is ready for review whenever you're available @Grazfather

[Grazfather]

Saw 2 rendering issues, LGTM overall.