Better unknown handling configuration #2743

imjoshin · 2022-02-16T18:37:12Z

Status: Draft
This is still a draft as I haven't been able to dedicate the time required to fix up the tests. I'm open to someone else helping out and/or providing guidance. 😄

This PR aims to have better handling of unknown keys. Within the validate configuration, instead of just a boolean, allowUnknown supports clearer definitions with backwards compatibility:

type AllowMode = boolean | 'allowed' | 'forbidden' | 'warn';
...

allowUnknown?: AllowMode | {
    mode: AllowMode,
    type?: string,
};

These means we can either allow unknown keys with allowed or true, reject with forbidden or false, or warn with warn. If warn or forbidden are set, we can set what type the warning or error object are by setting the type property.

imjoshin · 2022-02-16T18:40:09Z

test/validator.js

@@ -508,6 +508,47 @@ describe('Validator', () => {
                }
            });
        });
+
+        it('reports warnings with nested options', () => {


We'll definitely want more tests here to cover root level unknown as well as allowUnknown: 'forbidden'

WIP: Better unknown handling configuration

f399e3c

imjoshin commented Feb 16, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Better unknown handling configuration #2743

Better unknown handling configuration #2743

imjoshin commented Feb 16, 2022 •

edited

imjoshin Feb 16, 2022

Better unknown handling configuration #2743

Are you sure you want to change the base?

Better unknown handling configuration #2743

Conversation

imjoshin commented Feb 16, 2022 • edited

imjoshin Feb 16, 2022

Choose a reason for hiding this comment

imjoshin commented Feb 16, 2022 •

edited