126 lines
3.8 KiB
Ruby
126 lines
3.8 KiB
Ruby
# typed: true
|
|
# frozen_string_literal: true
|
|
|
|
module Utils
|
|
module Shell
|
|
extend T::Sig
|
|
|
|
module_function
|
|
|
|
# Take a path and heuristically convert it to a shell name,
|
|
# return `nil` if there's no match.
|
|
sig { params(path: String).returns(T.nilable(Symbol)) }
|
|
def from_path(path)
|
|
# we only care about the basename
|
|
shell_name = File.basename(path)
|
|
# handle possible version suffix like `zsh-5.2`
|
|
shell_name.sub!(/-.*\z/m, "")
|
|
shell_name.to_sym if %w[bash csh fish ksh mksh sh tcsh zsh].include?(shell_name)
|
|
end
|
|
|
|
sig { returns(T.nilable(Symbol)) }
|
|
def preferred
|
|
from_path(ENV.fetch("SHELL", ""))
|
|
end
|
|
|
|
sig { returns(T.nilable(Symbol)) }
|
|
def parent
|
|
from_path(`ps -p #{Process.ppid} -o ucomm=`.strip)
|
|
end
|
|
|
|
# Quote values. Quoting keys is overkill.
|
|
sig { params(key: String, value: String, shell: T.nilable(Symbol)).returns(T.nilable(String)) }
|
|
def export_value(key, value, shell = preferred)
|
|
case shell
|
|
when :bash, :ksh, :mksh, :sh, :zsh
|
|
"export #{key}=\"#{sh_quote(value)}\""
|
|
when :fish
|
|
# fish quoting is mostly Bourne compatible except that
|
|
# a single quote can be included in a single-quoted string via \'
|
|
# and a literal \ can be included via \\
|
|
"set -gx #{key} \"#{sh_quote(value)}\""
|
|
when :csh, :tcsh
|
|
"setenv #{key} #{csh_quote(value)};"
|
|
end
|
|
end
|
|
|
|
# Return the shell profile file based on user's preferred shell.
|
|
sig { returns(String) }
|
|
def profile
|
|
case preferred
|
|
when :bash
|
|
bash_profile = "#{Dir.home}/.bash_profile"
|
|
return bash_profile if File.exist? bash_profile
|
|
when :zsh
|
|
return "#{ENV["ZDOTDIR"]}/.zshrc" if ENV["ZDOTDIR"].present?
|
|
end
|
|
|
|
SHELL_PROFILE_MAP.fetch(preferred, "~/.profile")
|
|
end
|
|
|
|
sig { params(variable: String, value: String).returns(T.nilable(String)) }
|
|
def set_variable_in_profile(variable, value)
|
|
case preferred
|
|
when :bash, :ksh, :sh, :zsh, nil
|
|
"echo 'export #{variable}=#{sh_quote(value)}' >> #{profile}"
|
|
when :csh, :tcsh
|
|
"echo 'setenv #{variable} #{csh_quote(value)}' >> #{profile}"
|
|
when :fish
|
|
"echo 'set -gx #{variable} #{sh_quote(value)}' >> #{profile}"
|
|
end
|
|
end
|
|
|
|
sig { params(path: String).returns(T.nilable(String)) }
|
|
def prepend_path_in_profile(path)
|
|
case preferred
|
|
when :bash, :ksh, :mksh, :sh, :zsh, nil
|
|
"echo 'export PATH=\"#{sh_quote(path)}:$PATH\"' >> #{profile}"
|
|
when :csh, :tcsh
|
|
"echo 'setenv PATH #{csh_quote(path)}:$PATH' >> #{profile}"
|
|
when :fish
|
|
"fish_add_path #{sh_quote(path)}"
|
|
end
|
|
end
|
|
|
|
SHELL_PROFILE_MAP = {
|
|
bash: "~/.profile",
|
|
csh: "~/.cshrc",
|
|
fish: "~/.config/fish/config.fish",
|
|
ksh: "~/.kshrc",
|
|
mksh: "~/.kshrc",
|
|
sh: "~/.profile",
|
|
tcsh: "~/.tcshrc",
|
|
zsh: "~/.zshrc",
|
|
}.freeze
|
|
|
|
UNSAFE_SHELL_CHAR = %r{([^A-Za-z0-9_\-.,:/@~\n])}.freeze
|
|
|
|
sig { params(str: String).returns(String) }
|
|
def csh_quote(str)
|
|
# ruby's implementation of shell_escape
|
|
str = str.to_s
|
|
return "''" if str.empty?
|
|
|
|
str = str.dup
|
|
# anything that isn't a known safe character is padded
|
|
str.gsub!(UNSAFE_SHELL_CHAR, "\\\\" + "\\1") # rubocop:disable Style/StringConcatenation
|
|
# newlines have to be specially quoted in csh
|
|
str.gsub!(/\n/, "'\\\n'")
|
|
str
|
|
end
|
|
|
|
sig { params(str: String).returns(String) }
|
|
def sh_quote(str)
|
|
# ruby's implementation of shell_escape
|
|
str = str.to_s
|
|
return "''" if str.empty?
|
|
|
|
str = str.dup
|
|
# anything that isn't a known safe character is padded
|
|
str.gsub!(UNSAFE_SHELL_CHAR, "\\\\" + "\\1") # rubocop:disable Style/StringConcatenation
|
|
str.gsub!(/\n/, "'\n'")
|
|
str
|
|
end
|
|
end
|
|
end
|