@objctp/opencode-shell-routines 1.2.0

package/skills/shell-best-practices/assets/posix.sh

@@ -0,0 +1,180 @@
+#!/bin/sh
+#
+# Description: [BRIEF DESCRIPTION OF WHAT THIS SCRIPT DOES]
+# Usage: [SCRIPT_NAME] [ARGUMENTS]
+#
+# Arguments:
+#   $1 - [FIRST_ARGUMENT]: [DESCRIPTION]
+#
+# Options:
+#   -h    Show this help message
+#   -v    Enable verbose output
+#
+# Examples:
+#   [SCRIPT_NAME] input.txt
+#   [SCRIPT_NAME] -v data.txt
+#
+
+set -eu
+
+###
+### :::: Constants :::: ###############
+###
+
+# shellcheck disable=SC2034  # template placeholder, used after scaffolding
+script_name=$(basename "$0")
+# shellcheck disable=SC2034
+readonly script_name
+
+###
+### :::: Globals :::: #################
+###
+
+VERBOSE=0
+
+###
+### :::: Private functions :::: #######
+###
+
+# Logging
+_log_info() {
+  printf '[INFO] %s\n' "$*" >&2
+  return 0
+}
+
+_log_warn() {
+  printf '[WARN] %s\n' "$*" >&2
+  return 0
+}
+
+_log_error() {
+  printf '[ERROR] %s\n' "$*" >&2
+  return 0
+}
+
+_log_debug() {
+  [ "$VERBOSE" -eq 1 ] && printf '[DEBUG] %s\n' "$*" >&2
+  return 0
+}
+
+# Display help message
+_show_help() {
+  cat <<'EOF'
+Usage: [SCRIPT_NAME] [OPTIONS] [ARGUMENTS]
+
+Arguments:
+  $1 - [FIRST_ARGUMENT]: [DESCRIPTION]
+
+Options:
+  -h    Show this help message
+  -v    Enable verbose output
+
+Examples:
+  [SCRIPT_NAME] input.txt
+  [SCRIPT_NAME] -v data.txt
+EOF
+  exit 0
+}
+
+# Cleanup
+_cleanup() {
+  _log_debug "Cleaning up..."
+  # Remove temporary files here
+  # rm -f "$tmp_file"
+  return 0
+}
+
+trap _cleanup EXIT INT TERM HUP
+
+# Validate inputs
+# shellcheck disable=SC3043 # local is widely supported in POSIX-compatible shells
+_validate_inputs() {
+  local input="$1"
+
+  if [ -z "$input" ]; then
+    _log_error "Input is required"
+    _show_help
+    # shellcheck disable=SC2317
+    exit 2
+  fi
+
+  if [ ! -r "$input" ]; then
+    _log_error "Cannot read: $input"
+    exit 1
+  fi
+
+  return 0
+}
+
+# Main processing function
+# shellcheck disable=SC3043 # local is widely supported in POSIX-compatible shells
+_process() {
+  local input_path="$1"
+
+  _log_info "Processing: $input_path"
+
+  # Your processing logic here
+  while IFS= read -r line; do
+    printf '%s\n' "$line"
+  done <"$input_path"
+
+  _log_info "Complete"
+  return 0
+}
+
+###
+### :::: Public functions :::: ########
+###
+
+# Main entry point
+# POSIX sh does not support :: in function names.
+# Use shroutines_ prefix with single underscore separator.
+shroutines_main() {
+  # Parse command-line arguments
+  while [ $# -gt 0 ]; do
+    case "$1" in
+    -h)
+      _show_help
+      ;;
+    -v)
+      VERBOSE=1
+      shift
+      ;;
+    --)
+      shift
+      break
+      ;;
+    -*)
+      _log_error "Unknown option: $1"
+      _show_help
+      # shellcheck disable=SC2317
+      exit 2
+      ;;
+    *)
+      break
+      ;;
+    esac
+  done
+
+  # Check for required arguments
+  if [ $# -lt 1 ]; then
+    _log_error "Missing required arguments"
+    _show_help
+    # shellcheck disable=SC2317
+    exit 2
+  fi
+
+  _validate_inputs "$1"
+  _process "$1"
+  return 0
+}
+
+###
+### :::: Guard and execution :::: #####
+###
+
+# POSIX sh has no BASH_SOURCE equivalent.
+# Test files should set _SKIP_MAIN=1 before sourcing this script.
+if [ -z "${_SKIP_MAIN:-}" ]; then
+  shroutines_main "$@"
+fi

package/skills/shell-best-practices/assets/standard.sh

@@ -0,0 +1,203 @@
+#!/usr/bin/env bash
+#
+# Description: [BRIEF DESCRIPTION OF WHAT THIS SCRIPT DOES]
+# Usage: [SCRIPT_NAME] [ARGUMENTS]
+#
+# Arguments:
+#   $1 - [FIRST_ARGUMENT]: [DESCRIPTION]
+#   $2 - [SECOND_ARGUMENT]: [DESCRIPTION]
+#
+# Options:
+#   -h, --help    Show this help message
+#   -v, --verbose Enable verbose output
+#   -o FILE       Output to FILE instead of stdout
+#
+# Examples:
+#   [SCRIPT_NAME] input.txt output.txt
+#   [SCRIPT_NAME] --verbose --output result.txt data.txt
+#
+
+set -euo pipefail
+
+###
+### :::: Constants :::: ###############
+###
+
+SCRIPT_NAME=${0##*/}
+# shellcheck disable=SC2034  # template placeholder, used after scaffolding
+readonly SCRIPT_NAME
+# shellcheck disable=SC2034
+readonly VERSION="0.1.0"
+
+###
+### :::: Globals :::: #################
+###
+
+VERBOSE=0
+OUTPUT_FILE=""
+
+###
+### :::: Private functions :::: #######
+###
+
+# Logging
+function _log_info() {
+  printf '[INFO] %s\n' "$*" >&2
+  return 0
+}
+
+function _log_warn() {
+  printf '[WARN] %s\n' "$*" >&2
+  return 0
+}
+
+function _log_error() {
+  printf '[ERROR] %s\n' "$*" >&2
+  return 0
+}
+
+function _log_debug() {
+  if ((VERBOSE)); then
+    printf '[DEBUG] %s\n' "$*" >&2
+  fi
+  return 0
+}
+
+# Display help message
+function _show_help() {
+  cat <<'EOF'
+Usage: [SCRIPT_NAME] [OPTIONS] [ARGUMENTS]
+
+Arguments:
+  $1 - [FIRST_ARGUMENT]: [DESCRIPTION]
+  $2 - [SECOND_ARGUMENT]: [DESCRIPTION]
+
+Options:
+  -h, --help    Show this help message
+  -v, --verbose Enable verbose output
+  -o FILE       Output to FILE instead of stdout
+
+Examples:
+  [SCRIPT_NAME] input.txt output.txt
+  [SCRIPT_NAME] --verbose --output result.txt data.txt
+EOF
+  exit 0
+}
+
+# Cleanup
+function _cleanup() {
+  _log_debug "Cleaning up..."
+  # Remove temporary files here
+  # rm -f "$tmp_file"
+  return 0
+}
+
+trap _cleanup EXIT INT TERM HUP
+
+# Validate inputs
+function _validate_inputs() {
+  local input="$1"
+
+  if [[ -z "$input" ]]; then
+    _log_error "Input file is required"
+    _show_help
+    # shellcheck disable=SC2317
+    exit 2
+  fi
+
+  if [[ ! -r "$input" ]]; then
+    _log_error "Cannot read file: $input"
+    exit 1
+  fi
+
+  return 0
+}
+
+# Parse command-line arguments
+function _parse_args() {
+  while [[ $# -gt 0 ]]; do
+    case "$1" in
+    -h | --help)
+      _show_help
+      ;;
+    -v | --verbose)
+      VERBOSE=1
+      shift
+      ;;
+    -o | --output)
+      OUTPUT_FILE="$2"
+      shift 2
+      ;;
+    --)
+      shift
+      break
+      ;;
+    -*)
+      _log_error "Unknown option: $1"
+      _show_help
+      # shellcheck disable=SC2317
+      exit 2
+      ;;
+    *)
+      break
+      ;;
+    esac
+  done
+
+  REMAINING_ARGS=("$@")
+  return 0
+}
+
+###
+### :::: Public functions :::: ########
+###
+
+# Main processing function
+function shroutines::process_file() {
+  local input_path="$1"
+  local output="${2:-/dev/stdout}"
+
+  _log_info "Processing: $input_path"
+
+  # Your processing logic here
+  while IFS= read -r line; do
+    # Process each line
+    echo "$line"
+  done <"$input_path" >"$output"
+
+  _log_info "Complete: $output"
+  return 0
+}
+
+# Main entry point
+function shroutines::main() {
+  _parse_args "$@"
+
+  # Check for required arguments
+  if [[ ${#REMAINING_ARGS[@]} -lt 1 ]]; then
+    _log_error "Missing required arguments"
+    _show_help
+    # shellcheck disable=SC2317
+    exit 2
+  fi
+
+  local input_file="${REMAINING_ARGS[0]}"
+  _validate_inputs "$input_file"
+
+  # Process file
+  if [[ -n "$OUTPUT_FILE" ]]; then
+    shroutines::process_file "$input_file" "$OUTPUT_FILE"
+  else
+    shroutines::process_file "$input_file"
+  fi
+
+  return 0
+}
+
+###
+### :::: Guard and execution :::: #####
+###
+
+if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
+  shroutines::main "$@"
+fi