From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eduardo Ochs Newsgroups: gmane.emacs.devel Subject: ELPA submission: show-conses.el Date: Sun, 20 Oct 2024 02:18:30 -0300 Message-ID: Mime-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="18632"; mail-complaints-to="usenet@ciao.gmane.io" To: Emacs developers Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sun Oct 20 07:19:19 2024 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1t2OLW-0004hd-Ai for ged-emacs-devel@m.gmane-mx.org; Sun, 20 Oct 2024 07:19:18 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1t2OL2-00055z-Bc; Sun, 20 Oct 2024 01:18:48 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1t2OL0-00055V-A6 for emacs-devel@gnu.org; Sun, 20 Oct 2024 01:18:46 -0400 Original-Received: from mail-yw1-x112d.google.com ([2607:f8b0:4864:20::112d]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1t2OKy-0007Tc-Kj for emacs-devel@gnu.org; Sun, 20 Oct 2024 01:18:46 -0400 Original-Received: by mail-yw1-x112d.google.com with SMTP id 00721157ae682-6db20e22c85so29600277b3.0 for ; Sat, 19 Oct 2024 22:18:43 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1729401522; x=1730006322; darn=gnu.org; h=to:subject:message-id:date:from:mime-version:from:to:cc:subject :date:message-id:reply-to; bh=h2QBTecGPeEqU3cc+KMrFLXp4vhp3UuE+qdJWpvR4+Q=; b=dJYCoL5V7s0i87CgIzkNZLkEfR6r7dft5zeEQ2zaX3pyBF0DsCZp+ddjHGkZ5vZhbv 9xQirkbBXh9IE/up0Wg58QkpTPGdtrrHrCuDeHTRjyQ2Fv6XIhjkkC38LaaCNt+ansAX 8zjLzMAKXOf57o7LLyWJcGftX/K8WTN1dUs8VNsuf8TqlOLyjjUbe7KuiBlmOBEZe8FM P65HxPYrFAjLYGUNeK6hWkvI0GcMxzESY8wfhkidw+R59NlpVGfZJ+uDtK4Zg2jHkvbs GxEWWxiaWOmXTcPj60F8jvrodwmKjPlggl5Egu+tHGBTvGp1v3O4EjMcyzk7/NIegNan N7oA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1729401522; x=1730006322; h=to:subject:message-id:date:from:mime-version:x-gm-message-state :from:to:cc:subject:date:message-id:reply-to; bh=h2QBTecGPeEqU3cc+KMrFLXp4vhp3UuE+qdJWpvR4+Q=; b=XGOpCeFxlvqIZV7ob8XkU0l6FguATBjZxDo5B7Y3+yqOtO9yw1O1Jve2vGLF7spIA6 R2I3w4UmLR3F4KyMPQzrALA7ZN2ryV7UOXZnlHpnUNKf+iJ+fBeaZ2nMHqr1AvRP79Hr 0e5hgiBZBs8FSyUTviUnHTx7RbEeUlJU9GiAiwaY6BnNhAdnJfXzHKNJKHlXfbAM4YsV Xpj6VMHqblePgBKW+CSkPGjoI0uyOQp07ZtKeSb7ZDvJ4MvCnWoBxvBRfcf34psB4VtR rizNCjPKYN8LmfNvLsVrIPnYjyWd09OAnM4gHanLn2nKlfpc+qvPErWdtBayrv2znxuG VyOQ== X-Gm-Message-State: AOJu0Yx0RkeNFcI8KoyBb9VpUZncaei/OxKc1bCAkTXVMDXVeV3FatOt ncXwLR3y/h5RP9bqoyIjjMFOnjb3MzX1SHgqF4lhePJpxBYaZz4TpjA6Bx0AzzQ4wlKa0v6tw5H PpGmT8yTRbuVr4mHWIPMR184yDOkTXfHV X-Google-Smtp-Source: AGHT+IHtvgP/gzAqt8TPpeXx5ySYwJ8sOEwlKpbRQSx8rFifV7+yR8p71tcHbWJ6du1LpthSdOTfjZQUkgqneyWsSL0= X-Received: by 2002:a05:690c:4a06:b0:6dc:c105:6d84 with SMTP id 00721157ae682-6e5bfc36556mr76437797b3.12.1729401522184; Sat, 19 Oct 2024 22:18:42 -0700 (PDT) Received-SPF: pass client-ip=2607:f8b0:4864:20::112d; envelope-from=eduardoochs@gmail.com; helo=mail-yw1-x112d.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.devel:324683 Archived-At: 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 . 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 . 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