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

feat: automatically call hook-env #3373

Merged
merged 2 commits into from
Dec 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ docs/cli
docs/environments.md
docs/public/site.webmanifest
docs/registry.md
src/assets/bash_zsh_support/
tasks.md
tmp
xtasks/fig/src/mise.ts
14 changes: 5 additions & 9 deletions docs/cli/activate.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,18 @@

Initializes mise in the current shell session

This should go into your shell's rc file.
This should go into your shell's rc file or login shell.
Otherwise, it will only take effect in the current session.
(e.g. ~/.zshrc, ~/.bashrc)
(e.g. ~/.zshrc, ~/.zprofile, ~/.zshenv, ~/.bashrc, ~/.bash_profile, ~/.profile, ~/.config/fish/config.fish)

This is only intended to be used in interactive sessions, not scripts.
mise is only capable of updating PATH when the prompt is displayed to the user.
For non-interactive use-cases, use shims instead.
Typically, this can be added with something like the following:

Typically this can be added with something like the following:

echo 'eval "$(mise activate)"' >> ~/.zshrc
echo 'eval "$(mise activate zsh)"' >> ~/.zshrc

However, this requires that "mise" is in your PATH. If it is not, you need to
specify the full path like this:

echo 'eval "$(/path/to/mise activate)"' >> ~/.zshrc
echo 'eval "$(/path/to/mise activate zsh)"' >> ~/.zshrc

Customize status output with `status` settings.

Expand Down
8 changes: 4 additions & 4 deletions e2e/cli/test_hook_env
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

mise i dummy@{1.0.0,1.1.0,2.0.0}

eval "$(mise activate bash)"
eval "$(mise activate bash --status)"

mise use dummy@2.0.0
eval "$(mise hook-env)"
pushd .. && popd
assert_contains "dummy" "2.0.0"

mise shell dummy@1.0.0
eval "$(mise hook-env)"
pushd .. && popd
assert_contains "dummy" "1.0.0"

# TODO: make "v" prefixes optional
export MISE_DUMMY_VERSION=1.1.0
eval "$(mise hook-env)"
pushd .. && popd
assert_contains "dummy" "1.1.0"
25 changes: 6 additions & 19 deletions e2e/direnv/test_direnv
Original file line number Diff line number Diff line change
Expand Up @@ -14,39 +14,26 @@ cat <<EOF >.envrc
PATH_add node_modules/.bin
export FIRST='first'
EOF
direnv allow

export FIRST="last"

# Activate direnv and mise
eval "$(direnv hook bash)"
eval "$(mise activate bash --status)"
eval "$(direnv hook bash)"

# Tell mise to use dummy@latest
mise use dummy@latest && _mise_hook && _direnv_hook
mise use dummy@latest && _direnv_hook

# Should use dummy@latest
assert "which dummy" "$MISE_DATA_DIR/installs/dummy/2.0.0/bin/dummy"
assert "which dummy" "$PWD/node_modules/.bin/dummy"
# shellcheck disable=SC2016
assert 'echo $FIRST' "last"
assert 'echo $FIRST' "first"

# Allow direnv to use the .envrc file
direnv allow && _mise_hook && _direnv_hook
_direnv_hook

# Should use dummy from node_modules (direnv PATH takes precedence)
assert "which dummy" "$PWD/node_modules/.bin/dummy"
# shellcheck disable=SC2016
assert 'echo $FIRST' "first"

# Deny direnv from using the .envrc file
direnv deny && _mise_hook && _direnv_hook

# Should use dummy@latest again
assert "which dummy" "$MISE_DATA_DIR/installs/dummy/2.0.0/bin/dummy"
# shellcheck disable=SC2016
assert 'echo $FIRST' "last"

# Allow direnv to use the .envrc file, but this a different activation order
direnv allow && _direnv_hook && _mise_hook

# Should use dummy from node_modules (direnv PATH takes precedence)
assert "which dummy" "$PWD/node_modules/.bin/dummy"
14 changes: 5 additions & 9 deletions mise.usage.kdl
Original file line number Diff line number Diff line change
Expand Up @@ -56,22 +56,18 @@ arg "[TASK_ARGS]..." help="Task arguments" var=true hide=true
cmd "activate" help="Initializes mise in the current shell session" {
long_help r#"Initializes mise in the current shell session

This should go into your shell's rc file.
This should go into your shell's rc file or login shell.
Otherwise, it will only take effect in the current session.
(e.g. ~/.zshrc, ~/.bashrc)
(e.g. ~/.zshrc, ~/.zprofile, ~/.zshenv, ~/.bashrc, ~/.bash_profile, ~/.profile, ~/.config/fish/config.fish)

This is only intended to be used in interactive sessions, not scripts.
mise is only capable of updating PATH when the prompt is displayed to the user.
For non-interactive use-cases, use shims instead.
Typically, this can be added with something like the following:

Typically this can be added with something like the following:

echo 'eval "$(mise activate)"' >> ~/.zshrc
echo 'eval "$(mise activate zsh)"' >> ~/.zshrc

However, this requires that "mise" is in your PATH. If it is not, you need to
specify the full path like this:

echo 'eval "$(/path/to/mise activate)"' >> ~/.zshrc
echo 'eval "$(/path/to/mise activate zsh)"' >> ~/.zshrc

Customize status output with `status` settings."#
after_long_help r#"Examples:
Expand Down
165 changes: 165 additions & 0 deletions src/assets/bash_zsh_support/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007

Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.


This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.

0. Additional Definitions.

As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.

"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.

An "Application" is any work that makes use of an interface provided
by the Library, but which is not otherwise based on the Library.
Defining a subclass of a class defined by the Library is deemed a mode
of using an interface provided by the Library.

A "Combined Work" is a work produced by combining or linking an
Application with the Library. The particular version of the Library
with which the Combined Work was made is also called the "Linked
Version".

The "Minimal Corresponding Source" for a Combined Work means the
Corresponding Source for the Combined Work, excluding any source code
for portions of the Combined Work that, considered in isolation, are
based on the Application, and not on the Linked Version.

The "Corresponding Application Code" for a Combined Work means the
object code and/or source code for the Application, including any data
and utility programs needed for reproducing the Combined Work from the
Application, but excluding the System Libraries of the Combined Work.

1. Exception to Section 3 of the GNU GPL.

You may convey a covered work under sections 3 and 4 of this License
without being bound by section 3 of the GNU GPL.

2. Conveying Modified Versions.

If you modify a copy of the Library, and, in your modifications, a
facility refers to a function or data to be supplied by an Application
that uses the facility (other than as an argument passed when the
facility is invoked), then you may convey a copy of the modified
version:

a) under this License, provided that you make a good faith effort to
ensure that, in the event an Application does not supply the
function or data, the facility still operates, and performs
whatever part of its purpose remains meaningful, or

b) under the GNU GPL, with none of the additional permissions of
this License applicable to that copy.

3. Object Code Incorporating Material from Library Header Files.

The object code form of an Application may incorporate material from
a header file that is part of the Library. You may convey such object
code under terms of your choice, provided that, if the incorporated
material is not limited to numerical parameters, data structure
layouts and accessors, or small macros, inline functions and templates
(ten or fewer lines in length), you do both of the following:

a) Give prominent notice with each copy of the object code that the
Library is used in it and that the Library and its use are
covered by this License.

b) Accompany the object code with a copy of the GNU GPL and this license
document.

4. Combined Works.

You may convey a Combined Work under terms of your choice that,
taken together, effectively do not restrict modification of the
portions of the Library contained in the Combined Work and reverse
engineering for debugging such modifications, if you also do each of
the following:

a) Give prominent notice with each copy of the Combined Work that
the Library is used in it and that the Library and its use are
covered by this License.

b) Accompany the Combined Work with a copy of the GNU GPL and this license
document.

c) For a Combined Work that displays copyright notices during
execution, include the copyright notice for the Library among
these notices, as well as a reference directing the user to the
copies of the GNU GPL and this license document.

d) Do one of the following:

0) Convey the Minimal Corresponding Source under the terms of this
License, and the Corresponding Application Code in a form
suitable for, and under terms that permit, the user to
recombine or relink the Application with a modified version of
the Linked Version to produce a modified Combined Work, in the
manner specified by section 6 of the GNU GPL for conveying
Corresponding Source.

1) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (a) uses at run time
a copy of the Library already present on the user's computer
system, and (b) will operate properly with a modified version
of the Library that is interface-compatible with the Linked
Version.

e) Provide Installation Information, but only if you would otherwise
be required to provide such information under section 6 of the
GNU GPL, and only to the extent that such information is
necessary to install and execute a modified version of the
Combined Work produced by recombining or relinking the
Application with a modified version of the Linked Version. (If
you use option 4d0, the Installation Information must accompany
the Minimal Corresponding Source and Corresponding Application
Code. If you use option 4d1, you must provide the Installation
Information in the manner specified by section 6 of the GNU GPL
for conveying Corresponding Source.)

5. Combined Libraries.

You may place library facilities that are a work based on the
Library side by side in a single library together with other library
facilities that are not Applications and are not covered by this
License, and convey such a combined library under terms of your
choice, if you do both of the following:

a) Accompany the combined library with a copy of the same work based
on the Library, uncombined with any other library facilities,
conveyed under the terms of this License.

b) Give prominent notice with the combined library that part of it
is a work based on the Library, and explaining where to find the
accompanying uncombined form of the same work.

6. Revised Versions of the GNU Lesser General Public License.

The Free Software Foundation may publish revised and/or new versions
of the GNU Lesser General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the
Library as you received it specifies that a certain numbered version
of the GNU Lesser General Public License "or any later version"
applies to it, you have the option of following the terms and
conditions either of that published version or of any later version
published by the Free Software Foundation. If the Library as you
received it does not specify a version number of the GNU Lesser
General Public License, you may choose any version of the GNU Lesser
General Public License ever published by the Free Software Foundation.

If the Library as you received it specifies that a proxy can decide
whether future versions of the GNU Lesser General Public License shall
apply, that proxy's public statement of acceptance of any version is
permanent authorization for you to choose that version for the
Library.
3 changes: 3 additions & 0 deletions src/assets/bash_zsh_support/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# bash_zsh_support

support Zsh function hooks for Bash
17 changes: 17 additions & 0 deletions src/assets/bash_zsh_support/chpwd/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Bash support for Zsh like chpwd hook

Implemented based on the description from
<http://zsh.sourceforge.net/Doc/Release/Functions.html#Hook-Functions>

## Usage

1. load `function.sh` and `load.sh`, eg:

source chpwd/functions.sh
source chpwd/load.sh

2. add the hook - replace `_hook_name` with your function name:

export -a chpwd_functions # define hooks as an shell array
[[ " ${chpwd_functions[*]} " == *" _hook_name "* ]] || # prevent double addition
chpwd_functions+=(_hook_name) # finally add it to the list
19 changes: 19 additions & 0 deletions src/assets/bash_zsh_support/chpwd/function.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# shellcheck shell=bash
export -a chpwd_functions
function __zsh_like_cd()
{
\typeset __zsh_like_cd_hook
if
builtin "$@"
then
for __zsh_like_cd_hook in chpwd "${chpwd_functions[@]}"
do
if \typeset -f "$__zsh_like_cd_hook" >/dev/null 2>&1
then "$__zsh_like_cd_hook" || break # finish on first failed hook
fi
done
true
else
return $?
fi
}
7 changes: 7 additions & 0 deletions src/assets/bash_zsh_support/chpwd/load.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# shellcheck shell=bash
[[ -n "${ZSH_VERSION:-}" ]] ||
{
function cd() { __zsh_like_cd cd "$@" ; }
function popd() { __zsh_like_cd popd "$@" ; }
function pushd() { __zsh_like_cd pushd "$@" ; }
}
14 changes: 5 additions & 9 deletions src/cli/activate.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,18 @@ use itertools::Itertools;

/// Initializes mise in the current shell session
///
/// This should go into your shell's rc file.
/// This should go into your shell's rc file or login shell.
/// Otherwise, it will only take effect in the current session.
/// (e.g. ~/.zshrc, ~/.bashrc)
/// (e.g. ~/.zshrc, ~/.zprofile, ~/.zshenv, ~/.bashrc, ~/.bash_profile, ~/.profile, ~/.config/fish/config.fish)
///
/// This is only intended to be used in interactive sessions, not scripts.
/// mise is only capable of updating PATH when the prompt is displayed to the user.
/// For non-interactive use-cases, use shims instead.
/// Typically, this can be added with something like the following:
///
/// Typically this can be added with something like the following:
///
/// echo 'eval "$(mise activate)"' >> ~/.zshrc
/// echo 'eval "$(mise activate zsh)"' >> ~/.zshrc
///
/// However, this requires that "mise" is in your PATH. If it is not, you need to
/// specify the full path like this:
///
/// echo 'eval "$(/path/to/mise activate)"' >> ~/.zshrc
/// echo 'eval "$(/path/to/mise activate zsh)"' >> ~/.zshrc
///
/// Customize status output with `status` settings.
#[derive(Debug, clap::Args)]
Expand Down
Loading
Loading