Skip to content

chore: add .shfmt configuration and format shell scripts #403

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dmihalcik-virtru merged 7 commits into from
Feb 17, 2026
Merged

chore: add .shfmt configuration and format shell scripts #403

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2d8d9a5
chore: add .shfmt configuration and format shell scripts
dmihalcik-virtru Feb 13, 2026
c384513
chore(ci): enforce shell script formatting with shfmt
dmihalcik-virtru Feb 13, 2026
b04829b
chore: migrate shfmt config to .editorconfig and reformat
dmihalcik-virtru Feb 13, 2026
1a0aa46
chore: remove space_redirects option from shfmt config
dmihalcik-virtru Feb 13, 2026
59770f7
Merge branch 'main' into chore/add-shfmt
dmihalcik-virtru Feb 13, 2026
0a360f6
Merge branch 'main' into chore/add-shfmt
dmihalcik-virtru Feb 13, 2026
aee0e48
Merge branch 'main' into chore/add-shfmt
dmihalcik-virtru Feb 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .editorconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# EditorConfig is awesome: https://EditorConfig.org

# top-most EditorConfig file
root = true

# Shell scripts
[*.sh]
# Language variant
shell_variant = bash

# Indentation (2 spaces)
indent_style = space
indent_size = 2

# Binary operators at start of line
binary_next_line = false

# Switch case indentation
switch_case_indent = true

# Keep column alignment
keep_padding = true

# Function brace on same line
function_next_line = false
5 changes: 5 additions & 0 deletions .github/workflows/check.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ jobs:
run: >-
docker run --rm -v "$PWD:/mnt" --workdir "/mnt" "koalaman/shellcheck:v0.8.0" --color=always \
$(find . -type f -exec grep -m1 -l -E '^#!.*sh.*' {} \; | grep -v '/.git/')
- name: Check shell script formatting with shfmt
run: docker run --rm -v "$PWD:/mnt" --workdir "/mnt" mvdan/shfmt:v3 -d .
- uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
with:
python-version: '3.14'
- name: Install uv
uses: astral-sh/setup-uv@61cb8a9741eeb8a550a1b8544337180c0fc8476b # v7.2.0
with:
Expand Down
2 changes: 1 addition & 1 deletion xtest/sdk/go/cli.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
# XT_WITH_ATTRIBUTES [string] - Attributes to be used for encryption
# XT_WITH_MIME_TYPE [string] - MIME type for the encrypted file
#
SCRIPT_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)
SCRIPT_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)

cmd=("$SCRIPT_DIR"/otdfctl)
if [ ! -f "$SCRIPT_DIR"/otdfctl ]; then
Expand Down
2 changes: 1 addition & 1 deletion xtest/sdk/go/otdfctl.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
#
# Usage: ./otdfctl.sh [otdfctl options]
#
SCRIPT_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)
SCRIPT_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)

XTEST_DIR="$SCRIPT_DIR"
while [ ! -f "$XTEST_DIR/test.env" ] && [ "$(basename "$XTEST_DIR")" != "xtest" ]; do
Expand Down
2 changes: 1 addition & 1 deletion xtest/sdk/java/cli.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
# XT_WITH_MIME_TYPE [string] - MIME type for the encrypted file
# XT_WITH_TARGET_MODE [string] - Target spec mode for the encrypted file
#
SCRIPT_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)
SCRIPT_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)

XTEST_DIR="$SCRIPT_DIR"
while [ ! -f "$XTEST_DIR/test.env" ] && [ "$(basename "$XTEST_DIR")" != "xtest" ]; do
Expand Down
4 changes: 2 additions & 2 deletions xtest/sdk/js/cli.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
# XT_WITH_MIME_TYPE [string] - MIME type for the encrypted file
# XT_WITH_TARGET_MODE [string] - Target spec mode for the encrypted file
#
SCRIPT_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)
SCRIPT_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)

CTL=@opentdf/ctl
if grep opentdf/cli "$SCRIPT_DIR/package.json"; then
Expand Down Expand Up @@ -123,7 +123,7 @@ if [ -n "$XT_WITH_ASSERTIONS" ]; then
assertions=$(realpath "$assertions")
echo "Assertions are a file: $assertions"
args+=(--assertions "$assertions")
elif [ "$(echo "$assertions" | jq -e . >/dev/null 2>&1 && echo valid || echo invalid)" == "valid" ]; then
elif [ "$(echo "$assertions" | jq -e . >/dev/null 2>&1 && echo valid || echo invalid)" == "valid" ]; then
# Assertions are plain json
echo "Assertions are plain json: $assertions"
args+=(--assertions "$assertions")
Expand Down
2 changes: 1 addition & 1 deletion xtest/sdk/scripts/checkout-all.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Checks out the latest `main` branch of each of the sdks under test
# and builds them.

SCRIPT_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)
SCRIPT_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)

for sdk in go java js; do
if ! "$SCRIPT_DIR/checkout-sdk-branch.sh" "$sdk" main; then
Expand Down
4 changes: 2 additions & 2 deletions xtest/sdk/scripts/checkout-sdk-branch.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
# Example: ./checkout-sdk-branch.sh js main

# Resolve script directory
SCRIPT_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)
XTEST_DIR=$(cd -- "$SCRIPT_DIR/../../" &>/dev/null && pwd)
SCRIPT_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)
XTEST_DIR=$(cd -- "$SCRIPT_DIR/../../" &>/dev/null && pwd)

# Parse arguments
LANGUAGE=${1:-js}
Expand Down
2 changes: 1 addition & 1 deletion xtest/sdk/scripts/cleanup-all.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/bin/bash
# Removes the checked out branches of each of the sdks under test

SCRIPT_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)
SCRIPT_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)

for sdk in go java js; do
rm -rf "$SCRIPT_DIR/../$sdk/dist"
Expand Down
22 changes: 11 additions & 11 deletions xtest/sdk/scripts/post-checkout-java.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# on older branches that do not have it defined.

# Base directory for the script
SCRIPT_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)
SCRIPT_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)
BASE_DIR="$SCRIPT_DIR/../java/src"

# Detect the operating system to use the correct sed syntax
Expand All @@ -20,15 +20,15 @@ fi
get_platform_branch() {
local version="$1"
case "$version" in
0.7.8|0.7.7) echo "protocol/go/v0.2.29" ;;
0.7.6) echo "protocol/go/v0.2.25" ;;
0.7.5|0.7.4) echo "protocol/go/v0.2.18" ;;
0.7.3|0.7.2) echo "protocol/go/v0.2.17" ;;
0.6.1|0.6.0) echo "protocol/go/v0.2.14" ;;
0.5.0) echo "protocol/go/v0.2.13" ;;
0.4.0|0.3.0|0.2.0) echo "protocol/go/v0.2.10" ;;
0.1.0) echo "protocol/go/v0.2.3" ;;
*) echo "main" ;; # Default to main for unknown/newer versions
0.7.8 | 0.7.7) echo "protocol/go/v0.2.29" ;;
0.7.6) echo "protocol/go/v0.2.25" ;;
0.7.5 | 0.7.4) echo "protocol/go/v0.2.18" ;;
0.7.3 | 0.7.2) echo "protocol/go/v0.2.17" ;;
0.6.1 | 0.6.0) echo "protocol/go/v0.2.14" ;;
0.5.0) echo "protocol/go/v0.2.13" ;;
0.4.0 | 0.3.0 | 0.2.0) echo "protocol/go/v0.2.10" ;;
0.1.0) echo "protocol/go/v0.2.3" ;;
*) echo "main" ;; # Default to main for unknown/newer versions
esac
return 0
}
Expand All @@ -45,7 +45,7 @@ find "$BASE_DIR" -mindepth 1 -maxdepth 1 -type d -not -name "*.git" | while read

# Extract version from directory name (e.g., "v0.7.5" -> "0.7.5", "main" -> "main")
DIR_NAME=$(basename "$SRC_DIR")
VERSION="${DIR_NAME#v}" # Remove leading 'v' if present
VERSION="${DIR_NAME#v}" # Remove leading 'v' if present
PLATFORM_BRANCH=$(get_platform_branch "$VERSION")

# Check if the correct platform.branch is already set
Expand Down
Loading