jsx-eslint/eslint-plugin-react

[Bug]: `prefer-read-only-props` rule doesn't work with namespaces

Open

#3,786 opened on Jul 20, 2024

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (2,797 forks)batch import
bughelp wantedtypescript

Repository metrics

Stars
 (8,630 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Is there an existing issue for this?

  • I have searched the existing issues and my issue is unique
  • My issue appears in the command-line and not only in the text editor

Description Overview

prefer-read-only-props rule should work with namespace syntax

namespace ItemsListElementSkeleton {
  export interface Props {
    withArtists?: boolean
    withPlayedAt?: boolean
    position?: number
    positionSize?: ItemPosition.Props['size']
    positionClassName?: string
    withPlaysOrPlayTime?: boolean
  }
}

function ItemsListElementSkeleton({
  position,
  positionSize,
  positionClassName,
  withArtists,
  withPlayedAt,
  withPlaysOrPlayTime,
}: ItemsListElementSkeleton.Props) {
...
}

export { ItemsListElementSkeleton }

Should throw an error

Prop '...' should be read-only.

Expected Behavior

Should throw error if props are not readonly

eslint-plugin-react version

v7.35.0

eslint version

v8.57

node version

v20.10.0

Contributor guide

Research direction
Investigate the `prefer read only props` rule implementation, focusing on how it resolves type references. The issue indicates that TypeScript namespaces (e.g., `ItemsListElementSkeleton.Props`) are not being recognized. Examine the rule's logic for extracting prop types, and consider adding support for namespace qualified types. Check if there are existing tests for namespaces and add a failing test case. Then modify the rule to handle this pattern.
Tech stack
typescriptjavascriptreact
Domain
frontend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitESLintReactTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50