feat(icons): add deprecationReason and alias deprecation feature

[karsa-mistmere]

closes #1957

What is the purpose of this pull request?

• New Feature

Description

When deprecating icons (looking at you, brand icons) or aliases, it is important to clearly mark the reason of deprecation as well as any steps the users should take, this PR adds the possibility to add the reason for deprecation to icons as well as the possibility to mark aliases as deprecated as per #1957

Before Submitting

• I've read the Contribution Guidelines.
• I've checked if there was an existing PR that solves the same issue.

[jguddas]

My vote is to deprecationReason an enum instead of free text, so we can ensure that there are no typos and control what depracation types there are.

[karsa-mistmere]

My vote is to deprecationReason an enum instead of free text, so we can ensure that there are no typos and control what depracation types there are.

Any ideas as to what these options should be?

[jguddas]

My vote is to deprecationReason an enum instead of free text, so we can ensure that there are no typos and control what depracation types there are.

Any ideas as to what these options should be?

// depracation-reasons.en.json
{
  "alias.typo": "Renamed because of typo, use {name} instead.",
  "icon.brand": "Brand icons have been deprecated and are due to be removed, we recommend using simpleicons.org instead, refer to https://github.com/lucide-icons/lucide/issues/670"
}

https://formatjs.io/docs/intl-messageformat

[karsa-mistmere]

I think i18n is a bit of an overkill, since all of our packages are in English, but I've implemented a rudimentary template function and converted the deprecation reason to an enumeration.

(I meant options apart from these two, so that we are somewhat futureproof, but we can think about that later)

[github-actions]

This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 5 days.

[ericfennis]

Nice lovely work!

[jguddas]

What about my unanswered pr comments?

[karsa-mistmere]

What about my unanswered pr comments?

They've now been addressed.