From: Eduardo Ochs <eduardoochs@gmail.com>
To: Emacs developers <emacs-devel@gnu.org>
Subject: ELPA submission: show-conses.el
Date: Sun, 20 Oct 2024 02:18:30 -0300 [thread overview]
Message-ID: <CADs++6h7_KTO=Xq+fKcuFhyxys4XRVK3Wb95xcb7ue5ofJja1g@mail.gmail.com> (raw)
Hi list,
I just finished the first version of a package called
"show-conses.el", that at first sight is a tool that receives sexps
and draws their cons-cell diagrams in a format that looks like this,
(1 (2 "3") . 4)
.__._______4
| |
1 .__.
| |
2 "3"
but with text properties: if we type `C-c C-c' on a node of the tree
it highlights the corresponding part of the sexp above.
At second sight show-conses.el is a library that uses an extensible
DSL to draw these diagrams with text properties; that library builds
tree diagrams by composing rectangles, and it should be easy to make
it produce other kinds of diagrams besides parse trees.
At third sight show-conses.el demonstrates several techniques for
documenting code using "tests in comments". I use those techniques a
lot in my other package - "eev" - and I would like to make them more
popular. I discussed some of these techniques - the ones related to
"test blocks" - in my presentation at the EmacsConf 2021; see
<http://anggtwu.net/eepitch.html#test-blocks>. These techniques are
somewhat controversial: apparently Kids These Days believe that all
tests should be unit tests, or at least automated tests - and some of
these Kids These Days reacted very angrily when I showed them my test
blocks. But more on that later.
At fourth sight show-conses.el is a very early prototype - everything
works, but many parts are undocumented and many names are bad and need
to be changed. But I made a page about it here,
http://anggtwu.net/show-conses.html
and it has lots of links and screenshots, and it has instructions for
installing and trying it with a sexp - this one:
(progn
(package-initialize)
(package-refresh-contents)
(package-install 'eev)
(package-vc-install "https://github.com/edrx/show-conses")
(eev-beginner)
(find-2a ' (find-eev-quick-intro "2. Evaluating Lisp")
' (find-show-conses-intro)
)
)
The explanations are at <http://anggtwu.net/show-conses.html>.
I would like to submit it to ELPA after lots of clean-ups.
Does it look like something that deserves to be put in ELPA?
Should I start to do these clean-ups following what I know about
the conventions for ELPA packages?
Thanks in advance!
Eduardo Ochs
http://anggtwu.net/#eev
http://anggtwu.net/eepitch.html
reply other threads:[~2024-10-20 5:18 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CADs++6h7_KTO=Xq+fKcuFhyxys4XRVK3Wb95xcb7ue5ofJja1g@mail.gmail.com' \
--to=eduardoochs@gmail.com \
--cc=emacs-devel@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).