GNU logs - #76007, boring messages

Message sent to bug-gnu-emacs@HIDDEN:

Subject: bug#76007: 31.0.50; Interpreter not correctly found when using nix-shell.
Resent-From: Malcolm Purvis <malcolm@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Sun, 02 Feb 2025 11:48:02 +0000
Resent-Message-ID: <handler.76007.B.173849682226323 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: 76007 <at> debbugs.gnu.org
From: Malcolm Purvis <malcolm@HIDDEN>
Date: Sun, 02 Feb 2025 22:46:44 +1100
Message-ID: <m2zfj48t7f.fsf@HIDDEN>
User-Agent: Gnus/5.13 (Gnus v5.13)
MIME-Version: 1.0
Content-Type: text/plain; format=flowed
Received-SPF: neutral client-ip=103.150.252.56;
 envelope-from=malcolm@HIDDEN; helo=omr-waratah-01.pc5.atmailcloud.com
X-Spam_score_int: -10
X-Spam_score: -1.1
X-Spam_bar: -
X-Spam_report: (-1.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1,
 DKIM_VALID=-0.1, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001,
 RCVD_IN_VALIDITY_SAFE_BLOCKED=0.001, SPF_HELO_NONE=0.001,
 SPF_NEUTRAL=0.779 autolearn=no autolearn_force=no
X-Spam_action: no action
X-Spam-Score: 0.7 (/)
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -0.3 (/)

In NixOS if you want to use a script that manages its own 
dependencies, you use a command called "nix-shell" or "nix shell" 
to launch the script.

The start of such a script looks like:

#! /usr/bin/env nix-shell
#! nix-shell -i bash -p imagemagick cowsay

or

#! /usr/bin/env nix
#! nix shell github:tomberek/-#perlWith.HTMLTokeParserSimple.LWP 
   --command perl -x

The OS interpreter is nix-shell and nix-shell launches the real 
interpreter to execute the rest of the script.

With these scripts, Emacs's current behaviour is as follows:

- nix-shell is not interpreter-mode-alist so Emacs looks at the 
  file's 
 extension:

 - If the file has an extension then the correct mode is used
 - If the file does not have an extension then Fundamental mode is 
 used 
   regardless of the script's actual language.

If the file is a shell script with the correct extension, sh-mode 
is used but sh-mode fails to guess the shell, leaving the variable 
sh-shell as 'nix-shell.

In most cases this means that some shell features are not enabled, 
but otherwise it is possible to edit the script.

However, lsp-mode's bash language support (lsp-bash.el) throws an 
error if sh-shell is not set to it's supported values ('sh and 
'bash), and as a result nix bash scripts fail.

The solution is to add a new regexp to 
auto-mode-interpreter-regexp that will detect a nix script and 
extract the real interpreter from the second line.  Nix shell can 
be invoked in a number of ways but this regexp matches the common 
forms. 

diff --git a/lisp/files.el b/lisp/files.el
index 5ff40c335d7..1f3ac1431d2 100644
--- a/lisp/files.el
+++ b/lisp/files.el
@@ -3389,6 +3389,7 @@ and `inhibit-local-variables-suffixes'.  If
    "\\(?:[^ \t\n]+=[^ \t\n]*[ \t]+\\)*"
    "\\)?"
    "\\)?"
+   "\\(?:\\(?:nix\\|nix-shell\\)\n#![ 
\t]+\\(?:nix\\|nix-shell\\).*\\(?:-i\\|--command\\)[ \t]+\\)?"
    ;; Group 2: interpreter.  "\\([^ \t\n]+\\)")
   "Regexp matching interpreters, for file mode determination.

Malcolm

In GNU Emacs 31.0.50 (build 2, x86_64-apple-darwin24.2.0, NS
appkit-2575.30 Version 15.2 (Build 24C101)) of 2025-01-11 built on
lamechWindowing system distributor 'Apple', version 10.3.2575
System Description:  macOS 15.2

Configured using:
 'configure 
 --enable-locallisppath=/usr/local/share/emacs/site-lisp 
 --infodir=/usr/local/Cellar/emacs-head@31/31.0.50_1/share/info/emacs 
 --prefix=/usr/local/Cellar/emacs-head@31/31.0.50_1 --without-x 
 --without-dbus --with-native-compilation --with-imagemagick 
 --with-modules --with-gnutls --with-rsvg --with-xml2 
 --with-xwidgets --with-webp --with-ns --disable-ns-self-contained 
 'CFLAGS=-O2 -march=native -pipe -DFD_SETSIZE=10000 
 -DDARWIN_UNLIMITED_SELECT' 'LDFLAGS=-L/usr/local/lib/gcc/14 
 -I/usr/local/opt/gcc/include -I/usr/local/opt/libgccjit/include 
 -I/usr/local/opt/gmp/include -I/usr/local/opt/jpeg/include''

-- 
		    Malcolm Purvis <malcolm@HIDDEN>

Message sent:

Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-Mailer: MIME-tools 5.505 (Entity 5.505)
Content-Type: text/plain; charset=utf-8
X-Loop: help-debbugs@HIDDEN
From: help-debbugs@HIDDEN (GNU bug Tracking System)
To: Malcolm Purvis <malcolm@HIDDEN>
Subject: bug#76007: Acknowledgement (31.0.50; Interpreter not correctly
 found when using nix-shell.)
Message-ID: <handler.76007.B.173849682226323.ack <at> debbugs.gnu.org>
References: <m2zfj48t7f.fsf@HIDDEN>
X-Gnu-PR-Message: ack 76007
X-Gnu-PR-Package: emacs
Reply-To: 76007 <at> debbugs.gnu.org
Date: Sun, 02 Feb 2025 11:48:02 +0000

Thank you for filing a new bug report with debbugs.gnu.org.

This is an automatically generated reply to let you know your message
has been received.

Your message is being forwarded to the package maintainers and other
interested parties for their attention; they will reply in due course.

Your message has been sent to the package maintainer(s):
 bug-gnu-emacs@HIDDEN

If you wish to submit further information on this problem, please
send it to 76007 <at> debbugs.gnu.org.

Please do not send mail to help-debbugs@HIDDEN unless you wish
to report a problem with the Bug-tracking system.

--=20
76007: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D76007
GNU Bug Tracking System
Contact help-debbugs@HIDDEN with problems

Message sent to bug-gnu-emacs@HIDDEN:

Subject: bug#76007: 31.0.50; Interpreter not correctly found when using nix-shell.
Resent-From: Stefan Kangas <stefankangas@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Sun, 02 Feb 2025 13:50:02 +0000
Resent-Message-ID: <handler.76007.B76007.173850418526602 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: Malcolm Purvis <malcolm@HIDDEN>, 76007 <at> debbugs.gnu.org
From: Stefan Kangas <stefankangas@HIDDEN>
In-Reply-To: <m2zfj48t7f.fsf@HIDDEN>
References: <m2zfj48t7f.fsf@HIDDEN>
MIME-Version: 1.0
Date: Sun, 2 Feb 2025 08:49:36 -0500
Message-ID: <CADwFkmkP5BO4eCpdu8Cc+NgZOkvBtJeKzD6fK2Eo-r6841peNw@HIDDEN>
Content-Type: text/plain; charset="UTF-8"
Precedence: list
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>

Malcolm Purvis <malcolm@HIDDEN> writes:

> In NixOS if you want to use a script that manages its own
> dependencies, you use a command called "nix-shell" or "nix shell"
> to launch the script.
>
> The start of such a script looks like:
>
> #! /usr/bin/env nix-shell
> #! nix-shell -i bash -p imagemagick cowsay
>
> or
>
> #! /usr/bin/env nix
> #! nix shell github:tomberek/-#perlWith.HTMLTokeParserSimple.LWP
>    --command perl -x
>
> The OS interpreter is nix-shell and nix-shell launches the real
> interpreter to execute the rest of the script.
>
> With these scripts, Emacs's current behaviour is as follows:
>
> - nix-shell is not interpreter-mode-alist so Emacs looks at the
>   file's
>  extension:
>
>  - If the file has an extension then the correct mode is used
>  - If the file does not have an extension then Fundamental mode is
>  used
>    regardless of the script's actual language.
>
> If the file is a shell script with the correct extension, sh-mode
> is used but sh-mode fails to guess the shell, leaving the variable
> sh-shell as 'nix-shell.
>
> In most cases this means that some shell features are not enabled,
> but otherwise it is possible to edit the script.
>
> However, lsp-mode's bash language support (lsp-bash.el) throws an
> error if sh-shell is not set to it's supported values ('sh and
> 'bash), and as a result nix bash scripts fail.
>
> The solution is to add a new regexp to
> auto-mode-interpreter-regexp that will detect a nix script and
> extract the real interpreter from the second line.  Nix shell can
> be invoked in a number of ways but this regexp matches the common
> forms.
>
>
> diff --git a/lisp/files.el b/lisp/files.el
> index 5ff40c335d7..1f3ac1431d2 100644
> --- a/lisp/files.el
> +++ b/lisp/files.el
> @@ -3389,6 +3389,7 @@ and `inhibit-local-variables-suffixes'.  If
>     "\\(?:[^ \t\n]+=[^ \t\n]*[ \t]+\\)*"
>     "\\)?"
>     "\\)?"
> +   "\\(?:\\(?:nix\\|nix-shell\\)\n#![
> \t]+\\(?:nix\\|nix-shell\\).*\\(?:-i\\|--command\\)[ \t]+\\)?"
>     ;; Group 2: interpreter.  "\\([^ \t\n]+\\)")
>    "Regexp matching interpreters, for file mode determination.
>
>
> Malcolm

Thanks for the bug report.

This looks to me like a bug in lsp-mode, or lsp-bash.el.  I recommend
reporting the bug to them first.

Message received at control <at> debbugs.gnu.org:

Received: (at control) by debbugs.gnu.org; 2 Feb 2025 13:50:09 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Sun Feb 02 08:50:08 2025
Received: from localhost ([127.0.0.1]:33592 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1teaMS-00070R-Kj
	for submit <at> debbugs.gnu.org; Sun, 02 Feb 2025 08:50:08 -0500
Received: from mail-ed1-x52e.google.com ([2a00:1450:4864:20::52e]:60742)
 by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128)
 (Exim 4.84_2) (envelope-from <stefankangas@HIDDEN>)
 id 1teaMP-0006vN-Ej
 for control <at> debbugs.gnu.org; Sun, 02 Feb 2025 08:50:06 -0500
Received: by mail-ed1-x52e.google.com with SMTP id
 4fb4d7f45d1cf-5d90a5581fcso6208518a12.1
 for <control <at> debbugs.gnu.org>; Sun, 02 Feb 2025 05:50:05 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=gmail.com; s=20230601; t=1738504199; x=1739108999; darn=debbugs.gnu.org;
 h=to:subject:message-id:date:mime-version:from:from:to:cc:subject
 :date:message-id:reply-to;
 bh=2gVHTewmDuJr+mF1vHjFbnr+oHp12Mxp00Sd3ZqJYvo=;
 b=Y9gt4/QKjP/j+yMQjpkGm0/y1L4/brtQMo9o1ubKzkgCc7+sx4lIYFM5W3walqOfAF
 ewbZUjeZWU0Zn76fa2qjuXXHpbizqZOm6XQSWhP7w3o9zq530+ULOh1Lhmy38I3X+pq6
 pWdGdTF/iJOCt2oW/6fNkcBN2YQoMUnon6J9d+zwNR+GoQsg1jrFVTAyDIikMRgknbhk
 eG+3hizkw9lM5OABHKlN6/nozKe7qMEbOQ/HgBfX/AyRax5JtB/6u9HwjxFNYl5rIGun
 rbuGUno9BHtLKuO1bpAP1WVjL49oNGxQDVdmHzMGFwJ7KjoEfdAAjMuM4CKQryEuZEph
 YSPA==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20230601; t=1738504199; x=1739108999;
 h=to:subject:message-id:date:mime-version:from:x-gm-message-state
 :from:to:cc:subject:date:message-id:reply-to;
 bh=2gVHTewmDuJr+mF1vHjFbnr+oHp12Mxp00Sd3ZqJYvo=;
 b=Gg5nZaHDGDAPge4a4nqnejQ0jhJwHR3Itx5qxC7nDKU/WToMTFYTOtOHtuT/9F6NeW
 +1B3/GH7VVfu+OgHe+7LYb2NSFm2iwCb7IPIb9vfcbS6NzSvXd/YInJ6P5Y0F5RwaY5a
 AhzAM3+s7JPxEOxs5UuVV9IHNSTFbyiVUGLv+syf2GRDxLpvMhQ0xMy8gduK51pNLUzD
 OF6kQEaEEeiOfd4UC/+feCr0NBRo1udWfJOz598YKxP6rV0lH3n6UXFyHrxIM07w+3cT
 di/pGViOtMfRSnzjlM0hVL8AcYpPaQgknS9EghPG+Bt+W9qqD6k6Z/wprrnwjYwJzlZA
 EIwg==
X-Gm-Message-State: AOJu0Yz4YJb6ouvups9tC5/dF0zNHbGTDqWW72FUro9iefUNaOpdg4Ob
 H8yp7gV3C3sSUzfhTYKxHB5jUnp3PXNBjmoMdG/PeYDCG5/Fv/F7Q8mkxsKt5EueybIwtAAELxI
 VJpxtMsvK0PT/4dR5ZwsR2pv5i1bXPTUQyUI=
X-Gm-Gg: ASbGncu/lASo3QfHAVQFXwAo59x4FlYIVg4ZF8FoXdMRZp1lFaa3yKPqQHaYAqfZ0/d
 aLxzav+h2QFkeQUKHiJpNkoinTTN+3hy98vunFwXj31UFjmQLSzAUYAHK0F5u3tC1M7vmSC2Vxw
 ==
X-Google-Smtp-Source: AGHT+IGPgItOIF6adRPSlCuMqioucPxvRdxO+Adpp5sLCNKX/YEIyzUDe3EEgih1uJjLKGNoFkwLIB7OuKdAlS3D5pA=
X-Received: by 2002:a05:6402:42ce:b0:5d0:b925:a8a with SMTP id
 4fb4d7f45d1cf-5dc5efc7231mr21760292a12.16.1738504199186; Sun, 02 Feb 2025
 05:49:59 -0800 (PST)
Received: from 753933720722 named unknown by gmailapi.google.com with
 HTTPREST; Sun, 2 Feb 2025 14:49:58 +0100
From: Stefan Kangas <stefankangas@HIDDEN>
MIME-Version: 1.0
Date: Sun, 2 Feb 2025 14:49:58 +0100
X-Gm-Features: AWEUYZljyfxTNbH6x94m9D5zix1zdbX5V8lCdJVRlGZhzjq4TF28qGsCQUUs_G0
Message-ID: <CADwFkmnQO_48OvVjDnzUmkWEczvFxrAujX+WCMHh8iQ+xFLR=w@HIDDEN>
Subject: 
To: control <at> debbugs.gnu.org
Content-Type: text/plain; charset="UTF-8"
X-Spam-Score: 2.0 (++)
X-Spam-Report: Spam detection software, running on the system "debbugs.gnu.org",
 has NOT identified this incoming email as spam.  The original
 message has been attached to this so you can view it or label
 similar future email.  If you have any questions, see
 the administrator of that system for details.
 Content preview:  tags 76007 + notabug thanks 
 Content analysis details:   (2.0 points, 10.0 required)
 pts rule name              description
 ---- ---------------------- --------------------------------------------------
 0.0 SPF_HELO_NONE          SPF: HELO does not publish an SPF Record
 0.0 FREEMAIL_FROM          Sender email is commonly abused enduser mail
 provider (stefankangas[at]gmail.com)
 -0.0 SPF_PASS               SPF: sender matches SPF record
 -0.0 RCVD_IN_DNSWL_NONE     RBL: Sender listed at https://www.dnswl.org/,
 no trust [2a00:1450:4864:20:0:0:0:52e listed in]
 [list.dnswl.org]
 0.0 UNPARSEABLE_RELAY      Informational: message has unparseable relay
 lines 2.0 BLANK_SUBJECT          Subject is present but empty
X-Debbugs-Envelope-To: control
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: 1.0 (+)

tags 76007 + notabug
thanks

Last modified: Sun, 2 Feb 2025 14:00:02 UTC

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