Ability to create RTL variants of specific/all stories of a kind as substories

[jroebu14]

Resolves #1673

Overall change: Changes buildRTLSubstories to create RTL variants of all stories of a specific kind or specific stories of specific kind. Previously buildRTLSubstories would create RTL variants of all stories which was considered not a good approach because this would double the length of time it takes for ChromaticQA to run in the CI pipeline which is something we are actively trying to reduce.

The original plan was to do this with a new decorator that we could decorate individual or many stories with however it's not possible to create new substories this way.

Examples of use:

create RTL variants of all stories of a kind

import { buildRTLSubstories } from '@bbc/psammead-storybook-helpers';

buildRTLSubstories('Components|Paragraph');

create RTL variants of specific stories of a kind

import { buildRTLSubstories } from '@bbc/psammead-storybook-helpers';

buildRTLSubstories('Components|Paragraph', {
  include: ['containing an inline link'],
});

This would produce new substories in Storybook:

This new substory is then automatically added to ChromaticQA as the RTL example of the original story.

Code changes:

• updates buildRTLSubstories.js API and tests.
• updates changelog with new examples
• bumps major version number

---

• I have assigned myself to this PR and the corresponding issues
• Automated jest tests added (for new features) or updated (for existing features)
• This PR requires manual testing

[thekp]

is it worth adding change this to:

  const rtlServiceDecorator = withServicesKnob({ defaultService: 'arabic', services:['arabic', 'persian', 'urdu', 'pashto'] });

[jroebu14]

oh nice idea!

[jroebu14]

is that all the rtl services?

[thekp]

yup, I just confirmed on slack.

[thekp]

Great work, you just need to create follow up issues to apply these changes across our repos. 👍

[jroebu14]

@thekp I guess for Psammead we are still working on this issue #1673 although it doesn't detail which stories we should have rtl variants for. My guess is we should do them for components where the layout changes such as consent banner.

[thekp]

do them for components where the layout changes such as consent banner.

This sounds right to me 👍

[j-pendlebury]

LGTM