feat: definePlugin

[JoshuaKGoldberg]

Summary

Adds a definePlugin function to @eslint/plugin-kit as a recommended way to group plugin configs, meta, and rules.

Related Issues

• Change Request: Provide a definePlugin function in @eslint/plugin-kit rewrite#176
• Enhancement: Support Lazy Loading Rules typescript-eslint/typescript-eslint#11029
• Support Lazy Loading Rules vuejs/eslint-plugin-vue#2732

[michaelfaith]

This seems like an adjacent but separate conversation.

[nzakas]

Thanks for all the work and research you put into this.

At a high-level, I can see the value of a definePlugin() helper function that:

• provides type safety
• makes it easier to define configs
• enforces best practices (requiring meta.name, meta.version, and meta.namspace

I'm less convinced with some of the more ambitious parts of this proposal such as:

• lazy-loading rules
• autocreation of configs

By way of example, defineConfig()s goals were primary to provide type safety and add an extends key, so I'm wondering if maybe it makes sense to scale down definePlugin()'s MVP?

[JoshuaKGoldberg]

I'm less convinced with some of the more ambitious parts of this proposal such as:

Added:

• autocreation of configs: 5d25577
• lazy-loading rules: feat: definePlugin #132 (comment) ✅

[kirkwaiblinger]

Not totally following this... Are we saying that if I provide

definePlugin({
   meta,
   rules,
   configs: {
     [`${pluginName}/recommended`]: { /* ... */  },
     config1: { /* ... */ },
     config2: { /* ... */ },
   }
});

that all these configs should be transformed? Or that only the `${pluginName}/recommended` one will be? Or maybe something else?

[JoshuaKGoldberg]

Ah, you're right, this is weirdly phrased and kind of wrong. It's the first one. Each individual config will be transformed. Edited:

• This part just says it's an object whose properties describe the configs to create.
• Generated Configs describes the key-value mapping in more detail

cc4e515

Is that more clear? I'm having a hard time describing this.

[fasttime]

Thanks for your work, and apologies for the delayed review. I've added some comments throughout. Given the length of the text, I may have missed something. Feel free to let me know if anything in my remarks seems off.

[JoshuaKGoldberg]

@fasttime @nzakas I removed the config rules generation points and noted them as out of scope, similar to lazy-loading rules. The only modification the definePlugin function now would do is merging in a plugins array with the plugin set by meta.name.