Re: [ELPA] New package: breadcrumb.el

[Philip Kaludercic]

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";)