New: Implement processorOptions

[Conduitry]

What is the purpose of this pull request? (put an "X" next to item)

[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[X] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

This implements processorOptions, as described in this RFC.

This isn't ready yet, and I'm marking this PR as a draft. This is working for me locally, but I'd like to get more eyes on this now that the RFC has been merged.

TODO:

• Tests
• Documentation

Is there anything you'd like reviewers to focus on?

Tests, mostly. I'd appreciate some pointers about where tests should go and what I should look at.

I'd also like confirmation that I've updated the type comments appropriately.

[Conduitry]

I'm marking this as ready for review.

I've added some minimal docs for this. I'm not sure what else is wanted here.

I also have some questions about what sorts of tests should be added and where they should live. Should they focus on config extraction? Something else?

Thanks!

[mysticatea]

About tests, we should add the tests of user-facing behaviors. I think there are two.

• One is that CLIEngine#executeOnFiles(patterns) should pass processorOptions to preprocess and postprocess. (for a reference, some tests for processors are there: tests/lib/cli-engine/cli-engine.js#L3033)

And, sorry that I had overlooked while writing RFC, processorOptions should be in options in Linter#verify(code, config, options).
Because Linter.verify(code, config, options) doesn't support some properties of config (config.extends, config.plugins, config.overrides, and config.processor). About processors, instead, we use options.preprocess and options.postprocess in a historical reason (document is https://eslint.org/docs/developer-guide/nodejs-api#linterverify). Therefore, I feel odd if config.processor is not supported, but config.processorOptions is supported.

So...

• The other one is that Linter#verify(code, config, options) should pass options.processorOptions to options.preprocess and options.postprocess. (for a reference, some tests for processors are there: tests/lib/linter/linter.js#L4325)

[Conduitry]

Should config.processorOptions or options.processorOptions take precedence? Should they be merged in some way? Or is it a problem if config.processorOptions is supported at all in Linter#verify?

[mysticatea]

I think config.processorOptions should be ignored completely because config.processor is not supported in Linter#verify.

[mysticatea]

Hi. The implementation looks good to me.

Would you add some tests I mentioned in #12068 (comment) ? If you need helps, let tell me!

[Conduitry]

Hi, sorry about the big delay on this! I'll try to add some tests within the next day and will let you know if I get confused about something.

[platinumazure]

Adding a "request changes" review just to avoid accidental merge. @Conduitry Please feel free to ping me when you've added some tests and feel this is ready for review. Thanks!

[kaicataldo]

@Conduitry Friendly ping! We'd love to merge this.

[Conduitry]

Hey! Sorry again about the even bigger delay. I'm taking a look at this again. I'll let you know if I'd like some more guidance on specifically what sort of tests I should be writing for this.

I was also looking into why the tests are currently failing but it looks like that's just #12662.

[nzakas]

@Conduitry are you still planning on working on this?

[kaicataldo]

@Conduitry I'm going to close this so that others feel free to contribute. Please don't hesitate to reopen if/when you have the time!

[JamesHenry]

@kaicataldo so just to confirm, the status for this one is that the RFC remains approved and the team will accept a new implementation PR from anybody at any time? (I have a use-case for this within angular-eslint)

[kaicataldo]

@JamesHenry That's right! Here's the relevant RFC: https://github.com/eslint/rfcs/tree/master/designs/2019-processor-shared-settings

[kaicataldo]

Whoops, meant to just comment, not reopen 😅