microsoft / microsoft/TypeScript
Don't suggest private fields in contexts where they are out of scope
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.4k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 117
Description
🔎 Search Terms
private fields suggestions
🕗 Version & Regression Information
- This is the behavior in every version I tried, and I reviewed the FAQ for entries about private fields
⏯ Playground Link
💻 Code
type ExampleInit = {
foo: number,
};
type ExampleLike = Example | ExampleInit;
class Example {
static isExample(value: any): value is Example {
return #foo in value;
}
static from(exampleLike: ExampleLike): Example {
if (Example.isExample(exampleLike)) {
return exampleLike;
}
return new Example(exampleLike);
}
readonly #foo: number;
constructor({ foo }: ExampleInit) {
this.#foo = foo;
}
}
const example = Example.from({
// Try typing "f" and see that there is a suggestion for #foo
});
🙁 Actual behavior
We get suggestions for private fields:
This is particularly annoying as the private fields tend to be suggested first, so tab-completion tends to produce broken code.
🙂 Expected behavior
The private field should not be included as a suggestion when outside the class scope where the field is defined.
Additional information about the issue
No response
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 by reproducing the completion in the linked TypeScript Playground using the provided Example class and object literal. Trace the completion behavior for the private field outside the class scope, then verify that the suggestion is omitted there without changing valid private-field suggestions inside the defining class.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- compilers
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100