mirror of
https://github.com/expo/direnv.git
synced 2026-11-15 17:31:31 -10:00
536 lines
12 KiB
Bash
536 lines
12 KiB
Bash
#!bash
|
|
#
|
|
# These are the commands available in an .envrc context
|
|
#
|
|
set -e
|
|
direnv="%s"
|
|
|
|
DIRENV_LOG_FORMAT="${DIRENV_LOG_FORMAT-direnv: %%s}"
|
|
|
|
# Usage: log_status [<message> ...]
|
|
#
|
|
# Logs a status message. Acts like echo,
|
|
# but wraps output in the standard direnv log format
|
|
# (controlled by $DIRENV_LOG_FORMAT), and directs it
|
|
# to stderr rather than stdout.
|
|
#
|
|
# Example:
|
|
#
|
|
# log_status "Loading ..."
|
|
#
|
|
log_status() {
|
|
if [[ -n $DIRENV_LOG_FORMAT ]]; then
|
|
local msg=$*
|
|
# shellcheck disable=SC2059
|
|
printf "${DIRENV_LOG_FORMAT}\n" "$msg" >&2
|
|
fi
|
|
}
|
|
|
|
# Usage: log_error [<message> ...]
|
|
#
|
|
# Logs an error message. Acts like echo,
|
|
# but wraps output in the standard direnv log format
|
|
# (controlled by $DIRENV_LOG_FORMAT), and directs it
|
|
# to stderr rather than stdout.
|
|
#
|
|
# Example:
|
|
#
|
|
# log_error "Unable to find specified directory!"
|
|
|
|
log_error() {
|
|
local color_normal
|
|
local color_error
|
|
color_normal=$(tput sgr0)
|
|
color_error="\e[0;31m"
|
|
if [[ -n $DIRENV_LOG_FORMAT ]]; then
|
|
local msg=$*
|
|
# shellcheck disable=SC2059
|
|
printf "${color_error}${DIRENV_LOG_FORMAT}${color_normal}\n" "$msg" >&2
|
|
fi
|
|
}
|
|
|
|
# Usage: has <command>
|
|
#
|
|
# Returns 0 if the <command> is available. Returns 1 otherwise. It can be a
|
|
# binary in the PATH or a shell function.
|
|
#
|
|
# Example:
|
|
#
|
|
# if has curl; then
|
|
# echo "Yes we do"
|
|
# fi
|
|
#
|
|
has() {
|
|
type "$1" &>/dev/null
|
|
}
|
|
|
|
# Usage: expand_path <rel_path> [<relative_to>]
|
|
#
|
|
# Outputs the absolute path of <rel_path> relative to <relative_to> or the
|
|
# current directory.
|
|
#
|
|
# Example:
|
|
#
|
|
# cd /usr/local/games
|
|
# expand_path ../foo
|
|
# # output: /usr/local/foo
|
|
#
|
|
expand_path() {
|
|
"$direnv" expand_path "$@"
|
|
}
|
|
|
|
# Usage: dotenv [<dotenv>]
|
|
#
|
|
# Loads a ".env" file into the current environment
|
|
#
|
|
dotenv() {
|
|
local path=$1
|
|
if [[ -z $path ]]; then
|
|
path=$PWD/.env
|
|
elif [[ -d $path ]]; then
|
|
path=$path/.env
|
|
fi
|
|
if ! [[ -f $path ]]; then
|
|
log_error ".env at $path not found"
|
|
return 1
|
|
fi
|
|
eval "$("$direnv" dotenv bash "$@")"
|
|
watch_file "$path"
|
|
}
|
|
|
|
# Usage: user_rel_path <abs_path>
|
|
#
|
|
# Transforms an absolute path <abs_path> into a user-relative path if
|
|
# possible.
|
|
#
|
|
# Example:
|
|
#
|
|
# echo $HOME
|
|
# # output: /home/user
|
|
# user_rel_path /home/user/my/project
|
|
# # output: ~/my/project
|
|
# user_rel_path /usr/local/lib
|
|
# # output: /usr/local/lib
|
|
#
|
|
user_rel_path() {
|
|
local abs_path=${1#-}
|
|
|
|
if [[ -z $abs_path ]]; then return; fi
|
|
|
|
if [[ -n $HOME ]]; then
|
|
local rel_path=${abs_path#$HOME}
|
|
if [[ $rel_path != "$abs_path" ]]; then
|
|
abs_path=~$rel_path
|
|
fi
|
|
fi
|
|
|
|
echo "$abs_path"
|
|
}
|
|
|
|
# Usage: find_up <filename>
|
|
#
|
|
# Outputs the path of <filename> when searched from the current directory up to
|
|
# /. Returns 1 if the file has not been found.
|
|
#
|
|
# Example:
|
|
#
|
|
# cd /usr/local/my
|
|
# mkdir -p project/foo
|
|
# touch bar
|
|
# cd project/foo
|
|
# find_up bar
|
|
# # output: /usr/local/my/bar
|
|
#
|
|
find_up() {
|
|
(
|
|
cd "$(pwd -P 2>/dev/null)"
|
|
while true; do
|
|
if [[ -f $1 ]]; then
|
|
echo "$PWD/$1"
|
|
return 0
|
|
fi
|
|
if [[ $PWD = / ]] || [[ $PWD = // ]]; then
|
|
return 1
|
|
fi
|
|
cd ..
|
|
done
|
|
)
|
|
}
|
|
|
|
# Usage: source_env <file_or_dir_path>
|
|
#
|
|
# Loads another ".envrc" either by specifying its path or filename.
|
|
source_env() {
|
|
local rcpath=${1/#\~/$HOME}
|
|
local rcfile
|
|
if ! [[ -f $rcpath ]]; then
|
|
rcpath=$rcpath/.envrc
|
|
fi
|
|
|
|
rcfile=$(user_rel_path "$rcpath")
|
|
watch_file "$rcpath"
|
|
|
|
pushd "$(pwd -P 2>/dev/null)" > /dev/null
|
|
pushd "$(dirname "$rcpath")" > /dev/null
|
|
if [[ -f ./$(basename "$rcpath") ]]; then
|
|
log_status "loading $rcfile"
|
|
# shellcheck source=/dev/null
|
|
. "./$(basename "$rcpath")"
|
|
else
|
|
log_status "referenced $rcfile does not exist"
|
|
fi
|
|
popd > /dev/null
|
|
popd > /dev/null
|
|
}
|
|
|
|
# Usage: watch_file <filename>
|
|
#
|
|
# Adds <path> to the list of files that direnv will watch for changes - useful when the contents
|
|
# of a file influence how variables are set - especially in direnvrc
|
|
#
|
|
watch_file() {
|
|
local file=${1/#\~/$HOME}
|
|
|
|
eval "$($direnv watch "$file")"
|
|
}
|
|
|
|
|
|
# Usage: source_up [<filename>]
|
|
#
|
|
# Loads another ".envrc" if found with the find_up command.
|
|
#
|
|
source_up() {
|
|
local file=$1
|
|
local dir
|
|
if [[ -z $file ]]; then
|
|
file=.envrc
|
|
fi
|
|
dir=$(cd .. && find_up "$file")
|
|
if [[ -n $dir ]]; then
|
|
source_env "$(user_rel_path "$dir")"
|
|
fi
|
|
}
|
|
|
|
# Usage: direnv_load <command-generating-dump-output>
|
|
# e.g: direnv_load opam-env exec -- direnv dump
|
|
#
|
|
# Applies the environment generated by running <argv> as a
|
|
# command. This is useful for adopting the environment of a child
|
|
# process - cause that process to run "direnv dump" and then wrap
|
|
# the results with direnv_load.
|
|
#
|
|
direnv_load() {
|
|
local exports
|
|
exports=$("$direnv" apply_dump <("$@"))
|
|
local es=$?
|
|
if [[ $es -ne 0 ]]; then
|
|
return $es
|
|
fi
|
|
eval "$exports"
|
|
}
|
|
|
|
# Usage: PATH_add <path>
|
|
#
|
|
# Prepends the expanded <path> to the PATH environment variable. It prevents a
|
|
# common mistake where PATH is replaced by only the new <path>.
|
|
#
|
|
# Example:
|
|
#
|
|
# pwd
|
|
# # output: /home/user/my/project
|
|
# PATH_add bin
|
|
# echo $PATH
|
|
# # output: /home/user/my/project/bin:/usr/bin:/bin
|
|
#
|
|
PATH_add() {
|
|
PATH=$(expand_path "$1"):$PATH
|
|
export PATH
|
|
}
|
|
|
|
# Usage: path_add <varname> <path>
|
|
#
|
|
# Works like PATH_add except that it's for an arbitrary <varname>.
|
|
path_add() {
|
|
local old_paths="${!1}"
|
|
local dir
|
|
dir=$(expand_path "$2")
|
|
|
|
if [[ -z $old_paths ]]; then
|
|
old_paths="$dir"
|
|
else
|
|
old_paths="$dir:$old_paths"
|
|
fi
|
|
|
|
export "$1=$old_paths"
|
|
}
|
|
|
|
# Usage: load_prefix <prefix_path>
|
|
#
|
|
# Expands some common path variables for the given <prefix_path> prefix. This is
|
|
# useful if you installed something in the <prefix_path> using
|
|
# $(./configure --prefix=<prefix_path> && make install) and want to use it in
|
|
# the project.
|
|
#
|
|
# Variables set:
|
|
#
|
|
# CPATH
|
|
# LD_LIBRARY_PATH
|
|
# LIBRARY_PATH
|
|
# MANPATH
|
|
# PATH
|
|
# PKG_CONFIG_PATH
|
|
#
|
|
# Example:
|
|
#
|
|
# ./configure --prefix=$HOME/rubies/ruby-1.9.3
|
|
# make && make install
|
|
# # Then in the .envrc
|
|
# load_prefix ~/rubies/ruby-1.9.3
|
|
#
|
|
load_prefix() {
|
|
local dir
|
|
dir=$(expand_path "$1")
|
|
path_add CPATH "$dir/include"
|
|
path_add LD_LIBRARY_PATH "$dir/lib"
|
|
path_add LIBRARY_PATH "$dir/lib"
|
|
path_add MANPATH "$dir/man"
|
|
path_add MANPATH "$dir/share/man"
|
|
path_add PATH "$dir/bin"
|
|
path_add PKG_CONFIG_PATH "$dir/lib/pkgconfig"
|
|
}
|
|
|
|
# Usage: layout <type>
|
|
#
|
|
# A semantic dispatch used to describe common project layouts.
|
|
#
|
|
layout() {
|
|
local name=$1
|
|
shift
|
|
eval "layout_$name" "$@"
|
|
}
|
|
|
|
# Usage: layout go
|
|
#
|
|
# Sets the GOPATH environment variable to the current directory.
|
|
#
|
|
layout_go() {
|
|
path_add GOPATH "$PWD"
|
|
PATH_add bin
|
|
}
|
|
|
|
# Usage: layout node
|
|
#
|
|
# Adds "$PWD/node_modules/.bin" to the PATH environment variable.
|
|
layout_node() {
|
|
PATH_add node_modules/.bin
|
|
}
|
|
|
|
# Usage: layout perl
|
|
#
|
|
# Setup environment variables required by perl's local::lib
|
|
# See http://search.cpan.org/dist/local-lib/lib/local/lib.pm for more details
|
|
#
|
|
layout_perl() {
|
|
local libdir=$PWD/.direnv/perl5
|
|
export LOCAL_LIB_DIR=$libdir
|
|
export PERL_MB_OPT="--install_base '$libdir'"
|
|
export PERL_MM_OPT="INSTALL_BASE=$libdir"
|
|
path_add PERL5LIB "$libdir/lib/perl5"
|
|
path_add PERL_LOCAL_LIB_ROOT "$libdir"
|
|
PATH_add "$libdir/bin"
|
|
}
|
|
|
|
# Usage: layout python <python_exe>
|
|
#
|
|
# Creates and loads a virtualenv environment under
|
|
# "$PWD/.direnv/python-$python_version".
|
|
# This forces the installation of any egg into the project's sub-folder.
|
|
#
|
|
# It's possible to specify the python executable if you want to use different
|
|
# versions of python.
|
|
#
|
|
layout_python() {
|
|
local python=${1:-python}
|
|
local old_env=$PWD/.direnv/virtualenv
|
|
unset PYTHONHOME
|
|
if [[ -d $old_env && $python = python ]]; then
|
|
export VIRTUAL_ENV=$old_env
|
|
else
|
|
local python_version
|
|
python_version=$("$python" -c "import platform as p;print(p.python_version())")
|
|
if [[ -z $python_version ]]; then
|
|
log_error "Could not find python's version"
|
|
return 1
|
|
fi
|
|
|
|
export VIRTUAL_ENV=$PWD/.direnv/python-$python_version
|
|
if [[ ! -d $VIRTUAL_ENV ]]; then
|
|
virtualenv "--python=$python" "$VIRTUAL_ENV"
|
|
fi
|
|
fi
|
|
PATH_add "$VIRTUAL_ENV/bin"
|
|
}
|
|
|
|
# Usage: layout python3
|
|
#
|
|
# A shortcut for $(layout python python3)
|
|
#
|
|
layout_python3() {
|
|
layout_python python3
|
|
}
|
|
|
|
# Usage: layout ruby
|
|
#
|
|
# Sets the GEM_HOME environment variable to "$PWD/.direnv/ruby/RUBY_VERSION".
|
|
# This forces the installation of any gems into the project's sub-folder.
|
|
# If you're using bundler it will create wrapper programs that can be invoked
|
|
# directly instead of using the $(bundle exec) prefix.
|
|
#
|
|
layout_ruby() {
|
|
if ruby -e "exit Gem::VERSION > '2.2.0'" 2>/dev/null; then
|
|
export GEM_HOME=$PWD/.direnv/ruby
|
|
else
|
|
local ruby_version
|
|
ruby_version=$(ruby -e"puts (defined?(RUBY_ENGINE) ? RUBY_ENGINE : 'ruby') + '-' + RUBY_VERSION")
|
|
export GEM_HOME=$PWD/.direnv/ruby-${ruby_version}
|
|
fi
|
|
export BUNDLE_BIN=$PWD/.direnv/bin
|
|
|
|
PATH_add "$GEM_HOME/bin"
|
|
PATH_add "$BUNDLE_BIN"
|
|
}
|
|
|
|
# Usage: use <program_name> [<version>]
|
|
#
|
|
# A semantic command dispatch intended for loading external dependencies into
|
|
# the environment.
|
|
#
|
|
# Example:
|
|
#
|
|
# use_ruby() {
|
|
# echo "Ruby $1"
|
|
# }
|
|
# use ruby 1.9.3
|
|
# # output: Ruby 1.9.3
|
|
#
|
|
use() {
|
|
local cmd=$1
|
|
log_status "using $*"
|
|
shift
|
|
"use_$cmd" "$@"
|
|
}
|
|
|
|
# Usage: use rbenv
|
|
#
|
|
# Loads rbenv which add the ruby wrappers available on the PATH.
|
|
#
|
|
use_rbenv() {
|
|
eval "$(rbenv init -)"
|
|
}
|
|
|
|
# Usage: rvm [...]
|
|
#
|
|
# Should work just like in the shell if you have rvm installed.#
|
|
#
|
|
rvm() {
|
|
unset rvm
|
|
if [[ -n ${rvm_scripts_path:-} ]]; then
|
|
# shellcheck source=/dev/null
|
|
source "${rvm_scripts_path}/rvm"
|
|
elif [[ -n ${rvm_path:-} ]]; then
|
|
# shellcheck source=/dev/null
|
|
source "${rvm_path}/scripts/rvm"
|
|
else
|
|
# shellcheck source=/dev/null
|
|
source "$HOME/.rvm/scripts/rvm"
|
|
fi
|
|
rvm "$@"
|
|
}
|
|
|
|
# Usage: use node
|
|
# Loads NodeJS version from a `.node-version` or `.nvmrc` file.
|
|
#
|
|
# Usage: use node <version>
|
|
# Loads specified NodeJS version.
|
|
#
|
|
# If you specify a partial NodeJS version (i.e. `4.2`), a fuzzy match
|
|
# is performed and the highest matching version installed is selected.
|
|
#
|
|
# Environment Variables:
|
|
#
|
|
# - $NODE_VERSIONS (required)
|
|
# You must specify a path to your installed NodeJS versions via the `$NODE_VERSIONS` variable.
|
|
#
|
|
# - $NODE_VERSION_PREFIX (optional) [default="node-v"]
|
|
# Overrides the default version prefix.
|
|
|
|
use_node() {
|
|
local version=$1
|
|
local via=""
|
|
local node_wanted
|
|
local node_prefix
|
|
|
|
if [[ -z $NODE_VERSIONS ]] || [[ ! -d $NODE_VERSIONS ]]; then
|
|
log_error "You must specify a \$NODE_VERSIONS environment variable and the directory specified must exist!"
|
|
return 1
|
|
fi
|
|
|
|
if [[ -z $version ]] && [[ -f .nvmrc ]]; then
|
|
version=$(< .nvmrc)
|
|
via=".nvmrc"
|
|
fi
|
|
|
|
if [[ -z $version ]] && [[ -f .node-version ]]; then
|
|
version=$(< .node-version)
|
|
via=".node-version"
|
|
fi
|
|
|
|
if [[ -z $version ]]; then
|
|
log_error "I do not know which NodeJS version to load because one has not been specified!"
|
|
return 1
|
|
fi
|
|
|
|
node_wanted=${NODE_VERSION_PREFIX-"node-v"}$version
|
|
node_prefix=$(find "$NODE_VERSIONS" -maxdepth 1 -mindepth 1 -type d -name "$node_wanted*" | sort -r -t . -k 1,1n -k 2,2n -k 3,3n | head -1)
|
|
|
|
if [[ ! -d $node_prefix ]]; then
|
|
log_error "Unable to find NodeJS version ($version) in ($NODE_VERSIONS)!"
|
|
return 1
|
|
fi
|
|
|
|
if [[ ! -x $node_prefix/bin/node ]]; then
|
|
log_error "Unable to load NodeJS binary (node) for version ($version) in ($NODE_VERSIONS)!"
|
|
return 1
|
|
fi
|
|
|
|
load_prefix "$node_prefix"
|
|
|
|
if [[ -z $via ]]; then
|
|
log_status "Successfully loaded NodeJS $(node --version), from prefix ($node_prefix)"
|
|
else
|
|
log_status "Successfully loaded NodeJS $(node --version) (via $via), from prefix ($node_prefix)"
|
|
fi
|
|
}
|
|
|
|
# Usage: use_nix [...]
|
|
#
|
|
# Load environment variables from `nix-shell`.
|
|
# If you have a `default.nix` or `shell.nix` these will be
|
|
# used by default, but you can also specify packages directly
|
|
# (e.g `use nix -p ocaml`).
|
|
#
|
|
use_nix() {
|
|
direnv_load nix-shell --show-trace "$@" --run 'direnv dump'
|
|
if [[ $# = 0 ]]; then
|
|
watch_file default.nix
|
|
watch_file shell.nix
|
|
fi
|
|
}
|
|
|
|
## Load the global ~/.direnvrc if present
|
|
if [[ -f ${XDG_CONFIG_HOME:-$HOME/.config}/direnv/direnvrc ]]; then
|
|
source_env "${XDG_CONFIG_HOME:-$HOME/.config}/direnv/direnvrc" >&2
|
|
elif [[ -f $HOME/.direnvrc ]]; then
|
|
source_env "$HOME/.direnvrc" >&2
|
|
fi
|