Icons Src
Designicons-srcIcons Src is an Agent Skill for design published in the forcedotcom/salesforcedx-vscode repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Add custom SVG icons to salesforcedx-vscode-services for font generation. Use when adding new icons to media/icons-src, creating SVG icons for VS Code extension, or defining font-based icons.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/forcedotcom/salesforcedx-vscode/blob/HEAD/.claude/skills/icons-src/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/icons-src, 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.
Icons-src: Adding Custom Font Icons
Location
packages/salesforcedx-vscode-services/media/icons-src/
SVG Requirements
- viewBox:
0 0 24 24only (enables better upscaling) - xmlns:
http://www.w3.org/2000/svg - fill:
currentColoron inner<g>so VS Code themes control color - structure: wrap paths in
<g fill="currentColor" transform="scale(X)">— adjust scale so glyph fits 24×24
External sources (Wikipedia, Illustrator, etc.) may be too complex for font generation. Simplify in vector editor or substitute alternative.
Reference (leaf.svg)
<svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
<g fill="currentColor" transform="scale(0.75)">
<path d="..."></path>
</g>
</svg>
Avoid
- Hardcoded fill colors (e.g.
fill="#000") — breaks theme support - viewBox other than 24×24
- Strokes without
stroke="currentColor"if used
Workflow
- Add SVG —
media/icons-src/<name>.svg(name = lowercase, no spaces). Done: file matches SVG Requirements - Add manifest entry — append to
media/icons-src/icons.jsonper icons.json Format. Done: key +id+descriptionpresent - Run build —
npm run build:icons -w salesforcedx-vscode-services. Done: auto-generated artifacts updated — verifygit diff(see Artifacts) - Add ICONS constant —
src/vscode/mediaService.ts:ICONS+ICON_DESCRIPTION_KEYS; add i18n key in messages if needed. Done: new icon in both maps, compiles - Regenerate types — if services-types consumes ICONS, run its generate script. Done:
icons.tsincludes new icon
icons.json Format
{
"leaf": { "id": "sf-org-leaf", "description": "Leaf icon for default scratch org" },
"tree": { "id": "sf-org-tree", "description": "Tree icon for default dev hub" }
}
- Append new icons (order affects
0xe001,0xe002, … code point assignments) - Key = SVG filename without
.svg id= VS Code icon ID (usesf-org-*for custom icons)description= human-readable, used in contributes.icons
Artifacts that change (add/remove)
| Artifact | Add | Remove |
|---|---|---|
media/icons-src/<name>.svg | create | delete |
media/icons-src/icons.json | add entry | remove entry |
package.json → contributes.icons | auto (build:icons) | auto |
resources/icons-font/* | auto (build:icons) | auto |
src/vscode/mediaService.ts → ICONS, ICON_DESCRIPTION_KEYS | manual | manual |
src/messages/* (i18n) | manual if needed | manual |
salesforcedx-vscode-services-types (icons.ts) | manual (generate script) | manual |
Verification
Run npm run test -w salesforcedx-vscode-services — iconConsistency.test.ts validates SVG ↔ icons.json ↔ contributes.icons ↔ ICONS constant.