GNU bug report logs - #78099
[PATCH] Make 'project-remember-project' interactive

Previous Next

To reply to this bug, email your comments to 78099 AT debbugs.gnu.org.
There is no need to reopen the bug first.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Elijah Gabe Pérez <eg642616 <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: [PATCH] Make 'project-remember-project' interactive
Date: Sun, 27 Apr 2025 14:18:12 -0600

[Message part 1 (text/plain, inline)]

Tags: patch

Sometimes when creating a new project it is not added to project list.
AFAIK the only way to do it is using `project-remember-projects-under'
or `project-switch-project' but they are uncomfortable to use when you
just want to remember the current project you're in.

So I decided to make `project-remember-project' interactive in this
patch for archive this; this let to users use it in hooks (e.g
find-file-hook)

[0001-Make-project-remember-project-interactive.patch (text/x-patch, attachment)]

[Message part 3 (text/plain, inline)]

-- 
                                          - E.G via GNU Emacs and Org.

Message #8 received at 78099 <at> debbugs.gnu.org (full text, mbox):

From: Dmitry Gutov <dmitry <at> gutov.dev>
To: Elijah Gabe Pérez <eg642616 <at> gmail.com>,
 78099 <at> debbugs.gnu.org
Subject: Re: bug#78099: [PATCH] Make 'project-remember-project' interactive
Date: Mon, 28 Apr 2025 01:54:53 +0300

Hi!

On 27/04/2025 23:18, Elijah Gabe Pérez wrote:
> Sometimes when creating a new project it is not added to project list.
> AFAIK the only way to do it is using `project-remember-projects-under'
> or `project-switch-project' but they are uncomfortable to use when you
> just want to remember the current project you're in.

Please clarify the usage scenario. Doesn't it help to visit it just once?

Message #11 received at 78099 <at> debbugs.gnu.org (full text, mbox):

From: Elijah Gabe Pérez <eg642616 <at> gmail.com>
To: Dmitry Gutov <dmitry <at> gutov.dev>
Cc: 78099 <at> debbugs.gnu.org
Subject: Re: bug#78099: [PATCH] Make 'project-remember-project' interactive
Date: Sun, 27 Apr 2025 18:29:23 -0600

Dmitry Gutov <dmitry <at> gutov.dev> writes:

> Hi!
>
> On 27/04/2025 23:18, Elijah Gabe Pérez wrote:
>> Sometimes when creating a new project it is not added to project list.
>> AFAIK the only way to do it is using `project-remember-projects-under'
>> or `project-switch-project' but they are uncomfortable to use when you
>> just want to remember the current project you're in.
>
> Please clarify the usage scenario.

For example, visiting a new file (usually with `find-file') or importing
and opening a new project, you cannot be sure if it is already in the
project--list (or it was not added to project-list) unless you do
`project-switch-project' (which automatically index it), projectile have
a similar behavior (projectile-auto-update-cache), but it's very slow, so
one way i had to mimic this is this way.

A good use case would be adding it to `find-file-hook', so one would not
have to use `project-switch-project' for each new recent project.

Or for example if you are working in a remote project (not indexed) in
the current file you are in, instead using `project-remember-projects-under'
you can just type: M-x project-remember-project,
and in the current project you are working on gets indexed.

> Doesn't it help to visit it just once?

I don't understand this question well.

-- 
                                          - E.G via GNU Emacs and Org.

Message #14 received at 78099 <at> debbugs.gnu.org (full text, mbox):

From: Dmitry Gutov <dmitry <at> gutov.dev>
To: Elijah Gabe Pérez <eg642616 <at> gmail.com>
Cc: 78099 <at> debbugs.gnu.org
Subject: Re: bug#78099: [PATCH] Make 'project-remember-project' interactive
Date: Mon, 28 Apr 2025 03:35:23 +0300

On 28/04/2025 03:29, Elijah Gabe Pérez wrote:
> For example, visiting a new file (usually with `find-file') or importing
> and opening a new project, you cannot be sure if it is already in the
> project--list (or it was not added to project-list) unless you do
> `project-switch-project' (which automatically index it), projectile have
> a similar behavior (projectile-auto-update-cache), but it's very slow, so
> one way i had to mimic this is this way.

You're right. For it to be added to the list, you'd have to invoke a 
command in it which uses projects at least once (for example, 
project-find-file, 'C-x p f').

Not necessary to use project-switch-project, any command that calls 
(project-current t) will do.

Message #17 received at 78099 <at> debbugs.gnu.org (full text, mbox):

From: Elijah Gabe Pérez <eg642616 <at> gmail.com>
To: Dmitry Gutov <dmitry <at> gutov.dev>
Cc: 78099 <at> debbugs.gnu.org
Subject: Re: bug#78099: [PATCH] Make 'project-remember-project' interactive
Date: Sun, 27 Apr 2025 22:34:03 -0600

[Message part 1 (text/plain, inline)]

Dmitry Gutov <dmitry <at> gutov.dev> writes:

> On 28/04/2025 03:29, Elijah Gabe Pérez wrote:
> > For example, visiting a new file (usually with `find-file') or importing
> > and opening a new project, you cannot be sure if it is already in the
> > project--list (or it was not added to project-list) unless you do
> > `project-switch-project' (which automatically index it), projectile have
> > a similar behavior (projectile-auto-update-cache), but it's very slow, so
> > one way i had to mimic this is this way.
>
> You're right. For it to be added to the list, you'd have to invoke a
> command in it which uses projects at least once (for example,
> project-find-file, 'C-x p f').
>
> Not necessary to use project-switch-project, any command that calls
> (project-current t) will do.
>

Right, but all these commands will prompt for
select a project/file/directory, it is
exhausting to always have to press C-g to quit it.

In this case, the feature just display a message
whether if project was indexed or not (if called interactively)

[Message part 2 (text/html, inline)]

Message #20 received at 78099 <at> debbugs.gnu.org (full text, mbox):

From: Juri Linkov <juri <at> linkov.net>
To: Elijah Gabe Pérez <eg642616 <at> gmail.com>
Cc: Dmitry Gutov <dmitry <at> gutov.dev>, 78099 <at> debbugs.gnu.org
Subject: Re: bug#78099: [PATCH] Make 'project-remember-project' interactive
Date: Mon, 28 Apr 2025 18:03:34 +0300

> Sometimes when creating a new project it is not added to project list.
> AFAIK the only way to do it is using `project-remember-projects-under'
> or `project-switch-project' but they are uncomfortable to use when you
> just want to remember the current project you're in.
>
> So I decided to make `project-remember-project' interactive in this
> patch for archive this; this let to users use it in hooks (e.g
> find-file-hook)

For the same purpose I added an advice to functions like
'read-directory-name' and 'vc-dir' with the trick to
call 'project-current' that remembers a new project:

(define-advice vc-dir (:after (dir &optional _backend) add-project)
  (when (featurep 'project)
    ;; Add current vc project dir to project list
    (let ((default-directory dir))
      (project-current))))

But maybe `project-remember-project' would be more correct to use here.

Message #23 received at 78099 <at> debbugs.gnu.org (full text, mbox):

From: Dmitry Gutov <dmitry <at> gutov.dev>
To: Elijah Gabe Pérez <eg642616 <at> gmail.com>,
 78099 <at> debbugs.gnu.org
Subject: Re: bug#78099: [PATCH] Make 'project-remember-project' interactive
Date: Tue, 29 Apr 2025 04:39:15 +0300

On 27/04/2025 23:18, Elijah Gabe Pérez wrote:
> +  (interactive)

Something like

  (interactive (list (project-current t)))

should allow to keep PR a required argument.

Message #26 received at 78099 <at> debbugs.gnu.org (full text, mbox):

From: Dmitry Gutov <dmitry <at> gutov.dev>
To: Elijah Gabe Pérez <eg642616 <at> gmail.com>
Cc: 78099 <at> debbugs.gnu.org
Subject: Re: bug#78099: [PATCH] Make 'project-remember-project' interactive
Date: Tue, 29 Apr 2025 04:41:15 +0300

On 28/04/2025 07:34, Elijah Gabe Pérez wrote:
> Right, but all these commands will prompt for
> select a project/file/directory, it is
> exhausting to always have to press C-g to quit it.

So your scenario is to add a project but not do anything else 
project-related with it, at that time?

That's fine, I suppose.

> In this case, the feature just display a message
> whether if project was indexed or not (if called interactively)

No problem with that.

Message #29 received at 78099 <at> debbugs.gnu.org (full text, mbox):

From: Elijah Gabe Pérez <eg642616 <at> gmail.com>
To: Dmitry Gutov <dmitry <at> gutov.dev>
Cc: 78099 <at> debbugs.gnu.org
Subject: Re: bug#78099: [PATCH] Make 'project-remember-project' interactive
Date: Tue, 29 Apr 2025 18:38:05 -0600

[Message part 1 (text/plain, inline)]

Dmitry Gutov <dmitry <at> gutov.dev> writes:

> So your scenario is to add a project but not do anything else
> project-related with it, at that time?

Yes, so for not to break the default project-remember functionality.
In any case that's why exists the other project commands.

> On 27/04/2025 23:18, Elijah Gabe Pérez wrote:
>> +  (interactive)
>
> Something like
>
>   (interactive (list (project-current t)))
>
> should allow to keep PR a required argument.

Thanks, done:

[0001-Make-project-remember-project-interactive.patch (text/x-patch, attachment)]

[Message part 3 (text/plain, inline)]

-- 
                                          - E.G via GNU Emacs and Org.

Message #32 received at 78099 <at> debbugs.gnu.org (full text, mbox):

From: Dmitry Gutov <dmitry <at> gutov.dev>
To: Elijah Gabe Pérez <eg642616 <at> gmail.com>
Cc: 78099 <at> debbugs.gnu.org
Subject: Re: bug#78099: [PATCH] Make 'project-remember-project' interactive
Date: Thu, 15 May 2025 02:32:55 +0300

On 30/04/2025 03:38, Elijah Gabe Pérez wrote:
>> On 27/04/2025 23:18, Elijah Gabe Pérez wrote:
>>> +  (interactive)
>> Something like
>>
>>    (interactive (list (project-current t)))
>>
>> should allow to keep PR a required argument.
> Thanks, done:

How about this? Modulo reindentation.

diff --git a/lisp/progmodes/project.el b/lisp/progmodes/project.el
index 27b69277e81..e7ae7d282ab 100644
--- a/lisp/progmodes/project.el
+++ b/lisp/progmodes/project.el
@@ -1933,12 +1933,18 @@ project-remember-project
 If project PR satisfies `project-list-exclude', then nothing is done.
 Save the result in `project-list-file' if the list of projects
 has changed, and NO-WRITE is nil."
-  (let ((root (project-root pr)))
-    (unless (seq-some (lambda (r)
+  (interactive (list (project-current t)))
+  (let ((root (project-root pr))
+        (interact (called-interactively-p 'any)))
+    (if     (seq-some (lambda (r)
                         (if (functionp r)
                             (funcall r pr)
                           (string-match-p r root)))
                       project-list-exclude)
+        (when interact
+          (message "Current project is blacklisted!"))
+      (when interact
+        (message "Current project remembered"))
       (project--remember-dir root no-write))))

 (defun project--remove-from-project-list (project-root report-message)

Message #35 received at 78099 <at> debbugs.gnu.org (full text, mbox):

From: Elijah Gabe Pérez <eg642616 <at> gmail.com>
To: Dmitry Gutov <dmitry <at> gutov.dev>
Cc: 78099 <at> debbugs.gnu.org
Subject: Re: bug#78099: [PATCH] Make 'project-remember-project' interactive
Date: Wed, 14 May 2025 18:30:48 -0600

Dmitry Gutov <dmitry <at> gutov.dev> writes:

> On 30/04/2025 03:38, Elijah Gabe Pérez wrote:
>>> On 27/04/2025 23:18, Elijah Gabe Pérez wrote:
>>>> +  (interactive)
>>> Something like
>>>
>>>    (interactive (list (project-current t)))
>>>
>>> should allow to keep PR a required argument.
>> Thanks, done:
>
> How about this? Modulo reindentation.
>
> diff --git a/lisp/progmodes/project.el b/lisp/progmodes/project.el
> index 27b69277e81..e7ae7d282ab 100644
> --- a/lisp/progmodes/project.el
> +++ b/lisp/progmodes/project.el
> @@ -1933,12 +1933,18 @@ project-remember-project
>   If project PR satisfies `project-list-exclude', then nothing is done.
>   Save the result in `project-list-file' if the list of projects
>   has changed, and NO-WRITE is nil."
> -  (let ((root (project-root pr)))
> -    (unless (seq-some (lambda (r)
> +  (interactive (list (project-current t)))
> +  (let ((root (project-root pr))
> +        (interact (called-interactively-p 'any)))
> +    (if     (seq-some (lambda (r)
>                           (if (functionp r)
>                               (funcall r pr)
>                             (string-match-p r root)))
>                         project-list-exclude)
> +        (when interact
> +          (message "Current project is blacklisted!"))
> +      (when interact
> +        (message "Current project remembered"))
>         (project--remember-dir root no-write))))
>
>   (defun project--remove-from-project-list (project-root report-message)
>

LGTM, Maybe it is better to also add a message to indicate that the
project is already remembered, this would avoid having to re-remember
the project.

#+begin_src diff
@@ -1992,13 +1992,22 @@ project-remember-project
 If project PR satisfies `project-list-exclude', then nothing is done.
 Save the result in `project-list-file' if the list of projects
 has changed, and NO-WRITE is nil."
-  (let ((root (project-root pr)))
-    (unless (seq-some (lambda (r)
-                        (if (functionp r)
-                            (funcall r pr)
-                          (string-match-p r root)))
-                      project-list-exclude)
-      (project--remember-dir root no-write))))
+  (interactive (list (project-current t)))
+  (let ((root (project-root pr))
+        (interact (called-interactively-p 'any)))
+    (if (and (listp project--list) (assoc root project--list))
+        (when interact
+          (message "This project is already remembered"))
+      (if (seq-some (lambda (r)
+                      (if (functionp r)
+                          (funcall r pr)
+                        (string-match-p r root)))
+                    project-list-exclude)
+          (when interact
+            (message "Current project is blacklisted!"))
+        (when interact
+          (message "Current project remembered"))
+        (project--remember-dir root no-write)))))
 
 (defun project--remove-from-project-list (project-root report-message)
   "Remove directory PROJECT-ROOT of a missing project from the project list.
#+end_src

-- 
                                          - E.G via GNU Emacs and Org.

Message #38 received at 78099 <at> debbugs.gnu.org (full text, mbox):

From: Dmitry Gutov <dmitry <at> gutov.dev>
To: Elijah Gabe Pérez <eg642616 <at> gmail.com>
Cc: 78099 <at> debbugs.gnu.org
Subject: Re: bug#78099: [PATCH] Make 'project-remember-project' interactive
Date: Fri, 16 May 2025 02:05:39 +0300

On 15/05/2025 03:30, Elijah Gabe Pérez wrote:
> LGTM, Maybe it is better to also add a message to indicate that the
> project is already remembered, this would avoid having to re-remember
> the project.

It's not a no-op, though: if you invoke the function on such a project, 
it would move to the top of the list. Should be reject that?

Message #41 received at 78099 <at> debbugs.gnu.org (full text, mbox):

From: Elijah Gabe Pérez <eg642616 <at> gmail.com>
To: Dmitry Gutov <dmitry <at> gutov.dev>
Cc: 78099 <at> debbugs.gnu.org
Subject: Re: bug#78099: [PATCH] Make 'project-remember-project' interactive
Date: Thu, 15 May 2025 20:56:27 -0600

Dmitry Gutov <dmitry <at> gutov.dev> writes:

> On 15/05/2025 03:30, Elijah Gabe Pérez wrote:
>> LGTM, Maybe it is better to also add a message to indicate that the
>> project is already remembered, this would avoid having to re-remember
>> the project.
>
> It's not a no-op, though: if you invoke the function on such a
> project, it would move to the top of the list. Should be reject that?

Well, I don't know if the order of the list matters. If it does,
then your previous patch is fine.

-- 
                                          - E.G via GNU Emacs and Org.

Message #46 received at 78099-done <at> debbugs.gnu.org (full text, mbox):

From: Dmitry Gutov <dmitry <at> gutov.dev>
To: Elijah Gabe Pérez <eg642616 <at> gmail.com>
Cc: 78099-done <at> debbugs.gnu.org
Subject: Re: bug#78099: [PATCH] Make 'project-remember-project' interactive
Date: Thu, 29 May 2025 22:31:11 +0300

Version: 31.1

On 16/05/2025 05:56, Elijah Gabe Pérez wrote:
>> It's not a no-op, though: if you invoke the function on such a
>> project, it would move to the top of the list. Should be reject that?
> Well, I don't know if the order of the list matters. If it does,
> then your previous patch is fine.

I don't know either, but it might, for some.

I've installed that last version, let's wait and see if some will want 
more from this feature.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.