Configuration

Configuration

Extension Settings

All settings are under gitCommitMessageEditor in VS Code's Settings (Ctrl+,).

Setting	Default	Description
types	[]	Allowed values for the Type field
scopes	[]	Saved scopes
autoFillSignedOffBy	false	Auto-fill from git config
autoGitmoji	false	Auto-select emoji matching the Type
enableStatusBar	false	Show status in VS Code status bar
detectIssueFromBranch	true	Detect issue numbers from branch names
maxSubjectLength	72	Maximum subject length
maxLineLength	100	Maximum line length in body
rememberFrequentValues	true	Show frequent values as chips (deprecated)
rememberFrequentTypes	true	Show frequent Type values as chips
rememberFrequentScopes	true	Show frequent Scope values as chips
showRecentCommits	true	Show recent commits in the preview pane
recentCommitsMaxItems	12	Maximum recent commits to display
emojiPrefix	false	Prefix message with Gitmoji by default
keepAfterSave	true	Keep editor tab open after Insert
autoApplyGitEditor	true	Auto-apply message to SCM on Git Editor save
defaultEditorMode	"form"	Default editor mode ("form" or "freeform")
scmTitleCommand	"open"	SCM title command ("open" or "openAsGitEditor")
language	"auto"	UI language ("auto", "en", "fa")

Repo Config File

Place a .commit-message-editor.json (or .yaml/.yml) file in your repository root to share settings with your team.

Example

{
  "name": "Backend team convention",
  "types": ["feat", "fix", "chore"],
  "scopes": ["api", "auth", "db"],
  "maxSubjectLength": 60,
  "autoFillSignedOffBy": true,
  "detectIssueFromBranch": true,
  "template": {
    "template": ["{type}{scope}{subject}", "", "{body}"],
    "tokens": [
      {
        "label": "Type",
        "name": "type",
        "type": "enum",
        "required": true,
        "options": [
          { "label": "feat", "description": "New feature" },
          { "label": "fix", "description": "Bug fix" }
        ]
      }
    ]
  }
}

What Can Be Configured

• types – overrides the allowed type list
• scopes – pre-defined scopes
• maxSubjectLength, maxLineLength
• autoFillSignedOffBy, detectIssueFromBranch
• emojiPrefix
• Full custom template – when present, completely replaces the current template