Skip to content

docs(linter): Fix the react/only-export-components rule docs. #18319

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
graphite-app merged 1 commit into from
Jan 21, 2026
Merged

docs(linter): Fix the react/only-export-components rule docs. #18319

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions crates/oxc_linter/src/rules/react/only_export_components.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,12 +70,11 @@ pub struct OnlyExportComponentsConfig {

// NOTE: Ensure this is always kept in sync with OnlyExportComponentsConfig
#[derive(Debug, Default, Deserialize, Serialize, JsonSchema)]
#[serde(default)]
#[serde(default, rename_all = "camelCase")]
struct OnlyExportComponentsOptionsJson {
/// Treat specific named exports as HMR-safe (useful for frameworks that hot-replace
/// certain exports). For example, in Remix:
/// `{ "allowExportNames": ["meta", "links", "headers", "loader", "action"] }`
#[serde(rename = "allowExportNames")]
allow_export_names: Option<Vec<String>>,
/// Allow exporting primitive constants (string/number/boolean/template literal)
/// alongside component exports without triggering a violation. Recommended when your
Expand All @@ -87,7 +86,6 @@ struct OnlyExportComponentsOptionsJson {
/// export const VERSION = "3";
/// export const Foo = () => null;
/// ```
#[serde(rename = "allowConstantExport")]
allow_constant_export: Option<bool>,
/// If you export components wrapped in custom higher-order components, list their
/// identifiers here to avoid false positives.
Expand All @@ -106,7 +104,7 @@ declare_oxc_lint!(
/// that Fast Refresh (a.k.a. hot reloading) can safely preserve component state.
/// Concretely, it validates the shape of your module’s exports and common entrypoints
/// (e.g. `createRoot(...).render(<App />)`) to match what integrations like
/// `react-refresh` expect. The rule name is `react-refresh/only-export-components`.
/// `react-refresh` expect.
///
/// ### Why is this bad?
///
Expand Down
Loading