✨ Auto Gitmoji & Docs

A KueTech Digital product
Free · Local · Privacy-first · No AI

Insert Gitmojis into Git commit messages and docstrings from a JSON dictionary on your machine — no AI, no backend, no API calls for core features.

🎯 Features

Feature	Emoji	Description
Offline matching	📋	63 built-in groups in `data/gitmoji-map.json` + regex — `fix` → 🐛, `feat` → ✨, `docs` → 📚
Custom mappings	🧩	Override or extend the dictionary from your settings
Status bar hint	👀	See the emoji before applying it; click to insert
Format commit	💬	Git SCM input box — one command
Format docstring	📝	First line of selection or current line
Quick-pick	🎨	Choose any Gitmoji from the full dictionary
Support panel	☕	QR donate image + Buy Me a Coffee + kuetech.at
First-install welcome	👋	One-time thank-you (not spam)

🏢 KueTech Digital


🏷️ Company	KueTech Digital
🌐 Website	kuetech.at
📦 GitHub	FloKuersten/Gitmoji
☕ Support	buymeacoffee.com/kuetech

🖥️ Works in Cursor?

✅ Yes. Cursor uses the same VS Code extension host.

Install from Open VSX (search Auto Gitmoji & Docs in Cursor)
Or install from a .vsix file
Enable the built-in Git extension if commit formatting does nothing

📖 PUBLISHING.md — install & publish guide

⌨️ Commands

Command	Shortcut	What it does
`Auto Gitmoji: Format Commit Message`	`Ctrl+Alt+G`	💬 Add Gitmoji to Git commit box
`Auto Gitmoji: Pick and Insert Gitmoji`	`Ctrl+Alt+M`	🎨 Choose emoji from list
`Auto Gitmoji: Format Docstring / Comment`	—	📝 Add Gitmoji to comment/doc line
`Auto Gitmoji: Open Dictionary`	—	📖 Inspect the active mappings
`Auto Gitmoji: Support the Developer`	—	☕ KueTech Digital support webview

On macOS use Cmd instead of Ctrl.

SCM toolbar: Git commit icon in the Source Control title bar (when Git is active).

Status bar: When your commit message matches a keyword, the emoji appears in the status bar — click it to apply.

📖 Examples

Before	After
`feat: add login`	`✨ feat: add login`
`fix: crash on save`	`🐛 fix: crash on save`
`docs: api guide`	`📚 docs: api guide`
`refactor: auth module`	`♻️ refactor: auth module`
`perf: reduce bundle size`	`⚡️ perf: reduce bundle size`
`test: add unit tests`	`🧪 test: add unit tests`
`chore: bump deps`	`🔧 chore: bump deps`
`security: sanitize input`	`🔒 security: sanitize input`

Supports Conventional Commits: type(scope): message and simple type: message formats.

⚙️ Settings

Setting	Default	Description
`autoGitmoji.customMappings`	`[]`	🧩 Your own keyword-to-emoji entries
`autoGitmoji.position`	`prefix`	Emoji at the start, or after the commit type
`autoGitmoji.showStatusBar`	`true`	Show the suggested emoji in the status bar
`autoGitmoji.formatOnFocusLoss`	`false`	Format the commit box when the window loses focus
`autoGitmoji.notifyOnMajorUpdates`	`true`	One-time reminder after major updates
`autoGitmoji.buyMeACoffeeUrl`	buymeacoffee.com/kuetech	☕ Support link
`autoGitmoji.websiteUrl`	kuetech.at	🌐 Company website

🧩 Custom mappings

Add your own keywords in settings.json. A keyword defined here overrides the bundled entry:

{
  "autoGitmoji.customMappings": [
    {
      "keywords": ["ship", "launch"],
      "gitmoji": "🚢",
      "description": "Ship it"
    },
    { "keywords": ["wip"], "gitmoji": "🏗️" }
  ]
}

Run Auto Gitmoji: Open Dictionary to see the merged result.

🔒 Privacy & security

Question	Answer
Does it send my code to the cloud?	❌ No — matching is 100% local
Does it use AI?	❌ No
Does it need API keys?	❌ No
When does it use the network?	Only if you click Buy Me a Coffee or visit kuetech.at in the Support panel
Where is data stored?	`gitmoji-map.json` ships with the extension — you can extend it

See SECURITY.md in the repository root.

🧠 How matching works

📋 Read keywords from data/gitmoji-map.json
🔍 Parse commit type (fix:, feat(scope):, or first word)
🚫 Skip if a Gitmoji is already at the start
✨ Prepend the best match (longest keyword wins)

No network. No ML. No surprises.

🛠️ Development

npm install
npm run compile
npm run lint

Press F5 to run the Extension Development Host.

npm run package   # builds .vsix

🚀 Publish

Publisher: kuetech (KueTech Digital). Open VSX first (Cursor), then optionally the VS Marketplace — PUBLISHING.md

🤝 Contributing

CONTRIBUTING.md — add keyword → Gitmoji mappings via pull request.

📄 License

⭐ Star on GitHub · ☕ Buy me a coffee · 🌐 kuetech.at