https://github.com/purcell/inheritenv

Make emacs temp buffers inherit buffer-local environment variables
https://github.com/purcell/inheritenv

Last synced: about 2 months ago
JSON representation

Make emacs temp buffers inherit buffer-local environment variables

• Host: GitHub
• URL: https://github.com/purcell/inheritenv
• Owner: purcell
• Created: 2021-02-01T02:24:25.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-11-19T13:55:42.000Z (2 months ago)
• Last Synced: 2024-11-19T14:54:06.173Z (2 months ago)
• Language: Emacs Lisp
• Size: 11.7 KB
• Stars: 43
• Watchers: 3
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
[![Melpa Status](http://melpa.org/packages/inheritenv-badge.svg)](http://melpa.org/#/inheritenv)

[![Melpa Stable Status](http://stable.melpa.org/packages/inheritenv-badge.svg)](http://stable.melpa.org/#/inheritenv)

[![Build Status](https://github.com/purcell/inheritenv/actions/workflows/ci.yml/badge.svg)](https://github.com/purcell/inheritenv/actions/workflows/ci.yml)



# Make Emacs temp buffers inherit buffer-local environment variables

Environment variables in Emacs can be set buffer-locally, like many

Emacs preferences, and this allows users to have different buffer-local

paths for executables in different projects, specified by a

`.dir-locals.el` file or via a `direnv` integration like

[envrc](https://github.com/purcell/envrc).

However, there's a fairly common pitfall when Emacs libraries run

background processes on behalf of a user: many such libraries run

processes in temporary buffers that do not inherit the calling

buffer's environment if it is set buffer-locally.

This can result in executables not being found,

or the wrong versions of executables being picked up.

An example is the Emacs built-in command

`shell-command-to-string`. Whatever buffer-local `process-environment`

(or `exec-path`) the user has set, that command will always use the

Emacs-wide default. This is *specified* behaviour, but not *expected*

or *helpful*.

`inheritenv` provides a couple of tools for dealing with this

issue:

1. Library authors can wrap code that plans to execute processes in

   temporary buffers with the `inheritenv` macro.

2. Users can modify commands like `shell-command-to-string` using the

   `inheritenv-add-advice` macro.

## Installation

### Manual

Ensure `inheritenv.el` is in a directory on your load-path, and add

the following to your `~/.emacs` or `~/.emacs.d/init.el`:

```elisp

(require 'inheritenv)

```

### MELPA

If you're an Emacs 24 user or you have a recent version of

`package.el` you can install `inheritenv` from the

[MELPA](http://melpa.org) repository. The version of

`inheritenv` there will always be up-to-date.

## About

Author: Steve Purcell 

Homepage: https://github.com/purcell/inheritenv



[💝 Support this project and my other Open Source work](https://www.patreon.com/sanityinc)

[💼 LinkedIn profile](https://uk.linkedin.com/in/stevepurcell)

[✍ sanityinc.com](https://www.sanityinc.com/)