Add tests (bat-core) and CI

Author: grega

.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    name: Shellcheck
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Run shellcheck
+        run: shellcheck hdi
+
+  test:
+    name: Test (${{ matrix.os }})
+    needs: lint
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install bats-core
+        run: |
+          if [[ "$RUNNER_OS" == "macOS" ]]; then
+            brew install bats-core
+          else
+            sudo apt-get update -qq && sudo apt-get install -qq -y bats
+          fi
+
+      - name: Run tests
+        run: bats test/hdi.bats

.github/workflows/release.yml

@@ -0,0 +1,41 @@
+name: Release
+
+on:
+  push:
+    tags: ['v*']
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    name: Create release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Run tests before release
+        run: |
+          sudo apt-get update -qq && sudo apt-get install -qq -y bats
+          bats test/hdi.bats
+
+      - name: Get version from tag
+        id: version
+        run: echo "version=${GITHUB_REF#refs/tags/}" >> "$GITHUB_OUTPUT"
+
+      - name: Create GitHub release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: hdi
+          generate_release_notes: true
+          body: |
+            ## Install
+
+            ```bash
+            # Homebrew
+            brew install gregannandale/tap/hdi
+
+            # Manual
+            curl -fsSL https://raw.githubusercontent.com/gregannandale/hdi/${{ steps.version.outputs.version }}/hdi -o ~/.local/bin/hdi
+            chmod +x ~/.local/bin/hdi
+            ```

README.md

@@ -79,6 +79,15 @@ hdi /path/to/project   Scan a different directory
 
 No dependencies, just Bash. Should work on macOS and Linux.
 
+## Testing
+
+Tests use [bats-core](https://github.com/bats-core/bats-core).
+
+```bash
+brew install bats-core  # or: apt-get install bats
+bats test/hdi.bats
+```
+
 ## Publishing a new release
 
 1. Tag the release and push:

hdi

@@ -240,9 +240,9 @@ render_static() {
         ;;
       empty)
         if $RAW; then
-          [[ -n "$line" ]] && printf "  %s\n" "$line"
+          if [[ -n "$line" ]]; then printf "  %s\n" "$line"; fi
         else
-          [[ -n "$line" ]] && printf "  %s%s%s\n" "$DIM" "$line" "$RESET"
+          if [[ -n "$line" ]]; then printf "  %s%s%s\n" "$DIM" "$line" "$RESET"; fi
         fi
         ;;
     esac

test/fixtures/elixir-phoenix/README.md

@@ -0,0 +1,36 @@
+# phoenix-app
+
+An Elixir/Phoenix web application.
+
+## Setup
+
+```bash
+mix deps.get
+mix ecto.setup
+```
+
+## Start the server
+
+```bash
+mix phx.server
+```
+
+Or inside IEx:
+
+```bash
+iex -S mix phx.server
+```
+
+## Configuration
+
+```elixir
+config :phoenix_app, PhoenixApp.Repo,
+  database: "phoenix_app_dev",
+  hostname: "localhost"
+```
+
+## Test
+
+```bash
+mix test
+```

test/fixtures/go-project/README.md

@@ -0,0 +1,35 @@
+# go-service
+
+A microservice written in Go.
+
+## Requirements
+
+```bash
+brew install go
+```
+
+## Setup
+
+```bash
+go mod download
+cp config.example.yaml config.yaml
+```
+
+## Build
+
+```bash
+go build -o bin/service ./cmd/service
+```
+
+## Running
+
+```bash
+./bin/service --port 8080
+```
+
+## Environment Variables
+
+```env
+PORT=8080
+DB_HOST=localhost
+```

test/fixtures/java-spring/README.md

@@ -0,0 +1,37 @@
+# spring-boot-api
+
+A Spring Boot REST API.
+
+## Prerequisites
+
+```bash
+sdk install java 21-tem
+sdk install maven
+```
+
+## Build
+
+```bash
+mvn clean install
+```
+
+## Run
+
+```bash
+java -jar target/spring-boot-api-0.1.0.jar
+```
+
+Or with Maven:
+
+```bash
+mvn spring-boot:run
+```
+
+## API Docs
+
+```json
+{
+  "openapi": "3.0.0",
+  "info": { "title": "API", "version": "1.0" }
+}
+```

test/fixtures/kubernetes-helm/README.md

@@ -0,0 +1,32 @@
+# k8s-platform
+
+Kubernetes deployment with Helm charts.
+
+## Dependencies
+
+```bash
+brew install kubectl helm
+```
+
+## Installation
+
+```bash
+helm repo add bitnami https://charts.bitnami.com/bitnami
+helm install my-release bitnami/nginx
+```
+
+## Usage
+
+```bash
+kubectl get pods
+kubectl port-forward svc/my-release-nginx 8080:80
+```
+
+## Values
+
+```yaml
+replicaCount: 3
+image:
+  repository: nginx
+  tag: "1.25"
+```

test/fixtures/mixed-blocks/README.md

@@ -0,0 +1,52 @@
+# mixed-app
+
+An app with many code block types.
+
+## Installation
+
+Install the CLI:
+
+```bash
+npm install -g mixed-app
+```
+
+The config file looks like this:
+
+```json
+{
+  "port": 3000
+}
+```
+
+Environment setup:
+
+```yaml
+DATABASE_URL: postgres://localhost/app
+```
+
+```toml
+[server]
+port = 3000
+```
+
+Then initialize:
+
+```shell
+mixed-app init
+```
+
+## Running
+
+```bash
+mixed-app serve
+```
+
+Log output:
+
+```log
+[INFO] Server started on :3000
+```
+
+```xml
+<config><port>3000</port></config>
+```

test/fixtures/nested-sections/README.md

@@ -0,0 +1,35 @@
+# nested-project
+
+## Getting Started
+
+### Prerequisites
+
+```bash
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+```
+
+### Quick Start
+
+```bash
+cargo run
+```
+
+## Development
+
+### Dev Server
+
+```bash
+cargo watch -x run
+```
+
+### Building
+
+```bash
+cargo build --release
+```
+
+### Testing
+
+```bash
+cargo test
+```