Package does not pass AreTheTypesWrong

[jakebailey]

See: https://arethetypeswrong.github.io/?p=eslint-plugin-react-refresh%400.4.16

The package is bundled, and ends with:

var src_default = { rules, configs };
// Annotate the CommonJS export names for ESM import in node:
0 && (module.exports = {
  configs,
  rules
});

This means that the output dts file should actually read export = _default;, not export default _default;, since an export named default does not actually exist at runtime.

I noticed this on DT, which previously held types for this package (but will have to be deleted now that you're doing it): https://github.com/DefinitelyTyped/DefinitelyTyped/actions/runs/12118993180/job/33784693075#step:12:2663

[jakebailey]

Er, sorry, misread esbuild's output.

var src_exports = {};
__export(src_exports, {
  configs: () => configs,
  default: () => src_default,
  rules: () => rules
});
module.exports = __toCommonJS(src_exports);

I think it actually needs export = _default and export { _default as default }?

[jakebailey]

I should really just defer to the ATTW message 😅

The JavaScript appears to set both module.exports and module.exports.default for improved compatibility, but the types only reflect the latter (by using export default). This will cause TypeScript under the node16 module mode to think an extra .default property access is required, which will work at runtime but is not necessary. These types should export = an object with a default property instead of using export default.

[ArnaudBarre]

Oh I didn't know someone published types for this package.
I'll update the suggested syntax

[jakebailey]

My suggestion is probably wrong; you may need to declare a different type instead that's an object type with a default prop and not mix syntax. I think TS will error?

[ArnaudBarre]

Finally took some time to do the change suggested by ATTW cli, it was green after the change.

[jakebailey]

I'm not sure that change is exactly correct, though it does pass ATTW; the runtime code impies that code like:

const plugin = require("eslint-plugin-react-refresh");

plugin.configs;
plugin.rules;

Will work, but the new types imply that the exported object only has a prop named default.

[jakebailey]

(I had forgotten about this; when I have some time later I can try and come up with a "real" declaration for the shape of your runtime export.)

[ArnaudBarre]

export = _default both is valid for the cli and provide correct typing for moduleResolution bundler and node16 (with allowSyntheticDefaultImports).

I think this is good enough for me!

[jakebailey]

I'm testing with node16 in a plain CJS file, where those synthetic defaults and such don't work since TS wouldn't transform them (which should be the case for nearly all eslint configs).