feat: add BAT feature with Ubuntu/Debian package installation

Co-authored-by: jsburckhardt <[email protected]>

Author: Copilot

README.md

@@ -8,6 +8,7 @@ This repository contains a _collection_ of Features.
 
 | Name | URL | Description |
 | ---  | --- | ---         |
+| bat | https://github.com/sharkdp/bat | A cat(1) clone with syntax highlighting and Git integration. |
 | flux   | https://fluxcd.io/flux/installation/ | Flux is a tool for keeping Kubernetes clusters in sync with sources of configuration |
 | notation | https://notaryproject.dev/ | Notation is a CLI project to add signatures as standard items in the registry ecosystem, and to build a set of simple tooling for signing and verifying these signatures. This should be viewed as similar security to checking git commit signatures, although the signatures are generic and can be used for additional purposes. Notation is an implementation of the Notary v2 specifications.|
 | crane | https://github.com/google/go-containerregistry/blob/main/cmd/crane/README.md | crane is a tool for interacting with remote images and registries.|
@@ -26,6 +27,23 @@ This repository contains a _collection_ of Features.
 
 
 
+### `bat`
+
+Running `bat` inside the built container will print the help menu of bat.
+
+```jsonc
+{
+    "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
+    "features": {
+        "ghcr.io/jsburckhardt/devcontainer-features/bat:1": {}
+    }
+}
+```
+
+```bash
+bat --version
+```
+
 ### `flux`
 
 Running `flux` inside the built container will print the help menu of flux.

src/bat/README.md

@@ -0,0 +1,23 @@
+# bat (bat)
+
+A cat(1) clone with syntax highlighting and Git integration.
+
+## Example Usage
+
+```json
+"features": {
+    "ghcr.io/jsburckhardt/devcontainer-features/bat:1": {}
+}
+```
+
+## Options
+
+| Options Id | Description | Type | Default Value |
+|-----|-----|-----|-----|
+| version | Version of bat to install (currently installs from Ubuntu package repository). | string | latest |
+
+
+
+---
+
+_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/jsburckhardt/devcontainer-features/blob/main/src/bat/devcontainer-feature.json).  Add additional notes to a `NOTES.md`._

src/bat/devcontainer-feature.json

@@ -0,0 +1,13 @@
+{
+    "name": "bat",
+    "id": "bat",
+    "version": "1.0.0",
+    "description": "A cat(1) clone with syntax highlighting and Git integration.",
+    "options": {
+        "version": {
+            "type": "string",
+            "default": "latest",
+            "description": "Version of bat to install (currently installs from Ubuntu package repository)."
+        }
+    }
+}

src/bat/install.sh

@@ -0,0 +1,50 @@
+#!/usr/bin/env bash
+
+BAT_VERSION="${VERSION:-"latest"}"
+
+set -e
+
+if [ "$(id -u)" -ne 0 ]; then
+	echo -e 'Script must be run as root. Use sudo, su, or add "USER root" to your Dockerfile before running this script.'
+	exit 1
+fi
+
+# Checks if packages are installed and installs them if not
+check_packages() {
+	if ! dpkg -s "$@" >/dev/null 2>&1; then
+		if [ "$(find /var/lib/apt/lists/* | wc -l)" = "0" ]; then
+			echo "Running apt-get update..."
+			apt-get update -y
+		fi
+		apt-get -y install --no-install-recommends "$@"
+	fi
+}
+
+echo "Installing bat..."
+
+# For simplicity and reliability, install bat from Ubuntu repositories
+# This provides a stable version that works well in devcontainer environments
+check_packages bat
+
+# Verify installation
+echo "Verifying bat installation..."
+
+# In Ubuntu, bat is installed as 'batcat' to avoid conflicts
+if command -v batcat >/dev/null 2>&1; then
+	echo "batcat installed successfully!"
+	batcat --version
+	# Create a symlink so users can use 'bat' command
+	ln -sf /usr/bin/batcat /usr/local/bin/bat
+	echo "Created symlink: /usr/local/bin/bat -> /usr/bin/batcat"
+elif command -v bat >/dev/null 2>&1; then
+	echo "bat installed successfully!"
+	bat --version
+else
+	echo "ERROR: bat installation failed - neither bat nor batcat found"
+	exit 1
+fi
+
+# Clean up
+rm -rf /var/lib/apt/lists/*
+
+echo "Done!"

test/bat/test.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+set -e
+
+source dev-container-features-test-lib
+check "bat" bat --version
+reportResults