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

Migrate @storybook/addon-knobs package to @storybook/addon-controls #9520

Open
2 tasks done
amoore108 opened this issue Oct 7, 2021 · 0 comments
Open
2 tasks done
Labels
technical-work Technical debt, support work and building new technical tools and features

Comments

@amoore108
Copy link
Contributor

amoore108 commented Oct 7, 2021

Is your feature request related to a problem? Please describe.
The @storybook/addon-knobs addon we use in Storybook has been deprecated in favour of @storybook/addon-controls (which we have in the application). The deprecated package is not supported and has started to introduce some NPM audit warnings for its dependencies.

Steps for migration to the addon-controls library can be found here

This could potentially be a chunky piece of work as there is a Psammead package we use that also makes use of the @storybook/addon-knobs package called psammead-storybook-helpers. This is used extensively throughout Simorgh, so severing this dependency will likely be the bulk of the work here.

Describe the solution you'd like
Follow the migration guide above and remove @storybook/addon-knobs from Simorgh in favour of @storybook/addon-controls.

Ensure all functionality from @storybook/addon-knobs is retained in Storybook

Describe alternatives you've considered
We could retain @storybook/addon-knobs and accept the potential risk of dependency vulnerabilities, however this will continue to cause issues with the build pipeline reporting NPM audit warnings.

Testing notes
Ensure that all the original functionality that @storybook/addon-knobs introduced is retained with @storybook/addon-controls when using the new Controls functionality within Storybook.

  • This feature is expected to need manual testing.

Checklist

@amoore108 amoore108 added the technical-work Technical debt, support work and building new technical tools and features label Oct 7, 2021
@amoore108 amoore108 added this to Coming Soon in Simorgh via automation Oct 7, 2021
@amoore108 amoore108 changed the title Remove @storybook/addon-knobs package from Simorgh Migrate @storybook/addon-knobs package to @storybook/addon-controls Oct 7, 2021
@amoore108 amoore108 removed this from Coming Soon in Simorgh Oct 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
technical-work Technical debt, support work and building new technical tools and features
Projects
None yet
Development

No branches or pull requests

1 participant