Skip to content

Rule proposal: no-unsafe-readonly-mutable-assignment #5954

@JoshuaKGoldberg

Description

@JoshuaKGoldberg

Before You File a Proposal Please Confirm You Have Done The Following...

My proposal is suitable for this project

  • My proposal specifically checks TypeScript syntax, or it proposes a check that requires type information to be accurate.
  • My proposal is not a "formatting rule"; meaning it does not just enforce how code is formatted (whitespace, brace placement, etc).
  • I believe my proposal would be useful to the broader TypeScript community (meaning it is not a niche proposal).

Description

From https://github.com/danielnixon/eslint-plugin-total-functions:

Bans unsafe assignment of readonly values to mutable values (which can lead to surprising mutation in the readonly value). This includes passing readonly values as arguments to functions that expect mutable parameters.

For examples of assignment that this rule considers valid and invalid, see no-unsafe-readonly-mutable-assignment.test.ts.

See microsoft/TypeScript#13347 for a request to fix this at the language level.

Though, I wonder if we can shorten the name a bit?

Fail Cases

type MutableA = { a: string };
type ReadonlyA = { readonly a: string };

const mutate = (mut: MutableA): void => {
    mut.a = "whoops";
};

const readonlyA: ReadonlyA = { a: "readonly?" };
mutate(readonlyA);

Pass Cases

type MutableA = { a: string };
type ReadonlyA = { readonly a: string };

const read = (mut: ReadonlyA): void => {
    // No longer allowed:
    // mut.a = "whoops";
};

const readonlyA: ReadonlyA = { a: "readonly?" };
read(readonlyA);

Additional Info

Forking conversation out from danielnixon/eslint-plugin-total-functions#665.

Metadata

Metadata

Assignees

No one assigned

    Labels

    accepting prsGo ahead, send a pull request that resolves this issueenhancement: new plugin ruleNew rule request for eslint-pluginlocked due to agePlease open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing.package: eslint-pluginIssues related to @typescript-eslint/eslint-plugin

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      pFad - Phonifier reborn

      Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

      Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


      Alternative Proxies:

      Alternative Proxy

      pFad Proxy

      pFad v3 Proxy

      pFad v4 Proxy