Allow plugins to validate their options #112
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This introduces a new
validate
method to thePlugin
interface so that plugins can validate their options. It also implementsvalidate
for all plugins that have options. It also adds aPluginOptionsError
type tots-migrate-server
which should be thrown when validation fails.The motivation was originally described in #74, where I proposed a configuration file format. One consequence to a configuration format is that plugins will need to be more defensive about validating their options.
Internally the validation is implemented using JSON schema, with additional JS validation where JSON schema is not expressive enough (only the
member-accessibility
plugin, currently).