OpenParable
Skip to content
← Back to skills

Add Icon

Design
add-icon

Add Icon is an Agent Skill for design published in the gitkraken/vscode-gitlens repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Add new icons to the GitLens GL Icons font

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/gitkraken/vscode-gitlens/blob/HEAD/.claude/skills/add-icon/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/add-icon, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

/add-icon - Add GL Icon

Usage

/add-icon [icon-name]
  • icon-name — kebab-case (e.g., my-new-icon)

Workflow

1. Add SVG File

Place in images/icons/{icon-name}.svg

Requirements:

  • Square viewBox (e.g., viewBox="0 0 16 16")
  • Single color (fill controlled by CSS)
  • No embedded <style> tags or fonts
  • Use fill="currentColor" for color inheritance

2. Update Mapping

Append to images/icons/template/mapping.json:

"icon-name": {next-available-code-point}

Code points are in the Private Use Area range (57344-63743). Check existing entries for next available.

3. Build

pnpm run icons:svgo        # Optimize SVGs
pnpm run build:icons       # Generate font (runs svgo + fantasticon + apply + export)

4. Verify Font Cache-Busting

pnpm run build:icons (via scripts/applyIconsContribution.mjs) now automatically propagates the new glicons.woff2?{hash} cache-bust hash into both src/webviews/apps/shared/glicons.scss and every per-app webview *.html file (each declares its own @font-face). No manual search-replace needed.

Verify they're all unified (every reference must be the same hash):

grep -rho "glicons.woff2?[a-f0-9]*" src/ dist/ | sort | uniq -c

If any HTML file lags behind, re-run pnpm run build:icons — a stale hash leaves that webview pointing at a cached font without the new glyph.

5. Use the Icon

In Lit components (via the shared <code-icon> element, src/webviews/apps/shared/components/code-icon.ts — gl- prefix maps to the glicons font):

html`<code-icon icon="gl-my-new-icon"></code-icon>`;

In CSS:

.my-element::before {
	font-family: 'glicons';
	content: '\{codepoint}';
}

Troubleshooting

  • Icon not showing: Check font URL is updated, verify code point in mapping.json, rebuild with pnpm run build:icons
  • SVG issues: Ensure single path/shape, remove <style> tags, use fill="currentColor"