Documentation for implementing plugins and TypeScript types?

[JoshuaKGoldberg]

👋 good news: https://github.com/JoshuaKGoldberg/eslint-plugin-package-json now uses jsonc-eslint-parser as of 0.3.0!

Less good news: I'm having a bit of a hard time wrestling with TypeScript types trying to convert eslint-plugin-package-json to TypeScript in JoshuaKGoldberg/eslint-plugin-package-json#59. As noted in #159, the AST.JSON* types from jsonc-eslint-parser aren't assignable to or from ESTree.* types from estree. Example type assertions: https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/pull/59/files#diff-c14abd619a7569f9b82e00ce73302cacc0eca3d6462db5499652adeaf58c38faR36-R39

Is this ESTree<>JSONC types mismatch problem something that can be solved? If not, is there a workaround you'd recommend? And either way, could we document the answer?

For reference, it looks like the strategy in eslint-plugin-jsonc is to completely remove the built-in ESTree types?

• https://github.com/ota-meshi/eslint-plugin-jsonc/blob/247c013126fbbaa8eb169527c7b5cdf8e8987bab/lib/types.ts#L3-L5: a new RuleListener type that only allows node: never types
• https://github.com/ota-meshi/eslint-plugin-jsonc/blob/247c013126fbbaa8eb169527c7b5cdf8e8987bab/lib/rules/no-bigint-literals.ts#L25: example rule that explicitly uses a type annotation
  • Corresponding issue around these types: Internal code suggestion: add explicit call signatures for RuleListener node types? eslint-plugin-jsonc#268