more utils

.github/workflows/build.yml

@@ -5,7 +5,17 @@ jobs:
   black:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: psf/black@stable
         with:
           options: "--check"
+  jsonlint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: validate JSON
+        env:
+          REPORT_ONLY: true
+          SHOW_ERRORS: true
+        run: bash <(curl -s https://raw.githubusercontent.com/CICDToolbox/json-lint/master/pipeline.sh)
+

README.md

@@ -70,13 +70,15 @@ A set of functions for the **F**riendly **I**nteractive **Sh**ell (fish). This i
   - **`gitb`**: make a new git branch;
   - **`gitc`**: make a git commit (short for `git commit -am`);
   - **`gitcp`**: commit with the given parameters, and push the changes;
+  - **`gitcpr`**: commit with the given parameters, push the changes and open a pull request on *GitHub*;
   - **`gitd`**: calculate the git difference and work with a pager to read the full response;
   - **`gitf`**: alias for `git fetch`;
   - **`gith`**: checkout a given branch;
   - **`gitm`**: move a given file in a git repository;
   - **`gitmaster`**: checkout the master branch (and stash work in progress if any);
   - **`gitmastertag`**: checkout the master branch, pull from remote, tag the commit and push the tag to the repository;
   - **`gitp`**: pushes the changes to the remote repository (short for `git push`);
+  - **`gitpr`**: open a pull request on *GitHub*;
   - **`gitremote`**: add the remote as origin with the given `GIT_PREFIX` and the name of the directory as git project;
   - **`gits`**: prints the status of the current Git repository (short for `git status`);
   - **`gitt`**: make a git tag and push the tag;
@@ -131,6 +133,10 @@ A set of functions for the **F**riendly **I**nteractive **Sh**ell (fish). This i
   - **`natrix-env`**: run a Python program in the natrix environment;
   - **`numpy`**: start a Python shell with `numpy` imported;
 
+### O
+
+ - **`otp`**: generate/configure One Time Passwords (OTPs) with pass-extension-otp;
+
 ### P
 
   - **`pandas`**: start a Python shell with `numpy` and `pandas` imported;
@@ -151,6 +157,7 @@ A set of functions for the **F**riendly **I**nteractive **Sh**ell (fish). This i
 
 ### R
 
+  - **`rabbitdoc`**: ask [*CodeRabbit*](https://github.com/coderabbitai) to generate docstrings for the latest pull request;
   - **`redo`**: redo a command until the exit code is 0;
   - **`remake`**: a loop to remake certain products with a Makefile;
   - **`rmake`**: walk up the filetree until it finds a Makefile;
@@ -185,6 +192,7 @@ A set of functions for the **F**riendly **I**nteractive **Sh**ell (fish). This i
   - **`taskd`**: set the task with the given id as done;
   - **`taskflush`**: set all expired tasks to done;
   - **`teeth`**: help cleaning teeth;
+  - **`timeprompt`**: wait for a given amount of time, or until the person hits a key exits with 1 if the user interrupted;
   - **`timestamp`**: get a string that specifies date and time, used for filenames mainly;
   - **`todo`**: add or inspect to a todo list;
   - **`truthful`**: check if at least one of the given Python literals or JSON values has truthiness `true`;

blooddonation.fish

@@ -5,6 +5,9 @@ function blooddonation --description 'register a blood donation together with bl
   test -n "$bpm" || read -P (string unescape '\e[31mBPM\e[0m> ') bpm
   bloodpressure "$systolic" "$diastolic" &
   measurelog "blooddonation.$kind" true health.bodilyfunction.bpm "$bpm" &
-  waitfor 2700 '🩸 donation' '🩸 ' (getcolor blood body_colors ,)
-  here_is_the_news
+  if ! waitfor 2700 '' '🩸 donation' '🩸 ' (getcolor blood body_colors ,)
+    measurelog 'blooddonation.end' true
+  else
+    here_is_the_news
+  end
 end

eggs.fish

@@ -1,6 +1,6 @@
 function eggs --description 'wait until the eggs are fully cooked in the water boiler'
   measurelog cooking.eggs.boiled true &
   echo -e 'takes \e[1m7%\e[0m of the home battery'
-  waitfor 1500 '🥚 eggs' '🥚 '
+  waitfor 1500 '' '🥚 eggs' '🥚 '
   here_is_the_news
 end

gitcpr.fish

@@ -0,0 +1,6 @@
+function gitcpr --description 'commit with the given parameters, push the changes and open a pull request on GitHub'
+  set message (echo "$argv")
+  git commit -am $argv;
+  gitp
+  gitpr $argv
+end

gitpr.fish

@@ -0,0 +1,4 @@
+function gitpr --description 'open a pull request on GitHub'
+  set title (echo "$argv")
+  firefox (gh pr create --title "$title" --body "$title" 2>&1 | tail -n 1)
+end

homebattery.fish

@@ -7,5 +7,5 @@ function homebattery --description 'determine how long it will take to load the
   # 80% -> 100% @150Watts
   set s1 (math "max(80, $upto) - max(80, $cur)")
   set tot (math "round(73728*$s0/300 + 73728*$s1/150)")
-  waitfor "$tot" '⚡ battery' '⚡ '
+  waitfor "$tot" '' '⚡ battery' '⚡ '
 end

household.fish

@@ -1,5 +1,5 @@
 function household --description 'wait until a household device has finished with info' -a time -a emoji -a name -a energy -a water
   echo -e "takes \e[1m$energy%\e[0m of the home battery and \e[1m"$water"ℓ\e[0m water"
-  waitfor $time "$emoji  $name" "$emoji "
+  waitfor $time '' "$emoji  $name" "$emoji "
   here_is_the_news
 end

install.sh

@@ -1,12 +1,15 @@
 #!/bin/bash
 
 curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
+curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo gpg --dearmor -o /usr/share/keyrings/githubcli-archive-keyring.gpg
+
 echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
+echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list
 
 sudo add-apt-repository ppa:tatokis/alarm-clock-applet
 
 sudo apt-get update
-sudo apt-get install -y alarm-clock-applet apt-file agrep certbot cloc curl cvc4 djinn fish git git-filter-repo git-lfs gnuplot-nox haskell-stack hlint hoogle ipython3 jq lambdabot ledger lynx nodeenv nodejs npm pandoc pdfsam powerline pv pylint python-wxtools python3-pytest rename sdate sox supervisor swi-prolog-core tig tox xdotool yarn zbar-tools z3
+sudo apt-get install -y alarm-clock-applet apt-file agrep certbot cloc curl cvc4 djinn fish gh git git-filter-repo git-lfs gnuplot-nox haskell-stack hlint hoogle ipython3 jq lambdabot ledger lynx nodeenv nodejs npm pandoc pass-extension-otp pdfsam powerline pv pylint python-wxtools python3-pytest rename sdate sox supervisor swi-prolog-core tig tox xdotool yarn zbar-tools z3
 sudo snap install upscayl
 git lfs install
 

movie.fish

@@ -2,7 +2,7 @@ function movie --description 'register going to a movie' -a name -a duration
   test -n "$name" || read -P (string unescape '\e[31name of the movie\e[0m> ') name
   measurelog entertainment.movie "$name"
   if test -n "$duration"
-    waitfor "$duration" '🎥 movie' '🎥 '
+    waitfor "$duration" '' '🎥 movie' '🎥 '
     here_is_the_news
   end
 end

otp.fish

@@ -0,0 +1,3 @@
+function otp --wraps='pass otp' --description 'generate/configure One Time Passwords (OTPs) with pass-extension-otp'
+  pass otp $argv
+end

pomodoro.fish

@@ -29,7 +29,7 @@ function pomodoro --description 'the pomodoro technique to stay focussed'
       set end (date '+%Y-%m-%d %T%z' -d "+40 minutes")
       echo "$end" > "$HOME/block_sleep"
       measurelog pomodoro.work true &
-      waitfor 1500 '\e[100D                      \e[100D\e[31m[working]\e[0m' '▶️  ' (getcolor random focus_colors ,)
+      waitfor 1500 '' '\e[100D                      \e[100D\e[31m[working]\e[0m' '▶️  ' (getcolor random focus_colors ,)
       kill "$gamma"
       if [ "$i" -gt  3 ]
         set waitcolor '255,3,32'
@@ -46,7 +46,7 @@ function pomodoro --description 'the pomodoro technique to stay focussed'
       gsettings set org.gnome.desktop.notifications show-banners "$banners"
       notify-send -i /usr/share/icons/hicolor/64x64/apps/io.github.alarm-clock-applet.clock.png -c productivity -u low 'pomodoro ⏰' '⏸️ take a break'
       measurelog pomodoro.pause true &
-      waitfor "$pause" "$pausetype" "$pausetitle" "$waitcolor"
+      waitfor "$pause" '' "$pausetype" "$pausetitle" "$waitcolor"
       here_is_the_news &
     end
   end

rabbitdoc.fish

@@ -0,0 +1,3 @@
+function rabbitdoc --description 'ask CodeRabbit.ai to generate docstrings for the latest pull request'
+  firefox (gh pr comment (gh pr list --json number --jq '.[0].number') -b '@coderabbitai generate docstrings')
+end

smartwatch.fish

@@ -3,6 +3,6 @@ function smartwatch --description 'determine how long it will take to load the s
   test -n "$upto" || set upto 100
   measurelog home.smartwatch (jsonlist "$cur" "$upto") &
   set tot (math "round(51.724137931*($upto-$cur))")
-  waitfor "$tot" '⌚ battery' '⌚ '
+  waitfor "$tot" '' '⌚ battery' '⌚ '
   here_is_the_news
 end

teeth.fish

@@ -23,7 +23,7 @@ function teeth --description 'help cleaning teeth'
       for tooth in $teeth
         set kin (string sub -l 1 "$move")
         draw_teeth "$cc" "$tt" "$kin"
-        waitfor 3 "$cheek  - $move - $tooth" "clean teeth $cheek - $move - $tooth "
+        waitfor 3 '' "$cheek  - $move - $tooth" "clean teeth $cheek - $move - $tooth "
         echo -en '                 \e[100D\e[8A'
         set tt (math $tt+1)
       end
@@ -34,6 +34,6 @@ function teeth --description 'help cleaning teeth'
     echo '                                           '
   end
   echo -en '                 \e[100D\e[8A'
-  waitfor 5 'brush tongue' 'brush tongue '
+  waitfor 5 '' 'brush tongue' 'brush tongue '
   echo 'do NOT rinse with water        '
 end

timeprompt.fish

@@ -0,0 +1,3 @@
+function timeprompt --description 'wait for a given amount of time, or until the person hits a key exits with 1 if the user interrupted' -a time
+  ! bash -c "read -n 1 -t '$time'"
+end

vitamins.fish

@@ -1,5 +1,5 @@
 function vitamins --description 'take our daily vitamins and magnesium'
-  waitfor 90 '💊 vitamins' '💊 '
+  waitfor 90 '' '💊 vitamins' '💊 '
   measurelog health.vitamins true
   hydrate 33cl
 end

waitfor.fish

@@ -1,4 +1,5 @@
-function waitfor --description 'wait a certain amount of time, or until the user hits ENTER' -a time -a label -a desc -a keydown -a until -a step
+function waitfor --description 'wait a certain amount of time, or until the user hits ENTER' -a time -a allow -a label -a desc -a keydown -a until -a step
+  set es 0
   if [ -n "$keydown" ]
     keycolor (string split , "$keydown") 255 &
   end
@@ -16,27 +17,39 @@ function waitfor --description 'wait a certain amount of time, or until the user
   set oldval 256
   set oldn 8
   set time (math "round($time)")
-  for i in (seq "$time" "-$step" "$until")
-    set txt (timeformat "$i")
+  set cur (date '+%s')
+  set tar (math "$cur + $time")
+  while test "$cur" -lt "$tar"
+    set cur (date '+%s')
+    set rmd (math "$tar - $cur")
+    set txt (timeformat "$rmd")
     set n (string length "$txt")
     if [ "$n" -lt "$oldn" ]
       # erase previous one if length differs
       echo -en '        \e[8D'
     end
-    set cl (math "min(255, 4*$i)")
+    set cl (math "min(255, 4*$rmd)")
     echo -en "\e[1m\e[38;2;255;$cl;"$cl"m$txt\e[0m\e["$n"D"
-    set pct (math "round(100*($time-$i)/$time)")
+    set pct (math "round(100*($time-$rmd)/$time)")
     echo -en "\033]0;$desc$txt\007\033]9;4;1;$pct\033\0134"
     if [ -n "$keydown" ]
-      set newval (math "round(235*$i/$time)+20")
+      set newval (math "round(235*$rmd/$time)+20")
       if [ "$oldval" -ne "$newval" ]
          echo "$newval" > /sys/class/leds/rgb:kbd_backlight/brightness &
          set oldval $newval
       end
     end
-    sleep "$step"
+    if [ -z "$allow" ]
+      if ! timeprompt "$step"
+        set cur "$tar"
+        set es 1
+      end
+    else
+      sleep "$step"
+    end
     set oldn "$n"
   end
   # clear progress
   echo -en "\033]9;4;0\007"
+  return "$es"
 end

walking.fish

@@ -1,4 +1,4 @@
 function walking --description 'register a walk'
-  waitfor 2100 '🚶 walking' '🚶 '
+  waitfor 2100 '' '🚶 walking' '🚶 '
   measurelog activity.walking (activity_survey)
 end

whatday.fish

@@ -2,7 +2,7 @@ function whatday --description 'specifies the day with some counters'
   set dt (date +%s -d '0:00 UTC')
   set hr (date +%H%M)
   set colors '232;20;22' '255;165;0' '250;235;54' '121;195;20' '72;125;231' '75;54;157' '112;54;157'
-  set tcol 97 97 30 30 30 97 97
+  set tcol 97 30 30 30 97 97 97
   set planets '☽ ' '♂' '☿' '♃' '♀' '♄' '☉'
   set polars '↙' '↗'
   set caf '🚫☕'