Skip to main content

PreferReadonlyRule

Struct PreferReadonlyRule 

Source
pub struct PreferReadonlyRule;
Expand description

Type-aware rule that flags private members that are never reassigned and can therefore be marked readonly.

Faithful port of the tsgolint builtin prefer-readonly rule. The upstream Go implementation walks each class scope, tracks every modification of a private member through class/instance property accesses, and at scope exit reports the private, non-readonly, non-accessor, non-computed members that were never modified outside the constructor (modifications that occur directly inside the constructor still allow a readonly mark).

In this architecture the host performs the per-class data-flow walk and the Rust rule receives the result as a raw fact on each member declaration (__memberIsReassigned). All of the eligibility decisions (visibility, readonly/accessor/computed gating, and the onlyInlineLambdas option) stay in Rust; only the raw “was this member reassigned outside the constructor” query is delegated.

Upstream also reports on private constructor parameter properties (constructor(private x = 7)), which are surfaced in TS-ESTree as TSParameterProperty nodes rather than PropertyDefinition. We therefore listen on both kinds and normalize them.

Trait Implementations§

Source§

impl Clone for PreferReadonlyRule

Source§

fn clone(&self) -> PreferReadonlyRule

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for PreferReadonlyRule

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
Source§

impl Default for PreferReadonlyRule

Source§

fn default() -> PreferReadonlyRule

Returns the “default value” for a type. Read more
Source§

impl RustLintRule for PreferReadonlyRule

Source§

fn name(&self) -> &'static str

Returns the stable rule name exposed to JavaScript and diagnostics.
Source§

fn docs_description(&self) -> &'static str

Returns the short prose description used in generated rule metadata.
Source§

fn messages(&self) -> &'static [RuleMessage]

Returns the message catalog keyed by message_id.
Source§

fn listeners(&self) -> &'static [&'static str]

Returns the AST node kinds this rule wants the host to send.
Source§

fn has_suggestions(&self) -> bool

Returns whether diagnostics from this rule may include suggested fixes.
Source§

fn check(&self, ctx: &mut RuleContext<'_>, node: &LintNode)

Checks one host-provided node and records diagnostics in ctx.
Source§

fn requires_type_texts(&self) -> bool

Returns whether the host should attach TypeScript-rendered type text.
Source§

fn meta(&self) -> RuleMeta

Builds the serializable rule metadata exposed to binding layers.
Source§

impl Copy for PreferReadonlyRule

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.