Title: Enhance DOM API completion by sourcing descriptions from MDN · Issue #26404 · microsoft/TypeScript · GitHub
Open Graph Title: Enhance DOM API completion by sourcing descriptions from MDN · Issue #26404 · microsoft/TypeScript
X Title: Enhance DOM API completion by sourcing descriptions from MDN · Issue #26404 · microsoft/TypeScript
Description: At VS Code, we has been sourcing data from MDN to get up-to-date documentation and compatibility info. One example is: https://code.visualstudio.com/updates/v1_25#_new-css-pseudo-selectors-and-pseudo-elements-from-mdn, and more details a...
Open Graph Description: At VS Code, we has been sourcing data from MDN to get up-to-date documentation and compatibility info. One example is: https://code.visualstudio.com/updates/v1_25#_new-css-pseudo-selectors-and-pseu...
X Description: At VS Code, we has been sourcing data from MDN to get up-to-date documentation and compatibility info. One example is: https://code.visualstudio.com/updates/v1_25#_new-css-pseudo-selectors-and-pseu...
Opengraph URL: https://github.com/microsoft/TypeScript/issues/26404
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Enhance DOM API completion by sourcing descriptions from MDN","articleBody":"At VS Code, we has been sourcing data from MDN to get up-to-date documentation and compatibility info. One example is: https://code.visualstudio.com/updates/v1_25#_new-css-pseudo-selectors-and-pseudo-elements-from-mdn, and more details are at:\r\n- https://github.com/Microsoft/vscode-css-languageservice/issues/68\r\n- https://github.com/mdn/data/issues/199\r\n\r\nWhile chatting with @atopal last week, we thought it would be a great idea to make TypeScript source some documentation from MDN for a better auto-completion experience for JS/TS developers. For example, here is how DOM auto-completion looks like today:\r\n\r\n\r\n\r\nThe problem is that `lib.dom.d.ts` does not contain description for probably 95% of the items. Users would be at a loss to know what each API offers and how to use them.\r\n\r\nMDN currently offers an API to pull description for a specific endpoint. For example, this is the JSON API for `DOMParser`: https://developer.mozilla.org/en-US/docs/Web/API/DOMParser$json\r\n\r\nThe `summary` field is (once we remove the HTML and extract text): \r\n\r\n> The DOMParser interface provides the ability to parse XML or HTML source code from a string into a DOM Document.\r\n\r\nIt would be great if TypeScript could query MDN for each API without description and put the descriptions into `lib.dom.d.ts`, so that users could get much better auto-completion for DOM API.\r\n\r\nFrom MDN side, they are also working on making MDN data more easily accessible by tooling: See https://discourse.mozilla.org/t/proposal-including-css-short-descriptions-in-mdn-data/30500.\r\n\r\n/cc @atopal\r\n","author":{"url":"https://github.com/octref","@type":"Person","name":"octref"},"datePublished":"2018-08-13T06:06:02Z","url":"https://github.com/microsoft/TypeScript/issues/26404"}
| 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:e9beffac-68eb-6166-28b2-5cca9b6defc8 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | ACEC:29AEE8:2D56201:3C6FBCD:6B01D1A7 |
| html-safe-nonce | 992f429f4c5677cf8ac073d6e116fd82f8f2c7a7056718eae1e8b5beca920fee |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJBQ0VDOjI5QUVFODoyRDU2MjAxOjNDNkZCQ0Q6NkIwMUQxQTciLCJ2aXNpdG9yX2lkIjoiMTUxNDQ1ODkzODQxMjc0OTIyMyIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 1fb9985a58a31911062b876baada636dd1f8d23398e240c1bf892b93d1a728f9 |
| hovercard-subject-tag | issue:349898006 |
| 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/26404/issue_layout |
| twitter:image | https://opengraph.githubassets.com/8ba3140f8e1b9ba0fbd339b4048d0f75d8b9504d9f41ffc0dc79e8afbfd56128/microsoft/TypeScript/issues/26404 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/8ba3140f8e1b9ba0fbd339b4048d0f75d8b9504d9f41ffc0dc79e8afbfd56128/microsoft/TypeScript/issues/26404 |
| og:image:alt | At VS Code, we has been sourcing data from MDN to get up-to-date documentation and compatibility info. One example is: https://code.visualstudio.com/updates/v1_25#_new-css-pseudo-selectors-and-pseu... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | octref |
| hostname | github.com |
| expected-hostname | github.com |
| None | cc5dfdd32f62ebd3223cab3af3aa2b268d3605218237326a48a99d1efd89495c |
| 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 | 8c77c9e8439031ad54c75a250694842892f693e1 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width