bug#47287: 28.0.50; [PATCH] Add command project-remove-known-project

bug#47287: 28.0.50; [PATCH] Add command project-remove-known-project

[Theodor Thornhill via Bug reports for GNU Emacs, the Swiss army knife of text editors]

[-- Attachment #1: Type: text/plain, Size: 538 bytes --]


Hello!

This patch adds an interactive command 'project-remove-known-project',
that lets the user interactively remove a project from the project
list.  My usecase is that sometimes when a directory is moved, the
project isn't deleted from the list.

This command is modelled after the already present
'project--remove-from-project-list', but that function isn't
interactive, and also has a specific purpose.

I did not add a binding, nor add it to the
project-switch-commands. Unsure if deserves a spot there :).

--
Theodor Thornhill


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Add-command-project-remove-known-project.patch --]
[-- Type: text/x-patch, Size: 1901 bytes --]

From 60992f4f6c4a7e9bc876f5546e7316f3fea0bf59 Mon Sep 17 00:00:00 2001
From: Theodor Thornhill <theo@thornhill.no>
Date: Sun, 21 Mar 2021 00:23:28 +0100
Subject: [PATCH] Add command project-remove-known-project

* etc/NEWS: Add information about new command.
* lisp/progmodes/project.el (project-remove-known-project): New
command that allows deleting of known projects from the project list.
---
 etc/NEWS                  |  5 +++++
 lisp/progmodes/project.el | 11 +++++++++++
 2 files changed, 16 insertions(+)

diff --git a/etc/NEWS b/etc/NEWS
index c602166397..20017ea30b 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -1573,6 +1573,11 @@ project's root directory, respectively.
 +++
 *** New user option 'project-list-file'.
 
++++
+*** New command 'project-remove-known-project'.  
+This command lets you interactively remove an entry from the list of projects
+in 'project-list-file'
+
 ** xref
 
 ---
diff --git a/lisp/progmodes/project.el b/lisp/progmodes/project.el
index bd552c917a..a9db511b46 100644
--- a/lisp/progmodes/project.el
+++ b/lisp/progmodes/project.el
@@ -1228,6 +1228,17 @@ from the list."
     (message "Project `%s' not found; removed from list" pr-dir)
     (project--write-project-list)))
 
+;;;###autoload
+(defun project-remove-known-project (dir)
+  "Remove directory DIR, a known project from the project list. 
+Announce the projects removal from the `project-list-file'."
+  (interactive (list (project-prompt-project-dir)))
+  (project--ensure-read-project-list)
+  (when-let ((ent (assoc dir project--list)))
+    (setq project--list (delq ent project--list))
+    (message "Project `%s' removed from known projects" dir)
+    (project--write-project-list)))
+
 (defun project-prompt-project-dir ()
   "Prompt the user for a directory that is one of the known project roots.
 The project is chosen among projects known from the project list,
-- 
2.24.3 (Apple Git-128)

bug#47287: 28.0.50; [PATCH] Add command project-remove-known-project

[Dmitry Gutov]

Hi!

On 21.03.2021 01:28, Theodor Thornhill via Bug reports for GNU Emacs, 
the Swiss army knife of text editors wrote:
> This patch adds an interactive command 'project-remove-known-project',
> that lets the user interactively remove a project from the project
> list.  My usecase is that sometimes when a directory is moved, the
> project isn't deleted from the list.

What if we added an "inventorization" step in 
project--ensure-read-project-list? After having the list read, it could 
remove entries that do not exist anymore (and, if the list has been 
modified in this procedure, call project--write-project-list).

This should take care of moved directories, at least once per Emacs session.

> This command is modelled after the already present
> 'project--remove-from-project-list', but that function isn't
> interactive, and also has a specific purpose.

If the logic described above still doesn't satisfy your needs, let's add 
a command, sure.

 > I did not add a binding, nor add it to the
 > project-switch-commands. Unsure if deserves a spot there.

I don't know about a binding, but certainly it's not for 
project-switch-commands.

bug#47287: 28.0.50; [PATCH] Add command project-remove-known-project

[Theodor Thornhill via Bug reports for GNU Emacs, the Swiss army knife of text editors]

>> This patch adds an interactive command 'project-remove-known-project',
>> that lets the user interactively remove a project from the project
>> list.  My usecase is that sometimes when a directory is moved, the
>> project isn't deleted from the list.
> 
> What if we added an "inventorization" step in project--ensure-read-project-list? After having the list read, it could remove entries that do not exist anymore (and, if the list has been modified in this procedure, call project--write-project-list).
> 
> This should take care of moved directories, at least once per Emacs session.
> 

Yeah, we could! However, there is one more use case: at work we have lot of repos, some I touch every day, some once in a blue moon. I do not want them cluttering the project-list, so I would rather delete them, and have them  automatically appear for periods where I actually use them. Same with other FOSS projects I only ocasionally contribute to. These are directories I usually dont delete from my drive. 


>> This command is modelled after the already present
>> 'project--remove-from-project-list', but that function isn't
>> interactive, and also has a specific purpose.
> 
> I don't know about a binding, but certainly it's not for project-switch-commands.

Agreed :)

—
Theo

bug#47287: 28.0.50; [PATCH] Add command project-remove-known-project

[Dmitry Gutov]

On 21.03.2021 08:33, Theodor Thornhill via Bug reports for GNU Emacs, 
the Swiss army knife of text editors wrote:
> However, there is one more use case: at work we have lot of repos, some I touch every day, some once in a blue moon. I do not want them cluttering the project-list, so I would rather delete them, and have them  automatically appear for periods where I actually use them. Same with other FOSS projects I only ocasionally contribute to. These are directories I usually dont delete from my drive.

Sure, makes sense.

bug#47287: 28.0.50; [PATCH] Add command project-remove-known-project

[Eli Zaretskii]

> Date: Sun, 21 Mar 2021 00:28:24 +0100
> From:  Theodor Thornhill via "Bug reports for GNU Emacs,
>  the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
> 
> This patch adds an interactive command 'project-remove-known-project',
> that lets the user interactively remove a project from the project
> list.  My usecase is that sometimes when a directory is moved, the
> project isn't deleted from the list.

Thanks.  I'll let Dmitry and others comment about the command itself,
but a couple of minor nits, mainly regarding documentation:

> ++++
> +*** New command 'project-remove-known-project'.  
> +This command lets you interactively remove an entry from the list of projects
> +in 'project-list-file'
> +

The "+++" mark means that the manuals have been updated for this
change, but the patch doesn't include any change for the manuals.  If
this command is accepted, I do think it should be mentioned in the
user manual.

> +(defun project-remove-known-project (dir)
> +  "Remove directory DIR, a known project from the project list. 

This sounds somewhat confusingly: is DIR a project or a directory?
Can this be rephrased to avoid the confusion?

> +Announce the projects removal from the `project-list-file'."
                ^^^^^^^^
"project's".  And I'm not sure this part is needed in the doc string.
And the message itself perhaps should be suppressed if the function is
called non-interactively?

> This command is modelled after the already present
> 'project--remove-from-project-list', but that function isn't
> interactive, and also has a specific purpose.

So why doesn't your implementation call that function?

bug#47287: 28.0.50; [PATCH] Add command project-remove-known-project

[Theodor Thornhill via Bug reports for GNU Emacs, the Swiss army knife of text editors]

Hi and thanks for your comments - I will address them in the next patch.

>> This command is modelled after the already present
>> 'project--remove-from-project-list', but that function isn't
>> interactive, and also has a specific purpose.
> 
> So why doesn't your implementation call that function?


Mainly since the message seems specialized, and I didnt want to alter existing, used behavior. It isnt the best reason, and I can alter it if we want :)

—
Theo

bug#47287: 28.0.50; [PATCH] Add command project-remove-known-project

[Dmitry Gutov]

On 21.03.2021 08:38, Theodor Thornhill via Bug reports for GNU Emacs, 
the Swiss army knife of text editors wrote:
> Mainly since the message seems specialized, and I didnt want to alter existing, used behavior.

Perhaps we can move the 'message' call from it to its current caller 
(project-current).

bug#47287: 28.0.50; [PATCH] Add command project-remove-known-project

[Theodor Thornhill via Bug reports for GNU Emacs, the Swiss army knife of text editors]

Dmitry Gutov <dgutov@yandex.ru> writes:

> On 21.03.2021 08:38, Theodor Thornhill via Bug reports for GNU Emacs, 
> the Swiss army knife of text editors wrote:
>> Mainly since the message seems specialized, and I didnt want to alter existing, used behavior.
>
> Perhaps we can move the 'message' call from it to its current caller 
> (project-current).

Sure!

bug#47287: 28.0.50; [PATCH] Add command project-remove-known-project

[Theodor Thornhill via Bug reports for GNU Emacs, the Swiss army knife of text editors]

[-- Attachment #1: Type: text/plain, Size: 393 bytes --]


Hi,

>> Mainly since the message seems specialized, and I didnt want to alter existing, used behavior.
>
> Perhaps we can move the 'message' call from it to its current caller 
> (project-current).

See attached, improved patch, hopefully adressing Elis comments, and
using the already defined function. I did not yet add a manual entry.

Does this approach seem reasonable to you?

--
Theo


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Add-command-project-remove-known-project.patch --]
[-- Type: text/x-patch, Size: 3048 bytes --]

From 45245b872982f50c2093fda0c797b6dad7d205ed Mon Sep 17 00:00:00 2001
From: Theodor Thornhill <theo@thornhill.no>
Date: Mon, 22 Mar 2021 00:19:23 +0100
Subject: [PATCH] Add command project-remove-known-project

* etc/NEWS: Mention the new command.

* lisp/progmodes/project.el (project--remove-from-project-list): Add
new argument, report-message, used to signal various messages when
removal has happened.

* lisp/progmodes/project.el (project-remove-known-project): New
command that removes the selected directory from the project-list-file.

* lisp/progmodes/project.el (project-current): Add the report message.
---
 etc/NEWS                  |  4 ++++
 lisp/progmodes/project.el | 18 ++++++++++++++----
 2 files changed, 18 insertions(+), 4 deletions(-)

diff --git a/etc/NEWS b/etc/NEWS
index 49a4bb8106..abe7107f12 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -1573,6 +1573,10 @@ project's root directory, respectively.
 +++
 *** New user option 'project-list-file'.
 
+*** New command 'project-remove-known-project'.
+This command lets you interactively remove an entry from the list of projects
+in 'project-list-file'
+
 ** xref
 
 ---
diff --git a/lisp/progmodes/project.el b/lisp/progmodes/project.el
index b6a886f731..b3d49c288e 100644
--- a/lisp/progmodes/project.el
+++ b/lisp/progmodes/project.el
@@ -201,7 +201,8 @@ of the project instance object."
     (when maybe-prompt
       (if pr
           (project-remember-project pr)
-        (project--remove-from-project-list directory)
+        (project--remove-from-project-list
+         directory "Project `%s' not found; removed from list")
         (setq pr (cons 'transient directory))))
     pr))
 
@@ -1217,17 +1218,26 @@ Save the result in `project-list-file' if the list of projects has changed."
       (push (list dir) project--list)
       (project--write-project-list))))
 
-(defun project--remove-from-project-list (pr-dir)
+(defun project--remove-from-project-list (pr-dir report-message)
   "Remove directory PR-DIR of a missing project from the project list.
 If the directory was in the list before the removal, save the
 result in `project-list-file'.  Announce the project's removal
-from the list."
+from the list using REPORT-MESSAGE."
   (project--ensure-read-project-list)
   (when-let ((ent (assoc pr-dir project--list)))
     (setq project--list (delq ent project--list))
-    (message "Project `%s' not found; removed from list" pr-dir)
+    (message report-message pr-dir)
     (project--write-project-list)))
 
+;;;###autoload
+(defun project-remove-known-project (pr-dir)
+  "Remove directory PR-DIR from the project-list.
+PR-DIR is the root-directory of a known project listed in the
+project list."
+  (interactive (list (project-prompt-project-dir)))
+  (project--remove-from-project-list
+   dir "Project `%s' removed from known projects"))
+
 (defun project-prompt-project-dir ()
   "Prompt the user for a directory that is one of the known project roots.
 The project is chosen among projects known from the project list,
-- 
2.24.3 (Apple Git-128)

bug#47287: 28.0.50; [PATCH] Add command project-remove-known-project

[Dmitry Gutov]

On 22.03.2021 01:21, Theodor Thornhill via Bug reports for GNU Emacs, 
the Swiss army knife of text editors wrote:
> Does this approach seem reasonable to you?

It's fine, but it would be better for both function's argument to follow 
projectile-add-known-project (meaning, call it 'project-root').

Regarding report-message, I figured it would just be a separate 
'message' call in both caller functions. Apparently that might to this 
message appearing more often (due to the requested project not actually 
appearing in project--list?), but I wonder if we shouldn't replace that 
when-let with a presence assertion instead.

Anyway, the latter is not a big deal; project--remove-from-project-list 
can be changed at any time later.

bug#47287: 28.0.50; [PATCH] Add command project-remove-known-project

[Theodor Thornhill via Bug reports for GNU Emacs, the Swiss army knife of text editors]

[-- Attachment #1: Type: text/plain, Size: 837 bytes --]

Hi,
> It's fine, but it would be better for both function's argument to follow 
> projectile-add-known-project (meaning, call it 'project-root').

See attached patch.

>
> Regarding report-message, I figured it would just be a separate 
> 'message' call in both caller functions. Apparently that might to this 
> message appearing more often (due to the requested project not actually 
> appearing in project--list?), but I wonder if we shouldn't replace that 
> when-let with a presence assertion instead.

Yeah, we could do that. However, the nice thing now is at least that the
behavior is bundled together, so we don't need to remember to
report. Not sure what is best :)

>
> Anyway, the latter is not a big deal; project--remove-from-project-list 
> can be changed at any time later.

Sure! Do the manual later, or now?

--
Theo



[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Add-command-project-remove-known-project.patch --]
[-- Type: text/x-patch, Size: 3216 bytes --]

From 78f9aea9d96373721e2590cd79eef360bbc93f0d Mon Sep 17 00:00:00 2001
From: Theodor Thornhill <theo@thornhill.no>
Date: Mon, 22 Mar 2021 00:19:23 +0100
Subject: [PATCH] Add command project-remove-known-project

* etc/NEWS: Mention the new command.

* lisp/progmodes/project.el (project--remove-from-project-list): Add
new argument, report-message, used to signal various messages when
removal has happened.

* lisp/progmodes/project.el (project-remove-known-project): New
command that removes the selected directory from the project-list-file.

* lisp/progmodes/project.el (project-current): Add the report message.
---
 etc/NEWS                  |  4 ++++
 lisp/progmodes/project.el | 22 ++++++++++++++++------
 2 files changed, 20 insertions(+), 6 deletions(-)

diff --git a/etc/NEWS b/etc/NEWS
index 49a4bb8106..abe7107f12 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -1573,6 +1573,10 @@ project's root directory, respectively.
 +++
 *** New user option 'project-list-file'.
 
+*** New command 'project-remove-known-project'.
+This command lets you interactively remove an entry from the list of projects
+in 'project-list-file'
+
 ** xref
 
 ---
diff --git a/lisp/progmodes/project.el b/lisp/progmodes/project.el
index b6a886f731..d76bcbbe96 100644
--- a/lisp/progmodes/project.el
+++ b/lisp/progmodes/project.el
@@ -201,7 +201,8 @@ of the project instance object."
     (when maybe-prompt
       (if pr
           (project-remember-project pr)
-        (project--remove-from-project-list directory)
+        (project--remove-from-project-list
+         directory "Project `%s' not found; removed from list")
         (setq pr (cons 'transient directory))))
     pr))
 
@@ -1217,17 +1218,26 @@ Save the result in `project-list-file' if the list of projects has changed."
       (push (list dir) project--list)
       (project--write-project-list))))
 
-(defun project--remove-from-project-list (pr-dir)
-  "Remove directory PR-DIR of a missing project from the project list.
+(defun project--remove-from-project-list (project-root report-message)
+  "Remove directory PROJECT-ROOT of a missing project from the project list.
 If the directory was in the list before the removal, save the
 result in `project-list-file'.  Announce the project's removal
-from the list."
+from the list using REPORT-MESSAGE."
   (project--ensure-read-project-list)
-  (when-let ((ent (assoc pr-dir project--list)))
+  (when-let ((ent (assoc project-root project--list)))
     (setq project--list (delq ent project--list))
-    (message "Project `%s' not found; removed from list" pr-dir)
+    (message report-message project-root)
     (project--write-project-list)))
 
+;;;###autoload
+(defun project-remove-known-project (project-root)
+  "Remove directory PROJECT-ROOT from the project list.
+PROJECT-ROOT is the root directory of a known project listed in
+the project list."
+  (interactive (list (project-prompt-project-dir)))
+  (project--remove-from-project-list
+   dir "Project `%s' removed from known projects"))
+
 (defun project-prompt-project-dir ()
   "Prompt the user for a directory that is one of the known project roots.
 The project is chosen among projects known from the project list,
-- 
2.24.3 (Apple Git-128)

bug#47287: 28.0.50; [PATCH] Add command project-remove-known-project

[Dmitry Gutov]

On 22.03.2021 09:48, Theodor Thornhill via Bug reports for GNU Emacs, 
the Swiss army knife of text editors wrote:
>> It's fine, but it would be better for both function's argument to follow
>> projectile-add-known-project (meaning, call it 'project-root').
> See attached patch.

Thanks, LGTM.

>> Regarding report-message, I figured it would just be a separate
>> 'message' call in both caller functions. Apparently that might to this
>> message appearing more often (due to the requested project not actually
>> appearing in project--list?), but I wonder if we shouldn't replace that
>> when-let with a presence assertion instead.
> Yeah, we could do that. However, the nice thing now is at least that the
> behavior is bundled together, so we don't need to remember to
> report. Not sure what is best:)

Yeah, ok.

>> Anyway, the latter is not a big deal; project--remove-from-project-list
>> can be changed at any time later.
> Sure! Do the manual later, or now?

It's the next step, yes.

bug#47287: 28.0.50; [PATCH] Add command project-remove-known-project

[Theodor Thornhill via Bug reports for GNU Emacs, the Swiss army knife of text editors]

[-- Attachment #1: Type: text/plain, Size: 240 bytes --]


> Thanks, LGTM.
>
Great!

>>> Anyway, the latter is not a big deal; project--remove-from-project-list
>>> can be changed at any time later.
>> Sure! Do the manual later, or now?
>
> It's the next step, yes.

Something like this?

--
Theo


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Add-command-project-remove-known-project.patch --]
[-- Type: text/x-patch, Size: 4339 bytes --]

From adf4d92e5cea6183666611757f647c607f633bc0 Mon Sep 17 00:00:00 2001
From: Theodor Thornhill <theo@thornhill.no>
Date: Mon, 22 Mar 2021 00:19:23 +0100
Subject: [PATCH] Add command project-remove-known-project

* etc/NEWS: Mention the new command.

* lisp/progmodes/project.el (project--remove-from-project-list): Add
new argument, report-message, used to signal various messages when
removal has happened.

* lisp/progmodes/project.el (project-remove-known-project): New
command that removes the selected directory from the project-list-file.

* lisp/progmodes/project.el (project-current): Add the report message.

* doc/emacs/maintaining.text: Add information about the new command to
the manual.
---
 doc/emacs/maintaining.texi | 16 ++++++++++++++++
 etc/NEWS                   |  4 ++++
 lisp/progmodes/project.el  | 22 ++++++++++++++++------
 3 files changed, 36 insertions(+), 6 deletions(-)

diff --git a/doc/emacs/maintaining.texi b/doc/emacs/maintaining.texi
index 2750418871..7e449a5c25 100644
--- a/doc/emacs/maintaining.texi
+++ b/doc/emacs/maintaining.texi
@@ -1843,6 +1843,22 @@ in the menu, and which key invokes each command.
 records the list of known projects.  It defaults to the file
 @file{projects} in @code{user-emacs-directory} (@pxref{Find Init}).
 
+@node Managing project list file
+@subsection Managing Projects
+
+@table @kbd
+@item M-x project-remove-known-project
+Remove a known project from the (@code{project-list-file}).
+@end table
+
+@findex project-remove-known-project
+  Normally Emacs handle adding and removing projects to the
+(@code{project-list-file}) automatically.  Sometimes you still want to
+manually edit the available
+projects. @kbd{M-x project-remove-known-project} will prompt you for the
+available projects, and upon selecting one, it will disappear from the
+@code{project-list-file}
+
 @node Change Log
 @section Change Logs
 
diff --git a/etc/NEWS b/etc/NEWS
index 49a4bb8106..abe7107f12 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -1573,6 +1573,10 @@ project's root directory, respectively.
 +++
 *** New user option 'project-list-file'.
 
+*** New command 'project-remove-known-project'.
+This command lets you interactively remove an entry from the list of projects
+in 'project-list-file'
+
 ** xref
 
 ---
diff --git a/lisp/progmodes/project.el b/lisp/progmodes/project.el
index b6a886f731..d76bcbbe96 100644
--- a/lisp/progmodes/project.el
+++ b/lisp/progmodes/project.el
@@ -201,7 +201,8 @@ of the project instance object."
     (when maybe-prompt
       (if pr
           (project-remember-project pr)
-        (project--remove-from-project-list directory)
+        (project--remove-from-project-list
+         directory "Project `%s' not found; removed from list")
         (setq pr (cons 'transient directory))))
     pr))
 
@@ -1217,17 +1218,26 @@ Save the result in `project-list-file' if the list of projects has changed."
       (push (list dir) project--list)
       (project--write-project-list))))
 
-(defun project--remove-from-project-list (pr-dir)
-  "Remove directory PR-DIR of a missing project from the project list.
+(defun project--remove-from-project-list (project-root report-message)
+  "Remove directory PROJECT-ROOT of a missing project from the project list.
 If the directory was in the list before the removal, save the
 result in `project-list-file'.  Announce the project's removal
-from the list."
+from the list using REPORT-MESSAGE."
   (project--ensure-read-project-list)
-  (when-let ((ent (assoc pr-dir project--list)))
+  (when-let ((ent (assoc project-root project--list)))
     (setq project--list (delq ent project--list))
-    (message "Project `%s' not found; removed from list" pr-dir)
+    (message report-message project-root)
     (project--write-project-list)))
 
+;;;###autoload
+(defun project-remove-known-project (project-root)
+  "Remove directory PROJECT-ROOT from the project list.
+PROJECT-ROOT is the root directory of a known project listed in
+the project list."
+  (interactive (list (project-prompt-project-dir)))
+  (project--remove-from-project-list
+   dir "Project `%s' removed from known projects"))
+
 (defun project-prompt-project-dir ()
   "Prompt the user for a directory that is one of the known project roots.
 The project is chosen among projects known from the project list,
-- 
2.24.3 (Apple Git-128)

bug#47287: 28.0.50; [PATCH] Add command project-remove-known-project

[Eli Zaretskii]

> From: Theodor Thornhill <theo@thornhill.no>
> Cc: 47287@debbugs.gnu.org
> Date: Mon, 22 Mar 2021 08:48:47 +0100
> 
> +(defun project--remove-from-project-list (project-root report-message)
> +  "Remove directory PROJECT-ROOT of a missing project from the project list.
>  If the directory was in the list before the removal, save the
>  result in `project-list-file'.  Announce the project's removal
> -from the list."
> +from the list using REPORT-MESSAGE."

Please be sure to say here that REPORT-MESSAGE is a format string
passed to 'message' as its first arg.

Thanks.

bug#47287: 28.0.50; [PATCH] Add command project-remove-known-project

[Theodor Thornhill via Bug reports for GNU Emacs, the Swiss army knife of text editors]

[-- Attachment #1: Type: text/plain, Size: 198 bytes --]

Eli Zaretskii <eliz@gnu.org> writes:

> Please be sure to say here that REPORT-MESSAGE is a format string
> passed to 'message' as its first arg.
>

Done. Fixed in attached patch

Thanks.

--
Theo


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Add-command-project-remove-known-project.patch --]
[-- Type: text/x-patch, Size: 4409 bytes --]

From fdcf9ff14bf6d60c9898d558d6409f1ca8a288c2 Mon Sep 17 00:00:00 2001
From: Theodor Thornhill <theo@thornhill.no>
Date: Mon, 22 Mar 2021 00:19:23 +0100
Subject: [PATCH] Add command project-remove-known-project

* etc/NEWS: Mention the new command.

* lisp/progmodes/project.el (project--remove-from-project-list): Add
new argument, report-message, used to signal various messages when
removal has happened.

* lisp/progmodes/project.el (project-remove-known-project): New
command that removes the selected directory from the project-list-file.

* lisp/progmodes/project.el (project-current): Add the report message.

* doc/emacs/maintaining.text: Add information about the new command to
the manual.
---
 doc/emacs/maintaining.texi | 16 ++++++++++++++++
 etc/NEWS                   |  4 ++++
 lisp/progmodes/project.el  | 23 +++++++++++++++++------
 3 files changed, 37 insertions(+), 6 deletions(-)

diff --git a/doc/emacs/maintaining.texi b/doc/emacs/maintaining.texi
index 2750418871..7e449a5c25 100644
--- a/doc/emacs/maintaining.texi
+++ b/doc/emacs/maintaining.texi
@@ -1843,6 +1843,22 @@ in the menu, and which key invokes each command.
 records the list of known projects.  It defaults to the file
 @file{projects} in @code{user-emacs-directory} (@pxref{Find Init}).
 
+@node Managing project list file
+@subsection Managing Projects
+
+@table @kbd
+@item M-x project-remove-known-project
+Remove a known project from the (@code{project-list-file}).
+@end table
+
+@findex project-remove-known-project
+  Normally Emacs handle adding and removing projects to the
+(@code{project-list-file}) automatically.  Sometimes you still want to
+manually edit the available
+projects. @kbd{M-x project-remove-known-project} will prompt you for the
+available projects, and upon selecting one, it will disappear from the
+@code{project-list-file}
+
 @node Change Log
 @section Change Logs
 
diff --git a/etc/NEWS b/etc/NEWS
index 49a4bb8106..abe7107f12 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -1573,6 +1573,10 @@ project's root directory, respectively.
 +++
 *** New user option 'project-list-file'.
 
+*** New command 'project-remove-known-project'.
+This command lets you interactively remove an entry from the list of projects
+in 'project-list-file'
+
 ** xref
 
 ---
diff --git a/lisp/progmodes/project.el b/lisp/progmodes/project.el
index b6a886f731..07842977ef 100644
--- a/lisp/progmodes/project.el
+++ b/lisp/progmodes/project.el
@@ -201,7 +201,8 @@ of the project instance object."
     (when maybe-prompt
       (if pr
           (project-remember-project pr)
-        (project--remove-from-project-list directory)
+        (project--remove-from-project-list
+         directory "Project `%s' not found; removed from list")
         (setq pr (cons 'transient directory))))
     pr))
 
@@ -1217,17 +1218,27 @@ Save the result in `project-list-file' if the list of projects has changed."
       (push (list dir) project--list)
       (project--write-project-list))))
 
-(defun project--remove-from-project-list (pr-dir)
-  "Remove directory PR-DIR of a missing project from the project list.
+(defun project--remove-from-project-list (project-root report-message)
+  "Remove directory PROJECT-ROOT of a missing project from the project list.
 If the directory was in the list before the removal, save the
 result in `project-list-file'.  Announce the project's removal
-from the list."
+from the list using REPORT-MESSAGE, which is a format string
+passed to `message' as its first argument."
   (project--ensure-read-project-list)
-  (when-let ((ent (assoc pr-dir project--list)))
+  (when-let ((ent (assoc project-root project--list)))
     (setq project--list (delq ent project--list))
-    (message "Project `%s' not found; removed from list" pr-dir)
+    (message report-message project-root)
     (project--write-project-list)))
 
+;;;###autoload
+(defun project-remove-known-project (project-root)
+  "Remove directory PROJECT-ROOT from the project list.
+PROJECT-ROOT is the root directory of a known project listed in
+the project list."
+  (interactive (list (project-prompt-project-dir)))
+  (project--remove-from-project-list
+   dir "Project `%s' removed from known projects"))
+
 (defun project-prompt-project-dir ()
   "Prompt the user for a directory that is one of the known project roots.
 The project is chosen among projects known from the project list,
-- 
2.24.3 (Apple Git-128)

bug#47287: 28.0.50; [PATCH] Add command project-remove-known-project

[Eli Zaretskii]

> From: Theodor Thornhill <theo@thornhill.no>
> Cc: dgutov@yandex.ru, 47287@debbugs.gnu.org
> Date: Tue, 23 Mar 2021 13:30:37 +0100
> 
> > Please be sure to say here that REPORT-MESSAGE is a format string
> > passed to 'message' as its first arg.
> >
> 
> Done. Fixed in attached patch

Thanks.

> +*** New command 'project-remove-known-project'.
> +This command lets you interactively remove an entry from the list of projects
> +in 'project-list-file'
> +

One last nit from me: since you now include the changes to the manual,
this NEWS entry should be marked by "+++" before it, per the note at
the beginning of NEWS.

bug#47287: 28.0.50; [PATCH] Add command project-remove-known-project

[Theodor Thornhill via Bug reports for GNU Emacs, the Swiss army knife of text editors]

[-- Attachment #1: Type: text/plain, Size: 225 bytes --]


>
> One last nit from me: since you now include the changes to the manual,
> this NEWS entry should be marked by "+++" before it, per the note at
> the beginning of NEWS.

Of course - added. Thanks for patience :)

--
Theo


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Add-command-project-remove-known-project.patch --]
[-- Type: text/x-patch, Size: 4415 bytes --]

From aca3a486b391f92b04ef2c9a16d5d5760062ec4b Mon Sep 17 00:00:00 2001
From: Theodor Thornhill <theo@thornhill.no>
Date: Mon, 22 Mar 2021 00:19:23 +0100
Subject: [PATCH] Add command project-remove-known-project

* etc/NEWS: Mention the new command.

* lisp/progmodes/project.el (project--remove-from-project-list): Add
new argument, report-message, used to signal various messages when
removal has happened.

* lisp/progmodes/project.el (project-remove-known-project): New
command that removes the selected directory from the project-list-file.

* lisp/progmodes/project.el (project-current): Add the report message.

* doc/emacs/maintaining.text: Add information about the new command to
the manual.
---
 doc/emacs/maintaining.texi | 16 ++++++++++++++++
 etc/NEWS                   |  5 +++++
 lisp/progmodes/project.el  | 23 +++++++++++++++++------
 3 files changed, 38 insertions(+), 6 deletions(-)

diff --git a/doc/emacs/maintaining.texi b/doc/emacs/maintaining.texi
index 2750418871..7e449a5c25 100644
--- a/doc/emacs/maintaining.texi
+++ b/doc/emacs/maintaining.texi
@@ -1843,6 +1843,22 @@ in the menu, and which key invokes each command.
 records the list of known projects.  It defaults to the file
 @file{projects} in @code{user-emacs-directory} (@pxref{Find Init}).
 
+@node Managing project list file
+@subsection Managing Projects
+
+@table @kbd
+@item M-x project-remove-known-project
+Remove a known project from the (@code{project-list-file}).
+@end table
+
+@findex project-remove-known-project
+  Normally Emacs handle adding and removing projects to the
+(@code{project-list-file}) automatically.  Sometimes you still want to
+manually edit the available
+projects. @kbd{M-x project-remove-known-project} will prompt you for the
+available projects, and upon selecting one, it will disappear from the
+@code{project-list-file}
+
 @node Change Log
 @section Change Logs
 
diff --git a/etc/NEWS b/etc/NEWS
index 49a4bb8106..638e457972 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -1573,6 +1573,11 @@ project's root directory, respectively.
 +++
 *** New user option 'project-list-file'.
 
++++
+*** New command 'project-remove-known-project'.
+This command lets you interactively remove an entry from the list of projects
+in 'project-list-file'
+
 ** xref
 
 ---
diff --git a/lisp/progmodes/project.el b/lisp/progmodes/project.el
index b6a886f731..07842977ef 100644
--- a/lisp/progmodes/project.el
+++ b/lisp/progmodes/project.el
@@ -201,7 +201,8 @@ of the project instance object."
     (when maybe-prompt
       (if pr
           (project-remember-project pr)
-        (project--remove-from-project-list directory)
+        (project--remove-from-project-list
+         directory "Project `%s' not found; removed from list")
         (setq pr (cons 'transient directory))))
     pr))
 
@@ -1217,17 +1218,27 @@ Save the result in `project-list-file' if the list of projects has changed."
       (push (list dir) project--list)
       (project--write-project-list))))
 
-(defun project--remove-from-project-list (pr-dir)
-  "Remove directory PR-DIR of a missing project from the project list.
+(defun project--remove-from-project-list (project-root report-message)
+  "Remove directory PROJECT-ROOT of a missing project from the project list.
 If the directory was in the list before the removal, save the
 result in `project-list-file'.  Announce the project's removal
-from the list."
+from the list using REPORT-MESSAGE, which is a format string
+passed to `message' as its first argument."
   (project--ensure-read-project-list)
-  (when-let ((ent (assoc pr-dir project--list)))
+  (when-let ((ent (assoc project-root project--list)))
     (setq project--list (delq ent project--list))
-    (message "Project `%s' not found; removed from list" pr-dir)
+    (message report-message project-root)
     (project--write-project-list)))
 
+;;;###autoload
+(defun project-remove-known-project (project-root)
+  "Remove directory PROJECT-ROOT from the project list.
+PROJECT-ROOT is the root directory of a known project listed in
+the project list."
+  (interactive (list (project-prompt-project-dir)))
+  (project--remove-from-project-list
+   dir "Project `%s' removed from known projects"))
+
 (defun project-prompt-project-dir ()
   "Prompt the user for a directory that is one of the known project roots.
 The project is chosen among projects known from the project list,
-- 
2.24.3 (Apple Git-128)

bug#47287: 28.0.50; [PATCH] Add command project-remove-known-project

[Dmitry Gutov]

On 23.03.2021 14:50, Theodor Thornhill via Bug reports for GNU Emacs, 
the Swiss army knife of text editors wrote:
> 
>>
>> One last nit from me: since you now include the changes to the manual,
>> this NEWS entry should be marked by "+++" before it, per the note at
>> the beginning of NEWS.
> 
> Of course - added. Thanks for patience :)

Thank you for following up.

Installed and closing.

bug#47287: 28.0.50; [PATCH] Add command project-remove-known-project

[Basil L. Contovounesios]

Dmitry Gutov <dgutov@yandex.ru> writes:

> On 23.03.2021 14:50, Theodor Thornhill via Bug reports for GNU Emacs, the Swiss
> army knife of text editors wrote:
>> 
>>> One last nit from me: since you now include the changes to the manual,
>>> this NEWS entry should be marked by "+++" before it, per the note at
>>> the beginning of NEWS.
>> Of course - added. Thanks for patience :)
>
> Thank you for following up.
>
> Installed and closing.

Thanks, this is a useful function I wished for recently.

But Texinfo still had some comments on the patch ;).

  ./maintaining.texi:1821: warning: node `Managing project list file' is
  next for `Switching Projects' in sectioning but not in menu
  ./maintaining.texi:1846: warning: node `Switching Projects' is prev
  for `Managing project list file' in sectioning but not in menu
  ./maintaining.texi:1846: warning: node `Projects' is up for `Managing
  project list file' in sectioning but not in menu
  ./maintaining.texi:1641: node `Projects' lacks menu item for `Managing
  project list file' despite being its Up target

Could you please add a menu entry for the new node?

(There also seem to be some extraneous parentheses around
@code{project-list-file}, a missing space after full stop, and a missing
full stop in the new text.)

Thanks,

-- 
Basil

bug#47287: 28.0.50; [PATCH] Add command project-remove-known-project

[Dmitry Gutov]

Hi Basil,

On 25.03.2021 02:03, Basil L. Contovounesios wrote:
> But Texinfo still had some comments on the patch;).
> 
>    ./maintaining.texi:1821: warning: node `Managing project list file' is
>    next for `Switching Projects' in sectioning but not in menu
>    ./maintaining.texi:1846: warning: node `Switching Projects' is prev
>    for `Managing project list file' in sectioning but not in menu
>    ./maintaining.texi:1846: warning: node `Projects' is up for `Managing
>    project list file' in sectioning but not in menu
>    ./maintaining.texi:1641: node `Projects' lacks menu item for `Managing
>    project list file' despite being its Up target
> 
> Could you please add a menu entry for the new node?

If you know how to fix any of that, help welcome.

bug#47287: 28.0.50; [PATCH] Add command project-remove-known-project

[Theodor Thornhill via Bug reports for GNU Emacs, the Swiss army knife of text editors]

I think i see whats missing - adding followup later today :)

—
Theodor

> 25. mar. 2021 kl. 02:04 skrev Dmitry Gutov <dgutov@yandex.ru>:
> 
> Hi Basil,
> 
>> On 25.03.2021 02:03, Basil L. Contovounesios wrote:
>> But Texinfo still had some comments on the patch;).
>>   ./maintaining.texi:1821: warning: node `Managing project list file' is
>>   next for `Switching Projects' in sectioning but not in menu
>>   ./maintaining.texi:1846: warning: node `Switching Projects' is prev
>>   for `Managing project list file' in sectioning but not in menu
>>   ./maintaining.texi:1846: warning: node `Projects' is up for `Managing
>>   project list file' in sectioning but not in menu
>>   ./maintaining.texi:1641: node `Projects' lacks menu item for `Managing
>>   project list file' despite being its Up target
>> Could you please add a menu entry for the new node?
> 
> If you know how to fix any of that, help welcome.

bug#47287: 28.0.50; [PATCH] Add command project-remove-known-project

[Theodor Thornhill via Bug reports for GNU Emacs, the Swiss army knife of text editors]

Theodor Thornhill <theo@thornhill.no> writes:
>> If you know how to fix any of that, help welcome.

Looks like it was fixed for me - thanks, Dmitry and Glenn Morris :-)

--
Theo

bug#47287: 28.0.50; [PATCH] Add command project-remove-known-project

[Dmitry Gutov]

Hi Theodor,

On 25.03.2021 09:29, Theodor Thornhill wrote:
> Theodor Thornhill <theo@thornhill.no> writes:
>>> If you know how to fix any of that, help welcome.
> 
> Looks like it was fixed for me - thanks, Dmitry and Glenn Morris :-)

Just a heads-up: I've pushed a commit renaming the command to 
'project-forget-project', for symmetry with 'project-remember-project' 
which has been with us longer.

No compatibility alias since it's never been in an Emacs release, and 
it's not a frequently used command, but let me know if it's really needed.

bug#47287: 28.0.50; [PATCH] Add command project-remove-known-project

[Theodor Thornhill via Bug reports for GNU Emacs, the Swiss army knife of text editors]

On September 21, 2021 3:24:35 PM GMT+02:00, Dmitry Gutov <dgutov@yandex.ru> wrote:
>Hi Theodor,
>
>On 25.03.2021 09:29, Theodor Thornhill wrote:
>> Theodor Thornhill <theo@thornhill.no> writes:
>>>> If you know how to fix any of that, help welcome.
>> 
>> Looks like it was fixed for me - thanks, Dmitry and Glenn Morris :-)
>
>Just a heads-up: I've pushed a commit renaming the command to 
>'project-forget-project', for symmetry with 'project-remember-project' 
>which has been with us longer.
>
>No compatibility alias since it's never been in an Emacs release, and 
>it's not a frequently used command, but let me know if it's really needed.

No need from my end, but thanks a lot for the heads up :)

Theo