create-project.sh

#!/bin/bash
# Fail fast: a failed mkdir/touch/R call must abort instead of falling
# through to the success message at the end
set -euo pipefail

# Default directories
# May be adjusted based on the -l option
dirs=(
    "data"
    "data/input"
    "data/output"
    "documentation"
    "config"
    "notebooks"
    "src"
    "scripts"
    "research"
    "plans"
    "handoffs"
)

# Define files
files=(
    ".gitignore"
    "LICENSE"
    "README.md"
)

# Handle optional flags
# -l flag for language-specific directories
# -p path
lang=""
path=""

# Function to convert string to lowercase
to_lowercase() {
  echo "$1" | tr '[:upper:]' '[:lower:]'
}

while getopts ":l:p:" opt; do
  case $opt in
  l)
    lang=$(to_lowercase "$OPTARG")
    ;;
  p)
    path="$OPTARG"
    ;;
  \?)
    echo "Invalid option: -$OPTARG" >&2
    exit 1
    ;;
  :)
    echo "Option -$OPTARG requires an argument." >&2
    exit 1
    ;;
  esac
done

# Enforce required -p flag (no implicit current-directory behavior)
if [[ -z "$path" ]]; then
  echo "Error: -p <path> is required. Use -p . to target the current directory." >&2
  exit 1
fi

# Check if the specified path exists
if [[ ! -d "$path" ]]; then
  echo "Error: The specified path '$path' does not exist." >&2
  exit 1
fi

# Adjust the directories based on the -l flag
if [[ "$lang" == "r" || "$lang" == "py" || "$lang" == "python" ]]; then
    dirs+=("tests")
elif [[ "$lang" == "jl" || "$lang" == "julia" ]]; then
    dirs+=("test")
else
    dirs+=("test" "tests")
fi

# R reads .Renviron at startup for project-level environment variables
if [[ "$lang" == "r" ]]; then
    files+=(".Renviron")
fi

# Create directories
echo "Creating directories at $path..."
for dir in "${dirs[@]}"; do
    mkdir -p "$path/$dir"
    echo "Created $path/$dir"
done

# Create files
echo "Creating files at $path..."
for file in "${files[@]}"; do
    touch "$path/$file"
    echo "Created $path/$file"
done

# Sensible default .gitignore entries.
# Universal entries apply to every project; language entries are
# appended based on -l. Appends are idempotent so re-runs do not
# duplicate lines.
gitignore_lines=(
    ".env"
    ".env.*"
    "!.env.example"
    "/.roborev/"
    ".DS_Store"
    "Thumbs.db"
    "Desktop.ini"
    ".vscode/"
    ".idea/"
    "*.swp"
    "*.log"
)

case "$lang" in
    r)
        gitignore_lines+=(
            ".Renviron"
            ".Rproj.user/"
            ".Rhistory"
            ".RData"
            ".Ruserdata"
        )
        ;;
    py|python)
        gitignore_lines+=(
            "__pycache__/"
            "*.py[cod]"
            ".venv/"
            "venv/"
            ".pytest_cache/"
            ".mypy_cache/"
            ".ruff_cache/"
            ".ipynb_checkpoints/"
            "*.egg-info/"
            "dist/"
            "build/"
        )
        ;;
    jl|julia)
        gitignore_lines+=("*.jl.cov" "*.jl.mem")
        ;;
esac

# Append each missing pattern, keeping existing content intact
for line in "${gitignore_lines[@]}"; do
    if ! grep -qxF "$line" "$path/.gitignore"; then
        # Prepend a newline if the file lacks a trailing one, so we
        # append a line instead of gluing onto the previous one
        if [[ -s "$path/.gitignore" ]] &&
           [[ -n "$(tail -c 1 "$path/.gitignore")" ]]; then
            printf '\n' >> "$path/.gitignore"
        fi
        printf '%s\n' "$line" >> "$path/.gitignore"
    fi
done

# Only if R is selected and the path is not empty
# 1. If not already installed, install renv in the base R env as it's best practice to use project envs
# 2. Initialize the project env in the project path
# 3. Install usethis
# 4. Create an RStudio .Rproj file
if [[ "$lang" == "r" && -n "$path" ]]; then
  # A missing or failing R must fail the run, not print a success message
  if ! R -e "
  if (!require('renv', quietly = TRUE)){
    install.packages('renv', repos='http://cran.us.r-project.org')}

  renv::init(project = '$path')
  q(save = 'no')"; then
    echo "Error: R failed; project setup is incomplete." >&2
    exit 1
  fi
fi

# The end
echo "Project structure created successfully at $path!"