Add #'projectile-track-known-projects-find-file-hook to 'buffer-list-update-hook

[jtamagnan]

Foreword

I originally created #1879 but have since deleted that GitHub account,
as such the associated repository and pull request were closed. The
new version of that PR can be found at #1894.

This PR implements Solution 2 as described in #1894.

Problem

There are certain modes for which the
projectile-find-file-hook-function function does not run by
default. This includes, shell, eshell, and magit. If one
navigates directly to one of these buffers and calls
projectile-relevant-known-projects while
projectile-current-project-on-switch is set to 'keep they will
notice that the first repository in the list is not the one that they
expect

Solution

There are two possible solutions that come immediately to mind. I
want to mention both of them for consideration though naturally
this PR only implements one of them:

1. Add a new 'front option for
   projectile-current-project-on-switch such that the first item is
   the project associated with the current buffer.
2. Modify projectile-mode to add the hook to
   buffer-list-update-hook such that the current buffer is always
   added to the list of known-projects.

This PR implements Solution 2.
#1894 implements Solution 1.

Comparision

The main drawback with Solution 1 is that the newly selected project
will not be added to the projects list.

The main drawback of Solutionk 2 is that it will not work on versions
of emacs earlier than 28.1 because buffer-list-update-hook works
differently.

---

Before submitting a PR make sure the following things have been done (and denote this
by checking the relevant checkboxes):

• The commits are consistent with our contribution guidelines
• You've added tests (if possible) to cover your change(s)
• All tests are passing (eldev test)
• The new code is not generating bytecode or M-x checkdoc warnings
• You've updated the changelog (if adding/changing user-visible functionality)
• You've updated the readme (if adding/changing user-visible functionality)

Thanks!

[bbatsov]

This solution is preferable to me, so let's go with it. I find it to be cleaner, and most Emacs users are likely using Emacs 28+ anyways.

[jtamagnan]

Thank you for the review

---

This solution is preferable to me, so let's go with it. I find it to be cleaner, and most Emacs users are likely using Emacs 28+ anyways.

Agreed, this one seems more robust. I've closed out the other pull-request.

---

I've pulled from upstream, added a code comment, and pushed the new commit. Hopefully it is in a better state now

[bbatsov]

Thanks!

[jtamagnan]

@bbatsov thank you for the package, the conversation, and the reviews

[dgutov]

Hi!

FWIW, this might be suboptimal because the "temporary" buffers that Emacs 28+ treats specially are just the ones that had been created with non-nil second (new and optional) argument to get-buffer-create.

Which probably means that the contents of this hook will still run in many cases of buffers created for "temporary" work. See company-mode/company-mode#1492 or the Org related commit above referencing this issue.