Spaces:
Sleeping
Sleeping
| set -e | |
| JSON_MODE=false | |
| DRY_RUN=false | |
| ALLOW_EXISTING=false | |
| SHORT_NAME="" | |
| BRANCH_NUMBER="" | |
| USE_TIMESTAMP=false | |
| ARGS=() | |
| i=1 | |
| while [ $i -le $# ]; do | |
| arg="${!i}" | |
| case "$arg" in | |
| --json) | |
| JSON_MODE=true | |
| ;; | |
| --dry-run) | |
| DRY_RUN=true | |
| ;; | |
| --allow-existing-branch) | |
| ALLOW_EXISTING=true | |
| ;; | |
| --short-name) | |
| if [ $((i + 1)) -gt $# ]; then | |
| echo 'Error: --short-name requires a value' >&2 | |
| exit 1 | |
| fi | |
| i=$((i + 1)) | |
| next_arg="${!i}" | |
| # Check if the next argument is another option (starts with --) | |
| if [[ "$next_arg" == --* ]]; then | |
| echo 'Error: --short-name requires a value' >&2 | |
| exit 1 | |
| fi | |
| SHORT_NAME="$next_arg" | |
| ;; | |
| --number) | |
| if [ $((i + 1)) -gt $# ]; then | |
| echo 'Error: --number requires a value' >&2 | |
| exit 1 | |
| fi | |
| i=$((i + 1)) | |
| next_arg="${!i}" | |
| if [[ "$next_arg" == --* ]]; then | |
| echo 'Error: --number requires a value' >&2 | |
| exit 1 | |
| fi | |
| BRANCH_NUMBER="$next_arg" | |
| ;; | |
| --timestamp) | |
| USE_TIMESTAMP=true | |
| ;; | |
| --help|-h) | |
| echo "Usage: $0 [--json] [--dry-run] [--allow-existing-branch] [--short-name <name>] [--number N] [--timestamp] <feature_description>" | |
| echo "" | |
| echo "Options:" | |
| echo " --json Output in JSON format" | |
| echo " --dry-run Compute feature name and paths without creating directories or files" | |
| echo " --allow-existing-branch Reuse an existing feature directory if it already exists" | |
| echo " --short-name <name> Provide a custom short name (2-4 words) for the feature" | |
| echo " --number N Specify branch number manually (overrides auto-detection)" | |
| echo " --timestamp Use timestamp prefix (YYYYMMDD-HHMMSS) instead of sequential numbering" | |
| echo " --help, -h Show this help message" | |
| echo "" | |
| echo "Examples:" | |
| echo " $0 'Add user authentication system' --short-name 'user-auth'" | |
| echo " $0 'Implement OAuth2 integration for API' --number 5" | |
| echo " $0 --timestamp --short-name 'user-auth' 'Add user authentication'" | |
| exit 0 | |
| ;; | |
| *) | |
| ARGS+=("$arg") | |
| ;; | |
| esac | |
| i=$((i + 1)) | |
| done | |
| FEATURE_DESCRIPTION="${ARGS[*]}" | |
| if [ -z "$FEATURE_DESCRIPTION" ]; then | |
| echo "Usage: $0 [--json] [--dry-run] [--allow-existing-branch] [--short-name <name>] [--number N] [--timestamp] <feature_description>" >&2 | |
| exit 1 | |
| fi | |
| # Trim whitespace and validate description is not empty (e.g., user passed only whitespace) | |
| FEATURE_DESCRIPTION=$(echo "$FEATURE_DESCRIPTION" | sed -E 's/^[[:space:]]+|[[:space:]]+$//g') | |
| if [ -z "$FEATURE_DESCRIPTION" ]; then | |
| echo "Error: Feature description cannot be empty or contain only whitespace" >&2 | |
| exit 1 | |
| fi | |
| # Function to get highest number from specs directory | |
| get_highest_from_specs() { | |
| local specs_dir="$1" | |
| local highest=0 | |
| if [ -d "$specs_dir" ]; then | |
| for dir in "$specs_dir"/*; do | |
| [ -d "$dir" ] || continue | |
| dirname=$(basename "$dir") | |
| # Match sequential prefixes (>=3 digits), but skip timestamp dirs. | |
| if echo "$dirname" | grep -Eq '^[0-9]{3,}-' && ! echo "$dirname" | grep -Eq '^[0-9]{8}-[0-9]{6}-'; then | |
| number=$(echo "$dirname" | grep -Eo '^[0-9]+') | |
| number=$((10#$number)) | |
| if [ "$number" -gt "$highest" ]; then | |
| highest=$number | |
| fi | |
| fi | |
| done | |
| fi | |
| echo "$highest" | |
| } | |
| # Function to clean and format a branch name | |
| clean_branch_name() { | |
| local name="$1" | |
| echo "$name" | tr '[:upper:]' '[:lower:]' | sed 's/[^a-z0-9]/-/g' | sed 's/-\+/-/g' | sed 's/^-//' | sed 's/-$//' | |
| } | |
| # Resolve repository root using common.sh functions which prioritize .specify | |
| SCRIPT_DIR="$(CDPATH="" cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" | |
| source "$SCRIPT_DIR/common.sh" | |
| REPO_ROOT=$(get_repo_root) | |
| cd "$REPO_ROOT" | |
| SPECS_DIR="$REPO_ROOT/specs" | |
| if [ "$DRY_RUN" != true ]; then | |
| mkdir -p "$SPECS_DIR" | |
| fi | |
| # Function to generate branch name with stop word filtering and length filtering | |
| generate_branch_name() { | |
| local description="$1" | |
| # Common stop words to filter out | |
| local stop_words="^(i|a|an|the|to|for|of|in|on|at|by|with|from|is|are|was|were|be|been|being|have|has|had|do|does|did|will|would|should|could|can|may|might|must|shall|this|that|these|those|my|your|our|their|want|need|add|get|set)$" | |
| # Convert to lowercase and split into words | |
| local clean_name=$(echo "$description" | tr '[:upper:]' '[:lower:]' | sed 's/[^a-z0-9]/ /g') | |
| # Filter words: remove stop words and words shorter than 3 chars (unless they're uppercase acronyms in original) | |
| local meaningful_words=() | |
| for word in $clean_name; do | |
| # Skip empty words | |
| [ -z "$word" ] && continue | |
| # Keep words that are NOT stop words AND (length >= 3 OR are potential acronyms) | |
| if ! echo "$word" | grep -qiE "$stop_words"; then | |
| if [ ${#word} -ge 3 ]; then | |
| meaningful_words+=("$word") | |
| elif echo "$description" | grep -q "\b${word^^}\b"; then | |
| # Keep short words if they appear as uppercase in original (likely acronyms) | |
| meaningful_words+=("$word") | |
| fi | |
| fi | |
| done | |
| # If we have meaningful words, use first 3-4 of them | |
| if [ ${#meaningful_words[@]} -gt 0 ]; then | |
| local max_words=3 | |
| if [ ${#meaningful_words[@]} -eq 4 ]; then max_words=4; fi | |
| local result="" | |
| local count=0 | |
| for word in "${meaningful_words[@]}"; do | |
| if [ $count -ge $max_words ]; then break; fi | |
| if [ -n "$result" ]; then result="$result-"; fi | |
| result="$result$word" | |
| count=$((count + 1)) | |
| done | |
| echo "$result" | |
| else | |
| # Fallback to original logic if no meaningful words found | |
| local cleaned=$(clean_branch_name "$description") | |
| echo "$cleaned" | tr '-' '\n' | grep -v '^$' | head -3 | tr '\n' '-' | sed 's/-$//' | |
| fi | |
| } | |
| # Generate branch name | |
| if [ -n "$SHORT_NAME" ]; then | |
| # Use provided short name, just clean it up | |
| BRANCH_SUFFIX=$(clean_branch_name "$SHORT_NAME") | |
| else | |
| # Generate from description with smart filtering | |
| BRANCH_SUFFIX=$(generate_branch_name "$FEATURE_DESCRIPTION") | |
| fi | |
| # Warn if --number and --timestamp are both specified | |
| if [ "$USE_TIMESTAMP" = true ] && [ -n "$BRANCH_NUMBER" ]; then | |
| >&2 echo "[specify] Warning: --number is ignored when --timestamp is used" | |
| BRANCH_NUMBER="" | |
| fi | |
| # Determine branch prefix | |
| if [ "$USE_TIMESTAMP" = true ]; then | |
| FEATURE_NUM=$(date +%Y%m%d-%H%M%S) | |
| BRANCH_NAME="${FEATURE_NUM}-${BRANCH_SUFFIX}" | |
| else | |
| # Determine branch number from existing feature directories | |
| if [ -z "$BRANCH_NUMBER" ]; then | |
| HIGHEST=$(get_highest_from_specs "$SPECS_DIR") | |
| BRANCH_NUMBER=$((HIGHEST + 1)) | |
| fi | |
| # Force base-10 interpretation to prevent octal conversion (e.g., 010 → 8 in octal, but should be 10 in decimal) | |
| FEATURE_NUM=$(printf "%03d" "$((10#$BRANCH_NUMBER))") | |
| BRANCH_NAME="${FEATURE_NUM}-${BRANCH_SUFFIX}" | |
| fi | |
| # GitHub enforces a 244-byte limit on branch names | |
| # Validate and truncate if necessary | |
| MAX_BRANCH_LENGTH=244 | |
| if [ ${#BRANCH_NAME} -gt $MAX_BRANCH_LENGTH ]; then | |
| # Calculate how much we need to trim from suffix | |
| # Account for prefix length: timestamp (15) + hyphen (1) = 16, or sequential (3) + hyphen (1) = 4 | |
| PREFIX_LENGTH=$(( ${#FEATURE_NUM} + 1 )) | |
| MAX_SUFFIX_LENGTH=$((MAX_BRANCH_LENGTH - PREFIX_LENGTH)) | |
| # Truncate suffix at word boundary if possible | |
| TRUNCATED_SUFFIX=$(echo "$BRANCH_SUFFIX" | cut -c1-$MAX_SUFFIX_LENGTH) | |
| # Remove trailing hyphen if truncation created one | |
| TRUNCATED_SUFFIX=$(echo "$TRUNCATED_SUFFIX" | sed 's/-$//') | |
| ORIGINAL_BRANCH_NAME="$BRANCH_NAME" | |
| BRANCH_NAME="${FEATURE_NUM}-${TRUNCATED_SUFFIX}" | |
| >&2 echo "[specify] Warning: Branch name exceeded GitHub's 244-byte limit" | |
| >&2 echo "[specify] Original: $ORIGINAL_BRANCH_NAME (${#ORIGINAL_BRANCH_NAME} bytes)" | |
| >&2 echo "[specify] Truncated to: $BRANCH_NAME (${#BRANCH_NAME} bytes)" | |
| fi | |
| FEATURE_DIR="$SPECS_DIR/$BRANCH_NAME" | |
| SPEC_FILE="$FEATURE_DIR/spec.md" | |
| if [ "$DRY_RUN" != true ]; then | |
| if [ -d "$FEATURE_DIR" ] && [ "$ALLOW_EXISTING" != true ]; then | |
| if [ "$USE_TIMESTAMP" = true ]; then | |
| >&2 echo "Error: Feature directory '$FEATURE_DIR' already exists. Rerun to get a new timestamp or use a different --short-name." | |
| else | |
| >&2 echo "Error: Feature directory '$FEATURE_DIR' already exists. Please use a different feature name or specify a different number with --number." | |
| fi | |
| exit 1 | |
| fi | |
| mkdir -p "$FEATURE_DIR" | |
| if [ ! -f "$SPEC_FILE" ]; then | |
| TEMPLATE=$(resolve_template "spec-template" "$REPO_ROOT") || true | |
| if [ -n "$TEMPLATE" ] && [ -f "$TEMPLATE" ]; then | |
| cp "$TEMPLATE" "$SPEC_FILE" | |
| else | |
| echo "Warning: Spec template not found; created empty spec file" >&2 | |
| touch "$SPEC_FILE" | |
| fi | |
| fi | |
| # Persist to .specify/feature.json so downstream commands can find the feature | |
| _persist_feature_json "$REPO_ROOT" "$FEATURE_DIR" | |
| # Inform the user how to set feature state in their own shell | |
| printf '# To persist: export SPECIFY_FEATURE=%q\n' "$BRANCH_NAME" >&2 | |
| printf '# export SPECIFY_FEATURE_DIRECTORY=%q\n' "$FEATURE_DIR" >&2 | |
| fi | |
| if $JSON_MODE; then | |
| if command -v jq >/dev/null 2>&1; then | |
| if [ "$DRY_RUN" = true ]; then | |
| jq -cn \ | |
| --arg branch_name "$BRANCH_NAME" \ | |
| --arg spec_file "$SPEC_FILE" \ | |
| --arg feature_num "$FEATURE_NUM" \ | |
| '{BRANCH_NAME:$branch_name,SPEC_FILE:$spec_file,FEATURE_NUM:$feature_num,DRY_RUN:true}' | |
| else | |
| jq -cn \ | |
| --arg branch_name "$BRANCH_NAME" \ | |
| --arg spec_file "$SPEC_FILE" \ | |
| --arg feature_num "$FEATURE_NUM" \ | |
| '{BRANCH_NAME:$branch_name,SPEC_FILE:$spec_file,FEATURE_NUM:$feature_num}' | |
| fi | |
| else | |
| if [ "$DRY_RUN" = true ]; then | |
| printf '{"BRANCH_NAME":"%s","SPEC_FILE":"%s","FEATURE_NUM":"%s","DRY_RUN":true}\n' "$(json_escape "$BRANCH_NAME")" "$(json_escape "$SPEC_FILE")" "$(json_escape "$FEATURE_NUM")" | |
| else | |
| printf '{"BRANCH_NAME":"%s","SPEC_FILE":"%s","FEATURE_NUM":"%s"}\n' "$(json_escape "$BRANCH_NAME")" "$(json_escape "$SPEC_FILE")" "$(json_escape "$FEATURE_NUM")" | |
| fi | |
| fi | |
| else | |
| echo "BRANCH_NAME: $BRANCH_NAME" | |
| echo "SPEC_FILE: $SPEC_FILE" | |
| echo "FEATURE_NUM: $FEATURE_NUM" | |
| if [ "$DRY_RUN" != true ]; then | |
| printf '# To persist in your shell: export SPECIFY_FEATURE=%q\n' "$BRANCH_NAME" | |
| printf '# export SPECIFY_FEATURE_DIRECTORY=%q\n' "$FEATURE_DIR" | |
| fi | |
| fi | |