microsoft / microsoft/TypeScript

Wrong elementwise error location on optional object property that allows arrays too

Open
#57,541 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Domain: Related Error Spans Help Wanted Possible Improvement
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
1d 19h
Merged PRs (30d)
117

Description

🔎 Search Terms

error location elementwise elaboration array optional object

🕗 Version & Regression Information
  • This is a crash
  • This changed between versions ______ and _______
  • This changed in commit or PR _______
  • This is the behavior in every version I tried, and I reviewed the FAQ for entries about _________
  • I was unable to test this on prior versions because _______
⏯ Playground Link

https://www.typescriptlang.org/play?ts=5.5.0-dev.20240225#code/C4TwDgpgBAyglgOwOYBsIHkBOBBTmCGIAPACoB8UAvFCVAD5SYT4AmA9giiDQNoC6AbgBQQ0JCgAFTGwBucFhBbYAxsDaYqUAN5CoUAM6ZlALgPBMiJML2IwAV2AB+U3YQBrBGwDuCYQF9hUXBoAFl8ZQALRAgAYQ4AMzgkUhU1TH0oCAAPYAgEFgypWXlFVPUKah0bBBk2NwhnWEs0LFwCYhIy9LJ-QIVlFHwmKHjXVTgOAwhgOzAU1XUM7Nz8wuk5BSUFzDIACgBKUyqoZSZ8XLDI6NNd5QSk00uohFj75M7t-TJ9qgpa+V6In001mRC0BiMpgARPFppEAKrAzBQgRQWwOUz6cyWKB+Pb7AB0p2YF3Czwgu2OiFq9SOuj0EJMUBhcIiiIgyIANPTqvZgKYAIwABm5ej83L8+2EQA

💻 Code
type SingleOrArray<T> = T | readonly T[];

type ProvidedActor = {
  src: string;
  input?: unknown;
};

type MachineConfig<TActors extends ProvidedActor> = {
  invoke?: SingleOrArray<TActors>;
};

declare function setup<TActors extends ProvidedActor>(): {
  createMachine: (config: MachineConfig<TActors>) => void;
};

setup<{ src: "fetchUser"; input: string }>().createMachine({
  invoke: {
    src: "fetchUser",
    input: 10,
  },
});
🙁 Actual behavior

invoke property gets highlighted

🙂 Expected behavior

input property should get highlighted as it's the one that it's not correct and it's more specific than invoke

Additional information about the issue

we can observe the error location to change when:

  1. we remove optionality from invoke
  2. we make the provided type argument a union

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked TypeScript Playground and the provided generic setup/createMachine reproduction, then inspect how the checker chooses an error location for the optional invoke property and its input property. Done means the diagnostic highlights input rather than invoke, while preserving the expected behavior for the optional and union variations mentioned.

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
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.