diff --git a/.prettierignore b/.prettierignore index cc83ea3333..30ea2de414 100644 --- a/.prettierignore +++ b/.prettierignore @@ -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 diff --git a/src/assets/bash_zsh_support/LICENSE b/src/assets/bash_zsh_support/LICENSE new file mode 100644 index 0000000000..6600f1c98d --- /dev/null +++ b/src/assets/bash_zsh_support/LICENSE @@ -0,0 +1,165 @@ +GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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. diff --git a/src/assets/bash_zsh_support/README.md b/src/assets/bash_zsh_support/README.md new file mode 100644 index 0000000000..9214ef7d49 --- /dev/null +++ b/src/assets/bash_zsh_support/README.md @@ -0,0 +1,3 @@ +# bash_zsh_support + +support Zsh function hooks for Bash diff --git a/src/assets/bash_zsh_support/chpwd/README.md b/src/assets/bash_zsh_support/chpwd/README.md new file mode 100644 index 0000000000..99a5744438 --- /dev/null +++ b/src/assets/bash_zsh_support/chpwd/README.md @@ -0,0 +1,17 @@ +# Bash support for Zsh like chpwd hook + +Implemented based on the description from + + +## 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 diff --git a/src/assets/bash_zsh_support/chpwd/function.sh b/src/assets/bash_zsh_support/chpwd/function.sh new file mode 100644 index 0000000000..3b1fa2487c --- /dev/null +++ b/src/assets/bash_zsh_support/chpwd/function.sh @@ -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 +} diff --git a/src/assets/bash_zsh_support/chpwd/load.sh b/src/assets/bash_zsh_support/chpwd/load.sh new file mode 100644 index 0000000000..38a161d180 --- /dev/null +++ b/src/assets/bash_zsh_support/chpwd/load.sh @@ -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 "$@" ; } +} diff --git a/src/cli/activate.rs b/src/cli/activate.rs index d8f78f7fca..42b155832e 100644 --- a/src/cli/activate.rs +++ b/src/cli/activate.rs @@ -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) -/// -/// 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. +/// (e.g. ~/.zshrc, ~/.zprofile, ~/.bashrc, ~/.bash_profile, ~/.profile, ~/.config/fish/config.fish) /// /// Typically this can be added with something like the following: /// -/// echo 'eval "$(mise activate)"' >> ~/.zshrc +/// echo 'eval "$(mise activate zsh)"' >> ~/.zshenv /// /// 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)"' >> ~/.zshenv /// /// Customize status output with `status` settings. #[derive(Debug, clap::Args)] diff --git a/src/shell/bash.rs b/src/shell/bash.rs index 4d25132a16..a5830c04d6 100644 --- a/src/shell/bash.rs +++ b/src/shell/bash.rs @@ -45,7 +45,11 @@ impl Shell for Bash { if [[ ";${{PROMPT_COMMAND:-}};" != *";_mise_hook;"* ]]; then PROMPT_COMMAND="_mise_hook${{PROMPT_COMMAND:+;$PROMPT_COMMAND}}" fi - "#}; + {} + {} + chpwd_functions+=(_mise_hook) + _mise_hook + "#, include_str!("../assets/bash_zsh_support/chpwd/function.sh"), include_str!("../assets/bash_zsh_support/chpwd/load.sh")}; if settings.not_found_auto_install { out.push_str(&formatdoc! {r#" if [ -z "${{_mise_cmd_not_found:-}}" ]; then diff --git a/src/shell/fish.rs b/src/shell/fish.rs index 6248e02d30..efb02ba0d8 100644 --- a/src/shell/fish.rs +++ b/src/shell/fish.rs @@ -72,6 +72,8 @@ impl Shell for Fish { functions --erase __mise_cd_hook; end; + + __mise_env_eval "#}); if Settings::get().not_found_auto_install { out.push_str(&formatdoc! {r#" diff --git a/src/shell/snapshots/mise__shell__bash__tests__activate.snap b/src/shell/snapshots/mise__shell__bash__tests__activate.snap index b2fb261382..e57d2e338b 100644 --- a/src/shell/snapshots/mise__shell__bash__tests__activate.snap +++ b/src/shell/snapshots/mise__shell__bash__tests__activate.snap @@ -35,6 +35,36 @@ _mise_hook() { if [[ ";${PROMPT_COMMAND:-};" != *";_mise_hook;"* ]]; then PROMPT_COMMAND="_mise_hook${PROMPT_COMMAND:+;$PROMPT_COMMAND}" fi +# 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 +} + +# shellcheck shell=bash +[[ -n "${ZSH_VERSION:-}" ]] || +{ + function cd() { __zsh_like_cd cd "$@" ; } + function popd() { __zsh_like_cd popd "$@" ; } + function pushd() { __zsh_like_cd pushd "$@" ; } +} + +chpwd_functions+=(_mise_hook) +_mise_hook if [ -z "${_mise_cmd_not_found:-}" ]; then _mise_cmd_not_found=1 if [ -n "$(declare -f command_not_found_handle)" ]; then diff --git a/src/shell/snapshots/mise__shell__fish__tests__activate.snap b/src/shell/snapshots/mise__shell__fish__tests__activate.snap index 4adf13c99c..0a11c1ca6d 100644 --- a/src/shell/snapshots/mise__shell__fish__tests__activate.snap +++ b/src/shell/snapshots/mise__shell__fish__tests__activate.snap @@ -58,6 +58,8 @@ function __mise_env_eval_2 --on-event fish_preexec --description 'Update mise en functions --erase __mise_cd_hook; end; + +__mise_env_eval if functions -q fish_command_not_found; and not functions -q __mise_fish_command_not_found functions -e __mise_fish_command_not_found functions -c fish_command_not_found __mise_fish_command_not_found diff --git a/src/shell/snapshots/mise__shell__zsh__tests__activate.snap b/src/shell/snapshots/mise__shell__zsh__tests__activate.snap index d3a1a5caf3..5aa9cb33b6 100644 --- a/src/shell/snapshots/mise__shell__zsh__tests__activate.snap +++ b/src/shell/snapshots/mise__shell__zsh__tests__activate.snap @@ -39,6 +39,7 @@ if [[ -z "${chpwd_functions[(r)_mise_hook]+1}" ]]; then chpwd_functions=( _mise_hook ${chpwd_functions[@]} ) fi +_mise_hook if [ -z "${_mise_cmd_not_found:-}" ]; then _mise_cmd_not_found=1 [ -n "$(declare -f command_not_found_handler)" ] && eval "${$(declare -f command_not_found_handler)/command_not_found_handler/_command_not_found_handler}" diff --git a/src/shell/zsh.rs b/src/shell/zsh.rs index 925d94d3e5..ad2342b907 100644 --- a/src/shell/zsh.rs +++ b/src/shell/zsh.rs @@ -53,6 +53,7 @@ impl Shell for Zsh { chpwd_functions=( _mise_hook ${{chpwd_functions[@]}} ) fi + _mise_hook "#}); if Settings::get().not_found_auto_install { out.push_str(&formatdoc! {r#"