Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add shebang support for files using flakes. #196

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

djl
Copy link

@djl djl commented Dec 22, 2023

Docs: https://nixos.org/manual/nix/stable/command-ref/new-cli/nix.html#shebang-interpreter

This is slightly more complicated than nix-shell detection due to the #!nix ... not appearing directly after the shebang, so re-search-forward is used to find the matching line. This does mean that opening a huge file may slow down emacs while the search is running.

There are two mitigations for that:

  1. nix-shebang will try to parse the nix-shell line first.

  2. Users can keep nix-shell -i ... as the second line in your nix script. This won't affect the script at runtime (i.e. it will still use flakes) and keeps the old detection behavior.

  3. An option could be added to disable flake support entirely.

Docs: https://nixos.org/manual/nix/stable/command-ref/new-cli/nix.html#shebang-interpreter

This is slightly more complicated than nix-shell detection due to the
`#!nix ...` not appearing directly after the shebang, so
re-search-forward is used to find the matching line. This does mean that
opening a huge file may slow down emacs while the search is running.

There are two mitigations for that:

1. nix-shebang will try to parse the nix-shell line first.

2. Users can keep `nix-shell -i ...` as the second line in your nix
   script. This won't affect the script at runtime (i.e. it will still
   use flakes) and keeps the old detection behavior.

3. An option could be added to disable flake support entirely.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant