Merge pull request #1073 from somewatson/code-server-bat

Create mod to include bat in code-server

Author: aptalca

.github/workflows/BuildImage.yml

@@ -12,10 +12,10 @@ on:
 env:
   GITHUB_REPO: "linuxserver/docker-mods" #don't modify
   ENDPOINT: "linuxserver/mods" #don't modify
-  BASEIMAGE: "replace_baseimage" #replace
-  MODNAME: "replace_modname" #replace
+  BASEIMAGE: "code-server" #replaced
+  MODNAME: "bat" #replaced
   MOD_VERSION: ${{ inputs.mod_version }} #don't modify
-  MULTI_ARCH: "true" #set to false if not needed
+  MULTI_ARCH: "false" #set to false if not needed
 
 jobs:
   set-vars:

Dockerfile

@@ -2,7 +2,7 @@
 
 FROM scratch
 
-LABEL maintainer="username"
+LABEL maintainer="somewatson"
 
 # copy local files
 COPY root/ /

Dockerfile.complex

@@ -1,25 +1,17 @@
-# Rsync - Docker mod for openssh-server
+# Bat - Docker mod for code-server
 
-This mod adds rsync to openssh-server, to be installed/updated during container start.
+This mod adds [bat](https://github.com/sharkdp/bat) to code-server, to be installed/updated during container start.
 
-In openssh-server docker arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:openssh-server-rsync`
+Bat is a cat(1) clone with syntax highlighting and Git integration.
 
-If adding multiple mods, enter them in an array separated by `|`, such as `DOCKER_MODS=linuxserver/mods:openssh-server-rsync|linuxserver/mods:openssh-server-mod2`
+In code-server docker arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:code-server-bat`
 
-# Mod creation instructions
+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`
 
-* Fork the repo, create a new branch based on the branch `template`.
-* Edit the `Dockerfile` for the mod. `Dockerfile.complex` is only an example and included for reference; it should be deleted when done.
-* Inspect the `root` folder contents. Edit, add and remove as necessary.
-* After all init scripts and services are created, run `find ./  -path "./.git" -prune -o \( -name "run" -o -name "finish" -o -name "check" \) -not -perm -u=x,g=x,o=x -print -exec chmod +x {} +` to fix permissions.
-* Edit this readme with pertinent info, delete these instructions.
-* Finally edit the `.github/workflows/BuildImage.yml`. Customize the vars for `BASEIMAGE` and `MODNAME`. Set the versioning logic and `MULTI_ARCH` if needed.
-* Ask the team to create a new branch named `<baseimagename>-<modname>`. Baseimage should be the name of the image the mod will be applied to. The new branch will be based on the `template` branch.
-* Submit PR against the branch created by the team.
+### Bat-extras and Ripgrep
 
+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.
 
-## Tips and tricks
+### Aliases
 
-* Some images have helpers built in, these images are currently:
-    * [Openvscode-server](https://github.com/linuxserver/docker-openvscode-server/pull/10/files)
-    * [Code-server](https://github.com/linuxserver/docker-code-server/pull/95)
+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`. 

README.md

@@ -0,0 +1,27 @@
+#!/usr/bin/with-contenv bash
+
+# This is the init file used for adding os or pip packages to install lists.
+# It takes advantage of the built-in init-mods-package-install init script that comes with the baseimages.
+# 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
+else
+    echo "**** git already installed, skipping ****"
+fi

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

@@ -0,0 +1 @@
+/etc/s6-overlay/s6-rc.d/init-mod-code-server-bat-add-package/run

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

@@ -0,0 +1,61 @@
+#!/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 ! command -v zsh >/dev/null 2>&1; then
+    echo "**** zsh not installed, skipping alias setup ****"
+else
+    if [ -f /config/.zshrc ]; then
+        if ! grep -q 'alias bat="batcat"' /config/.zshrc; then
+            echo 'Adding alias to zsh for bat'
+            echo 'alias bat="batcat"' >> /config/.zshrc
+        else
+            echo 'Alias already exists in zsh, skipping'
+        fi
+    else
+        echo '/config/.zshrc not found, creating one with the alias'
+        echo 'alias bat="batcat"' > /config/.zshrc
+    fi
+fi
+
+if ! command -v bash >/dev/null 2>&1; then
+    echo "**** bash not installed, skipping alias setup ****"
+else
+    if [ -f /config/.bash_profile ]; then
+        if ! grep -q 'alias bat="batcat"' /config/.bash_profile; then
+            echo 'Adding alias to /config/.bash_profile for bat'
+            echo 'alias bat="batcat"' >> /config/.bash_profile
+        else
+            echo 'Alias already exists in /config/.bash_profile, skipping'
+        fi
+    elif [ -f /config/.bashrc ]; then
+        if ! grep -q 'alias bat="batcat"' /config/.bashrc; then
+            echo 'Adding alias to /config/.bashrc for bat'
+            echo 'alias bat="batcat"' >> /config/.bashrc
+        else
+            echo 'Alias already exists in /config/.bashrc, skipping'
+        fi
+    else
+        echo '/config/.bash_profile or /config/.bashrc not found, creating one with the alias'
+        echo 'alias bat="batcat"' > /config/.bash_profile
+    fi
+fi
+
+if [ -d /config/.bat-extras ]; then
+    echo 'Bat-extras already cloned, updating'
+    git config --global --add safe.directory /config/.bat-extras
+    git -C /config/.bat-extras pull
+else
+    echo 'Cloning bat-extras repo'
+    git clone https://github.com/eth-p/bat-extras.git /config/.bat-extras
+fi
+
+echo 'Installing bat-extras'
+ln -sf /config/.bat-extras/src/*.sh /usr/local/bin
+
+echo 'Setting permissions for bat-extras'
+chmod +x /config/.bat-extras/src/*.sh
+lsiown -R abc:abc \
+    /config/.bat-extras