Add a reference to context settings and options

[dwightjack]

Hi great project!

I'm using this library's filterReports to modify a rule i eslint-plugin-vue but I'd like to be able to access rules' options and global settings.

For what I can understand reading the sourcecode, right now there's no way to access those property, so I extracted them from the context object and exposed them on the metadata object.

[dwightjack]

As reference here is the implementation or the extended rule: https://github.com/dwightjack/eslint-plugin-vue-types/blob/develop/lib/rules/require-default-prop.js

[not-an-aardvark]

Thanks for the pull request! Can you update the documentation in README.md to note these new properties?

[dwightjack]

@not-an-aardvark Thanks for the review.

Added documentation and tests as well.

[not-an-aardvark]

Thanks, I left a few minor comments about the documentation.

[not-an-aardvark]

Nitpick: Can you replace this with return !whitelist.includes(value)?

[not-an-aardvark]

I'm a bit confused about this example -- shouldn't tokenWhitelist be in the rule options rather than settings? It seems like the option is only applicable to this one rule.

[dwightjack]

The ability to read settings for the configuration is provided to make it possibile to setup rules like eslint-plugin-import resolvers.

Maybe the example doesn't fit well and could be confusiong. Any hint on a better example?

[not-an-aardvark]

To clarify, I agree that it's useful to have access to settings -- I just think this isn't a good example of the utility because this type of configuration would be better in options. (I was initially confused because I didn't see the similar options example above it.)

It's probably not really necessary to have separate examples for options and settings, so it might be simplest to just remove this example.

[dwightjack]

You're right. I removed the example and merged the two text descriptions.

[not-an-aardvark]

LGTM, thanks!