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

Fix: Validate options after applying defaults, not before #165

Open
JoshuaKGoldberg opened this issue Jun 10, 2024 · 0 comments
Open

Fix: Validate options after applying defaults, not before #165

JoshuaKGoldberg opened this issue Jun 10, 2024 · 0 comments
Labels

Comments

@JoshuaKGoldberg
Copy link

Coming over from eslint/eslint#17656 (comment): right now, eslintrc validates options and then validates defaults. Copying the example from @mdjermanovic's comment, if this is a rule:

{
    meta: {
        defaultOptions: [{
            foo: 42
        }],
        schema: [{
            type: "object",
            maxProperties: 2 // allows one or two in addition to "foo"?
        }]
    },
    create() {
        return {};
    }
}

...then the configuration ["error", { bar: 6, baz: 7 }] is still considered valid.

This is different from the new ESLint flat config format.

Technically this proposed stricter behavior could be considered a breaking change and out of scope given this package's feature freeze. However, I'd propose we consider it a bugfix, as IMO the invalid options should not have been allowed to begin with.

Filing a tracking issue for my reference. I plan on sending a PR for this soon, unless directed otherwise.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Ready to Implement
Development

No branches or pull requests

2 participants