bug#73044: [PATCH] Add project-find-file-in-root

bug#73044: [PATCH] Add project-find-file-in-root

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

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

Tags: patch


Several users have asked me for a command which is just
find-file, but starting from the project root.  In large
projects, where project-files is expensive, this will have
substantially better performance than project-find-file.

Also, it allows opening files which aren't included in
project-files without paying the further cost of running
project--files-in-directory (which is what happens when passing
INCLUDE-ALL=t to project-find-file).

Also, it may help with user confusion about why
project-find-file doesn't behave like find-file.  (which I've
encountered a few times)

This command is equivalent to C-x p o C-x C-f, but it's nice to
be able to bind it to a specific key.

Overall, this is easy enough to provide, so let's just do that.

In GNU Emacs 29.2.50 (build 16, x86_64-pc-linux-gnu, X toolkit, cairo
 version 1.15.12, Xaw scroll bars) of 2024-08-26 built on
 igm-qws-u22796a
Repository revision: e6d04c06a7eb6ce932b52a346368d02b7a811a00
Repository branch: emacs-29
Windowing system distributor 'The X.Org Foundation', version 11.0.12011000
System Description: Rocky Linux 8.10 (Green Obsidian)

Configured using:
 'configure --with-x-toolkit=lucid --without-gpm --without-gconf
 --without-selinux --without-imagemagick --with-modules --with-gif=no
 --with-cairo --with-rsvg --without-compress-install
 --with-native-compilation=aot --with-tree-sitter
 PKG_CONFIG_PATH=/usr/local/home/garnish/libtree-sitter/0.22.6-1/lib/pkgconfig/'


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Add-project-find-file-in-root.patch --]
[-- Type: text/patch, Size: 1937 bytes --]

From 960e5fc3486aa56d42c8c90fae025fe51c4cd7ad Mon Sep 17 00:00:00 2001
From: Spencer Baugh <sbaugh@janestreet.com>
Date: Thu, 5 Sep 2024 09:56:50 -0400
Subject: [PATCH] Add project-find-file-in-root

Several users have asked me for a command which is just
find-file, but starting from the project root.  In large
projects, where project-files is expensive, this will have
substantially better performance than project-find-file.

Also, it allows opening files which aren't included in
project-files without paying the further cost of running
project--files-in-directory (which is what happens when passing
INCLUDE-ALL=t to project-find-file).

Also, it may help with user confusion about why
project-find-file doesn't behave like find-file.  (which I've
encountered a few times)

This command is equivalent to C-x p o C-x C-f, but it's nice to
be able to bind it to a specific key.

Overall, this is easy enough to provide, so let's just do that.

* lisp/progmodes/project.el (project-find-file-in-root): Add.
---
 lisp/progmodes/project.el | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/lisp/progmodes/project.el b/lisp/progmodes/project.el
index 983242628f0..cfb81e5425c 100644
--- a/lisp/progmodes/project.el
+++ b/lisp/progmodes/project.el
@@ -1069,6 +1069,18 @@ project--find-default-from
               (file-relative-name filename (project-root filename-proj)))
     filename))
 
+;;;###autoload
+(defun project-find-file-in-root ()
+  "Call `find-file' in the current project root.
+
+Unlike `project-find-file', this doesn't provide completion over the
+entire file tree.
+
+This is equivalent to running `project-any-command' with `find-file'."
+  (let* ((pr (project-current t))
+         (default-directory (project-root pr)))
+    (call-interactively #'find-file)))
+
 ;;;###autoload
 (defun project-find-file (&optional include-all)
   "Visit a file (with completion) in the current project.
-- 
2.39.3

bug#73044: [PATCH] Add project-find-file-in-root

[Dmitry Gutov]

Version: 31.1

Hi Spencer,

On 05/09/2024 17:01, Spencer Baugh via Bug reports for GNU Emacs, the 
Swiss army knife of text editors wrote:
> Several users have asked me for a command which is just
> find-file, but starting from the project root.  In large
> projects, where project-files is expensive, this will have
> substantially better performance than project-find-file.
> 
> Also, it allows opening files which aren't included in
> project-files without paying the further cost of running
> project--files-in-directory (which is what happens when passing
> INCLUDE-ALL=t to project-find-file).
> 
> Also, it may help with user confusion about why
> project-find-file doesn't behave like find-file.  (which I've
> encountered a few times)
> 
> This command is equivalent to C-x p o C-x C-f, but it's nice to
> be able to bind it to a specific key.
> 
> Overall, this is easy enough to provide, so let's just do that.

Makes sense, thanks, pushed to master (adding the 'interactive' form and 
a NEWS entry).

The name is a little verbose - if anybody has a better idea later, 
they're welcome to suggest it, there is some time to do a change.

bug#73044: [PATCH] Add project-find-file-in-root

[Eli Zaretskii]

> Resent-To: bug-gnu-emacs@gnu.org
> Date: Fri, 6 Sep 2024 19:20:16 +0300
> From: Dmitry Gutov <dmitry@gutov.dev>
> 
> > This command is equivalent to C-x p o C-x C-f, but it's nice to
> > be able to bind it to a specific key.
> > 
> > Overall, this is easy enough to provide, so let's just do that.
> 
> Makes sense, thanks, pushed to master (adding the 'interactive' form and 
> a NEWS entry).

Thanks, but why only NEWS?  I think this should be in the user manual
as well.

bug#73044: [PATCH] Add project-find-file-in-root

[Dmitry Gutov]

On 06/09/2024 20:44, Eli Zaretskii wrote:
>> Resent-To:bug-gnu-emacs@gnu.org
>> Date: Fri, 6 Sep 2024 19:20:16 +0300
>> From: Dmitry Gutov<dmitry@gutov.dev>
>>
>>> This command is equivalent to C-x p o C-x C-f, but it's nice to
>>> be able to bind it to a specific key.
>>>
>>> Overall, this is easy enough to provide, so let's just do that.
>> Makes sense, thanks, pushed to master (adding the 'interactive' form and
>> a NEWS entry).
> Thanks, but why only NEWS?  I think this should be in the user manual
> as well.

I don't know, to me it seems like a niche enough feature, having lived 
without this addition for a number of major releases.

Spencer seems to agree, having submitted the patch without a default 
binding.

But if someone wants to describe it in the manual, I of course wouldn't 
mind. They can mention the situations described in this report.

bug#73044: [PATCH] Add project-find-file-in-root

[Eli Zaretskii]

> Date: Fri, 6 Sep 2024 23:05:06 +0300
> Cc: 73044@debbugs.gnu.org, sbaugh@janestreet.com
> From: Dmitry Gutov <dmitry@gutov.dev>
> 
> On 06/09/2024 20:44, Eli Zaretskii wrote:
> >> Resent-To:bug-gnu-emacs@gnu.org
> >> Date: Fri, 6 Sep 2024 19:20:16 +0300
> >> From: Dmitry Gutov<dmitry@gutov.dev>
> >>
> >>> This command is equivalent to C-x p o C-x C-f, but it's nice to
> >>> be able to bind it to a specific key.
> >>>
> >>> Overall, this is easy enough to provide, so let's just do that.
> >> Makes sense, thanks, pushed to master (adding the 'interactive' form and
> >> a NEWS entry).
> > Thanks, but why only NEWS?  I think this should be in the user manual
> > as well.
> 
> I don't know, to me it seems like a niche enough feature, having lived 
> without this addition for a number of major releases.
> 
> Spencer seems to agree, having submitted the patch without a default 
> binding.
> 
> But if someone wants to describe it in the manual, I of course wouldn't 
> mind. They can mention the situations described in this report.

If you consider this not important enough to be in the manual, please
mark the NEWS entry with "---", to convey your opinion.

bug#73044: [PATCH] Add project-find-file-in-root

[Dmitry Gutov]

On 07/09/2024 09:10, Eli Zaretskii wrote:
> If you consider this not important enough to be in the manual, please
> mark the NEWS entry with "---", to convey your opinion.

Added, thanks.

Also split the entry into two lines.

bug#73044: [PATCH] Add project-find-file-in-root

[Sean Whitton]

Hello,

On Fri 06 Sep 2024 at 07:20pm +03, Dmitry Gutov wrote:

> The name is a little verbose - if anybody has a better idea later, they're
> welcome to suggest it, there is some time to do a change.

How about project-root-find-file ?

-- 
Sean Whitton

bug#73044: [PATCH] Add project-find-file-in-root

[Dmitry Gutov]

On 15/09/2024 21:14, Sean Whitton wrote:
> Hello,
> 
> On Fri 06 Sep 2024 at 07:20pm +03, Dmitry Gutov wrote:
> 
>> The name is a little verbose - if anybody has a better idea later, they're
>> welcome to suggest it, there is some time to do a change.
> 
> How about project-root-find-file ?

Nice! Renamed, thanks.

It does seem to create the necessary distinction.