Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

idea: @deprecated for certain aliases #1957

Closed
2 of 14 tasks
jguddas opened this issue Mar 8, 2024 · 4 comments · Fixed by #1960
Closed
2 of 14 tasks

idea: @deprecated for certain aliases #1957

jguddas opened this issue Mar 8, 2024 · 4 comments · Fixed by #1960
Assignees
Labels
💡 idea New ideas

Comments

@jguddas
Copy link
Member

jguddas commented Mar 8, 2024

Package

  • lucide
  • lucide-angular
  • lucide-flutter
  • lucide-preact
  • lucide-react
  • lucide-react-native
  • lucide-solid
  • lucide-svelte
  • lucide-vue
  • lucide-vue-next
  • Figma plugin
  • all JS packages
  • site

Description

I would love to see aliases that are for example typos get an @deprecated.

Currently, we can only deprecate a whole icon but not an alias.

Use cases

#1956 thank you @devjayprakash for bringing this to our attention.

Checklist

  • I have searched the existing issues to make sure this bug has not already been reported.
@jguddas jguddas added the 💡 idea New ideas label Mar 8, 2024
@jguddas
Copy link
Member Author

jguddas commented Mar 8, 2024

A solution could be to change the type of the depracated field from boolean to array or to add a new field called depracatedAliases.

@karsa-mistmere
Copy link
Member

karsa-mistmere commented Mar 8, 2024

A solution could be to change the type of the deprecated field from boolean to array or to add a new field called deprecatedAliases.

As I've stated on Discord, this doesn't really suffice, a description should also be provided why this icon/alias was deprecated in the first place and what steps should be taken.

@karsa-mistmere karsa-mistmere changed the title @depracated for aliases @deprecated for certain aliases Mar 8, 2024
@karsa-mistmere karsa-mistmere changed the title @deprecated for certain aliases idea: @deprecated for certain aliases Mar 8, 2024
@jguddas
Copy link
Member Author

jguddas commented Mar 8, 2024

A solution could be to change the type of the deprecated field from boolean to array or to add a new field called deprecatedAliases.

As I've stated on Discord, this doesn't really suffice, a description should also be provided why this icon/alias was deprecated in the first place and what steps should be taken.

What about this

{
  name: 'turtle',
  depracated: true,
  depracationReason: "I don't like turtles.",
  aliases: [
    {
      name: 'turdle',
      depracated: true,
      depracationReason: "Spelling mistake.",
    }
  ]
}

@karsa-mistmere
Copy link
Member

Apart from the typos, yeah. We could even keep support for the current version:

{
  name: 'turtle',
  deprecated: true,
  deprecationReason: "I don't like turtles.",
  aliases: [
    'tortoise',
    {
      name: 'turdle',
      deprecated: true,
      deprecationReason: "Spelling mistake.",
    }
  ]
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💡 idea New ideas
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants