phundrak/dotfiles
1
0
Fork 0
Code Issues Pull Requests Activity

Better literate programming for fish config

Browse Source 
Most abbreviations for my fish configuration are now presented as
tables that are then used by some python code to generate fish code.
This commit is contained in:
Lucien Cartier-Tilet 2020-02-24 19:52:13 +01:00
parent d16437c1e8
commit 14ee2e6516
Signed by: phundrak
GPG Key ID: BD7789E705CB8DCA
2 changed files with 203 additions and 168 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

333
org/config/fish.org
View File

@ -5,7 +5,7 @@
#+HTML_HEAD_EXTRA: <meta name="description" content="Phundrak's fish config" /> #+HTML_HEAD_EXTRA: <meta name="description" content="Phundrak's fish config" />
#+HTML_HEAD_EXTRA: <meta property="og:title" content="Phundrak's fish config" /> #+HTML_HEAD_EXTRA: <meta property="og:title" content="Phundrak's fish config" />
#+HTML_HEAD_EXTRA: <meta property="og:description" content="Description of the fish config file of Phundrak" /> #+HTML_HEAD_EXTRA: <meta property="og:description" content="Description of the fish config file of Phundrak" />
#+PROPERTY: header-args:fish :tangle ~/.config/fish/config.fish :exports code #+PROPERTY: header-args:fish :tangle ~/.config/fish/config.fish :exports code :noweb yes
#+PROPERTY: header-args :exports code :tangle no #+PROPERTY: header-args :exports code :tangle no
* Table of Contents :TOC:noexport: * Table of Contents :TOC:noexport:
@ -21,7 +21,7 @@
- [[#abbreviations][Abbreviations]] - [[#abbreviations][Abbreviations]]
- [[#system-monitoring][System monitoring]] - [[#system-monitoring][System monitoring]]
- [[#system-management-packages-and-services][System management (packages and services)]] - [[#system-management-packages-and-services][System management (packages and services)]]
- [[#package-mangaement][Package mangaement]] - [[#package-management][Package management]]
- [[#service-management][Service management]] - [[#service-management][Service management]]
- [[#development][Development]] - [[#development][Development]]
- [[#cmake][CMake]] - [[#cmake][CMake]]
@ -44,6 +44,7 @@
- [[#compression][Compression]] - [[#compression][Compression]]
- [[#feh][Feh]] - [[#feh][Feh]]
- [[#network-management][Network Management]] - [[#network-management][Network Management]]
- [[#nordvpn][NordVPN]]
- [[#wget][Wget]] - [[#wget][Wget]]
* Presentation * Presentation
@ -210,48 +211,44 @@
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: h-740bd904-3e32-4c09-b0a4-bde16ae2e116 :CUSTOM_ID: h-740bd904-3e32-4c09-b0a4-bde16ae2e116
:END: :END:
#+NAME: generate-abbr
#+BEGIN_SRC python :var table=[] :exports none
result = ''
for abbr in table:
result += "abbr {0} '{1}'\n".format(abbr[0], abbr[1].replace("\\vert{}", "|").replace("\\vert", "|"))
return result
#+END_SRC
** System monitoring ** System monitoring
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: h-ec910a8c-9154-48a4-b4cd-df28cb4e54d9 :CUSTOM_ID: h-ec910a8c-9154-48a4-b4cd-df28cb4e54d9
:END: :END:
Here I have some abbreviations which are quite useful when performing some Here I have some abbreviations which are quite useful when performing some
system monitoring. With =df=, we can get an overview of our filesystem system monitoring. With =df=, we can get an overview of our filesystem usage,
usage, while with =diskspace= we get some more precise information. while with =diskspace= we get some more precise information. =meminfo= is a
#+BEGIN_SRC fish call to =free= with sane defaults, and similar to =meminfo=, we also have
abbr df 'df -H' =gpumeminfo= so we can get a quick look at the memory-related logs of our X
abbr diskspace 'sudo df -h | grep -E "sd|lv|Size"' session. I also declared =cpuinfo= an alias of =lscpu= in order to keep
#+END_SRC consistent with =meminfo=. =pscpu= gives us information on what the CPU is
running right now, and =pscpu10= limits that to the top 10 threads.
=meminfo= is a call to =free= with sane defaults.
#+BEGIN_SRC fish
abbr meminfo 'free -m -l -t'
#+END_SRC
Similar to =meminfo=, we also have =gpumeminfo= so we can get a quick look
at the memory-related logs of our X session.
#+BEGIN_SRC fish
abbr gpumeminfo 'grep -i --color memory /var/log/Xorg.0.log'
#+END_SRC
I also declared =cpuinfo= an alias of =lscpu= in order to keep consistent
with =meminfo=.
#+BEGIN_SRC fish
abbr cpuinfo lscpu
#+END_SRC
=pscpu= gives us information on what the CPU is running right now, and
=pscpu10= limits that to the top 10 threads.
#+BEGIN_SRC fish
abbr pscpu 'ps auxf | sort -nr -k 3'
abbr pscpu10 'ps auxf | sort -nr -k 3 | head -10'
#+END_SRC
Similarly, =psmem= gives us information on the memory usage of the current Similarly, =psmem= gives us information on the memory usage of the current
threads, and =psmem10= only the ten most important threads in terms of threads, and =psmem10= only the ten most important threads in terms of memory
memory usage. usage.
#+BEGIN_SRC fish #+NAME: mgmt-abbr
abbr psmem 'ps auxf | sort -nr -k 4' | abbreviation | command |
abbr psmem10 'ps auxf | sort -nr -k 4 | head -10' |--------------+---------------------------------------------------|
| df | df -H |
| diskspace | sudo df -h \vert grep -E "sd\vert{}lv\vert{}Size" |
| meminfo | free -m -l -t |
| gpumeminfo | grep -i --color memory /var/log/Xorg.0.log |
| cpuinfo | lscpu |
| pscpu | ps auxf \vert sort -nr -k 3 |
| pscpu10 | ps auxf \vert sort -nr -k 3 \vert head -10 |
| psmem | ps auxf \vert sort -nr -k 4 |
| psmem10 | ps auxf \vert sort -nr -k 4 \vert head -10 |
#+begin_SRC fish
<<generate-abbr(table=mgmt-abbr)>>
#+END_SRC #+END_SRC
** System management (packages and services) ** System management (packages and services)
@ -261,38 +258,26 @@
I added some of these abbreviations due to how often I have to write the I added some of these abbreviations due to how often I have to write the
whole thing. whole thing.
*** Package mangaement *** Package management
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: h-281a59aa-4ea0-47ab-a4cc-33fff8d38165 :CUSTOM_ID: h-281a59aa-4ea0-47ab-a4cc-33fff8d38165
:END: :END:
The first command is =remove= which removes a package from my system, as The first command is =remove= which removes a package from my system, as
well as its dependencies no longer needed. well as its dependencies no longer needed. =p=. =pacman='s or =yay='s. This
#+BEGIN_SRC fish is why I simply type =purge=. And if I want to simply seach among the
abbr remove 'sudo pacman -Rscnd' =pacman= repos, I can type =search=. Otherwise, if I want to include AUR
#+END_SRC results, I’ll use =yay=.
But if I just want to run =pacman= as sudo, then I could always just type #+NAME: pm-abbr
=p=. | abbreviation | command |
#+BEGIN_SRC fish |--------------+--------------------|
abbr p 'sudo -A pacman' | remove | sudo pacman -Rscnd |
#+END_SRC | p | sudo pacman |
| purge | yay -Sc |
| search | yay -Ss |
Sometimes, I just want to purge my package manager’s cache, be it
=pacman='s or =yay='s. This is why I simply type =purge=.
#+BEGIN_SRC fish #+BEGIN_SRC fish
abbr purge 'yay -Sc' <<generate-abbr(table=pm-abbr)>>
#+END_SRC
And if I want to simply seach among the =pacman= repos, I can type
=search=. Otherwise, if I want to include AUR results, I’ll use =yay=.
#+BEGIN_SRC fish
abbr search 'pacman -Ss'
#+END_SRC
To update everything from the official repos, I’ll sometimes type =update=
instead of the full command.
#+BEGIN_SRC fish
abbr update 'sudo pacman -Syu'
#+END_SRC #+END_SRC
*** Service management *** Service management
@ -301,14 +286,16 @@
:END: :END:
I don’t have the muscle memory of =systemctl=. So instead, I simply type I don’t have the muscle memory of =systemctl=. So instead, I simply type
=c= when I want to do something user service related. =c= when I want to do something user service related.
#+BEGIN_SRC fish
abbr s 'systemctl --user'
#+END_SRC
And if I want to manipulate system services, I can instead type a simple And if I want to manipulate system services, I can instead type a simple
capital =S=. capital =S=.
#+NAME: service-abbr
| abbreviation | command |
|--------------+------------------|
| s | systemctl --user |
| S | sudo systemctl |
#+BEGIN_SRC fish #+BEGIN_SRC fish
abbr S 'sudo systemctl' <<generate-abbr(table=service-abbr)>>
#+END_SRC #+END_SRC
** Development ** Development
@ -324,9 +311,15 @@
:END: :END:
I have the following abbreviations so I can quickly run CMake and create a I have the following abbreviations so I can quickly run CMake and create a
configuration for debug or release profiles. configuration for debug or release profiles.
#+NAME: abbr-cmake
| abbreviation | command |
|--------------+----------------------------------|
| cdebug | cmake -DCMAKE_BUILD_TYPE=Debug |
| crelease | cmake -DCMAKE_BUILD_TYPE=Release |
Here is the corresponding fish configuration:
#+BEGIN_SRC fish #+BEGIN_SRC fish
abbr cdebug 'cmake -DCMAKE_BUILD_TYPE=Debug' <<generate-abbr(table=abbr-cmake)>>
abbr crelease 'cmake -DCMAKE_BUILD_TYPE=Release'
#+END_SRC #+END_SRC
*** Compilation *** Compilation
@ -335,11 +328,17 @@
:END: :END:
By default, I set =clang=, =clang++=, =gcc= and =g++= to the latest By default, I set =clang=, =clang++=, =gcc= and =g++= to the latest
standard and with the =-Wall= flag activated. standard and with the =-Wall= flag activated.
#+NAME: abbr-comp
| abbreviation | command |
|--------------+----------------------|
| clang | clang -Wall |
| clang++ | clang++ -Wall |
| g++ | g++ -Wall -std=c++17 |
| gcc | gcc -Wall -std=c18 |
Here is the corresponding fish configuration:
#+BEGIN_SRC fish :tangle #+BEGIN_SRC fish :tangle
abbr clang 'clang -Wall' <<generate-abbr(table=abbr-comp)>>
abbr clang++ 'clang++ -Wall'
abbr g++ 'g++ -Wall -std=c++17'
abbr gcc 'gcc -Wall -std=c18'
#+END_SRC #+END_SRC
*** Docker *** Docker
@ -348,12 +347,18 @@
:END: :END:
And of course, when it comes to Docker Compose, I don’t have time to write And of course, when it comes to Docker Compose, I don’t have time to write
the full command, so I use these instead. the full command, so I use these instead.
#+NAME: abbr-docker
| abbreviation | command |
|--------------+---------------------------|
| dc | docker-compose |
| dcd | docker-compose down |
| dcr | docker-compose run --rm |
| dcu | docker-compose up |
| dcub | docker-compose up --build |
Here is the corresponding fish configuration:
#+BEGIN_SRC fish #+BEGIN_SRC fish
abbr dc docker-compose <<generate-abbr(table=abbr-docker)>>
abbr dcd 'docker-compose down'
abbr dcr 'docker-compose run --rm'
abbr dcu 'docker-compose up'
abbr dcub 'docker-compose up --build'
#+END_SRC #+END_SRC
*** Git *** Git
@ -363,8 +368,14 @@
And let’s face it: we all at one point just wanted to commit our code 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, without thinking about the message, to just get over with it. Don’t worry,
I got you covered. I got you covered.
#+NAME: abbr-git
| abbreviation | command |
|--------------+-----------------------------------------------------|
| randcommit | git commit -m (curl -s whatthecommit.com/index.txt) |
Here is the corresponding fish configuration:
#+BEGIN_SRC fish :tangle #+BEGIN_SRC fish :tangle
abbr randcommit 'git commit -m (curl -s whatthecommit.com/index.txt)' <<generate-abbr(table=abbr-git)>>
#+END_SRC #+END_SRC
*** Prolog *** Prolog
@ -373,8 +384,14 @@
:END: :END:
When I launch =swipl=, I prefer to have my terminal cleaned before and When I launch =swipl=, I prefer to have my terminal cleaned before and
after it runs, I find it more clean. after it runs, I find it more clean.
#+NAME: abbr-prolog
| abbreviation | command |
|--------------+----------------------------|
| swipl | clear && swipl -q && clear |
Here is the corresponding fish configuration:
#+BEGIN_SRC fish #+BEGIN_SRC fish
abbr swipl 'clear && swipl -q && clear' <<generate-abbr(table=abbr-prolog)>>
#+END_SRC #+END_SRC
*** Text editors *** Text editors
@ -383,21 +400,25 @@
:END: :END:
I greatly prefer to use Emacsclient as my main text editor; Emacs has 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 basically all I need. So, it’s only normal I have an abbreviation to launch
a new instance of it. a new instance of it. However, in a graphical environment, this will launch
#+BEGIN_SRC fish a new graphical window of Emacs. To launch a terminal instance, I’ll use
abbr e 'emacsclient -c' =enw= (=nw= stands for the option “nowindow” =-nw= of Emacs). I also wish to
#+END_SRC completely stop using other text editors, such as =vi=, =vim=, =nano= and
However, in a graphical environment, this will launch a new graphical =ed=, so let’s all add their command as an abbreviation for Emacs.
window of Emacs. To launch a terminal instance, I’ll use =enw= (=nw= stands
for the option “nowindow” =-nw= of Emacs).
#+BEGIN_SRC fish
abbr enw 'emacsclient -c -nw'
#+END_SRC
I also have the abbreviation =vi= which refers to =vim=. I really should #+NAME: abbr-text-ed
learn =vi=, but I also really don’t feel like it. | abbreviation | command |
#+BEGIN_SRC fish |--------------+--------------------|
abbr vi vim | e | emacsclient -c |
| enw | emacsclient -c -nw |
| vi | emacsclient -c |
| vim | emacsclient -c |
| nano | emacsclient -c |
| ed | emacsclient -c |
Here is the corresponding fish configuration:
#+BEGIN_SRC fish :noweb yes
<<generate-abbr(table=abbr-text-ed)>>
#+END_SRC #+END_SRC
** LaTeX ** LaTeX
@ -408,13 +429,16 @@
when it comes to PDF exports of my org files. Hence why I use the LaTeX 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=, 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 but I can never remember the command, and the latter is faster to type, so
time for an abbreviation. time for an abbreviation. Same goes for =texhash= which must be run as sudo.
#+BEGIN_SRC fish #+NAME: latex-abbr
abbr tlmgr tllocalmgr | abbreviation | command |
#+END_SRC |--------------+--------------|
| tlmgr | tllocalmgr |
| texhash | sudo texhash |
Here is the corresponding fish configuration:
#+BEGIN_SRC fish #+BEGIN_SRC fish
abbr texhash 'sudo texhash' <<generate-abbr(table=latex-abbr)>>
#+END_SRC #+END_SRC
** Some security measures ** Some security measures
@ -422,28 +446,31 @@
:CUSTOM_ID: h-dd97ea71-c43f-4b79-8bb7-1f857284b1b4 :CUSTOM_ID: h-dd97ea71-c43f-4b79-8bb7-1f857284b1b4
:END: :END:
Some commands can be quite dangerous when not used properly, which is why I 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 added default flags and options so I can get warnings before things get ugly.
ugly.
#+BEGIN_SRC fish
abbr cp 'cp -i'
abbr ln 'ln -i'
abbr lns 'ln -si'
abbr mv 'mv -i'
abbr rm 'rm -Iv'
abbr rmd 'rm --preserve-root -Irv'
abbr rmdf 'rm --preserve-root -Irfv'
abbr rmf 'rm --preserve-root -Ifv'
#+END_SRC
The =-i= and =-I= add prompts in case we might not want to do what we asked 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 the shell to do. Notice =lns= which creates symlinks, =rmd= which removes
directories, =rmf= which forces deletion, and =rmdf= which forces the directories, =rmf= which forces deletion, and =rmdf= which forces the
delition of a directory. Notice also the =--preserve-root= which will delition of a directory. Notice also the =--preserve-root= which will prevent
prevent me from accidentally removing the root folder. I added the same me from accidentally removing the root folder. I added the same option to
option to =chgrp=, =chmod=, and =chown=. =chgrp=, =chmod=, and =chown=.
#+NAME: sec-abbr
| abbreviation | command |
|--------------+--------------------------|
| cp | cp -i |
| 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:
#+BEGIN_SRC fish #+BEGIN_SRC fish
abbr chgrp 'chgrp --preserve-root -v' <<generate-abbr(table=sec-abbr)>>
abbr chmod 'chmod --preserve-root -v'
abbr chown 'chown --preserve-root -v'
#+END_SRC #+END_SRC
** Typos ** Typos
@ -451,25 +478,22 @@
:CUSTOM_ID: h-4c5a03cd-20a8-437e-87b7-af990780084e :CUSTOM_ID: h-4c5a03cd-20a8-437e-87b7-af990780084e
:END: :END:
Let’s admit it, we all make typos from time to time in the shell, and some 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 are recurrent enough we make abbreviations or aliases of the correct command.
command. Well, I have some of my abbreviations which were make exactly Well, I have some of my abbreviations which were make exactly because of
because of this. 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=.
#+NAME: typo-abbr
| abbreviation | command |
|--------------+---------|
| clean | clear |
| exi | exit |
| exti | exit |
| hotp | htop |
Sometimes for some reasons, my brain makes me write =clean= instead of Here is the corresponding fish configuration:
=clear=. So, let’s just replace the former by the latter.
#+BEGIN_SRC fish #+BEGIN_SRC fish
abbr clean clear <<generate-abbr(table=typo-abbr)>>
#+END_SRC
I’m also very bad at typing =exit=.
#+BEGIN_SRC fish
abbr exi exit
abbr exti exit
#+END_SRC
And sometimes I suck at typing =htop=.
#+BEGIN_SRC fish
abbr hotp htop
#+END_SRC #+END_SRC
** Misc ** Misc
@ -557,9 +581,14 @@
one day hopefully, after seeing the abbreviations’ expansion over and over 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 I’ll remember the command like I did for the abbreviation of =remove= (see
[[#h-281a59aa-4ea0-47ab-a4cc-33fff8d38165][Package management]]). [[#h-281a59aa-4ea0-47ab-a4cc-33fff8d38165][Package management]]).
#+NAME: tar-abbr
| abbreviation | command |
|--------------+-----------|
| compress | tar -czf |
| untar | tar -xvzf |
#+BEGIN_SRC fish #+BEGIN_SRC fish
abbr compress 'tar -czf' <<generate-abbr(table=tar-abbr)>>
abbr untar 'tar -xvzf'
#+END_SRC #+END_SRC
*** Feh *** Feh
@ -583,22 +612,28 @@
abbr nmcli 'nmcli -p -c auto' abbr nmcli 'nmcli -p -c auto'
#+END_SRC #+END_SRC
*** NordVPN
:PROPERTIES:
:CUSTOM_ID: h-f35e00a2-ec5b-416d-821f-56040ad1d6b4
:END:
Next, we have some NordVPN-related shortcuts. The first one is a simple 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 abbreviation to =nordvpn=. The second one is a shortcut to connect to a
server, and to disconnect from the current server. server, and to disconnect from the current server. I also have a couple of
#+BEGIN_SRC fish shortcuts to quickly connect to some preselected countries, mainly France,
abbr n 'nordvpn' Germany, Japan and the US.
abbr nc 'nordvpn c' #+NAME: nordvpn-abbr
abbr nd 'nordvpn d' | abbreviation | command |
#+END_SRC |--------------+-------------------------|
| 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 |
I also have a couple of shortcuts to quickly connect to some preselected
countries, mainly France, Germany, Japan and the US.
#+BEGIN_SRC fish #+BEGIN_SRC fish
abbr ncf 'nordvpn c France' <<generate-abbr(table=nordvpn-abbr)>>
abbr ncg 'nordvpn c Germany'
abbr ncj 'nordvpn c Japan'
abbr ncu 'nordvpn c United_States'
#+END_SRC #+END_SRC
*** Wget *** Wget

4
org/config/i3.org
View File

@ -93,7 +93,7 @@
#+NAME: variable-table #+NAME: variable-table
| variable | value | | variable | value |
|-------------+--------------------------------------------------------------------------| |----------+-------|
| $mod | Mod4 | | $mod | Mod4 |
| $alt | Mod1 | | $alt | Mod1 |
| $up | Up | | $up | Up |
@ -125,7 +125,7 @@
return result return result
#+END_SRC #+END_SRC
#+RESULTS[58c517fe29b63f631ff0ba754d5d9ec4ea673388]: generate-variables #+RESULTS[187d9be7907abf05492d27a454685b424b933b7d]: generate-variables
: set $mod Mod4 : set $mod Mod4
: set $alt Mod1 : set $alt Mod1
: set $up Up : set $up Up