openwebdocs/project

mdn-bcd-collector: Use unjs/runtime-compat to update node/deno compat data in BCD

queengooborg opened this issue · 0 comments

queengooborg commented

Problem statement

Node.js and Deno compat data is currently not automatically updated in BCD and therefore outdated data is sometimes shown on MDN Web Docs.

Proposed solutions

A sister project to BCD by UnJS, runtime-compat-data (hereby referred to as RCD), uses parts of the collector to run tests and generate data.

We should use RCD and bring back the nodejs and deno data to BCD.

Task list

  • Update runtime-compat to internally use the collector's format unjs/runtime-compat#110
  • Update the useragent parser to accept a slightly custom UA format used in runtime-compat (done to prevent incorrect UA parsing) openwebdocs/mdn-bcd-collector#1436
  • Perform one of the following...
    • Update the documentation about update-bcd to reference runtime-compat
    • Update runtime-compat to automatically submit a PR to the collector's results repo
  • Start updating BCD according to the results

Priority assessment

  • Effort: Setup - minimal, updating BCD - large
  • Dependencies: https://github.com/unjs/runtime-compat
  • Community enablement: We're working with the UnJS community. They use OWD's collector project to maintain the data on https://runtime-compat.unjs.io
  • Momentum: High; https://twitter.com/tomlienard/status/1769738096893894892
  • Enabling learners: See "Addressing needs of the web industry"
  • Enabling professionals: See "Addressing needs of the web industry"
  • Underrepresented topics / Ethical web: N/A
  • Operational necessities: None
  • Addressing needs of the web industry: Just like browsers with the mdn-bcd-collector on its own, provides accurate, up-to-date info about JS runtimes on MDN Web Docs and BCD consumers

More information

Open Web Docs (OWD) is a non-profit collective funded by corporate and individual donations.

In order for this project to happen, please consider donating to OWD at https://opencollective.com/open-web-docs.
For more information on sponsorship and membership tiers, see https://openwebdocs.org/membership/

More information is available at https://openwebdocs.org/.
For questions, please reach out to florian@openwebdocs.org.