Create a docker mod to add rbenv to code-server

This mod adds rbenv to code-server, to be installed/updated during container start.

rbenv is a version manager tool for the Ruby programming language on Unix-like systems. It is useful for switching between multiple Ruby versions on the same machine and for ensuring that each project you are working on always runs on the correct Ruby version.

This mod includes adding shell completions for rbenv in bash and zsh.

Author: somewatson

.github/workflows/BuildImage.yml

@@ -10,10 +10,10 @@ on:
         required: false
 
 env:
-  GITHUB_REPO: "linuxserver/docker-mods" #don't modify
-  ENDPOINT: "linuxserver/mods" #don't modify
+  GITHUB_REPO: "somewatson/docker-mods" #don't modify -- modified
+  ENDPOINT: "somewatson/mods" #don't modify -- modified
   BASEIMAGE: "code-server" #replaced
-  MODNAME: "bat" #replaced
+  MODNAME: "rbenv-sw" #replaced
   MOD_VERSION: ${{ inputs.mod_version }} #don't modify
   MULTI_ARCH: "false" #set to false if not needed
 

README.md

@@ -1,17 +1,21 @@
-# Bat - Docker mod for code-server
+# Rbenv - Docker mod for code-server
 
-This mod adds [bat](https://github.com/sharkdp/bat) to code-server, to be installed/updated during container start.
+This mod adds [rbenv](https://github.com/rbenv/rbenv) to code-server, to be installed/updated during container start.
 
-Bat is a cat(1) clone with syntax highlighting and Git integration.
+rbenv is a version manager tool for the Ruby programming language on Unix-like systems. It is useful for switching between multiple Ruby versions on the same machine and for ensuring that each project you are working on always runs on the correct Ruby version.
 
-In code-server docker arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:code-server-bat`
+In code-server docker arguments, set an environment variable `DOCKER_MODS=somewatson/mods:code-server-rbenv-sw`
 
-If adding multiple mods, enter them in an array separated by `|`, such as `DOCKER_MODS=linuxserver/mods:code-server-bat|linuxserver/mods:openssh-server-mod2`
+If adding multiple mods, enter them in an array separated by `|`, such as `DOCKER_MODS=somewatson/mods:code-server-rbenv-sw|linuxserver/mods:openssh-server-mod2`
 
-### Bat-extras and Ripgrep
+### Shell completions
 
-This mod also includes [bat-extras](https://github.com/eth-p/bat-extras) which has a dependency of [ripgrep](https://github.com/BurntSushi/ripgrep). Ripgrep has also been included because it is a requirment of bat-extras.
+This mod includes adding [shell completions](https://github.com/rbenv/rbenv?tab=readme-ov-file#shell-completions) for `rbenv` in `bash` and `zsh`.
 
-### Aliases
+The zsh completion script ships with the project, but needs to be added to FPATH in zsh before it can be discovered by the shell. So, the mod will automatically detect and update the `~/.zshrc` file:
 
-This mod includes aliases for `bat` in `bash` and `zsh`. Under Ubuntu `bat` gets installed as `batcat` to avoid a name collision. So, for convenience, an alias to set `bat="batcat"` is included for both `bash` and `zsh`. 
+```
+FPATH=~/.rbenv/completions:"$FPATH"
+autoload -U compinit
+compinit
+```

root/etc/s6-overlay/s6-rc.d/init-mod-code-server-bat-install/run

@@ -5,20 +5,6 @@
 # If using this, we need to make sure we set this init as a dependency of init-mods-package-install so this one runs first
 #!/usr/bin/with-contenv bash
 
-if ! dpkg -s ripgrep >/dev/null 2>&1; then
-    echo "**** Adding ripgrep to package install list ****"
-    echo "ripgrep" >> /mod-repo-packages-to-install.list
-else
-    echo "**** ripgrep already installed, skipping ****"
-fi
-
-if ! dpkg -s bat >/dev/null 2>&1; then
-    echo "**** Adding bat to package install list ****"
-    echo "bat" >> /mod-repo-packages-to-install.list
-else
-    echo "**** bat already installed, skipping ****"
-fi
-
 if ! dpkg -s git >/dev/null 2>&1; then
     echo "**** Adding git to package install list ****"
     echo "git" >> /mod-repo-packages-to-install.list

…bat-add-package/dependencies.d/init-mods …env-add-package/dependencies.d/init-modsroot/etc/s6-overlay/s6-rc.d/init-mod-code-server-bat-add-package/dependencies.d/init-mods renamed to root/etc/s6-overlay/s6-rc.d/init-mod-code-server-rbenv-add-package/dependencies.d/init-mods root/etc/s6-overlay/s6-rc.d/init-mod-code-server-bat-add-package/dependencies.d/init-mods renamed to root/etc/s6-overlay/s6-rc.d/init-mod-code-server-rbenv-add-package/dependencies.d/init-mods

@@ -0,0 +1,37 @@
+#!/usr/bin/with-contenv bash
+
+# This is an install script that is designed to run after init-mods-package-install
+# so it can take advantage of packages installed
+# init-mods-end depends on this script so that later init and services wait until this script exits
+
+if [ -d ~/.rbenv ]; then
+    echo 'rbenv already cloned, skipping'
+else
+    echo 'Cloning rbenv repo'
+    git clone https://github.com/rbenv/rbenv.git ~/.rbenv
+fi
+
+# Needs the - because it's being run in a script
+~/.rbenv/bin/rbenv init -
+
+if ! command -v zsh >/dev/null 2>&1; then
+    echo "**** zsh not installed, skipping shell completions setup ****"
+else
+    if [ -f ~/.zshrc ]; then
+        if ! grep -q 'FPATH=~/.rbenv/completions:"$FPATH"' ~/.zshrc; then
+            echo 'Adding shell completions to zsh for rbenv'
+            
+            echo 'FPATH=~/.rbenv/completions:"$FPATH"' >> ~/.zshrc
+            echo 'autoload -U compinit' >> ~/.zshrc
+            echo 'compinit' >> ~/.zshrc
+        else
+            echo 'rbenv shell completions already exist in zsh, skipping'
+        fi
+    else
+        echo '~/.zshrc not found, creating one with the shell completions'
+
+        echo 'FPATH=~/.rbenv/completions:"$FPATH"' >> ~/.zshrc
+        echo 'autoload -U compinit' >> ~/.zshrc
+        echo 'compinit' >> ~/.zshrc
+    fi
+fi