microsoft / microsoft/TypeScript
Codefix: convert `Type[]` to `readonly Type[]`
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Search Terms
codefix readonlyarray readonly array immutable
Suggestion
It'd be nice to have a codefix for converting non-readonly arrays to readonly.
Use Cases
When converting/refactoring code to be more immutable/readonly-friendly, it's a bit of a pain to manually add these annotations.
Examples
Given this:
function takesArrays(items: /*| |*/string[], moreItems: /*| |*/string[]) { /* ... */ }
...having a codefix to make one or all parameters readonly would be useful:
function takesArrays(items: readonly string[], moreItems: readonly string[]) { /* ... */ }
Checklist
My suggestion meets these guidelines:
- This wouldn't be a breaking change in existing TypeScript/JavaScript code
- This wouldn't change the runtime behavior of existing JavaScript code
- This could be implemented without emitting different JS based on the types of the expressions
- This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
- This feature would agree with the rest of TypeScript's Design Goals.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start from the issue's TypeScript examples and the existing codefix infrastructure for related type annotations. Identify the codefix entry point and its tests, then implement conversion for one or all applicable parameters and verify that the resulting types use readonly array syntax.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- compilers, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100