FEUIUX-407 feat: add no-deprecated-components rule

[kubaprzetakiewicz]

Jira

https://plentific.atlassian.net/browse/FEUIUX-315
https://plentific.atlassian.net/browse/FEUIUX-407

Description

This is a new rule that will detect imports from paths that were configured as restricted and output a message with a suitable replacement.

Example configuration:

'plentific/no-deprecated-components': [
  'error',
  {
    'components/ButtonBlock': 'components/Button',
  },
],

Screenshots

[kubaprzetakiewicz]

note: the only change in this file, everything else is prettified

[r1seUp]

Leaving it as suggestion here, potentially this can be extended to an array, where as a second optional value we can provide a link to storybook where detailed examples can help developers with migrations.

[rostislav-simonik-plc]

I was thinking about that as well but the value is quite universal you can even do

{
  "examples/app/components/ComponentDeprecated":
    "examples/app/components/Component (see documentation on https://bla.com)",
}

[rostislav-simonik-plc]

but probably i'd won't do exact matching because if deprecated component will be moved, and somebody forget to adjust the rule, it will stop matching, maybe so if we do matching like import ends with, you can still do exact match or just sub matching components/ComponentDeprecated or just ComponentDeprecated

[kubaprzetakiewicz]

yeah, as @rostislav-simonik-plc mentioned - i did similar in the dashboard PR already: https://github.com/plentific/dashboard/pull/25141/files#diff-e2954b558f2aa82baff0e30964490d12942e0e251c1aa56c3294de6ec67b7cf5R32

[kubaprzetakiewicz]

i wouldn't lock it into Storybook, because not every substitution is UX/UI/Storybook/Blueprint-related