microsoft / microsoft/vscode-codicons
Improvements to mappings and automate manual steps
Open
Nobody has claimed this yet.
engineering
- Dominant language
- Handlebars
- Stars
- 1.2k
- Forks
- 210
- Avg merge
- 43m
- Merged PRs (30d)
- 3
Description
Right now adding/changing icons in VS Code feels like it needs too many manual steps.
Issues:
icons.ttfcauses unresolvable conflicts and blocks having multiple PRs open in progress. It should probably not be kept in the git repo being a binary file.- Can't easily see what icons share a mapping in
mapping.json - Need to manually add an arbitrary number to mapping.json` and its hex value to codicons.ts which is error prone
icons.ttfneeds to be manually committed to the main vscode repo
Possible improvements:
- Add CI to check for errors
- When a PR is merged or a commit made, CI can publish
dist/icons.*to the Releases page. This way we keep the repo free of conflicts and can have multiple ongoing PRs open at the same time - Add icons.ttf to the gitignore so it doesn't get committed.
- Use JSON lists to group names in
mapping.json. This way we can see which icon names map to the same icon, and we don't need to add numbers. This will also make the mappings much easier to edit. - Remove the manual numbering in the mapping.json. This can be autogenerated when the previous suggestion is implemented.
- Automatically create a PR to the vscode repo with the new
icons.ttf - Automatically update vscode-docs
MAGIC LEVEL:
- Launch a web instance for each with the new icons for review.
We can ask Lee to help us with this.
cc @daviddossett
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing the current workflow around mapping.json, codicons.ts, icons.ttf, and the generated dist/icons.* files. Review how changes are committed to the VS Code repository and how vscode-docs is updated; the issue is complete only when the agreed automation and validation steps replace the relevant manual work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- json, typescript
- Domain
- build-system, ci-cd, documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100