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

Allow (specified) additional keys in plugin validator #2312

Open
3 tasks done
nataliecarey opened this issue Aug 25, 2023 · 1 comment
Open
3 tasks done

Allow (specified) additional keys in plugin validator #2312

nataliecarey opened this issue Aug 25, 2023 · 1 comment
Assignees

Comments

@nataliecarey
Copy link
Contributor

nataliecarey commented Aug 25, 2023

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:

  • When oneNewKey (from the example above) isn't known to the validator it should be accepted
  • When oneNewKey (from the example above) is known to the validator it should be validated as usual

Why

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

Who needs to work on this

  • Developer
  • Content Designer (for the interface keysToIgnoreIfUnknown)

Who needs to review this

  • Developer
  • Content Designer (for the interface)

Done when

  • New keys can be specified by the person running the validator
  • These new keys are ignored if they aren't known to the validator
  • These new keys are validated as usual if they are known to the validator
@nataliecarey
Copy link
Contributor Author

Relates to #2293 (and similar tickets in the future)

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

No branches or pull requests

1 participant