From: Philip Kaludercic <philipk@posteo.net>
To: "João Távora" <joaotavora@gmail.com>
Cc: emacs-devel@gnu.org
Subject: Re: [ELPA] New package: breadcrumb.el
Date: Mon, 04 Sep 2023 20:47:11 +0000 [thread overview]
Message-ID: <87cyyx7jjk.fsf@posteo.net> (raw)
In-Reply-To: <87tts9llst.fsf@gmail.com> ("João Távora"'s message of "Mon, 04 Sep 2023 21:34:42 +0100")
João Távora <joaotavora@gmail.com> writes:
> Hi all
>
> I'd like to add my package "breadcrumb" to GNU ELPA.
>
> Breadcrumbs are a a "header-line" indication of where you are in a large
> project, both in terms of "which file"and "where point is within a
> file". You turn this on with breadcrumb-mode.
>
> Here's a link to the project (which has a screenshot)
> https://github.com/joaotavora/breadcrumb
Looks nice! I have no notable comments on the code, except that the
indentation out of place in two parts of the file.
>
> breadcrumb.el uses information derived from existing Emacs libraries
> imenu.el and project.el. It has some points in common with
> "which-func.el" but is simpler (and faster).
>
> You don't really have to put "breadcrumbs" in the header-line (I don't)
> so the package also come with some lower-level utils so you can plug this
> into mode-line-format however you see fit.
>
> I created this package some time ago to answer some common feature
> requests for Eglot, but it turned out somewhat more generic and works
> nicely with or without Eglot. I recently cleaned it up a little and
> implemented some pendingfeature requests like faces and mouse stuff.
>
> There are a few few TODOs/FIXMEs to help out with, of course.
>
> Here's the patch for elpa.git
>
> diff --git a/elpa-packages b/elpa-packages
> index 7bbf35a..cfceb7e 100644
> --- a/elpa-packages
> +++ b/elpa-packages
> @@ -99,6 +99,9 @@
> (bnf-mode :url "https://github.com/sergeyklay/bnf-mode")
> (boxy :url "https://gitlab.com/tygrdev/boxy")
> (boxy-headings :url "https://gitlab.com/tygrdev/boxy-headings")
> + (breadcrumb :url "https://github.com/joaotavora/breadcrumb"
> + :readme "README.md"
Are you sure you want to use the README.md file to generate the package
description, or wouldn't you rather rely on the Commentary section?
Having a "Screenshot" heading followed by nothing might look weird.
> + :ignored-files ("screenshot.png"))
If possible, it would be nice to track this on your end with a
.elpaignore file.
> (brief :url nil)
> (buffer-env :url "https://github.com/astoff/buffer-env")
> (buffer-expose :url "https://github.com/clemera/buffer-expose")
next prev parent reply other threads:[~2023-09-04 20:47 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-09-04 20:34 [ELPA] New package: breadcrumb.el João Távora
2023-09-04 20:47 ` Philip Kaludercic [this message]
2023-09-04 20:56 ` João Távora
2023-09-05 6:21 ` Philip Kaludercic
2023-09-05 9:16 ` João Távora
2023-09-05 10:16 ` Philip Kaludercic
2023-09-05 10:22 ` João Távora
2023-09-05 15:58 ` Jonas Bernoulli
2023-09-05 16:41 ` João Távora
2023-09-05 16:54 ` Sebastian Miele
2023-09-05 16:55 ` Philip Kaludercic
2023-09-05 17:00 ` João Távora
2023-09-05 17:39 ` Philip Kaludercic
2023-09-05 17:42 ` João Távora
2023-09-05 21:35 ` Jonas Bernoulli
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=87cyyx7jjk.fsf@posteo.net \
--to=philipk@posteo.net \
--cc=emacs-devel@gnu.org \
--cc=joaotavora@gmail.com \
/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).