feat(metadata): apply tag groups to variant icons (#5038)

* feat(metadata): reusable tag groups with `$group:`

A `$group:<group-name>` marker in `tags` is replaced in place with the tags of
`groups/<group-name>.json`: a small set of tags for what a variant suffix
means, such as `-minus` → remove, delete.

- Read groups in `readGroups` and resolve markers next to `$extends:`,
  failing on unknown groups and on `$group:` outside `tags`
- Add `group.schema.json` and lint, spell-check and format `groups/*.json`
- `pnpm checkIcons` also fails on literals a group already provides, and
  warns about icons that list a group's tags by hand and unused groups
- Add the `minus`, `plus` and `x` groups and use them in
  `alarm-clock-minus`, `file-minus`, `file-plus` and `file-x`

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* feat(icons): apply tag groups to variant icons

Add 23 groups for common variant suffixes and use them in 89 icons, removing
the literal tags a group now provides. No icon loses a resolved tag; 65
icons gain tags from their group.

Groups: alert, check, clock, code, cog, currency, dot, heart, key, lock,
off, pause, pen, percent, play, question-mark, search, slash, sparkles,
star, stop, sync, user.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* Add favorite

* feat(icons): extend base icon metadata in variant icons

Use `$extends:<base>` in 703 variant icons whose tags or categories already
include every value of their base icon, and remove the 1952 tags and 1058
categories the base now provides. The base is the longest prefix of the icon
name that is an icon, e.g. `clipboard-pen-line` extends `clipboard-pen`.

- `tags` extend their base in 417 icons, `categories` in 675
- Only applied where the base adds nothing new, so the resolved tags and
  categories of every icon are unchanged
- `contributors` are left as they are

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01YBLsKpZMoKKKVeibcuRXnC

* Apply batched suggestions from code review

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Karsa <contact@karsa.org>

* Apply feedback

* Updated groups

* Apply updates

* Apply more extends and groups

* Stricter checks

* Remove more duplicates

* Update tags

* Apply batched suggestions from code review

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Fix tags

* feat(metadata): reusable tag groups with `$group:`

A `$group:<group-name>` marker in `tags` is replaced in place with the tags of
`groups/<group-name>.json`: a small set of tags for what a variant suffix
means, such as `-minus` → remove, delete.

- Read groups in `readGroups` and resolve markers next to `$extends:`,
  failing on unknown groups and on `$group:` outside `tags`
- Add `group.schema.json` and lint, spell-check and format `groups/*.json`
- `pnpm checkIcons` also fails on literals a group already provides, and
  warns about icons that list a group's tags by hand and unused groups
- Add the `minus`, `plus` and `x` groups and use them in
  `alarm-clock-minus`, `file-minus`, `file-plus` and `file-x`

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* feat(icons): apply tag groups to variant icons

Add 23 groups for common variant suffixes and use them in 89 icons, removing
the literal tags a group now provides. No icon loses a resolved tag; 65
icons gain tags from their group.

Groups: alert, check, clock, code, cog, currency, dot, heart, key, lock,
off, pause, pen, percent, play, question-mark, search, slash, sparkles,
star, stop, sync, user.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* Add favorite

* feat(icons): extend base icon metadata in variant icons

Use `$extends:<base>` in 703 variant icons whose tags or categories already
include every value of their base icon, and remove the 1952 tags and 1058
categories the base now provides. The base is the longest prefix of the icon
name that is an icon, e.g. `clipboard-pen-line` extends `clipboard-pen`.

- `tags` extend their base in 417 icons, `categories` in 675
- Only applied where the base adds nothing new, so the resolved tags and
  categories of every icon are unchanged
- `contributors` are left as they are

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01YBLsKpZMoKKKVeibcuRXnC

* Apply batched suggestions from code review

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Karsa <contact@karsa.org>

* Apply feedback

* Updated groups

* Apply updates

* Apply more extends and groups

* Stricter checks

* Remove more duplicates

* Update tags

* Apply batched suggestions from code review

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Fix tags

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Karsa <contact@karsa.org>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
This commit is contained in:
Eric Fennis
2026-10-29 17:29:59 +01:00
committed by GitHub
co-authored by Claude Opus 5.5 Copilot Autofix powered by AI Karsa github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
parent 831740411f
commit d9d05635ca
898 changed files with 2467 additions and 5345 deletions
+39 -16
View File
@@ -1,3 +1,4 @@
import fs from 'fs/promises';
import path from 'path';
import {
readSvgDirectory,
@@ -126,25 +127,20 @@ Object.entries(rawIcons).forEach(([iconName, rawMetadata]) => {
});
});
// Check if the icon has literal tags that could be replaced by group references.
// An icon that lists every tag of a group as literals describes that group's
// meaning by hand, so it should reference the group instead.
Object.entries(rawIcons).forEach(([iconName, rawMetadata]) => {
const tags = rawMetadata.tags ?? [];
const unreferencedGroups = Object.entries(groups).filter(
([groupName]) => !tags.includes(`${GROUP_PREFIX}${groupName}`),
);
const literals = new Set(tags.filter((entry) => !isMarker(entry)));
tags
.filter((entry) => !isMarker(entry))
.forEach((tag) => {
const matchingMarkers = unreferencedGroups
.filter(([, groupTags]) => groupTags.includes(tag))
.map(([groupName]) => `"${GROUP_PREFIX}${groupName}"`);
if (matchingMarkers.length > 0) {
console.error(
`Icon '${iconName}': tag '${tag}' is in ${matchingMarkers.join(', ')} — consider using the group instead.`,
);
}
Object.entries(groups)
.filter(([groupName]) => !tags.includes(`${GROUP_PREFIX}${groupName}`))
.filter(([, groupTags]) => groupTags.every((tag) => literals.has(tag)))
.forEach(([groupName, groupTags]) => {
console.error(
`Icon '${iconName}': tags ${groupTags.map((tag) => `'${tag}'`).join(', ')} are all in group '${groupName}' — use "${GROUP_PREFIX}${groupName}" instead.`,
);
error = true;
});
});
@@ -159,6 +155,33 @@ Object.keys(categories).forEach((categoryName) => {
}
});
// The schema lists every group as an enum so editors can autocomplete the
// markers; it has to match the files in `groups/`.
const iconSchema = JSON.parse(
await fs.readFile(path.resolve(currentDir, '../icon.schema.json'), 'utf-8'),
);
const schemaGroups = new Set<string>(
(iconSchema.$defs.groupMarker.enum as string[]).map((marker) =>
marker.slice(GROUP_PREFIX.length),
),
);
Object.keys(groups)
.filter((groupName) => !schemaGroups.has(groupName))
.forEach((groupName) => {
console.error(`Group '${groupName}' is missing in icon.schema.json.`);
error = true;
});
[...schemaGroups]
.filter((groupName) => typeof groups[groupName] === 'undefined')
.forEach((groupName) => {
console.error(
`'${GROUP_PREFIX}${groupName}' in icon.schema.json refers to the non-existing group 'groups/${groupName}.json'.`,
);
error = true;
});
Object.keys(groups)
.filter((groupName) => !usedGroups.has(groupName))
.forEach((groupName) => {