bug#43153: Add new command project-find-dir (and move binding of project-dired)

bug#43153: Add new command project-find-dir (and move binding of project-dired)

[Stefan Kangas]

Severity: wishlist

Please consider adding a new command `project-find-dir' that works like
`project-find-file' but for directories.

I would also suggest to move `project-dired to `C-c p D' and put the new
`project-find-dir' command on `C-c p d'.  These key bindings would be in
line with the third-party projectile package.

Thanks in advance.

bug#43153: Add new command project-find-dir (and move binding of project-dired)

[Dmitry Gutov]

Hi!

On 01.09.2020 13:48, Stefan Kangas wrote:
> Severity: wishlist
> 
> Please consider adding a new command `project-find-dir' that works like
> `project-find-file' but for directories.

Would you like to try your hand at the patch?

> I would also suggest to move `project-dired to `C-c p D' and put the new
> `project-find-dir' command on `C-c p d'.  These key bindings would be in
> line with the third-party projectile package.

Sounds good to me.

bug#43153: Add new command project-find-dir (and move binding of project-dired)

[Stefan Kangas]

Dmitry Gutov <dgutov@yandex.ru> writes:

> Would you like to try your hand at the patch?

A patch!?  I have written or two of them before, sure.
I could take a gander.

bug#43153: Add new command project-find-dir (and move binding of project-dired)

[Dmitry Gutov]

On 01.09.2020 18:32, Stefan Kangas wrote:
> Dmitry Gutov <dgutov@yandex.ru> writes:
> 
>> Would you like to try your hand at the patch?
> 
> A patch!?  I have written or two of them before, sure.
> I could take a gander.

Excellent. :-)

It should be straightforward. One moderately tricky issue is to how to 
generate a directory completion table from the return value of 
project-files (which returns only files, not directories).

Perhaps the simplest approach is to create a unique set of all parent 
directories of said files. It would omit empty directories, but oh well.

I'm not sure we want to create a new generic function (e.g. 
project-directories) just for that command, but it's also an option.

bug#43153: Add new command project-find-dir (and move binding of project-dired)

[Stefan Kangas]

Hi Dmitry,

Dmitry Gutov <dgutov@yandex.ru> writes:

> On 01.09.2020 13:48, Stefan Kangas wrote:
>> Severity: wishlist
>> Please consider adding a new command `project-find-dir' that works like
>> `project-find-file' but for directories.
>
> Would you like to try your hand at the patch?
>
>> I would also suggest to move `project-dired to `C-c p D' and put the new
>> `project-find-dir' command on `C-c p d'.  These key bindings would be in
>> line with the third-party projectile package.
>
> Sounds good to me.

It seems like I won't be able to have time to write this patch before
Emacs 28.1.

Could we move `project-dired' to `C-x p D' in Emacs 28.1, while awaiting
this new keybinding `C-x p d'?  Moving it later will be much harder.

bug#43153: Add new command project-find-dir (and move binding of project-dired)

[Juri Linkov]

>>> Please consider adding a new command `project-find-dir' that works like
>>> `project-find-file' but for directories.
>>
>> Would you like to try your hand at the patch?
>>
>>> I would also suggest to move `project-dired to `C-c p D' and put the new
>>> `project-find-dir' command on `C-c p d'.  These key bindings would be in
>>> line with the third-party projectile package.
>>
>> Sounds good to me.
>
> It seems like I won't be able to have time to write this patch before
> Emacs 28.1.
>
> Could we move `project-dired' to `C-x p D' in Emacs 28.1, while awaiting
> this new keybinding `C-x p d'?  Moving it later will be much harder.

If current `project-dired' actually means "project-root-dired",
then it makes sense to bind it to `C-x p D' like `C-x v D' (vc-root-diff).

bug#43153: Add new command project-find-dir (and move binding of project-dired)

[Stefan Kangas]

Juri Linkov <juri@linkov.net> writes:

>> Could we move `project-dired' to `C-x p D' in Emacs 28.1, while awaiting
>> this new keybinding `C-x p d'?  Moving it later will be much harder.
>
> If current `project-dired' actually means "project-root-dired",
> then it makes sense to bind it to `C-x p D' like `C-x v D' (vc-root-diff).

Does it makes sense to rename it, as well?

For the sake of completion I mention that the same command is named
`projectile-dired' in projectile, where it is bound here to `C-c p D'.
I believe you can use whatever prefix you want, though.

bug#43153: Add new command project-find-dir (and move binding of project-dired)

[Juri Linkov]

>>> Could we move `project-dired' to `C-x p D' in Emacs 28.1, while awaiting
>>> this new keybinding `C-x p d'?  Moving it later will be much harder.
>>
>> If current `project-dired' actually means "project-root-dired",
>> then it makes sense to bind it to `C-x p D' like `C-x v D' (vc-root-diff).
>
> Does it makes sense to rename it, as well?
>
> For the sake of completion I mention that the same command is named
> `projectile-dired' in projectile, where it is bound here to `C-c p D'.
> I believe you can use whatever prefix you want, though.

Maybe then better to rename `project-dired' to `project-root-dired',
then bind `C-x p D' to `project-root-dired' without the prompt,
and bind `project-dired' to `C-x p d' with a prompt that
asks for a directory like `C-x p f' (project-find-file).

bug#43153: Add new command project-find-dir (and move binding of project-dired)

[Stefan Kangas]

Juri Linkov <juri@linkov.net> writes:

> Maybe then better to rename `project-dired' to `project-root-dired',
> then bind `C-x p D' to `project-root-dired' without the prompt,
> and bind `project-dired' to `C-x p d' with a prompt that
> asks for a directory like `C-x p f' (project-find-file).

Agreed.  Let's see what Dmitry thinks about it.

bug#43153: Add new command project-find-dir (and move binding of project-dired)

[Dmitry Gutov]

Hi all!

On 19.09.2021 23:42, Stefan Kangas wrote:
> Juri Linkov<juri@linkov.net>  writes:
> 
>> Maybe then better to rename `project-dired' to `project-root-dired',
>> then bind `C-x p D' to `project-root-dired' without the prompt,
>> and bind `project-dired' to `C-x p d' with a prompt that
>> asks for a directory like `C-x p f' (project-find-file).
> Agreed.  Let's see what Dmitry thinks about it.

Here's a quick implementation of this feature inside project-dired:

diff --git a/lisp/progmodes/project.el b/lisp/progmodes/project.el
index 563b9c3c90..3a21cc15a4 100644
--- a/lisp/progmodes/project.el
+++ b/lisp/progmodes/project.el
@@ -963,7 +963,18 @@ project--completing-read-strict
  (defun project-dired ()
    "Start Dired in the current project's root."
    (interactive)
-  (dired (project-root (project-current t))))
+  (let* ((project (project-current t))
+         (all-files (project-files (project-current)))
+         (completion-ignore-case read-file-name-completion-ignore-case)
+         ;; FIXME: This misses directories without any files directly
+         ;; inside.  Consider DIRS-ONLY as an argument for
+         ;; `project-files-filtered', and see
+         ;; https://stackoverflow.com/a/50685235/615245 for possible
+         ;; implementation.
+         (all-dirs (mapcar #'file-name-directory all-files))
+         (dir (funcall project-read-file-name-function
+                       "Dired" all-dirs nil nil)))
+    (dired dir)))

  ;;;###autoload
  (defun project-vc-dir ()


It's a little flawed, but that shouldn't stop us from installing it.

Note that the user can simply press RET without typing any directory 
name and that will launch Dired in the project root.

That seems like it might make having a separate command unnecessary, 
since 'C-x p D' and 'C-x p d RET' take the same number of keypresses. 
The latter might make you move your hand farther, though.

But I don't mind having a separate command if you both think it's a good 
idea. Then we either call it project-root-dired, and this new one -- 
just project-dired. Or we move project-dired to 'C-x p D' without 
changing it, and add this functionality in 'project-find-dir', bound to 
'C-x p d'.

OTOH, it might make sense to keep 'project-dired' on 'C-x p d' and move 
project-find-dir to 'C-x p D' because the users of the latter must be 
prepared to do more typing anyway during completion, so having to also 
press Shift once won't hurt their efficiency much. But compatibility 
with Projectile can be important, too.

Cast your votes, everybody ;-)

bug#43153: Add new command project-find-dir (and move binding of project-dired)

[Juri Linkov]

> Here's a quick implementation of this feature inside project-dired:

Thanks, I tried it and everything's working as expected.

> Note that the user can simply press RET without typing any directory name
> and that will launch Dired in the project root.

This is a nice feature.

> That seems like it might make having a separate command unnecessary, since
> 'C-x p D' and 'C-x p d RET' take the same number of keypresses. The latter
> might make you move your hand farther, though.

We had such discussion about 'C-x v d' where the request
was for a command that doesn't require RET.  But 'C-x v D'
can't be used because it's bound to 'vc-root-diff'.

BTW, I have such customization:

  (define-key project-prefix-map "V" vc-prefix-map)

to allow vc commands in a project, e.g. 'C-x p V D' for 'vc-root-diff'.

bug#43153: Add new command project-find-dir (and move binding of project-dired)

[Stefan Kangas]

Dmitry Gutov <dgutov@yandex.ru> writes:

> Here's a quick implementation of this feature inside project-dired:

Thanks!  I don't currently have time to test it, but I'm sure it is very
good.

Let me know if you think that testing would be useful, and I'll be glad
to help when I can find some time.

> OTOH, it might make sense to keep 'project-dired' on 'C-x p d' and move
> project-find-dir to 'C-x p D' because the users of the latter must be
> prepared to do more typing anyway during completion, so having to also
> press Shift once won't hurt their efficiency much. But compatibility
> with Projectile can be important, too.
>
> Cast your votes, everybody ;-)

I don't see one way as fundamentally better than the other, so IMHO it's
better to just have the same UI as projectile.

bug#43153: Add new command project-find-dir (and move binding of project-dired)

[Dmitry Gutov]

On 20.09.2021 09:54, Juri Linkov wrote:
>> Here's a quick implementation of this feature inside project-dired:
> 
> Thanks, I tried it and everything's working as expected.
> 
>> Note that the user can simply press RET without typing any directory name
>> and that will launch Dired in the project root.
> 
> This is a nice feature.
> 
>> That seems like it might make having a separate command unnecessary, since
>> 'C-x p D' and 'C-x p d RET' take the same number of keypresses. The latter
>> might make you move your hand farther, though.
> 
> We had such discussion about 'C-x v d' where the request
> was for a command that doesn't require RET.  But 'C-x v D'
> can't be used because it's bound to 'vc-root-diff'.

True.

> BTW, I have such customization:
> 
>    (define-key project-prefix-map "V" vc-prefix-map)
> 
> to allow vc commands in a project, e.g. 'C-x p V D' for 'vc-root-diff'.

Hmm. I'm not sure when I'd use it instead of the shorter 'C-x v D'.

When you are inside a Git submodule, maybe? It can make a difference. 
But then you have to be aware that the diff will not include changes in 
the submodules (just the changed summary hashes).

bug#43153: Add new command project-find-dir (and move binding of project-dired)

[Dmitry Gutov]

On 20.09.2021 10:11, Stefan Kangas wrote:
> Dmitry Gutov <dgutov@yandex.ru> writes:
> 
>> Here's a quick implementation of this feature inside project-dired:
> 
> Thanks!  I don't currently have time to test it, but I'm sure it is very
> good.
> 
> Let me know if you think that testing would be useful, and I'll be glad
> to help when I can find some time.

No, it's all right. It seems functional (though it will likely be more 
sluggish with medium-large size projects), and the main caveat is 
already documented. We'll get more testing from the users, too.

>> OTOH, it might make sense to keep 'project-dired' on 'C-x p d' and move
>> project-find-dir to 'C-x p D' because the users of the latter must be
>> prepared to do more typing anyway during completion, so having to also
>> press Shift once won't hurt their efficiency much. But compatibility
>> with Projectile can be important, too.
>>
>> Cast your votes, everybody ;-)
> 
> I don't see one way as fundamentally better than the other, so IMHO it's
> better to just have the same UI as projectile.

OK, that makes sense. Easier transition, etc.

bug#43153: Add new command project-find-dir (and move binding of project-dired)

[Juri Linkov]

>> BTW, I have such customization:
>>    (define-key project-prefix-map "V" vc-prefix-map)
>> to allow vc commands in a project, e.g. 'C-x p V D' for 'vc-root-diff'.
>
> Hmm. I'm not sure when I'd use it instead of the shorter 'C-x v D'.
>
> When you are inside a Git submodule, maybe? It can make a difference. But
> then you have to be aware that the diff will not include changes in the
> submodules (just the changed summary hashes).

I meant that 'C-x p V D' can be typed outside of a repository
to select a project.

bug#43153: Add new command project-find-dir (and move binding of project-dired)

[Stefan Kangas]

Dmitry Gutov <dgutov@yandex.ru> writes:

> > I don't see one way as fundamentally better than the other, so IMHO it's
> > better to just have the same UI as projectile.
>
> OK, that makes sense. Easier transition, etc.

Yup, that's my thinking too.

(In my use, project does everything I need so while projectile is
still installed it goes largely unused these days.)

bug#43153: Add new command project-find-dir (and move binding of project-dired)

[Dmitry Gutov]

On 20.09.2021 18:17, Juri Linkov wrote:
>>> BTW, I have such customization:
>>>     (define-key project-prefix-map "V" vc-prefix-map)
>>> to allow vc commands in a project, e.g. 'C-x p V D' for 'vc-root-diff'.
>> Hmm. I'm not sure when I'd use it instead of the shorter 'C-x v D'.
>>
>> When you are inside a Git submodule, maybe? It can make a difference. But
>> then you have to be aware that the diff will not include changes in the
>> submodules (just the changed summary hashes).
> I meant that 'C-x p V D' can be typed outside of a repository
> to select a project.

Ah. That should be handy, yes.

bug#43153: Add new command project-find-dir (and move binding of project-dired)

[Dmitry Gutov]

Version: 28.1

On 20.09.2021 18:29, Stefan Kangas wrote:
> Dmitry Gutov <dgutov@yandex.ru> writes:
> 
>>> I don't see one way as fundamentally better than the other, so IMHO it's
>>> better to just have the same UI as projectile.
>>
>> OK, that makes sense. Easier transition, etc.
> 
> Yup, that's my thinking too.

Now installed with commit df1d4f5894.

> (In my use, project does everything I need so while projectile is
> still installed it goes largely unused these days.)

Good to hear ;-)

But as far as missing pieces go, I think people are still asking for 
https://debbugs.gnu.org/41572, in some shape or form.

Emacs 28 probably should have a solution for it.

bug#43153: Add new command project-find-dir (and move binding of project-dired)

[Juri Linkov]

>>>> BTW, I have such customization:
>>>>     (define-key project-prefix-map "V" vc-prefix-map)
>>>> to allow vc commands in a project, e.g. 'C-x p V D' for 'vc-root-diff'.
>>> Hmm. I'm not sure when I'd use it instead of the shorter 'C-x v D'.
>>>
>>> When you are inside a Git submodule, maybe? It can make a difference. But
>>> then you have to be aware that the diff will not include changes in the
>>> submodules (just the changed summary hashes).
>> I meant that 'C-x p V D' can be typed outside of a repository
>> to select a project.
>
> Ah. That should be handy, yes.

But like there is the binding 'C-x v d' to 'vc-dir'
wouldn't it better to provide the same for project?
Then 'C-x p v d' could use 'project-vc-dir', and
other 'C-x v' bindings will be available under 'C-x p v'.

bug#43153: Add new command project-find-dir (and move binding of project-dired)

[Dmitry Gutov]

On 21.09.2021 20:29, Juri Linkov wrote:
>>>>> BTW, I have such customization:
>>>>>      (define-key project-prefix-map "V" vc-prefix-map)
>>>>> to allow vc commands in a project, e.g. 'C-x p V D' for 'vc-root-diff'.
>>>> Hmm. I'm not sure when I'd use it instead of the shorter 'C-x v D'.
>>>>
>>>> When you are inside a Git submodule, maybe? It can make a difference. But
>>>> then you have to be aware that the diff will not include changes in the
>>>> submodules (just the changed summary hashes).
>>> I meant that 'C-x p V D' can be typed outside of a repository
>>> to select a project.
>> Ah. That should be handy, yes.
> But like there is the binding 'C-x v d' to 'vc-dir'
> wouldn't it better to provide the same for project?
> Then 'C-x p v d' could use 'project-vc-dir', and
> other 'C-x v' bindings will be available under 'C-x p v'.

Don't we mostly have that already?

'C-x p v D' will get you vc-diff for the project,
'C-x p v L' will get you vc-print-root-log,
'C-x p v B' gets you branch commands,

and so on.