Update dependency eslint-plugin-react-refresh to v0.5.0

[renovate]

This PR contains the following updates:

Package	Change	Age	Confidence
eslint-plugin-react-refresh	0.4.5 → 0.5.0

---

Release Notes

ArnaudBarre/eslint-plugin-react-refresh (eslint-plugin-react-refresh)

v0.5.0

Compare Source

Breaking changes

• The package now ships as ESM and requires ESLint 9 + node 20. Because legacy config doesn't support ESM, this requires to use flat config
• A new reactRefresh export is available and prefered over the default export. It's an object with two properties:
  • plugin: The plugin object with the rules
  • configs: An object containing configuration presets, each exposed as a function. These functions accept your custom options, merge them with sensible defaults for that config, and return the final config object.
• customHOCs option was renamed to extraHOCs
• Validation of HOCs calls is now more strict, you may need to add some HOCs to the extraHOCs option

Config example:

import { defineConfig } from "eslint/config";
import { reactRefresh } from "eslint-plugin-react-refresh";

export default defineConfig(
  /* Main config */
  reactRefresh.configs.vite({ extraHOCs: ["someLibHOC"] }),
);

Config example without config:

import { defineConfig } from "eslint/config";
import { reactRefresh } from "eslint-plugin-react-refresh";

export default defineConfig({
  files: ["**/*.ts", "**/*.tsx"],
  plugins: {
    // other plugins
    "react-refresh": reactRefresh.plugin,
  },
  rules: {
    // other rules
    "react-refresh/only-export-components": [
      "warn",
      { extraHOCs: ["someLibHOC"] },
    ],
  },
});

Why

This version follows a revamp of the internal logic to better make the difference between random call expressions like export const Enum = Object.keys(Record) and actual React HOC calls like export const MemoComponent = memo(Component). (fixes #​93)

The rule now handles ternaries and patterns like export default customHOC(props)(Component) which makes it able to correctly support files like this one given this config:

{
  "react-refresh/only-export-components": [
    "warn",
    { "extraHOCs": ["createRootRouteWithContext"] }
  ]
}

[!NOTE]
Actually createRoute functions from TanStack Router are not React HOCs, they return route objects that fake to be a memoized component but are not. When only doing createRootRoute({ component: Foo }), HMR will work fine, but as soon as you add a prop to the options that is not a React component, HMR will not work. I would recommend to avoid adding any TanStack function to extraHOCs it you want to preserve good HMR in the long term. Bluesky thread.

Because I'm not 100% sure this new logic doesn't introduce any false positive, this is done in a major-like version. This also give me the occasion to remove the hardcoded connect from the rule. If you are using connect from react-redux, you should now add it to extraHOCs like this:

{
  "react-refresh/only-export-components": ["warn", { "extraHOCs": ["connect"] }]
}

v0.4.26

Compare Source

• Revert changes to fix #​93 (fixes #​95)

v0.4.25

Compare Source

• Report cases like export const ENUM = Object.keys(TABLE) as EnumType[]; (fixes #​93)
• Allow _ in component names (#​94)

v0.4.24

Compare Source

• Add "generateImageMetadata", "generateSitemaps" & "generateStaticParams" to allowExportNames in Next config

v0.4.23

Compare Source

• Add "metadata", "generateMetadata" & "generateViewport" to allowExportNames in Next config

v0.4.22

Compare Source

• Add "viewport" to allowExportNames in Next config (#​89)

v0.4.21

Compare Source

• Add Next config (fixes #​85)

This allows exports like fetchCache and revalidate which are used in Page or Layout components and don't trigger a full page reload.

import reactRefresh from "eslint-plugin-react-refresh";

export default [
  /* Main config */
  reactRefresh.configs.next,
];

v0.4.20

Compare Source

• Don't warn on nested HOC calls (fixes #​79)
• Fix false positive with as const (fixes #​80)

v0.4.19

Compare Source

Add name to configs for ESLint Config Inspector

v0.4.18

Compare Source

ESM/CJS interop is the worse that happened to this ecosystem, this is all I have to say.

v0.4.17

Compare Source

• Fix detection of local components to not generate warning on for variable inside JSX files that follow React component naming (fixes #​75)
• Update types to not require extra unnecessary .default property access under TS node16 module resolution (fixes #​70)

v0.4.16

Compare Source

Fix CJS/ESM interop issue. Sorry everyone for the trouble.

v0.4.15

Compare Source

Add support for custom HOCs (#​60)

By default, the rule only knows that memo & forwardRef function calls with return a React component. With this option, you can also allow extra function names like Mobx observer to make this code valid:

const Foo = () => <></>;
export default observer(Foo);

{
  "react-refresh/only-export-components": [
    "error",
    { "customHOCs": ["observer"] }
  ]
}

Thanks @​HorusGoul!

Add recommended config and simple types (#​67)

You can now add the recommended config to your ESLint config like this:

import reactRefresh from "eslint-plugin-react-refresh";

export default [
  /* Main config */
  reactRefresh.configs.recommended, // Or reactRefresh.configs.vite for Vite users
];

To follow ESLint recommandations, the rule is added with the error severity.

Some simple types ensure that people typecheking their config won't need @ts-expect-error anymore.

Bump ESLint peer dependency to 8.40

This was actually done by mistake in the previous release when moving from a deprecated API to a new one.

Given that ESLint 8 is officialy end-of-life and the only report (#​56) didn't get likes, I'm going forward and documenting the expected minimum version from ESLin in the package JSON so that people can get warning from their package manager.

v0.4.14

Compare Source

• Warn if a context is exported alongside a component (fixes #​53). Thanks @​IgorAufricht!

v0.4.13

Compare Source

• Support for react-redux connect (export default connect(mapStateToProps, mapDispatchToProps)(MyComponent)) (fixes #​51)
• Support for Arbitrary Module Identifiers syntax (fixes #​52)

v0.4.12

Compare Source

• Support type assertion on default export (fixes #​48)
• Add default export to fix usage with jiti (fixes #​50)

v0.4.11

Compare Source

• Ignore type exports (ex. export type foo = string;) (fixes #​47)

v0.4.10

Compare Source

• Support function Foo() {}; export default React.memo(Foo) (#​46) (thanks @​SukkaW!)

v0.4.9

Compare Source

• Support function Foo() {}; export default memo(Foo) (fixes #​44) (thanks @​SukkaW!)

v0.4.8

Compare Source

• Support export const foo = -1 with allowConstantExport (fixes #​43)

v0.4.7

Compare Source

• Support export { Component as default } (fixes #​41)

v0.4.6

Compare Source

• Ignore cypress test files (#​39)

---

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

---

• If you want to rebase/retry this PR, check this box

---

This PR was generated by Mend Renovate. View the repository job log.