alphagov / govuk-prototype-kit

Rapidly create HTML prototypes of GOV.UK services
https://prototype-kit.service.gov.uk
MIT License
302 stars 236 forks source link

Allow (specified) additional keys in plugin validator #2312

Open nataliecarey opened 1 year ago

nataliecarey commented 1 year ago

What

We're experimenting with adding keys to the config to support Frontend v5. The addition of these keys breaks the validation, in a lot of cases we'll be able to publish updates to the validator which resolve this but there are some cases where it's too early to do that. In these cases we should allow the plugin developer to specify which keys they want ignored by the validator e.g.

npx govuk-prototype-kit@latest validate-plugin --keysToIgnoreIfUnknown="oneNewKey,anotherNewKey"

This will help any time we're in the early stages of adding new features to the interface. The behaviour should be:

Why

So that we can more easily experiment with interface design before committing to it.

Who needs to work on this

Who needs to review this

Done when

nataliecarey commented 1 year ago

Relates to https://github.com/alphagov/govuk-prototype-kit/issues/2293 (and similar tickets in the future)