feat: add support for headless rule config

[camchenry]

• Towards Allow configuring rules #51

This is an initial pass at supporting rule configurations in headless mode. We currently do not pass any options along, but this allows passing an options field in the headless payload with each rule which will get serialized and pass along to the rule. We will need to be careful about how we handle the configs and validate the input coming in. However, this should be a backwards compatible change since it only adds a new field to the existing payload.

I believe we'll need to update each rule to allow getting valid options from an arbitrary map type.

[camchenry]

• feat: add support for headless rule config #258 👈 (View in Graphite)
• main

---

How to use the Graphite Merge Queue

Add the label 0-merge to this PR to add it to the merge queue.

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

[camchenry]

@camc314 I'd appreciate your early thoughts on this direction. I'd love to find a way to avoid rewriting every rule to be compatible with accepting JSON input.

[camchenry]

Sorry @auvred I should have pinged you too last night! You're much more familiar with Go than I am, so perhaps there is a more idiomatic way of handling this. With the current approach, we would need to manually (or have AI) write a function for every rule that allows accepting any and checks if it's a map of some kind, or an exact match for the rule options. Would be a decent chunk of work, but if it's necessary, then I guess that's what we need to do. 🤷

[auvred]

As stated in #51 (comment), the main issue is that Go structs don't allow expressing typescript-eslint options one-to-one. If I were doing this, I'd write (or try to find) a Go code generator that takes typescript-eslint meta.schema (JSON Schema) and generates a small, interface-based typed deserializer for each rule.

[osdiab]

Is there any update on progress towards the go struct/typescript-eslint option mapping? don't want to be pushy, just really looking forward to this so we can give it a spin! Thanks!

[camchenry]

@osdiab I've been busy with other things, but I am actively working on this again, so I hope to have it usable in oxlint in the next month or so.