Documentation
¶
Index ¶
- Constants
- Variables
- func EnsureMCPConfig(projectRoot, ideID string) (string, error)
- func EnsureRulesForIDE(projectRoot string, detected DetectedIDE) ([]string, error)
- func EnsureRulesWithAIConsent(projectRoot string, detected DetectedIDE, interactive bool, appVersion string) ([]string, error)
- func Generate(projectRoot, ideType string) ([]string, error)
- func MCPConfigExists(projectRoot, ideID string) bool
- func SetGeneratorVersion(version string)
- type DetectedIDE
Constants ¶
View Source
const ( IDECursor = "cursor" IDEVSCode = "vscode" IDECopilot = "copilot" // vscode + copilot IDEClaudeCode = "claude-code" IDEWindsurf = "windsurf" IDECline = "cline" IDEZed = "zed" IDENeovim = "neovim" IDEJetBrains = "jetbrains" IDEUnknown = "unknown" IDEBoth = "both" // legacy: cursor + copilot )
IDE type constants
View Source
const GitflowInstructionsCompact = `## Gitflow Enforcement
**Before modifying ANY code, run the gitflow pre-flight check.**
` + "```bash" + `
gitflow --json status
` + "```" + `
### Pre-flight sequence
1. Check ` + "`git_flow_initialized`" + ` → if false, run ` + "`gitflow --json init`" + `
2. Check ` + "`merge.in_merge`" + ` → if true, STOP and report to user
3. Check ` + "`main_ahead_of_develop`" + ` → if > 0, run ` + "`gitflow --json backmerge`" + `
4. Ensure you are on the correct branch for the task type
5. NEVER modify code on main or develop directly — use flow branches
6. When done: ` + "`gitflow --json finish`" + `
### Branch routing
| Task type | Start command |
|-------------|----------------------------------------------|
| Feature | ` + "`gitflow --json start feature <name>`" + ` |
| Bugfix | ` + "`gitflow --json start bugfix <name>`" + ` |
| Hotfix | ` + "`gitflow --json start hotfix <version>`" + ` |
| Release | ` + "`gitflow --json start release <version>`" + ` |
### Skill Activation (Homologated)
- Use the gitflow skill before any code modifications.
- Always begin with ` + "`gitflow --json status`" + `.
- Keep command selection aligned with task intent and branch type.
### LLM Activity Routing (Compact)
- discovery/state -> ` + "`gitflow --json status`" + `
- branch divergence -> ` + "`gitflow --json backmerge`" + `
- new work -> ` + "`gitflow --json start feature <name>`" + `
- bug fix -> ` + "`gitflow --json start bugfix <name>`" + `
- prod urgent fix -> ` + "`gitflow --json start hotfix <version>`" + `
- release prep -> ` + "`gitflow --json start release <version>`" + `
- branch sync/update -> ` + "`gitflow --json sync`" + ` / ` + "`gitflow --json pull`" + `
- diagnostics -> ` + "`gitflow --json health`" + ` / ` + "`gitflow --json doctor`" + `
- rollback last flow action -> ` + "`gitflow --json undo`" + `
- close flow branch -> ` + "`gitflow --json finish`" + `
### Full CLI
` + "```" + `
gitflow --json status|pull|init|sync|switch|backmerge|cleanup|health|doctor|log|undo|releasenotes|finish
gitflow --json start feature|bugfix|release|hotfix <name>
` + "```" + `
Exit codes: 0=success, 1=error, 2=conflict-needs-human
`
GitflowInstructionsCompact is a shorter version for IDEs with limited instruction space (e.g. appended sections in existing files).
View Source
const GitflowInstructionsFull = `## Gitflow Pre-flight Check
**MANDATORY: Before modifying ANY code, run the pre-flight check.**
### Step 1 — Run status (EVERY TIME before code changes)
` + "```bash" + `
gitflow --json status
` + "```" + `
Evaluate the JSON response in order:
#### 1a. Is git-flow initialized?
If ` + "`git_flow_initialized`" + ` is false:
` + "```bash" + `
gitflow --json init
` + "```" + `
#### 1b. Is there a merge conflict?
If ` + "`merge.in_merge`" + ` is true → **STOP.** Report to user.
#### 1c. Is there branch divergence?
If ` + "`main_ahead_of_develop > 0`" + ` → **STOP.** Fix immediately:
` + "```bash" + `
gitflow --json backmerge
` + "```" + `
#### 1d. Are we on the right branch?
| User wants to... | Correct branch | If wrong, run |
|---------------------------|-------------------------|--------------------------------------------|
| Add a new feature | feature/* or develop | ` + "`gitflow --json switch develop`" + `, then ` + "`gitflow --json start feature <name>`" + ` |
| Fix a bug (non-urgent) | bugfix/* or develop | ` + "`gitflow --json switch develop`" + `, then ` + "`gitflow --json start bugfix <name>`" + ` |
| Fix a production bug | hotfix/* or main | ` + "`gitflow --json switch main`" + `, then ` + "`gitflow --json start hotfix <ver>`" + ` |
| Prepare a release | release/* or develop | ` + "`gitflow --json switch develop`" + `, then ` + "`gitflow --json start release <ver>`" + ` |
**NEVER modify code on main. NEVER commit directly to develop.**
#### 1e. Ask user intent
If no flow branch exists, ask the user:
1. Feature — new functionality
2. Bugfix — fix a non-urgent bug
3. Hotfix — urgent fix for production
4. Continue — already on the right branch
#### 1f. Only NOW proceed with code changes
### Step 2 — During Development
` + "```bash" + `
gitflow --json sync # sync with parent
gitflow --json pull # pull before pushing
` + "```" + `
### Step 3 — Finishing Work
` + "```bash" + `
gitflow --json finish
` + "```" + `
### Skill Activation (Homologated)
- Use the gitflow skill before any code modifications.
- Run ` + "`gitflow --json status`" + ` first and follow branch/merge checks.
- Keep branch routing aligned with the skill decision tree.
### LLM Activity Routing (Command Selection)
Use this mapping to choose commands according to model interaction intent.
| Interaction intent | Primary command(s) | Use when |
|---|---|---|
| Understand current gitflow state | ` + "`gitflow --json status`" + ` | Start of every coding task; validate branch/divergence/merge state |
| Initialize git-flow in repo | ` + "`gitflow --json init`" + ` | ` + "`git_flow_initialized`" + ` is false |
| Resolve main/develop divergence | ` + "`gitflow --json backmerge`" + ` | ` + "`main_ahead_of_develop > 0`" + ` |
| Start feature work | ` + "`gitflow --json start feature <name>`" + ` | New capability or enhancement |
| Start non-urgent bug fix | ` + "`gitflow --json start bugfix <name>`" + ` | Defect that is not production-emergency |
| Start production fix | ` + "`gitflow --json start hotfix <version>`" + ` | Urgent issue in production/main |
| Start release preparation | ` + "`gitflow --json start release <version>`" + ` | Cut release candidate and stabilize |
| Sync active work branch | ` + "`gitflow --json sync`" + ` | Before big changes and before final validation |
| Pull latest updates | ` + "`gitflow --json pull`" + ` | Keep branch current before push/finish |
| Run health diagnostics | ` + "`gitflow --json health`" + `, ` + "`gitflow --json doctor`" + ` | User reports workflow inconsistency/conflicts |
| Review timeline / history | ` + "`gitflow --json log`" + ` | Need operational trace or audit trail |
| Undo last gitflow action | ` + "`gitflow --json undo`" + ` | Last operation was wrong and needs rollback |
| Finish current flow branch | ` + "`gitflow --json finish`" + ` | Tests pass and branch is ready to merge |
### CLI Reference
` + "```" + `
gitflow --json status|pull|init|sync|switch|backmerge|cleanup|health|doctor|log|undo|releasenotes|finish
gitflow --json start feature|bugfix|release|hotfix <name>
gitflow setup [--ide cursor|copilot|both]
` + "```" + `
Exit codes: 0=success, 1=error, 2=conflict-needs-human
`
GitflowInstructionsFull is the complete gitflow preflight instruction set, reusable across all IDE rule generators. It uses pure markdown (no IDE-specific frontmatter) so each generator can wrap it as needed.
Variables ¶
View Source
var AskAIIntegrationFunc = askAIIntegration
View Source
var MCPSupportedIDEs = map[string]bool{ IDECursor: true, IDECopilot: true, IDEVSCode: true, IDEClaudeCode: true, IDEWindsurf: true, IDECline: true, IDEZed: true, IDENeovim: true, IDEJetBrains: true, }
MCPSupportedIDEs lists IDE IDs that support MCP server configuration.
View Source
var UserHomeDirFunc = os.UserHomeDir
Functions ¶
func EnsureMCPConfig ¶
EnsureMCPConfig creates or updates the MCP config file for the given IDE, adding a gitflow server entry if not already present. Returns the file path if created/updated, or empty string if already present or IDE unsupported.
func EnsureRulesForIDE ¶
func EnsureRulesForIDE(projectRoot string, detected DetectedIDE) ([]string, error)
EnsureRulesForIDE checks if rules exist for the detected IDE. If missing, it creates them. Also ensures the embedded gitflow skill is installed, AGENTS.md is present as a universal fallback, and MCP config for IDEs that support it. Returns list of newly created files (empty if all exist).
func EnsureRulesWithAIConsent ¶
func EnsureRulesWithAIConsent(projectRoot string, detected DetectedIDE, interactive bool, appVersion string) ([]string, error)
EnsureRulesWithAIConsent installs IDE-specific instructions and embedded skill only when user consent for AI integration is enabled.
Consent is persisted at {projectRoot}/.gitflow/config.json (per project). In non-interactive mode (agents / --json) this function does NOT auto-enable; it skips provisioning when no prior consent exists, preserving explicit user opt-in.
When consent exists, provisioning runs only when appVersion is unknown, no stored version exists yet, or the running appVersion is newer than the stored version. Otherwise, file I/O is skipped.
func Generate ¶
Generate dispatches to the appropriate rule/instruction file generators. For explicit setup: always generates for the specified IDE, installs the embedded skill, ensures AGENTS.md, and writes MCP config when supported.
func MCPConfigExists ¶
MCPConfigExists checks whether an MCP config with a gitflow entry already exists.
func SetGeneratorVersion ¶
func SetGeneratorVersion(version string)
Types ¶
type DetectedIDE ¶
DetectedIDE holds the result of IDE detection with display-friendly name.
func DetectAll ¶
func DetectAll(projectRoot string) []DetectedIDE
DetectAll returns all detected IDEs (there may be multiple signals).
func DetectPrimary ¶
func DetectPrimary(projectRoot string) DetectedIDE
DetectPrimary returns the most specific IDE detected, or "unknown".
Source Files
Click to show internal directories.
Click to hide internal directories.