Title: Do not substitute string literals with `string` when reporting errors · Issue #56844 · microsoft/TypeScript · GitHub
Open Graph Title: Do not substitute string literals with `string` when reporting errors · Issue #56844 · microsoft/TypeScript
X Title: Do not substitute string literals with `string` when reporting errors · Issue #56844 · microsoft/TypeScript
Description: 🔍 Search Terms error box, string literal, type assignability ✅ Viability Checklist 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...
Open Graph Description: 🔍 Search Terms error box, string literal, type assignability ✅ Viability Checklist This wouldn't be a breaking change in existing TypeScript/JavaScript code This wouldn't change the runtime behavio...
X Description: 🔍 Search Terms error box, string literal, type assignability ✅ Viability Checklist This wouldn't be a breaking change in existing TypeScript/JavaScript code This wouldn't change the runtime...
Opengraph URL: https://github.com/microsoft/TypeScript/issues/56844
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Do not substitute string literals with `string` when reporting errors","articleBody":"### 🔍 Search Terms\r\n\r\nerror box, string literal, type assignability\r\n\r\n### ✅ Viability Checklist\r\n\r\n- [X] This wouldn't be a breaking change in existing TypeScript/JavaScript code\r\n- [X] This wouldn't change the runtime behavior of existing JavaScript code\r\n- [X] This could be implemented without emitting different JS based on the types of the expressions\r\n- [X] This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)\r\n- [X] This isn't a request to add a new utility type: https://github.com/microsoft/TypeScript/wiki/No-New-Utility-Types\r\n- [X] This feature would agree with the rest of our Design Goals: https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals\r\n\r\n### ⭐ Suggestion\r\n\r\nDo not coerce string literal types to a \"general\" `string` type when checking assignability and reporting errors.\r\n\r\n### 📃 Motivating Example\r\n\r\nGiven a code like this:\r\n\r\n\r\n```ts\r\ntype S = \"Literal type\";\r\ndeclare const s: S;\r\n\r\nfunction acceptsNumber(arg: number){}\r\n\r\nacceptsNumber(s);\r\n```\r\n\r\nIn TS **v3.9.7** the last line would trigger an error `Argument of type '\"Literal type\"' is not assignable to parameter of type 'number'.` The string literal type would be presented as it is, and we were using it a lot, primarily to craft helpful error messages in some corner cases of conditional types. \r\n\r\nHowever, since TS **v4.0.5** the error changes to the following: `Argument of type 'string' is not assignable to parameter of type 'number'.`. That's a correct error, but we consider it to be less helpful than the previous one. \r\n\r\n### 💻 Use Cases\r\n\r\n**1. What do you want to use this for?**\r\n\r\nMore helpful error messages in conditional types (e.g. telling programmers that \"Hey, you probably did X and Y wrong\")\r\n\r\n**2. What shortcomings exist with current approaches?**\r\n\r\nInstead of seeing a message in the error box (preview), people have to open the declaration file and understand how the conditional type is constructed\r\n\r\n**3. What workarounds are you using in the meantime?**\r\n\r\nInstead of using a string literal with `\"Error text\"`, using a named type e.g. `interface OpenThisError { message: \"Error Text\" }`\r\n","author":{"url":"https://github.com/erheron","@type":"Person","name":"erheron"},"datePublished":"2023-12-21T14:31:51Z","url":"https://github.com/microsoft/TypeScript/issues/56844"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:309bd085-3946-3acb-4c4f-c614814704f4 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | BA8C:14ECB:C80739:FF8C00:6B00FF13 |
| html-safe-nonce | de585c23aecbe7024484c757300331e3b7d835c512ee46f9072039d97b167604 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCQThDOjE0RUNCOkM4MDczOTpGRjhDMDA6NkIwMEZGMTMiLCJ2aXNpdG9yX2lkIjoiMjY4MzQ0MzU5MDY0MTgxMTIxOSIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 26b6086637f880af0f53ebcbb07225019501cdd78b68394e55cee2e1355776f4 |
| hovercard-subject-tag | issue:2052534646 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/microsoft/TypeScript/56844/issue_layout |
| twitter:image | https://opengraph.githubassets.com/8e0381c3dfaef8369b5ee7ea8360ae4e67ce8ae0b47eb5d1791ff00acf51677c/microsoft/TypeScript/issues/56844 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/8e0381c3dfaef8369b5ee7ea8360ae4e67ce8ae0b47eb5d1791ff00acf51677c/microsoft/TypeScript/issues/56844 |
| og:image:alt | 🔍 Search Terms error box, string literal, type assignability ✅ Viability Checklist This wouldn't be a breaking change in existing TypeScript/JavaScript code This wouldn't change the runtime behavio... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | erheron |
| hostname | github.com |
| expected-hostname | github.com |
| None | cb7fa109eca7d4156c889f474306b0e91336055e9adf8fd4684b61e49094d124 |
| turbo-cache-control | no-preview |
| go-import | github.com/microsoft/TypeScript git https://github.com/microsoft/TypeScript.git |
| octolytics-dimension-user_id | 6154722 |
| octolytics-dimension-user_login | microsoft |
| octolytics-dimension-repository_id | 20929025 |
| octolytics-dimension-repository_nwo | microsoft/TypeScript |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 20929025 |
| octolytics-dimension-repository_network_root_nwo | microsoft/TypeScript |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 2b59d31a4e44f08b7af67a4b67f8fd0af3befe2a |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width