mirror of
https://github.com/github/spec-kit.git
synced 2026-03-24 14:23:09 +00:00
5e49ec6936
- Fix bash common.sh sourcing: check .specify/scripts/bash/ first, then scripts/bash/, with explicit error if neither found - Fix PowerShell common.ps1 sourcing: use $fallbackRoot for reliable path resolution, with explicit error if not found - Remove undocumented branch_template and auto_fetch from extension.yml defaults and config-template.yml (scripts don't use them yet) - Remove unused ExtensionError import in _install_bundled_git_extension - Remove undocumented SPECKIT_GIT_BRANCH_NUMBERING env var from README - Fix specify.md: skip step 2 when before_specify hook already executed - Fix specify.md: add explicit FEATURE_DIR/SPEC_FILE in disabled-git path - Fix specify.md: add PowerShell path to script resolution - Add tests for git extension auto-install during specify init Co-authored-by: mnriem <15701806+mnriem@users.noreply.github.com> Agent-Logs-Url: https://github.com/github/spec-kit/sessions/008835a0-7778-40bb-bdb2-4182b22be315
361 lines
12 KiB
PowerShell
361 lines
12 KiB
PowerShell
#!/usr/bin/env pwsh
|
|
# Create a new feature
|
|
[CmdletBinding()]
|
|
param(
|
|
[switch]$Json,
|
|
[string]$ShortName,
|
|
[Parameter()]
|
|
[int]$Number = 0,
|
|
[switch]$Timestamp,
|
|
[switch]$Help,
|
|
[Parameter(Position = 0, ValueFromRemainingArguments = $true)]
|
|
[string[]]$FeatureDescription
|
|
)
|
|
$ErrorActionPreference = 'Stop'
|
|
|
|
# Show help if requested
|
|
if ($Help) {
|
|
Write-Host "Usage: ./create-new-feature.ps1 [-Json] [-ShortName <name>] [-Number N] [-Timestamp] <feature description>"
|
|
Write-Host ""
|
|
Write-Host "Options:"
|
|
Write-Host " -Json Output in JSON format"
|
|
Write-Host " -ShortName <name> Provide a custom short name (2-4 words) for the branch"
|
|
Write-Host " -Number N Specify branch number manually (overrides auto-detection)"
|
|
Write-Host " -Timestamp Use timestamp prefix (YYYYMMDD-HHMMSS) instead of sequential numbering"
|
|
Write-Host " -Help Show this help message"
|
|
Write-Host ""
|
|
Write-Host "Examples:"
|
|
Write-Host " ./create-new-feature.ps1 'Add user authentication system' -ShortName 'user-auth'"
|
|
Write-Host " ./create-new-feature.ps1 'Implement OAuth2 integration for API'"
|
|
Write-Host " ./create-new-feature.ps1 -Timestamp -ShortName 'user-auth' 'Add user authentication'"
|
|
exit 0
|
|
}
|
|
|
|
# Check if feature description provided
|
|
if (-not $FeatureDescription -or $FeatureDescription.Count -eq 0) {
|
|
Write-Error "Usage: ./create-new-feature.ps1 [-Json] [-ShortName <name>] [-Number N] [-Timestamp] <feature description>"
|
|
exit 1
|
|
}
|
|
|
|
$featureDesc = ($FeatureDescription -join ' ').Trim()
|
|
|
|
# Validate description is not empty after trimming (e.g., user passed only whitespace)
|
|
if ([string]::IsNullOrWhiteSpace($featureDesc)) {
|
|
Write-Error "Error: Feature description cannot be empty or contain only whitespace"
|
|
exit 1
|
|
}
|
|
|
|
# Resolve repository root. Prefer git information when available, but fall back
|
|
# to searching for repository markers so the workflow still functions in repositories that
|
|
# were initialized with --no-git.
|
|
function Find-RepositoryRoot {
|
|
param(
|
|
[string]$StartDir,
|
|
[string[]]$Markers = @('.git', '.specify')
|
|
)
|
|
$current = Resolve-Path $StartDir
|
|
while ($true) {
|
|
foreach ($marker in $Markers) {
|
|
if (Test-Path (Join-Path $current $marker)) {
|
|
return $current
|
|
}
|
|
}
|
|
$parent = Split-Path $current -Parent
|
|
if ($parent -eq $current) {
|
|
# Reached filesystem root without finding markers
|
|
return $null
|
|
}
|
|
$current = $parent
|
|
}
|
|
}
|
|
|
|
function Get-HighestNumberFromSpecs {
|
|
param([string]$SpecsDir)
|
|
|
|
$highest = 0
|
|
if (Test-Path $SpecsDir) {
|
|
Get-ChildItem -Path $SpecsDir -Directory | ForEach-Object {
|
|
if ($_.Name -match '^(\d{3})-') {
|
|
$num = [int]$matches[1]
|
|
if ($num -gt $highest) { $highest = $num }
|
|
}
|
|
}
|
|
}
|
|
return $highest
|
|
}
|
|
|
|
function Get-HighestNumberFromBranches {
|
|
param()
|
|
|
|
$highest = 0
|
|
try {
|
|
$branches = git branch -a 2>$null
|
|
if ($LASTEXITCODE -eq 0) {
|
|
foreach ($branch in $branches) {
|
|
# Clean branch name: remove leading markers and remote prefixes
|
|
$cleanBranch = $branch.Trim() -replace '^\*?\s+', '' -replace '^remotes/[^/]+/', ''
|
|
|
|
# Extract feature number if branch matches pattern ###-*
|
|
if ($cleanBranch -match '^(\d{3})-') {
|
|
$num = [int]$matches[1]
|
|
if ($num -gt $highest) { $highest = $num }
|
|
}
|
|
}
|
|
}
|
|
} catch {
|
|
# If git command fails, return 0
|
|
Write-Verbose "Could not check Git branches: $_"
|
|
}
|
|
return $highest
|
|
}
|
|
|
|
function Get-NextBranchNumber {
|
|
param(
|
|
[string]$SpecsDir
|
|
)
|
|
|
|
# Fetch all remotes to get latest branch info (suppress errors if no remotes)
|
|
try {
|
|
git fetch --all --prune 2>$null | Out-Null
|
|
} catch {
|
|
# Ignore fetch errors
|
|
}
|
|
|
|
# Get highest number from ALL branches (not just matching short name)
|
|
$highestBranch = Get-HighestNumberFromBranches
|
|
|
|
# Get highest number from ALL specs (not just matching short name)
|
|
$highestSpec = Get-HighestNumberFromSpecs -SpecsDir $SpecsDir
|
|
|
|
# Take the maximum of both
|
|
$maxNum = [Math]::Max($highestBranch, $highestSpec)
|
|
|
|
# Return next number
|
|
return $maxNum + 1
|
|
}
|
|
|
|
function ConvertTo-CleanBranchName {
|
|
param([string]$Name)
|
|
|
|
return $Name.ToLower() -replace '[^a-z0-9]', '-' -replace '-{2,}', '-' -replace '^-', '' -replace '-$', ''
|
|
}
|
|
$fallbackRoot = (Find-RepositoryRoot -StartDir $PSScriptRoot)
|
|
if (-not $fallbackRoot) {
|
|
Write-Error "Error: Could not determine repository root. Please run this script from within the repository."
|
|
exit 1
|
|
}
|
|
|
|
# Load common functions (includes Resolve-Template).
|
|
# Search locations in priority order:
|
|
# 1. common.ps1 next to this script (source checkout layout)
|
|
# 2. .specify/scripts/powershell/common.ps1 under the project root (installed project)
|
|
# 3. scripts/powershell/common.ps1 under the project root (source checkout fallback)
|
|
# 4. git-common.ps1 next to this script (minimal fallback)
|
|
$commonLoaded = $false
|
|
|
|
if (Test-Path "$PSScriptRoot/common.ps1") {
|
|
. "$PSScriptRoot/common.ps1"
|
|
$commonLoaded = $true
|
|
} else {
|
|
$coreCommonCandidates = @()
|
|
|
|
if ($fallbackRoot) {
|
|
$coreCommonCandidates += (Join-Path $fallbackRoot ".specify/scripts/powershell/common.ps1")
|
|
$coreCommonCandidates += (Join-Path $fallbackRoot "scripts/powershell/common.ps1")
|
|
}
|
|
|
|
$coreCommonCandidates += "$PSScriptRoot/git-common.ps1"
|
|
|
|
foreach ($candidate in $coreCommonCandidates) {
|
|
if ($candidate -and (Test-Path $candidate)) {
|
|
. $candidate
|
|
$commonLoaded = $true
|
|
break
|
|
}
|
|
}
|
|
}
|
|
|
|
if (-not $commonLoaded) {
|
|
throw "Unable to locate common script file. Please ensure the Specify core scripts are installed."
|
|
}
|
|
|
|
try {
|
|
$repoRoot = git rev-parse --show-toplevel 2>$null
|
|
if ($LASTEXITCODE -eq 0) {
|
|
$hasGit = $true
|
|
} else {
|
|
throw "Git not available"
|
|
}
|
|
} catch {
|
|
$repoRoot = $fallbackRoot
|
|
$hasGit = $false
|
|
}
|
|
|
|
Set-Location $repoRoot
|
|
|
|
$specsDir = Join-Path $repoRoot 'specs'
|
|
New-Item -ItemType Directory -Path $specsDir -Force | Out-Null
|
|
|
|
# Function to generate branch name with stop word filtering and length filtering
|
|
function Get-BranchName {
|
|
param([string]$Description)
|
|
|
|
# Common stop words to filter out
|
|
$stopWords = @(
|
|
'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 extract words (alphanumeric only)
|
|
$cleanName = $Description.ToLower() -replace '[^a-z0-9\s]', ' '
|
|
$words = $cleanName -split '\s+' | Where-Object { $_ }
|
|
|
|
# Filter words: remove stop words and words shorter than 3 chars (unless they're uppercase acronyms in original)
|
|
$meaningfulWords = @()
|
|
foreach ($word in $words) {
|
|
# Skip stop words
|
|
if ($stopWords -contains $word) { continue }
|
|
|
|
# Keep words that are length >= 3 OR appear as uppercase in original (likely acronyms)
|
|
if ($word.Length -ge 3) {
|
|
$meaningfulWords += $word
|
|
} elseif ($Description -match "\b$($word.ToUpper())\b") {
|
|
# Keep short words if they appear as uppercase in original (likely acronyms)
|
|
$meaningfulWords += $word
|
|
}
|
|
}
|
|
|
|
# If we have meaningful words, use first 3-4 of them
|
|
if ($meaningfulWords.Count -gt 0) {
|
|
$maxWords = if ($meaningfulWords.Count -eq 4) { 4 } else { 3 }
|
|
$result = ($meaningfulWords | Select-Object -First $maxWords) -join '-'
|
|
return $result
|
|
} else {
|
|
# Fallback to original logic if no meaningful words found
|
|
$result = ConvertTo-CleanBranchName -Name $Description
|
|
$fallbackWords = ($result -split '-') | Where-Object { $_ } | Select-Object -First 3
|
|
return [string]::Join('-', $fallbackWords)
|
|
}
|
|
}
|
|
|
|
# Generate branch name
|
|
if ($ShortName) {
|
|
# Use provided short name, just clean it up
|
|
$branchSuffix = ConvertTo-CleanBranchName -Name $ShortName
|
|
} else {
|
|
# Generate from description with smart filtering
|
|
$branchSuffix = Get-BranchName -Description $featureDesc
|
|
}
|
|
|
|
# Warn if -Number and -Timestamp are both specified
|
|
if ($Timestamp -and $Number -ne 0) {
|
|
Write-Warning "[specify] Warning: -Number is ignored when -Timestamp is used"
|
|
$Number = 0
|
|
}
|
|
|
|
# Determine branch prefix
|
|
if ($Timestamp) {
|
|
$featureNum = Get-Date -Format 'yyyyMMdd-HHmmss'
|
|
$branchName = "$featureNum-$branchSuffix"
|
|
} else {
|
|
# Determine branch number
|
|
if ($Number -eq 0) {
|
|
if ($hasGit) {
|
|
# Check existing branches on remotes
|
|
$Number = Get-NextBranchNumber -SpecsDir $specsDir
|
|
} else {
|
|
# Fall back to local directory check
|
|
$Number = (Get-HighestNumberFromSpecs -SpecsDir $specsDir) + 1
|
|
}
|
|
}
|
|
|
|
$featureNum = ('{0:000}' -f $Number)
|
|
$branchName = "$featureNum-$branchSuffix"
|
|
}
|
|
|
|
# GitHub enforces a 244-byte limit on branch names
|
|
# Validate and truncate if necessary
|
|
$maxBranchLength = 244
|
|
if ($branchName.Length -gt $maxBranchLength) {
|
|
# Calculate how much we need to trim from suffix
|
|
# Account for prefix length: timestamp (15) + hyphen (1) = 16, or sequential (3) + hyphen (1) = 4
|
|
$prefixLength = $featureNum.Length + 1
|
|
$maxSuffixLength = $maxBranchLength - $prefixLength
|
|
|
|
# Truncate suffix
|
|
$truncatedSuffix = $branchSuffix.Substring(0, [Math]::Min($branchSuffix.Length, $maxSuffixLength))
|
|
# Remove trailing hyphen if truncation created one
|
|
$truncatedSuffix = $truncatedSuffix -replace '-$', ''
|
|
|
|
$originalBranchName = $branchName
|
|
$branchName = "$featureNum-$truncatedSuffix"
|
|
|
|
Write-Warning "[specify] Branch name exceeded GitHub's 244-byte limit"
|
|
Write-Warning "[specify] Original: $originalBranchName ($($originalBranchName.Length) bytes)"
|
|
Write-Warning "[specify] Truncated to: $branchName ($($branchName.Length) bytes)"
|
|
}
|
|
|
|
if ($hasGit) {
|
|
$branchCreated = $false
|
|
try {
|
|
git checkout -q -b $branchName 2>$null | Out-Null
|
|
if ($LASTEXITCODE -eq 0) {
|
|
$branchCreated = $true
|
|
}
|
|
} catch {
|
|
# Exception during git command
|
|
}
|
|
|
|
if (-not $branchCreated) {
|
|
# Check if branch already exists
|
|
$existingBranch = git branch --list $branchName 2>$null
|
|
if ($existingBranch) {
|
|
if ($Timestamp) {
|
|
Write-Error "Error: Branch '$branchName' already exists. Rerun to get a new timestamp or use a different -ShortName."
|
|
} else {
|
|
Write-Error "Error: Branch '$branchName' already exists. Please use a different feature name or specify a different number with -Number."
|
|
}
|
|
exit 1
|
|
} else {
|
|
Write-Error "Error: Failed to create git branch '$branchName'. Please check your git configuration and try again."
|
|
exit 1
|
|
}
|
|
}
|
|
} else {
|
|
Write-Warning "[specify] Warning: Git repository not detected; skipped branch creation for $branchName"
|
|
}
|
|
|
|
$featureDir = Join-Path $specsDir $branchName
|
|
New-Item -ItemType Directory -Path $featureDir -Force | Out-Null
|
|
|
|
$template = Resolve-Template -TemplateName 'spec-template' -RepoRoot $repoRoot
|
|
$specFile = Join-Path $featureDir 'spec.md'
|
|
if ($template -and (Test-Path $template)) {
|
|
Copy-Item $template $specFile -Force
|
|
} else {
|
|
New-Item -ItemType File -Path $specFile | Out-Null
|
|
}
|
|
|
|
# Set the SPECIFY_FEATURE environment variable for the current session
|
|
$env:SPECIFY_FEATURE = $branchName
|
|
|
|
if ($Json) {
|
|
$obj = [PSCustomObject]@{
|
|
BRANCH_NAME = $branchName
|
|
SPEC_FILE = $specFile
|
|
FEATURE_NUM = $featureNum
|
|
HAS_GIT = $hasGit
|
|
}
|
|
$obj | ConvertTo-Json -Compress
|
|
} else {
|
|
Write-Output "BRANCH_NAME: $branchName"
|
|
Write-Output "SPEC_FILE: $specFile"
|
|
Write-Output "FEATURE_NUM: $featureNum"
|
|
Write-Output "HAS_GIT: $hasGit"
|
|
Write-Output "SPECIFY_FEATURE environment variable set to: $branchName"
|
|
}
|
|
|