dotfiles/org/config/fish.org
Lucien Cartier-Tilet 73c629afc4
All checks were successful
continuous-integration/drone/push Build is passing
[Misc] Move files to XDG user dirs
2022-06-07 19:45:58 +02:00

26 KiB
Raw Blame History

Fish config

Presentation

The file present in ~/.config/fish/config.fish is the configuration file for the fish shell. It contains custom functions, environment variables and abbreviations.

Just in case, we might need sometimes to declare the fish function fish_title as true, so lets do so.

function fish_title
    true
end

Fish from within Emacs

I sometimes call fish from within emacs, with M-x ansi-term. In this case, the variable TERM needs to have the value eterm-color.

if test -n "$EMACS"
    set -x TERM eterm-color
end

Global variables

In order to keep some other code clean, I set the $BROWSER variable so I dont have to call my web browser directly but rather with this variable.

set -gx BROWSER firefox

Sometimes, software will rely on SUDO_ASKPASS to get a GUI from which it can get the sudo password. So, lets declare it.

set -gx SUDO_ASKPASS ~/.local/bin/askpass

In general, I prefer using bat to less, although the former relies on the latter, but bat provides nice wrapping around less, including syntax highlighting. Lets set the manpager to bat then:

set -x MANPAGER "sh -c 'col -bx | bat -l man -p'"

XMODIFIERS is set to nothing as to not impede Emacs inputs.

set -x XMODIFIERS

Lets start the Gnome keyring daemon. It will return a variable which must be set.

if test -n "$DESKTOP_SESSION"
    set -x (gnome-keyring-daemon --start | string split "=")
end

XDG user directories

Theres a couple of XDG user directories that are not set, lets fix that.

set -x XDG_CACHE_HOME  $HOME/.cache
set -x XDG_CONFIG_HOME $HOME/.config
set -x XDG_DATA_HOME   $HOME/.local/share
set -x XDG_STATE_HOME  $HOME/.local/state

Now, let's clean the $HOME directory. Be aware it will require quite a few lines.

set -x HISTFILE "$XDG_STATE_HOME"/bash/history
set -x _Z_DATA "$XDG_DATA_HOME"/z
set -x XAUTHORITY "$XDG_RUNTIME_DIR"/Xauthority
set -x WINEPREFIX "$XDG_DATA_HOME"/wine
set -x TEXMFVAR "$XDG_CACHE_HOME"/texlive/texmf-var
set -x RUSTUP_HOME "$XDG_DATA_HOME"/rustup
set -x BUNDLE_USER_CONFIG "$XDG_CONFIG_HOME"/bundle
set -x BUNDLE_USER_CACHE "$XDG_CACHE_HOME"/bundle
set -x BUNDLE_USER_PLUGIN "$XDG_DATA_HOME"/bundle
set -x PYLINTHOME "$XDG_CACHE_HOME"/pylint
set -x PYENV_ROOT "$XDG_DATA_HOME"/pyenv
set -x PASSWORD_STORE_DIR "$XDG_DATA_HOME"/pass
set -x PARALLEL_HOME "$XDG_CONFIG_HOME"/parallel
set -x _JAVA_OPTIONS -Djava.util.prefs.userRoot="$XDG_CONFIG_HOME"/java
set -x NVM_DIR "$XDG_DATA_HOME"/nvm
set -x CUDA_CACHE_PATH "$XDG_CACHE_HOME"/nv
set -x __GL_SHADER_DISK_CACHE_PATH "$XDG_CACHE_HOME"/nv
set -x NUGET_PACKAGES "$XDG_CACHE_HOME"/NuGetPackages
set -x NPM_CONFIG_USERCONFIG "$XDG_CONFIG_HOME"/npm/npmrc
set -x TERMINFO "$XDG_DATA_HOME"/terminfo
set -x TERMINFO_DIRS "$XDG_DATA_HOME"/terminfo:/usr/share/terminfo
set -x MPLAYER_HOME "$XDG_CONFIG_HOME"/mplayer
set -x ICEAUTHORITY "$XDG_CACHE_HOME"/ICEauthority
set -x LESSHISTFILE "$XDG_CACHE_HOME"/less/history
set -x GTK2_RC_FILES "$XDG_CONFIG_HOME"/gtk-2.0/gtkrc
set -x GOPATH "$XDG_DATA_HOME"/go
set -x GNUPGHOME "$XDG_DATA_HOME"/gnupg
set -x GEM_HOME "$XDG_DATA_HOME"/gem
set -x GEM_SPEC_CACHE "$XDG_CACHE_HOME"/gem
set -x DOCKER_CONFIG "$XDG_CONFIG_HOME"/docker
set -x CARGO_HOME "$XDG_DATA_HOME"/cargo

Development

Now, lets declare our editor of choice, EmacsClient; not Emacs itself since it will most often be just quick edits, nothing too heavy, if it is called from the EDITOR variable (from Git, for example), or from the VISUAL variable.

set -gx EDITOR emacsclient -c
set -gx VISUAL emacsclient -c

We also need to set the path to the Dart SDK.

set -gx DART_SDK /opt/dart-sdk/bin

And we also need to specify where the Android SDK it located.

set -gx ANDROID_HOME $HOME/Android/Sdk

Still related to Dart and Flutter development,

set -gx CHROME_EXECUTABLE /usr/bin/chromium

Next, we have two variables from Deno, the Node.js destroyer. Its base directory will be set in my XDG config directory, and its binaries will be located in my local binaries directory (see below).

set -gx DENO_DIR $HOME/.config/deno
set -gx DENO_INSTALL_ROOT $HOME/.local/bin/deno

Finally, some development packages require the PKG_CONFIG_PATH to be set, so lets do so.

set -gx PKG_CONFIG_PATH /usr/local/lib/pkgconfig/ $PKG_CONFIG_PATH

$PATH

A variable available with the fish shell is fish_user_paths which lists custom paths to binaries specified by the user. Using this variable ensures they are included in the $PATH variable only once without the need to set it directly. For instance, my PATH variable needs Rusts Cargos binaries, Gos binaries, my own executables, and some more.

additional path what it leads to
$HOME/.local/bin Custom executables, see /phundrak/dotfiles/src/commit/914bfdb3b64a175d1192083b2faa1e3bc2e351b9/org/config/bin.org
$GOPATH/bin Go binaries and executables
$CARGO_HOME/bin Rust binaries and executables
$GEM_HOME/ruby/3.0.0/bin Ruby 3.0 binaries and executables
$GEM_HOME/ruby/2.6.0/bin Ruby 2.6 binaries and executables
$HOME/.cabal/bin Haskel binaries
/usr/lib/xfce-polkit Path to XFCEs PolKit
$HOME/.local/bin \
$GOPATH/bin \
$CARGO_HOME/bin \
$GEM_HOME/ruby/3.0.0/bin \
$GEM_HOME/ruby/2.6.0/bin \
$HOME/.cabal/bin \
/usr/lib/xfce-polkit

So, lets set our user paths:

set -g fish_user_paths \
<<generate-extra-paths()>>

Tramp remote access

When accessing from a remote machine our computer from Emacs, tramp needs a precise shell appearance: a simple $ followed by a space after which to put the commands it needs to execute, and nothing else. Due to this, lets deactivate and redefine some of the functions defining the appearance of fish.

if test "$TERM" = "dumb"
    function fish_prompt
        echo "\$ "
    end
    function fish_right_prompt; end
    function fish_greeting; end
    function fish_title; end
end

Regular fish shell appearance

Now, there is only one function I modify when it comes to the appearance of fish when Im the one using it: the fish_greeting function. I use it to display the output of a utility I wrote.

function fish_greeting
    which pumo-system-info 2&> /dev/null && pumo-system-info
end

For my fish prompt, I use starship, a shell-agnostic prompt. Lets load it:

starship init fish | source

Setting up external tools

Starship configuration

As mentioned above, starship is a shell-agnostic prompt, written in Rust and which can be configured separately from the shell. I decided to configure it here though, since fish is the only shell I use which is compatible with starship.

First Ill modify the default format variable, removing the modules I dont need.

format = """
$username\
$hostname\
$shlvl\
$singularity\
$kubernetes\
$directory\
$vcsh\
$git_branch\
$git_commit\
$git_state\
$git_metrics\
$git_status\
$hg_branch\
$docker_context\
$package\
$cmake\
$dart\
$deno\
$lua\
$nodejs\
$python\
$rlang\
$rust\
$scala\
$zig\
$memory_usage\
$env_var\
$custom\
$cmd_duration\
$line_break\
$jobs\
$battery\
$time\
$status\
$shell\
$character"""

I want starship to be able to detect Lisp files, be it CommonLisp or EmacsLisp. Unfortunately, it seems nerd-font doesnt have any symbol for either language, so Im just using a lambda character.

[custom.lisp]
extensions = ["lisp", "el"]
symbol = "λ "
style = "bold green"

Finally, lets disable all modules I dont need.

[cobol]
disable = true
[dotnet]
disable = true
[elixir]
disable = true
[elm]
disable = true
[erlang]
disable = true
[golang]
disable = true
[helm]
disable = true
[java]
disable = true
[julia]
disable = true
[kotlin]
disable = true
[nim]
disable = true
[ocaml]
disable = true
[perl]
disable = true
[php]
disable = true
[pulumi]
disable = true
[purescript]
disable = true
[red]
disable = true
[ruby]
disable = true
[swift]
disable = true
[terraform]
disable = true
[vlang]
disable = true
[vagrant]
disable = true
[nix_shell]
disable = true
[conda]
disable = true
[aws]
disable = true
[gcloud]
disable = true
[openstack]
disable = true
[crystal]
disable = true

Loading zoxide

zoxide is a smarter cd command, accessible through z. It can be loaded like so:

zoxide init fish | source

Abbreviations

Abbreviations are a great way to keep correctly track of which commands are run in the shell without polluting the history of the shell with obscure commands. When typing an abbreviation, fish will replace it with replace it with its expanded equivalent. Below are some of the abbreviations I use. Be aware some of them that invoke GUI programs can be invoked through devour which will make the terminal disappear while the program runs, and once the GUI program exists the terminal window will come back.

System monitoring

Here I have some abbreviations which are quite useful when performing some system monitoring. With df, we can get an overview of our filesystem usage, while with diskspace we get some more precise information. meminfo is a call to free with sane defaults, and similar to meminfo, we also have gpumeminfo so we can get a quick look at the memory-related logs of our X session. I also declared cpuinfo an alias of lscpu in order to keep consistent with meminfo. pscpu gives us information on what the CPU is running right now, and pscpu10 limits that to the top 10 threads. Similarly, psmem gives us information on the memory usage of the current threads, and psmem10 only the ten most important threads in terms of memory usage.

abbreviation command
df df -H
diskspace sudo df -h | grep -E "sd|lv|Size"
du du -ch
meminfo free -m -l -t
gpumeminfo grep -i color memory /var/log/Xorg.0.log
cpuinfo lscpu
pscpu ps auxf | sort -nr -k 3
pscpu10 ps auxf | sort -nr -k 3 | head -10
psmem ps auxf | sort -nr -k 4
psmem10 ps auxf | sort -nr -k 4 | head -10
<<generate-abbr(table=mgmt-abbr)>>

System management (packages and services)

I added some of these abbreviations due to how often I have to write the whole thing.

Package management

The first command is remove which removes a package from my system, as well as its dependencies no longer needed. p. pacman's or paru's. This is why I simply type purge. And if I want to simply seach among the pacman repos, I can type search. Otherwise, if I want to include AUR results, Ill use paru.

abbreviation command
remove sudo pacman -Rsc
purge paru -Sc
<<generate-abbr(table=pm-abbr)>>

Service management

I dont have the muscle memory of systemctl. So instead, I simply type c when I want to do something user service related. And if I want to manipulate system services, I can instead type a simple capital S.

abbreviation command
s systemctl
suser systemctl user
<<generate-abbr(table=service-abbr)>>

Development

A good amount of these commands are development related, especially when it comes to compilation or Docker.

CMake

I have the following abbreviations so I can quickly run CMake and create a configuration for debug or release profiles.

abbreviation command
cdebug cmake -DCMAKE_BUILD_TYPE=Debug
crelease cmake -DCMAKE_BUILD_TYPE=Release

Here is the corresponding fish configuration:

<<generate-abbr(table=abbr-cmake)>>

Docker

And of course, when it comes to Docker Compose, I don't have time to write the full command, so I use these instead.

abbreviation command
dc docker-compose
dcb docker-compose build
dcd docker-compose down
dcl docker-compose logs
dcp docker-compose pull
dcr docker-compose run rm
dcu docker-compose up
dcub docker-compose up build
dcud docker-compose up -d
dcudb docker-compose up -d build

Here is the corresponding fish configuration:

<<generate-abbr(table=abbr-docker)>>

Text editors

I greatly prefer to use Emacsclient as my main text editor; Emacs has basically all I need. So, it's only normal I have an abbreviation to launch a new instance of it. If launched in the terminal, Ill usually want Emacs to be displayed in CLI mode and not in GUI mode, otherwise I would invoke it with my WMs shortcut. In case we want to launch Emacs in GUI mode anyways, egui is available too.

abbreviation command
e emacsclient -c -nw
egui devour emacsclient -c

Here is the corresponding fish configuration:

<<generate-abbr(table=abbr-text-ed)>>

Compilation

By default, I set clang, clang++, gcc and g++ to the latest standard and with the -Wall flag activated.

abbreviation command
clang clang -Wall
clang++ clang++ -Wall
g++ g++ -Wall -std=c++20
gcc gcc -Wall -std=c18

Here is the corresponding fish configuration:

<<generate-abbr(table=abbr-comp)>>

Git

And let's face it: we all at one point just wanted to commit our code without thinking about the message, to just get over with it. Don't worry, I got you covered.

abbreviation command
randcommit git commit -m (curl -s whatthecommit.com/index.txt)

Here is the corresponding fish configuration:

<<generate-abbr(table=abbr-git)>>

LaTeX

Yes, although I use org-mode, I still have some use for LaTeX, especially when it comes to PDF exports of my org files. Hence why I use the LaTeX package manager. It is recommended to use tllocalmgr instead of tlmgr, but I can never remember the command, and the latter is faster to type, so time for an abbreviation. Same goes for texhash which must be run as sudo.

abbreviation command
tlmgr tllocalmgr
texhash sudo texhash

Here is the corresponding fish configuration:

<<generate-abbr(table=latex-abbr)>>

Some security measures

Some commands can be quite dangerous when not used properly, which is why I added default flags and options so I can get warnings before things get ugly. The -i and -I add prompts in case we might not want to do what we asked the shell to do. Notice lns which creates symlinks, rmd which removes directories, rmf which forces deletion, and rmdf which forces the delition of a directory. Notice also the --preserve-root which will prevent me from accidentally removing the root folder. I added the same option to chgrp, chmod, and chown.

abbreviation command
cp cp -i
rsync rsync -ruvtEhl progress
ln ln -i
lns ln -si
mv mv -i
rm rm -Iv
rmd rm preserve-root -Irv
rmdf rm preserve-root -Irfv
rmf rm preserve-root -Ifv
chgrp chgrp preserve-root -v
chmod chmod preserve-root -v
chown chown preserve-root -v

Here is the corresponding fish configuration:

<<generate-abbr(table=sec-abbr)>>

Typos

Let's admit it, we all make typos from time to time in the shell, and some are recurrent enough we make abbreviations or aliases of the correct command. Well, I have some of my abbreviations which were make exactly because of this. Sometimes for some reasons, my brain makes me write clean instead of clear. So, let's just replace the former by the latter. I'm also very bad at typing exit. And sometimes I suck at typing htop.

abbreviation command
clean clear
exi exit
exti exit
hotp htop

Here is the corresponding fish configuration:

<<generate-abbr(table=typo-abbr)>>

Misc

Finally, some miscellaneous abbreviations that don't really fit into any of the above categories.

Media

Here you will find various commands related to media in general. the first one is a command to play some chillhop from the Chillhop YouTube channel's livestream.

abbr chill 'mpv --force-window=no --no-video "https://www.youtube.com/user/Chillhopdotcom/live" &'

When it comes to mpv, I do not want to force it to open a graphical window if for example I want to listen to an audio file. I also do not want any border on that window. So, I declared this abbreviation.

abbr mpv 'mpv --no-border --force-window=no'

When I want to download a song from YouTube, I'll just use the command flac videoIdentifier to get it through youtube-dl.

abbr flac 'youtube-dl -x --audio-format flac --audio-quality 0 -o "~/Music/%(uploader)s/%(title)s.%(ext)s"'

Some sane default options for nsxiv. This includes playing GIFs and not displaying the filename below. Nsxiv will also open in fullscreen and will fit the displayed image to the frame.

abbr nsxiv 'nsxiv -abfs f'
abbr sxiv  'nsxiv -abfs f' # old habits die hard

Finally, let's declare the following abbreviation that will launch an mpv instance displaying my webcam:

abbr webcam 'devour mpv --demuxer-lavf-format=video4linux2 --demuxer-lavf-o-set=input_format=mjpeg av://v4l2:/dev/video0'

Sudo

First, I make it so that sudo comes with the -A switch in order to call my custom graphical script for getting my password (see askpass). I also made it so please is an equivalent to sudo -A as a joke.

abbr please 'sudo -A'

History

I find it more intuitive and faster to just write hist instead of history, so let's declare that.

abbr hist history

Compression

It seems it's just like many other people, but I cannot for the life of me remember the syntax of tar. So, I made the following abbreviations, and one day hopefully, after seeing the abbreviations' expansion over and over I'll remember the command like I did for the abbreviation of remove (see Package management).

abbreviation command
compress tar -czf
untar tar -xvzf
<<generate-abbr(table=tar-abbr)>>

exa

abbreviation command
exa exa -halg@ group-directories-first git
lsl exa -halg@ group-directories-first git
<<generate-abbr(table=exa-abbr)>>

Network Management

First, we have just nmcli with sane default options, that is a pretty output with colors.

abbr nmcli 'nmcli -p -c auto'

NordVPN

Next, we have some NordVPN-related shortcuts. The first one is a simple abbreviation to nordvpn. The second one is a shortcut to connect to a server, and to disconnect from the current server. I also have a couple of shortcuts to quickly connect to some preselected countries, mainly France, Germany, Japan and the US.

abbreviation command
n nordvpn
nc nordvpn c
nd nordvpn d
ncf nordvpn c France
ncg nordvpn c Germany
ncj nordvpn c Japan
ncu nordvpn c United_States
<<generate-abbr(table=nordvpn-abbr)>>

Wget

By default, continue a download that was interupted.

abbr wget 'wget --hsts-file="$XDG_DATA_HOME/wget-hsts" -c'

Last thing before were done

For some reason, Fish began searching for packages when I enter a command name wrong. For instance, if I type vim, I get something like this:

$ vim
fish: Unknown command: vim
usr/bin/vim is owned by extra/gvim 8.2.2653-1
usr/bin/vim is owned by extra/vim 8.2.2653-1

But I dont want that, it slows down my shell. So, in order to fix that, we need the following lines:

function fish_command_not_found
    __fish_default_command_not_found_handler $argv
end

Tadah! No more package suggestions from fish!