:boom: Replace exec-path-from-shell w/ 'bin/doom env'
IMPORTANT: This is a breaking update for Mac users, as your shell
environment will no longer be inherited correctly (with the removal of
exec-path-from-shell). The quick fix is: 'bin/doom env refresh'. Also,
the set-env! autodef now does nothing (and is deprecated), be sure to
remove calls to it in your config.
Smaller changes:
+ This update also adds --no-* switches to doom quickstart
+ Includes general improvements to the documentation of several bin/doom
commands.
+ Moves doom/reload* commands to core/autoload/config.el
+ doom/reload-project has been removed (it didn't actually do anything)
The breaking change:
This update adds an "envvar file" to Doom Emacs. This file is generated
by `doom env refresh`, populated with variables scraped from your shell
environment (from both non-interactive and interactive sessions). This
file is then (inexpensively) loaded at startup, if it exists.
+ The file is manually generated with `doom env refresh`.
+ It can be regenerated automatically whenever `doom refresh` is run by
running `doom env enable` (`doom env clear` will reverse this and
delete the env file).
+ `doom quickstart` will ask if you want to auto-generate this envvar
file. You won't need it if you're confident Emacs will always be
started from the correct environment, however.
+ Your env file can be reloaded from a running Emacs session with `M-x
doom/reload-env`. Note: this won't work if the Emacs session you're
running it in doesn't have a correct SHELL set. i.e. don't use this to
create your first env file!
The idea isn't mine -- it's borrowed from Spacemacs -- and was
introduced to me in #1053 by @yurimx. I was impressed with it. Prior to
this, I was unhappy with exec-path-from-shell (no hate to the dev, I
understand its necessity), and 'doom patch-macos' wasn't ideal for mac
users (needed to be reapplied every time you update Emacs). What's more,
many users (even Linux users) had to install exec-path-from-shell
anyway.
This solution suffers from none of their shortcomings. More reliable
than patch-macos, more performant and complete than
exec-path-from-shell, and easily handled by bin/doom.
2019-03-28 12:06:10 +08:00
|
|
|
;;; core/cli/env.el -*- lexical-binding: t; -*-
|
|
|
|
|
|
2019-07-28 07:32:16 +08:00
|
|
|
(defcli! env (&rest args)
|
2019-08-07 13:42:46 +08:00
|
|
|
"Creates or regenerates your envvars file.
|
:boom: Replace exec-path-from-shell w/ 'bin/doom env'
IMPORTANT: This is a breaking update for Mac users, as your shell
environment will no longer be inherited correctly (with the removal of
exec-path-from-shell). The quick fix is: 'bin/doom env refresh'. Also,
the set-env! autodef now does nothing (and is deprecated), be sure to
remove calls to it in your config.
Smaller changes:
+ This update also adds --no-* switches to doom quickstart
+ Includes general improvements to the documentation of several bin/doom
commands.
+ Moves doom/reload* commands to core/autoload/config.el
+ doom/reload-project has been removed (it didn't actually do anything)
The breaking change:
This update adds an "envvar file" to Doom Emacs. This file is generated
by `doom env refresh`, populated with variables scraped from your shell
environment (from both non-interactive and interactive sessions). This
file is then (inexpensively) loaded at startup, if it exists.
+ The file is manually generated with `doom env refresh`.
+ It can be regenerated automatically whenever `doom refresh` is run by
running `doom env enable` (`doom env clear` will reverse this and
delete the env file).
+ `doom quickstart` will ask if you want to auto-generate this envvar
file. You won't need it if you're confident Emacs will always be
started from the correct environment, however.
+ Your env file can be reloaded from a running Emacs session with `M-x
doom/reload-env`. Note: this won't work if the Emacs session you're
running it in doesn't have a correct SHELL set. i.e. don't use this to
create your first env file!
The idea isn't mine -- it's borrowed from Spacemacs -- and was
introduced to me in #1053 by @yurimx. I was impressed with it. Prior to
this, I was unhappy with exec-path-from-shell (no hate to the dev, I
understand its necessity), and 'doom patch-macos' wasn't ideal for mac
users (needed to be reapplied every time you update Emacs). What's more,
many users (even Linux users) had to install exec-path-from-shell
anyway.
This solution suffers from none of their shortcomings. More reliable
than patch-macos, more performant and complete than
exec-path-from-shell, and easily handled by bin/doom.
2019-03-28 12:06:10 +08:00
|
|
|
|
2019-07-26 01:42:01 +08:00
|
|
|
doom env [-c|--clear]
|
:boom: Replace exec-path-from-shell w/ 'bin/doom env'
IMPORTANT: This is a breaking update for Mac users, as your shell
environment will no longer be inherited correctly (with the removal of
exec-path-from-shell). The quick fix is: 'bin/doom env refresh'. Also,
the set-env! autodef now does nothing (and is deprecated), be sure to
remove calls to it in your config.
Smaller changes:
+ This update also adds --no-* switches to doom quickstart
+ Includes general improvements to the documentation of several bin/doom
commands.
+ Moves doom/reload* commands to core/autoload/config.el
+ doom/reload-project has been removed (it didn't actually do anything)
The breaking change:
This update adds an "envvar file" to Doom Emacs. This file is generated
by `doom env refresh`, populated with variables scraped from your shell
environment (from both non-interactive and interactive sessions). This
file is then (inexpensively) loaded at startup, if it exists.
+ The file is manually generated with `doom env refresh`.
+ It can be regenerated automatically whenever `doom refresh` is run by
running `doom env enable` (`doom env clear` will reverse this and
delete the env file).
+ `doom quickstart` will ask if you want to auto-generate this envvar
file. You won't need it if you're confident Emacs will always be
started from the correct environment, however.
+ Your env file can be reloaded from a running Emacs session with `M-x
doom/reload-env`. Note: this won't work if the Emacs session you're
running it in doesn't have a correct SHELL set. i.e. don't use this to
create your first env file!
The idea isn't mine -- it's borrowed from Spacemacs -- and was
introduced to me in #1053 by @yurimx. I was impressed with it. Prior to
this, I was unhappy with exec-path-from-shell (no hate to the dev, I
understand its necessity), and 'doom patch-macos' wasn't ideal for mac
users (needed to be reapplied every time you update Emacs). What's more,
many users (even Linux users) had to install exec-path-from-shell
anyway.
This solution suffers from none of their shortcomings. More reliable
than patch-macos, more performant and complete than
exec-path-from-shell, and easily handled by bin/doom.
2019-03-28 12:06:10 +08:00
|
|
|
|
2019-08-07 13:42:46 +08:00
|
|
|
This is meant to be a faster and more comprehensive alternative to
|
|
|
|
|
exec-path-from-shell. See the FAQ in the documentation for an explanation why.
|
2019-07-26 01:42:01 +08:00
|
|
|
|
2019-08-07 13:42:46 +08:00
|
|
|
The envvars file is created by scraping your (interactive) shell environment
|
|
|
|
|
into newline-delimited KEY=VALUE pairs. Typically by running '$SHELL -ic env'
|
|
|
|
|
(or '$SHELL -c set' on windows). Doom loads this file at startup (if it exists)
|
|
|
|
|
to ensure Emacs mirrors your shell environment (particularly to ensure PATH and
|
|
|
|
|
SHELL are correctly set).
|
:boom: Replace exec-path-from-shell w/ 'bin/doom env'
IMPORTANT: This is a breaking update for Mac users, as your shell
environment will no longer be inherited correctly (with the removal of
exec-path-from-shell). The quick fix is: 'bin/doom env refresh'. Also,
the set-env! autodef now does nothing (and is deprecated), be sure to
remove calls to it in your config.
Smaller changes:
+ This update also adds --no-* switches to doom quickstart
+ Includes general improvements to the documentation of several bin/doom
commands.
+ Moves doom/reload* commands to core/autoload/config.el
+ doom/reload-project has been removed (it didn't actually do anything)
The breaking change:
This update adds an "envvar file" to Doom Emacs. This file is generated
by `doom env refresh`, populated with variables scraped from your shell
environment (from both non-interactive and interactive sessions). This
file is then (inexpensively) loaded at startup, if it exists.
+ The file is manually generated with `doom env refresh`.
+ It can be regenerated automatically whenever `doom refresh` is run by
running `doom env enable` (`doom env clear` will reverse this and
delete the env file).
+ `doom quickstart` will ask if you want to auto-generate this envvar
file. You won't need it if you're confident Emacs will always be
started from the correct environment, however.
+ Your env file can be reloaded from a running Emacs session with `M-x
doom/reload-env`. Note: this won't work if the Emacs session you're
running it in doesn't have a correct SHELL set. i.e. don't use this to
create your first env file!
The idea isn't mine -- it's borrowed from Spacemacs -- and was
introduced to me in #1053 by @yurimx. I was impressed with it. Prior to
this, I was unhappy with exec-path-from-shell (no hate to the dev, I
understand its necessity), and 'doom patch-macos' wasn't ideal for mac
users (needed to be reapplied every time you update Emacs). What's more,
many users (even Linux users) had to install exec-path-from-shell
anyway.
This solution suffers from none of their shortcomings. More reliable
than patch-macos, more performant and complete than
exec-path-from-shell, and easily handled by bin/doom.
2019-03-28 12:06:10 +08:00
|
|
|
|
2019-08-07 13:42:46 +08:00
|
|
|
This is useful in cases where you cannot guarantee that Emacs (or the daemon)
|
|
|
|
|
will be launched from the correct environment (e.g. on MacOS or through certain
|
|
|
|
|
app launchers on Linux).
|
:boom: Replace exec-path-from-shell w/ 'bin/doom env'
IMPORTANT: This is a breaking update for Mac users, as your shell
environment will no longer be inherited correctly (with the removal of
exec-path-from-shell). The quick fix is: 'bin/doom env refresh'. Also,
the set-env! autodef now does nothing (and is deprecated), be sure to
remove calls to it in your config.
Smaller changes:
+ This update also adds --no-* switches to doom quickstart
+ Includes general improvements to the documentation of several bin/doom
commands.
+ Moves doom/reload* commands to core/autoload/config.el
+ doom/reload-project has been removed (it didn't actually do anything)
The breaking change:
This update adds an "envvar file" to Doom Emacs. This file is generated
by `doom env refresh`, populated with variables scraped from your shell
environment (from both non-interactive and interactive sessions). This
file is then (inexpensively) loaded at startup, if it exists.
+ The file is manually generated with `doom env refresh`.
+ It can be regenerated automatically whenever `doom refresh` is run by
running `doom env enable` (`doom env clear` will reverse this and
delete the env file).
+ `doom quickstart` will ask if you want to auto-generate this envvar
file. You won't need it if you're confident Emacs will always be
started from the correct environment, however.
+ Your env file can be reloaded from a running Emacs session with `M-x
doom/reload-env`. Note: this won't work if the Emacs session you're
running it in doesn't have a correct SHELL set. i.e. don't use this to
create your first env file!
The idea isn't mine -- it's borrowed from Spacemacs -- and was
introduced to me in #1053 by @yurimx. I was impressed with it. Prior to
this, I was unhappy with exec-path-from-shell (no hate to the dev, I
understand its necessity), and 'doom patch-macos' wasn't ideal for mac
users (needed to be reapplied every time you update Emacs). What's more,
many users (even Linux users) had to install exec-path-from-shell
anyway.
This solution suffers from none of their shortcomings. More reliable
than patch-macos, more performant and complete than
exec-path-from-shell, and easily handled by bin/doom.
2019-03-28 12:06:10 +08:00
|
|
|
|
2019-08-07 13:42:46 +08:00
|
|
|
This file is automatically regenerated when you run this command or 'doom
|
|
|
|
|
refresh'. However, 'doom refresh' will only regenerate this file if it exists.
|
:boom: Replace exec-path-from-shell w/ 'bin/doom env'
IMPORTANT: This is a breaking update for Mac users, as your shell
environment will no longer be inherited correctly (with the removal of
exec-path-from-shell). The quick fix is: 'bin/doom env refresh'. Also,
the set-env! autodef now does nothing (and is deprecated), be sure to
remove calls to it in your config.
Smaller changes:
+ This update also adds --no-* switches to doom quickstart
+ Includes general improvements to the documentation of several bin/doom
commands.
+ Moves doom/reload* commands to core/autoload/config.el
+ doom/reload-project has been removed (it didn't actually do anything)
The breaking change:
This update adds an "envvar file" to Doom Emacs. This file is generated
by `doom env refresh`, populated with variables scraped from your shell
environment (from both non-interactive and interactive sessions). This
file is then (inexpensively) loaded at startup, if it exists.
+ The file is manually generated with `doom env refresh`.
+ It can be regenerated automatically whenever `doom refresh` is run by
running `doom env enable` (`doom env clear` will reverse this and
delete the env file).
+ `doom quickstart` will ask if you want to auto-generate this envvar
file. You won't need it if you're confident Emacs will always be
started from the correct environment, however.
+ Your env file can be reloaded from a running Emacs session with `M-x
doom/reload-env`. Note: this won't work if the Emacs session you're
running it in doesn't have a correct SHELL set. i.e. don't use this to
create your first env file!
The idea isn't mine -- it's borrowed from Spacemacs -- and was
introduced to me in #1053 by @yurimx. I was impressed with it. Prior to
this, I was unhappy with exec-path-from-shell (no hate to the dev, I
understand its necessity), and 'doom patch-macos' wasn't ideal for mac
users (needed to be reapplied every time you update Emacs). What's more,
many users (even Linux users) had to install exec-path-from-shell
anyway.
This solution suffers from none of their shortcomings. More reliable
than patch-macos, more performant and complete than
exec-path-from-shell, and easily handled by bin/doom.
2019-03-28 12:06:10 +08:00
|
|
|
|
2019-08-07 13:42:46 +08:00
|
|
|
Use the -c or --clear switch to delete your envvar file."
|
2019-07-21 21:39:45 +08:00
|
|
|
(let ((default-directory doom-emacs-dir))
|
2019-07-26 01:42:01 +08:00
|
|
|
(when (member "clear" args) ; DEPRECATED
|
|
|
|
|
(message "'doom env clear' is deprecated. Use 'doom env -c' or 'doom env --clear' instead")
|
|
|
|
|
(push "-c" args))
|
|
|
|
|
|
|
|
|
|
(cond ((or (member "-c" args)
|
|
|
|
|
(member "--clear" args))
|
|
|
|
|
(unless (file-exists-p doom-env-file)
|
|
|
|
|
(user-error! "%S does not exist to be cleared"
|
|
|
|
|
(relpath doom-env-file)))
|
|
|
|
|
(delete-file doom-env-file)
|
|
|
|
|
(print! (success "Successfully deleted %S")
|
|
|
|
|
(relpath doom-env-file)))
|
|
|
|
|
|
|
|
|
|
((null args)
|
|
|
|
|
(doom-reload-env-file 'force))
|
|
|
|
|
|
|
|
|
|
((user-error "I don't understand 'doom env %s'"
|
|
|
|
|
(string-join args " "))))))
|
:boom: Replace exec-path-from-shell w/ 'bin/doom env'
IMPORTANT: This is a breaking update for Mac users, as your shell
environment will no longer be inherited correctly (with the removal of
exec-path-from-shell). The quick fix is: 'bin/doom env refresh'. Also,
the set-env! autodef now does nothing (and is deprecated), be sure to
remove calls to it in your config.
Smaller changes:
+ This update also adds --no-* switches to doom quickstart
+ Includes general improvements to the documentation of several bin/doom
commands.
+ Moves doom/reload* commands to core/autoload/config.el
+ doom/reload-project has been removed (it didn't actually do anything)
The breaking change:
This update adds an "envvar file" to Doom Emacs. This file is generated
by `doom env refresh`, populated with variables scraped from your shell
environment (from both non-interactive and interactive sessions). This
file is then (inexpensively) loaded at startup, if it exists.
+ The file is manually generated with `doom env refresh`.
+ It can be regenerated automatically whenever `doom refresh` is run by
running `doom env enable` (`doom env clear` will reverse this and
delete the env file).
+ `doom quickstart` will ask if you want to auto-generate this envvar
file. You won't need it if you're confident Emacs will always be
started from the correct environment, however.
+ Your env file can be reloaded from a running Emacs session with `M-x
doom/reload-env`. Note: this won't work if the Emacs session you're
running it in doesn't have a correct SHELL set. i.e. don't use this to
create your first env file!
The idea isn't mine -- it's borrowed from Spacemacs -- and was
introduced to me in #1053 by @yurimx. I was impressed with it. Prior to
this, I was unhappy with exec-path-from-shell (no hate to the dev, I
understand its necessity), and 'doom patch-macos' wasn't ideal for mac
users (needed to be reapplied every time you update Emacs). What's more,
many users (even Linux users) had to install exec-path-from-shell
anyway.
This solution suffers from none of their shortcomings. More reliable
than patch-macos, more performant and complete than
exec-path-from-shell, and easily handled by bin/doom.
2019-03-28 12:06:10 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
;;
|
|
|
|
|
;; Helpers
|
|
|
|
|
|
2019-04-03 12:08:06 +08:00
|
|
|
(defvar doom-env-ignored-vars
|
2019-07-10 21:06:45 +08:00
|
|
|
'("^PWD$"
|
|
|
|
|
"^PS1$"
|
|
|
|
|
"^R?PROMPT$"
|
|
|
|
|
"^DBUS_SESSION_BUS_ADDRESS$"
|
|
|
|
|
"^GPG_AGENT_INFO$"
|
|
|
|
|
"^SSH_AGENT_PID$"
|
|
|
|
|
"^SSH_AUTH_SOCK$"
|
2019-03-29 02:47:31 +08:00
|
|
|
;; Doom envvars
|
2019-07-10 21:06:45 +08:00
|
|
|
"^INSECURE$"
|
|
|
|
|
"^DEBUG$"
|
2019-07-27 06:01:44 +08:00
|
|
|
"^YES$"
|
|
|
|
|
"^__")
|
2019-06-26 00:38:27 +08:00
|
|
|
"Environment variables to not save in `doom-env-file'.
|
|
|
|
|
|
|
|
|
|
Each string is a regexp, matched against variable names to omit from
|
|
|
|
|
`doom-env-file'.")
|
:boom: Replace exec-path-from-shell w/ 'bin/doom env'
IMPORTANT: This is a breaking update for Mac users, as your shell
environment will no longer be inherited correctly (with the removal of
exec-path-from-shell). The quick fix is: 'bin/doom env refresh'. Also,
the set-env! autodef now does nothing (and is deprecated), be sure to
remove calls to it in your config.
Smaller changes:
+ This update also adds --no-* switches to doom quickstart
+ Includes general improvements to the documentation of several bin/doom
commands.
+ Moves doom/reload* commands to core/autoload/config.el
+ doom/reload-project has been removed (it didn't actually do anything)
The breaking change:
This update adds an "envvar file" to Doom Emacs. This file is generated
by `doom env refresh`, populated with variables scraped from your shell
environment (from both non-interactive and interactive sessions). This
file is then (inexpensively) loaded at startup, if it exists.
+ The file is manually generated with `doom env refresh`.
+ It can be regenerated automatically whenever `doom refresh` is run by
running `doom env enable` (`doom env clear` will reverse this and
delete the env file).
+ `doom quickstart` will ask if you want to auto-generate this envvar
file. You won't need it if you're confident Emacs will always be
started from the correct environment, however.
+ Your env file can be reloaded from a running Emacs session with `M-x
doom/reload-env`. Note: this won't work if the Emacs session you're
running it in doesn't have a correct SHELL set. i.e. don't use this to
create your first env file!
The idea isn't mine -- it's borrowed from Spacemacs -- and was
introduced to me in #1053 by @yurimx. I was impressed with it. Prior to
this, I was unhappy with exec-path-from-shell (no hate to the dev, I
understand its necessity), and 'doom patch-macos' wasn't ideal for mac
users (needed to be reapplied every time you update Emacs). What's more,
many users (even Linux users) had to install exec-path-from-shell
anyway.
This solution suffers from none of their shortcomings. More reliable
than patch-macos, more performant and complete than
exec-path-from-shell, and easily handled by bin/doom.
2019-03-28 12:06:10 +08:00
|
|
|
|
2019-04-03 12:08:06 +08:00
|
|
|
(defvar doom-env-executable
|
|
|
|
|
(if IS-WINDOWS
|
|
|
|
|
"set"
|
|
|
|
|
(executable-find "env"))
|
|
|
|
|
"The program to use to scrape your shell environment with.
|
|
|
|
|
It is rare that you'll need to change this.")
|
|
|
|
|
|
|
|
|
|
(defvar doom-env-switches
|
|
|
|
|
(if IS-WINDOWS
|
2019-05-18 09:34:21 +08:00
|
|
|
"-c"
|
|
|
|
|
"-ic") ; Execute in an interactive shell
|
2019-04-03 12:08:06 +08:00
|
|
|
"The `shell-command-switch'es to use on `doom-env-executable'.
|
|
|
|
|
This is a list of strings. Each entry is run separately and in sequence with
|
|
|
|
|
`doom-env-executable' to scrape envvars from your shell environment.")
|
|
|
|
|
|
|
|
|
|
;; Borrows heavily from Spacemacs' `spacemacs//init-spacemacs-env'.
|
:boom: Replace exec-path-from-shell w/ 'bin/doom env'
IMPORTANT: This is a breaking update for Mac users, as your shell
environment will no longer be inherited correctly (with the removal of
exec-path-from-shell). The quick fix is: 'bin/doom env refresh'. Also,
the set-env! autodef now does nothing (and is deprecated), be sure to
remove calls to it in your config.
Smaller changes:
+ This update also adds --no-* switches to doom quickstart
+ Includes general improvements to the documentation of several bin/doom
commands.
+ Moves doom/reload* commands to core/autoload/config.el
+ doom/reload-project has been removed (it didn't actually do anything)
The breaking change:
This update adds an "envvar file" to Doom Emacs. This file is generated
by `doom env refresh`, populated with variables scraped from your shell
environment (from both non-interactive and interactive sessions). This
file is then (inexpensively) loaded at startup, if it exists.
+ The file is manually generated with `doom env refresh`.
+ It can be regenerated automatically whenever `doom refresh` is run by
running `doom env enable` (`doom env clear` will reverse this and
delete the env file).
+ `doom quickstart` will ask if you want to auto-generate this envvar
file. You won't need it if you're confident Emacs will always be
started from the correct environment, however.
+ Your env file can be reloaded from a running Emacs session with `M-x
doom/reload-env`. Note: this won't work if the Emacs session you're
running it in doesn't have a correct SHELL set. i.e. don't use this to
create your first env file!
The idea isn't mine -- it's borrowed from Spacemacs -- and was
introduced to me in #1053 by @yurimx. I was impressed with it. Prior to
this, I was unhappy with exec-path-from-shell (no hate to the dev, I
understand its necessity), and 'doom patch-macos' wasn't ideal for mac
users (needed to be reapplied every time you update Emacs). What's more,
many users (even Linux users) had to install exec-path-from-shell
anyway.
This solution suffers from none of their shortcomings. More reliable
than patch-macos, more performant and complete than
exec-path-from-shell, and easily handled by bin/doom.
2019-03-28 12:06:10 +08:00
|
|
|
(defun doom-reload-env-file (&optional force-p)
|
2019-06-26 00:38:27 +08:00
|
|
|
"Generates `doom-env-file', if it doesn't exist (or if FORCE-P).
|
2019-04-03 12:08:06 +08:00
|
|
|
|
2019-06-26 00:38:27 +08:00
|
|
|
This scrapes the variables from your shell environment by running
|
|
|
|
|
`doom-env-executable' through `shell-file-name' with `doom-env-switches'. By
|
|
|
|
|
default, on Linux, this is '$SHELL -ic /usr/bin/env'. Variables in
|
|
|
|
|
`doom-env-ignored-vars' are removed."
|
:boom: Replace exec-path-from-shell w/ 'bin/doom env'
IMPORTANT: This is a breaking update for Mac users, as your shell
environment will no longer be inherited correctly (with the removal of
exec-path-from-shell). The quick fix is: 'bin/doom env refresh'. Also,
the set-env! autodef now does nothing (and is deprecated), be sure to
remove calls to it in your config.
Smaller changes:
+ This update also adds --no-* switches to doom quickstart
+ Includes general improvements to the documentation of several bin/doom
commands.
+ Moves doom/reload* commands to core/autoload/config.el
+ doom/reload-project has been removed (it didn't actually do anything)
The breaking change:
This update adds an "envvar file" to Doom Emacs. This file is generated
by `doom env refresh`, populated with variables scraped from your shell
environment (from both non-interactive and interactive sessions). This
file is then (inexpensively) loaded at startup, if it exists.
+ The file is manually generated with `doom env refresh`.
+ It can be regenerated automatically whenever `doom refresh` is run by
running `doom env enable` (`doom env clear` will reverse this and
delete the env file).
+ `doom quickstart` will ask if you want to auto-generate this envvar
file. You won't need it if you're confident Emacs will always be
started from the correct environment, however.
+ Your env file can be reloaded from a running Emacs session with `M-x
doom/reload-env`. Note: this won't work if the Emacs session you're
running it in doesn't have a correct SHELL set. i.e. don't use this to
create your first env file!
The idea isn't mine -- it's borrowed from Spacemacs -- and was
introduced to me in #1053 by @yurimx. I was impressed with it. Prior to
this, I was unhappy with exec-path-from-shell (no hate to the dev, I
understand its necessity), and 'doom patch-macos' wasn't ideal for mac
users (needed to be reapplied every time you update Emacs). What's more,
many users (even Linux users) had to install exec-path-from-shell
anyway.
This solution suffers from none of their shortcomings. More reliable
than patch-macos, more performant and complete than
exec-path-from-shell, and easily handled by bin/doom.
2019-03-28 12:06:10 +08:00
|
|
|
(when (or force-p (not (file-exists-p doom-env-file)))
|
|
|
|
|
(with-temp-file doom-env-file
|
2019-07-21 21:39:45 +08:00
|
|
|
(print! (start "%s envvars file at %S")
|
:boom: Replace exec-path-from-shell w/ 'bin/doom env'
IMPORTANT: This is a breaking update for Mac users, as your shell
environment will no longer be inherited correctly (with the removal of
exec-path-from-shell). The quick fix is: 'bin/doom env refresh'. Also,
the set-env! autodef now does nothing (and is deprecated), be sure to
remove calls to it in your config.
Smaller changes:
+ This update also adds --no-* switches to doom quickstart
+ Includes general improvements to the documentation of several bin/doom
commands.
+ Moves doom/reload* commands to core/autoload/config.el
+ doom/reload-project has been removed (it didn't actually do anything)
The breaking change:
This update adds an "envvar file" to Doom Emacs. This file is generated
by `doom env refresh`, populated with variables scraped from your shell
environment (from both non-interactive and interactive sessions). This
file is then (inexpensively) loaded at startup, if it exists.
+ The file is manually generated with `doom env refresh`.
+ It can be regenerated automatically whenever `doom refresh` is run by
running `doom env enable` (`doom env clear` will reverse this and
delete the env file).
+ `doom quickstart` will ask if you want to auto-generate this envvar
file. You won't need it if you're confident Emacs will always be
started from the correct environment, however.
+ Your env file can be reloaded from a running Emacs session with `M-x
doom/reload-env`. Note: this won't work if the Emacs session you're
running it in doesn't have a correct SHELL set. i.e. don't use this to
create your first env file!
The idea isn't mine -- it's borrowed from Spacemacs -- and was
introduced to me in #1053 by @yurimx. I was impressed with it. Prior to
this, I was unhappy with exec-path-from-shell (no hate to the dev, I
understand its necessity), and 'doom patch-macos' wasn't ideal for mac
users (needed to be reapplied every time you update Emacs). What's more,
many users (even Linux users) had to install exec-path-from-shell
anyway.
This solution suffers from none of their shortcomings. More reliable
than patch-macos, more performant and complete than
exec-path-from-shell, and easily handled by bin/doom.
2019-03-28 12:06:10 +08:00
|
|
|
(if (file-exists-p doom-env-file)
|
|
|
|
|
"Regenerating"
|
|
|
|
|
"Generating")
|
2019-07-21 21:39:45 +08:00
|
|
|
(relpath doom-env-file doom-emacs-dir))
|
|
|
|
|
(let ((process-environment doom--initial-process-environment))
|
|
|
|
|
(let ((shell-command-switch doom-env-switches)
|
|
|
|
|
(error-buffer (get-buffer-create "*env errors*")))
|
|
|
|
|
(print! (info "Scraping shell environment with '%s %s %s'")
|
|
|
|
|
(filename shell-file-name)
|
|
|
|
|
shell-command-switch
|
|
|
|
|
(filename doom-env-executable))
|
2019-06-26 00:38:27 +08:00
|
|
|
(save-excursion
|
2019-07-21 21:39:45 +08:00
|
|
|
(shell-command doom-env-executable (current-buffer) error-buffer))
|
|
|
|
|
(print-group!
|
|
|
|
|
(let ((errors (with-current-buffer error-buffer (buffer-string))))
|
|
|
|
|
(unless (string-empty-p errors)
|
|
|
|
|
(print! (info "Error output:\n\n%s") (indent 4 errors))))
|
|
|
|
|
;; Remove undesireable variables
|
2019-07-27 06:02:38 +08:00
|
|
|
(insert
|
|
|
|
|
(concat
|
|
|
|
|
"# -*- mode: dotenv -*-\n"
|
|
|
|
|
(format "# Generated with: %s %s %s\n"
|
|
|
|
|
shell-file-name
|
|
|
|
|
doom-env-switches
|
|
|
|
|
doom-env-executable)
|
|
|
|
|
"# ---------------------------------------------------------------------------\n"
|
2019-08-16 04:07:16 +08:00
|
|
|
"# This file was auto-generated by `doom env'. It contains a list of environment\n"
|
|
|
|
|
"# variables scraped from your default shell (excluding variables blacklisted\n"
|
|
|
|
|
"# in doom-env-ignored-vars).\n"
|
2019-07-27 06:02:38 +08:00
|
|
|
"#\n"
|
|
|
|
|
"# It is NOT safe to edit this file. Changes will be overwritten next time that\n"
|
2019-08-16 04:07:16 +08:00
|
|
|
"# `doom refresh` is executed. Alternatively, create your own env file and load\n"
|
|
|
|
|
"# it with `(doom-load-envvars-file FILE)` in your private config.el.\n"
|
2019-07-27 06:02:38 +08:00
|
|
|
"# ---------------------------------------------------------------------------\n\n"))
|
|
|
|
|
(goto-char (point-min))
|
2019-07-21 21:39:45 +08:00
|
|
|
(while (re-search-forward "\n\\([^= \n]+\\)=" nil t)
|
|
|
|
|
(save-excursion
|
|
|
|
|
(let* ((valend (or (save-match-data
|
|
|
|
|
(when (re-search-forward "^\\([^= ]+\\)=" nil t)
|
|
|
|
|
(line-beginning-position)))
|
|
|
|
|
(point-max)))
|
|
|
|
|
(var (match-string 1)))
|
|
|
|
|
(when (cl-loop for regexp in doom-env-ignored-vars
|
|
|
|
|
if (string-match-p regexp var)
|
|
|
|
|
return t)
|
|
|
|
|
(print! (info "Ignoring %s") var)
|
|
|
|
|
(delete-region (match-beginning 0) (1- valend)))))))
|
|
|
|
|
(print! (success "Successfully generated %S")
|
|
|
|
|
(relpath doom-env-file doom-emacs-dir))
|
|
|
|
|
t)))))
|