Add formatting check for shell scripts (#106)

Author: matifali

.github/workflows/ci.yaml

@@ -20,6 +20,8 @@ jobs:
       - uses: oven-sh/setup-bun@v1
         with:
           bun-version: latest
+      - name: Setup
+        run: bun install
       - run: bun test
   pretty:
     runs-on: ubuntu-latest
@@ -28,7 +30,9 @@ jobs:
       - uses: oven-sh/setup-bun@v1
         with:
           bun-version: latest
+      - name: Setup
+        run: bun install
       - name: Format
         run: bun fmt:ci
       - name: Lint
-        run: bun install && bun lint
+        run: bun lint

.sample/run.sh

@@ -1,7 +1,15 @@
-#!/usr/bin/env bash
+#!/usr/bin/env sh
 
+# Convert templated variables to shell variables
+# shellcheck disable=SC2269
+LOG_PATH=${LOG_PATH}
+
+# shellcheck disable=SC2034
 BOLD='\033[0;1m'
+
+# shellcheck disable=SC2059
 printf "$${BOLD}Installing MODULE_NAME ...\n\n"
+
 # Add code here
 # Use varibles from the templatefile function in main.tf
 # e.g. LOG_PATH, PORT, etc.
@@ -13,6 +21,6 @@ printf "👷 Starting MODULE_NAME in background...\n\n"
 # 1. Use & to run it in background
 # 2. redirct stdout and stderr to log files
 
-./app >${LOG_PATH} 2>&1 &
+./app > "$${LOG_PATH}" 2>&1 &
 
-printf "check logs at ${LOG_PATH} \n\n"
+printf "check logs at %s\n\n" "$${LOG_PATH}"

bun.lockb

@@ -42,9 +42,9 @@ done
 if [ ! -f ~/.local/share/code-server/Machine/settings.json ]; then
   echo "⚙️ Creating settings file..."
   mkdir -p ~/.local/share/code-server/Machine
-  echo "${SETTINGS}" >~/.local/share/code-server/Machine/settings.json
+  echo "${SETTINGS}" > ~/.local/share/code-server/Machine/settings.json
 fi
 
 echo "👷 Running code-server in the background..."
 echo "Check logs at ${LOG_PATH}!"
-$CODE_SERVER --auth none --port ${PORT} >${LOG_PATH} 2>&1 &
+$CODE_SERVER --auth none --port ${PORT} > ${LOG_PATH} 2>&1 &

code-server/run.sh

@@ -7,8 +7,9 @@ BOLD='\033[0;1m'
 
 printf "$${BOLD}Logging into Coder...\n\n$${RESET}"
 
-if ! coder list >/dev/null 2>&1; then
-  set +x; coder login --token="${CODER_USER_TOKEN}" --url="${CODER_DEPLOYMENT_URL}"
+if ! coder list > /dev/null 2>&1; then
+  set +x
+  coder login --token="${CODER_USER_TOKEN}" --url="${CODER_DEPLOYMENT_URL}"
 else
   echo "You are already authenticated with coder."
 fi

coder-login/run.sh

@@ -21,6 +21,6 @@ printf "📂 Serving $${ROOT_DIR} at http://localhost:${PORT} \n\n"
 
 printf "Running 'filebrowser --noauth --root $ROOT_DIR --port ${PORT}$${DB_FLAG}' \n\n"
 
-filebrowser --noauth --root $ROOT_DIR --port ${PORT}$${DB_FLAG} >${LOG_PATH} 2>&1 & 
+filebrowser --noauth --root $ROOT_DIR --port ${PORT}$${DB_FLAG} > ${LOG_PATH} 2>&1 &
 
 printf "📝 Logs at ${LOG_PATH} \n\n"

filebrowser/run.sh

@@ -18,7 +18,7 @@ if [ -z "$CLONE_PATH" ]; then
 fi
 
 # Check if `git` is installed...
-if ! command -v git >/dev/null; then
+if ! command -v git > /dev/null; then
   echo "Git is not installed!"
   exit 1
 fi

git-clone/run.sh

@@ -1,33 +1,33 @@
 #!/usr/bin/env sh
 
 if ! command -v git > /dev/null; then
-        echo "git is not installed"
-        exit 1
+  echo "git is not installed"
+  exit 1
 fi
 
 if ! command -v curl > /dev/null; then
-        echo "curl is not installed"
-        exit 1
+  echo "curl is not installed"
+  exit 1
 fi
 
 if ! command -v jq > /dev/null; then
-        echo "jq is not installed"
-        exit 1
+  echo "jq is not installed"
+  exit 1
 fi
 
 mkdir -p ~/.ssh/git-commit-signing
 
 echo "Downloading SSH key"
 
 ssh_key=$(curl --request GET \
-        --url "${CODER_AGENT_URL}api/v2/workspaceagents/me/gitsshkey" \
-        --header "Coder-Session-Token: ${CODER_AGENT_TOKEN}")
+  --url "${CODER_AGENT_URL}api/v2/workspaceagents/me/gitsshkey" \
+  --header "Coder-Session-Token: ${CODER_AGENT_TOKEN}")
 
-jq --raw-output ".public_key" > ~/.ssh/git-commit-signing/coder.pub <<EOF
+jq --raw-output ".public_key" > ~/.ssh/git-commit-signing/coder.pub << EOF
 $ssh_key
 EOF
 
-jq --raw-output ".private_key" > ~/.ssh/git-commit-signing/coder <<EOF
+jq --raw-output ".private_key" > ~/.ssh/git-commit-signing/coder << EOF
 $ssh_key
 EOF
 
@@ -38,4 +38,4 @@ echo "Configuring git to use the SSH key"
 
 git config --global gpg.format ssh
 git config --global commit.gpgsign true
-git config --global user.signingkey ~/.ssh/git-commit-signing/coder
+git config --global user.signingkey ~/.ssh/git-commit-signing/coder

git-commit-signing/run.sh

@@ -4,20 +4,20 @@ BOLD='\033[0;1m'
 printf "$${BOLD}Checking git-config!\n"
 
 # Check if git is installed
-command -v git >/dev/null 2>&1 || {
-    echo "Git is not installed!"
-    exit 1
+command -v git > /dev/null 2>&1 || {
+  echo "Git is not installed!"
+  exit 1
 }
 
 # Set git username and email if missing
 if [ -z $(git config --get user.email) ]; then
-    printf "git-config: No user.email found, setting to ${GIT_EMAIL}\n"
-    git config --global user.email "${GIT_EMAIL}"
+  printf "git-config: No user.email found, setting to ${GIT_EMAIL}\n"
+  git config --global user.email "${GIT_EMAIL}"
 fi
 
 if [ -z $(git config --get user.name) ]; then
-    printf "git-config: No user.name found, setting to ${GIT_USERNAME}\n"
-    git config --global user.name "${GIT_USERNAME}"
+  printf "git-config: No user.name found, setting to ${GIT_USERNAME}\n"
+  git config --global user.name "${GIT_USERNAME}"
 fi
 
 printf "\n$${BOLD}git-config: using email: $(git config --get user.email)\n"

git-config/run.sh

@@ -3,7 +3,7 @@
 BOLD='\033[0;1m'
 
 # check if JFrog CLI is already installed
-if command -v jf >/dev/null 2>&1; then
+if command -v jf > /dev/null 2>&1; then
   echo "✅ JFrog CLI is already installed, skipping installation."
 else
   echo "📦 Installing JFrog CLI..."
@@ -23,15 +23,15 @@ if [ -z "${REPOSITORY_NPM}" ]; then
   echo "🤔 REPOSITORY_NPM is not set, skipping npm configuration."
 else
   # check if npm is installed and configure it to use the Artifactory "npm" repository.
-  if command -v npm >/dev/null 2>&1; then
+  if command -v npm > /dev/null 2>&1; then
     echo "📦 Configuring npm..."
     jf npmc --global --repo-resolve "${REPOSITORY_NPM}"
   fi
-  cat <<EOF >~/.npmrc
+  cat << EOF > ~/.npmrc
 email = ${ARTIFACTORY_EMAIL}
 registry = ${JFROG_URL}/artifactory/api/npm/${REPOSITORY_NPM}
 EOF
-  jf rt curl /api/npm/auth >>~/.npmrc
+  jf rt curl /api/npm/auth >> ~/.npmrc
 fi
 
 # Configure the `pip` to use the Artifactory "python" repository.
@@ -41,7 +41,7 @@ else
   echo "🐍 Configuring pip..."
   jf pipc --global --repo-resolve "${REPOSITORY_PYPI}"
   mkdir -p ~/.pip
-  cat <<EOF >~/.pip/pip.conf
+  cat << EOF > ~/.pip/pip.conf
 [global]
 index-url = https://${ARTIFACTORY_USERNAME}:${ARTIFACTORY_ACCESS_TOKEN}@${JFROG_HOST}/artifactory/api/pypi/${REPOSITORY_PYPI}/simple
 EOF

jfrog-oauth/run.sh

@@ -3,7 +3,7 @@
 BOLD='\033[0;1m'
 
 # check if JFrog CLI is already installed
-if command -v jf >/dev/null 2>&1; then
+if command -v jf > /dev/null 2>&1; then
   echo "✅ JFrog CLI is already installed, skipping installation."
 else
   echo "📦 Installing JFrog CLI..."
@@ -23,15 +23,15 @@ if [ -z "${REPOSITORY_NPM}" ]; then
   echo "🤔 REPOSITORY_NPM is not set, skipping npm configuration."
 else
   # check if npm is installed and configure it to use the Artifactory "npm" repository.
-  if command -v npm >/dev/null 2>&1; then
+  if command -v npm > /dev/null 2>&1; then
     echo "📦 Configuring npm..."
     jf npmc --global --repo-resolve "${REPOSITORY_NPM}"
   fi
-  cat <<EOF >~/.npmrc
+  cat << EOF > ~/.npmrc
 email = ${ARTIFACTORY_EMAIL}
 registry = ${JFROG_URL}/artifactory/api/npm/${REPOSITORY_NPM}
 EOF
-  jf rt curl /api/npm/auth >>~/.npmrc
+  jf rt curl /api/npm/auth >> ~/.npmrc
 fi
 
 # Configure the `pip` to use the Artifactory "python" repository.
@@ -41,7 +41,7 @@ else
   echo "🐍 Configuring pip..."
   jf pipc --global --repo-resolve "${REPOSITORY_PYPI}"
   mkdir -p ~/.pip
-  cat <<EOF >~/.pip/pip.conf
+  cat << EOF > ~/.pip/pip.conf
 [global]
 index-url = https://${ARTIFACTORY_USERNAME}:${ARTIFACTORY_ACCESS_TOKEN}@${JFROG_HOST}/artifactory/api/pypi/${REPOSITORY_PYPI}/simple
 EOF

jfrog-token/run.sh

@@ -5,21 +5,21 @@ BOLD='\033[0;1m'
 printf "$${BOLD}Installing jupyter-notebook!\n"
 
 # check if jupyter-notebook is installed
-if ! command -v jupyter-notebook >/dev/null 2>&1; then
-    # install jupyter-notebook
-    # check if python3 pip is installed
-    if ! command -v pip3 >/dev/null 2>&1; then
-        echo "pip3 is not installed"
-        echo "Please install pip3 in your Dockerfile/VM image before running this script"
-        exit 1
-    fi
-    # install jupyter-notebook
-    pip3 install --upgrade --no-cache-dir --no-warn-script-location jupyter
-    echo "🥳 jupyter-notebook has been installed\n\n"
+if ! command -v jupyter-notebook > /dev/null 2>&1; then
+  # install jupyter-notebook
+  # check if python3 pip is installed
+  if ! command -v pip3 > /dev/null 2>&1; then
+    echo "pip3 is not installed"
+    echo "Please install pip3 in your Dockerfile/VM image before running this script"
+    exit 1
+  fi
+  # install jupyter-notebook
+  pip3 install --upgrade --no-cache-dir --no-warn-script-location jupyter
+  echo "🥳 jupyter-notebook has been installed\n\n"
 else
-    echo "🥳 jupyter-notebook is already installed\n\n"
+  echo "🥳 jupyter-notebook is already installed\n\n"
 fi
 
 echo "👷 Starting jupyter-notebook in background..."
 echo "check logs at ${LOG_PATH}"
-$HOME/.local/bin/jupyter notebook --NotebookApp.ip='0.0.0.0' --ServerApp.port=${PORT} --no-browser --ServerApp.token='' --ServerApp.password='' >${LOG_PATH} 2>&1 &
+$HOME/.local/bin/jupyter notebook --NotebookApp.ip='0.0.0.0' --ServerApp.port=${PORT} --no-browser --ServerApp.token='' --ServerApp.password='' > ${LOG_PATH} 2>&1 &

jupyter-notebook/run.sh

@@ -5,21 +5,21 @@ BOLD='\033[0;1m'
 printf "$${BOLD}Installing jupyterlab!\n"
 
 # check if jupyterlab is installed
-if ! command -v jupyterlab >/dev/null 2>&1; then
-    # install jupyterlab
-    # check if python3 pip is installed
-    if ! command -v pip3 >/dev/null 2>&1; then
-        echo "pip3 is not installed"
-        echo "Please install pip3 in your Dockerfile/VM image before running this script"
-        exit 1
-    fi
-    # install jupyterlab
-    pip3 install --upgrade --no-cache-dir --no-warn-script-location jupyterlab
-    echo "🥳 jupyterlab has been installed\n\n"
+if ! command -v jupyterlab > /dev/null 2>&1; then
+  # install jupyterlab
+  # check if python3 pip is installed
+  if ! command -v pip3 > /dev/null 2>&1; then
+    echo "pip3 is not installed"
+    echo "Please install pip3 in your Dockerfile/VM image before running this script"
+    exit 1
+  fi
+  # install jupyterlab
+  pip3 install --upgrade --no-cache-dir --no-warn-script-location jupyterlab
+  echo "🥳 jupyterlab has been installed\n\n"
 else
-    echo "🥳 jupyterlab is already installed\n\n"
+  echo "🥳 jupyterlab is already installed\n\n"
 fi
 
 echo "👷 Starting jupyterlab in background..."
 echo "check logs at ${LOG_PATH}"
-$HOME/.local/bin/jupyter lab --ServerApp.ip='0.0.0.0' --ServerApp.port=${PORT} --no-browser --ServerApp.token='' --ServerApp.password='' >${LOG_PATH} 2>&1 &
+$HOME/.local/bin/jupyter lab --ServerApp.ip='0.0.0.0' --ServerApp.port=${PORT} --no-browser --ServerApp.token='' --ServerApp.password='' > ${LOG_PATH} 2>&1 &

jupyterlab/run.sh

@@ -7,15 +7,15 @@ MODULE_NAME=$1
 
 # Check if module name is provided
 if [ -z "$MODULE_NAME" ]; then
-    echo "Usage: ./new.sh <module_name>"
-    exit 1
+  echo "Usage: ./new.sh <module_name>"
+  exit 1
 fi
 
 # Create module directory and exit if it alredy exists
 if [ -d "$MODULE_NAME" ]; then
-    echo "Module with name $MODULE_NAME already exists"
-    echo "Please choose a different name"
-    exit 1
+  echo "Module with name $MODULE_NAME already exists"
+  echo "Please choose a different name"
+  exit 1
 fi
 mkdir -p "${MODULE_NAME}"
 
@@ -27,13 +27,13 @@ cd "${MODULE_NAME}"
 
 # Detect OS
 if [[ "$OSTYPE" == "darwin"* ]]; then
-    # macOS
-    sed -i '' "s/MODULE_NAME/${MODULE_NAME}/g" main.tf
-    sed -i '' "s/MODULE_NAME/${MODULE_NAME}/g" README.md
+  # macOS
+  sed -i '' "s/MODULE_NAME/${MODULE_NAME}/g" main.tf
+  sed -i '' "s/MODULE_NAME/${MODULE_NAME}/g" README.md
 else
-    # Linux
-    sed -i "s/MODULE_NAME/${MODULE_NAME}/g" main.tf
-    sed -i "s/MODULE_NAME/${MODULE_NAME}/g" README.md
+  # Linux
+  sed -i "s/MODULE_NAME/${MODULE_NAME}/g" main.tf
+  sed -i "s/MODULE_NAME/${MODULE_NAME}/g" README.md
 fi
 
 # Make run.sh executable

new.sh

@@ -2,16 +2,17 @@
   "name": "modules",
   "scripts": {
     "test": "bun test",
-    "fmt": "bun x prettier -w **/*.ts **/*.md *.md && terraform fmt **/*.tf",
-    "fmt:ci": "bun x prettier --check **/*.ts **/*.md *.md && terraform fmt -check **/*.tf",
+    "fmt": "bun x prettier --plugin prettier-plugin-sh -w **/*.sh .sample/run.sh new.sh **/*.ts **/*.md *.md && terraform fmt **/*.tf .sample/main.tf",
+    "fmt:ci": "bun x prettier --plugin prettier-plugin-sh --check **/*.sh .sample/run.sh new.sh **/*.ts **/*.md *.md && terraform fmt -check **/*.tf .sample/main.tf",
     "lint": "bun run lint.ts"
   },
   "devDependencies": {
-    "bun-types": "^1.0.3",
+    "bun-types": "^1.0.18",
     "gray-matter": "^4.0.3",
-    "marked": "^9.0.3"
+    "marked": "^11.1.0",
+    "prettier-plugin-sh": "^0.13.1"
   },
   "peerDependencies": {
-    "typescript": "^5.0.0"
+    "typescript": "^5.3.3"
   }
 }