tree: f1c4ed18567011b2f887f6d1b2f67825dd6cf26f [path history] [tgz]
  1. generator/
  2. README.md
  3. renames.md
  4. scrape_mdn.dart
  5. update_bindings.dart
tool/README.md

Updating the package

The Dart code in this package is generated from Web IDL definitions and MDN API documentation.

Regenerating the package

To regenerate the package from the current IDL versions, run:

dart tool/update_bindings.dart

Updating the dartdoc info from MDN

package:web's dartdoc comments come from the MDN Web Docs project. In order to update to the latest version of the documentation, run:

dart tool/scrape_mdn.dart

That will collect the MDN documentation into third_party/mdn/mdn.json; changes to that file should be committed to git. You'll need to run tool/update_bindings.dart to produce Dart code using the updated documentation.

Updating to use the latest Web IDL versions

To re-generate the package from newer IDL versions, you can either run:

dart tool/update_bindings.dart --update

or, edit manually edit tool/generator/package.json to use specific IDL versions, and re-run tool/update_bindings.dart.

Web IDL versions

Based on:

ItemVersion
@webref/css6.11.0
@webref/elements2.2.2
@webref/idl3.43.1

For instructions on re-generating the DOM bindings, see the generator docs.