Merge remote-tracking branch 'upstream/main'

.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,39 @@
+name: Bug Report
+description: Report your bugs with the theme here!
+labels: [bug]
+body:
+  - type: checkboxes
+    attributes:
+      label: Is there an existing issue outlining your problem?
+      description: Please search to see if an issue already exists for your problem.
+      options:
+        - label: I have searched the existing issues and they do not solve my problem.
+          required: true
+  - type: textarea
+    attributes:
+      label: Describe your problem.
+      description: Also tell us, what do you expect to see?
+      placeholder: The battery charging icon is missing...
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Paste your configuration.
+      description: Provide us with the contents of your `.tmux.conf` file.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Attach screenshots.
+      description: If applicable, attach screenshots which clearly highlight the issue.
+  - type: input
+    attributes:
+      label: What tmux version are you seeing the issue on?
+      description: "You can find your version by running `tmux -V`"
+      placeholder: tmux 3.3a
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Any additional comments?
+      description: Add any information that hasn't been covered in the previous sections!

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,11 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Ask A Question
+    url: https://github.com/catppuccin/tmux/discussions/new?category=q-a
+    about: Need help tweaking your Catppuccin tmux configuration? Ask questions in GitHub Discussions!
+  - name: Show & Tell
+    url: https://github.com/catppuccin/tmux/discussions/new?category=show-tell
+    about: Want to showcase your customised Catppuccin tmux configuration? Show it off in GitHub Discussions!
+  - name: Community Discord
+    url: https://discord.com/servers/catppuccin-907385605422448742
+    about: Chat to other community members!

.github/ISSUE_TEMPLATE/enhancement.yml

@@ -0,0 +1,18 @@
+name: Enhancement Issue
+description: Request improvements to the theme here!
+labels: [enhancement]
+body:
+  - type: checkboxes
+    attributes:
+      label: Is there an existing issue outlining your improvement?
+      description: Please search to see if your improvement has already been raised as an issue.
+      options:
+        - label: I have searched the existing issues and my improvement has not been raised yet.
+          required: true
+  - type: textarea
+    attributes:
+      label: What would you like to see added and/or changed?
+      description: Make sure to mention why you think this is an improvement!
+      placeholder: I'd like to have an extra configuration option for...
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/meta.yml

@@ -0,0 +1,18 @@
+name: Meta Issue
+description: Raise any issue regarding the repository here!
+labels: [meta]
+body:
+  - type: checkboxes
+    attributes:
+      label: Is there an existing issue outlining your problem?
+      description: Please search to see if an issue already exists for your problem.
+      options:
+        - label: I have searched the existing issues and they do not solve my problem.
+          required: true
+  - type: textarea
+    attributes:
+      label: Describe your issue.
+      description: Bugs should be raised under a [Bug Report](https://github.com/catppuccin/tmux/issues/new?assignees=&labels=bug&template=bug.yml).
+      placeholder: The README is missing crucial information such as...
+    validations:
+      required: true

.github/scripts/test.bash

@@ -0,0 +1,71 @@
+#!/usr/bin/env bash
+
+#
+# Usage:
+# ./test.bash catpuccin-tmux/catpuccin-tmux.tmux
+# ./test.bash catpuccin-tmux/catpuccin-tmux.tmux ./config-example1
+#
+
+SOCKET_NAME="${SOCKET_NAME:-test}"
+
+tmux() {
+  command tmux -L "$SOCKET_NAME" "$@"
+}
+
+start_tmux_server() {
+  echo "Starting tmux server" >&2
+  tmux new -s dummy -d
+}
+
+kill_tmux_server() {
+  echo "Stopping tmux server" >&2
+  tmux kill-server
+}
+
+check() {
+  local out exit_code
+  exit_code="$1"
+  out="$2"
+
+  if [ "$exit_code" -ne 0 ] || [ -n "$out" ]; then
+    echo "Failed with exit code $exit_code and output:"
+    echo "$out"
+    exit 1
+  fi
+
+}
+
+main() {
+  local config_file plugin output exit_code
+
+  plugin="$1"
+  config_file="$2"
+
+  echo "Using socket '$SOCKET_NAME'" >&2
+
+  # Make sure its a new/clean server
+  kill_tmux_server 2>/dev/null
+  start_tmux_server
+
+  if [ -z "$config_file" ]; then
+    echo "No config file provided" >&2
+  else
+    echo "sourcing config file '$config_file'" >&2
+    tmux source-file "$config_file"
+  fi
+
+  if [ -z "$plugin" ]; then
+    echo "ERROR: No path to the plugin provided" >&2
+    exit 1
+  else
+    echo "Running plugin: $plugin" >&2
+    output="$(tmux run-shell "$plugin" 2>&1)"
+    exit_code="$?"
+
+    check "$exit_code" "$output"
+  fi
+
+  kill_tmux_server
+}
+
+main "$@"

.github/workflows/shellcheck.yml

@@ -0,0 +1,32 @@
+---
+name: Shellcheck
+permissions:
+  contents: read
+on:
+  pull_request:
+    paths-ignore:
+      - "*.md"
+      - "assets/**"
+  push:
+    paths-ignore:
+      - "*.md"
+      - "assets/**"
+    branches:
+      - main
+  workflow_dispatch:
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  shellcheck:
+    name: Shellcheck
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Run ShellCheck
+        uses: ludeeus/action-shellcheck@master
+        with:
+          additional_files: "catppuccin.tmux"
+        env:
+          SHELLCHECK_OPTS: "-a"

.github/workflows/test.yml

@@ -0,0 +1,51 @@
+---
+name: Tests
+permissions:
+  contents: read
+on:
+  pull_request:
+    paths-ignore:
+      - "*.md"
+      - "assets/**"
+  push:
+    paths-ignore:
+      - "*.md"
+      - "assets/**"
+    branches:
+      - main
+  workflow_dispatch:
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  ubuntu:
+    name: Test
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Install tmux
+        run: sudo apt-get update && sudo apt-get install -y tmux=3.2a-4ubuntu0.2
+      - uses: actions/checkout@v4
+      - name: Config and Plugin
+        shell: bash
+        run: |
+          bash --version
+          tmux -V
+          ./.github/scripts/test.bash ./catppuccin.tmux
+
+  old-bash:
+    name: "Old Bash"
+    runs-on: ubuntu-latest
+    container:
+      image: bash:3.2.57-alpine3.19 # Bash version used by macos
+    steps:
+      - uses: actions/checkout@v4
+      - name: Check Syntax is Valid
+        shell: bash
+        run: |
+          apk update
+          apk add tmux
+          bash --version
+          tmux -V
+          ./.github/scripts/test.bash ./catppuccin.tmux

.gitignore

@@ -1 +1,3 @@
 custom
+!custom/README.md
+!custom/example.sh

.shellcheckrc

@@ -0,0 +1,6 @@
+shell=bash
+
+# TODO: Find a way to declare color variables
+disable=SC2154
+
+external-sources=true