dart-sdk/pkg
Srujan Gaddam 81ba8a2583 [pkg:js] Add documentation for @staticInterop, @JSExport, and export APIs
Adds information and examples of usage and limitations for
@staticInterop classes, the new @JSExport annotation, createDartExport,
and createStaticInteropMock.

Change-Id: I2b4cafc8ff2a201ab2057399e638babbebe151a2
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/265004
Reviewed-by: Sigmund Cherem <sigmund@google.com>
Commit-Queue: Srujan Gaddam <srujzs@google.com>
Reviewed-by: Riley Porter <rileyporter@google.com>
2022-10-26 16:34:38 +00:00
..
_fe_analyzer_shared Prepare to publish analyzer 5.2.0 and _fe_analyzer_shared 50.0.0 2022-10-25 21:03:37 +00:00
_js_interop_checks [pkg:js] Rename export and mock transformers and separate them 2022-10-26 16:34:38 +00:00
analysis_server Use FooImpl in BarImpl getters/setters, property related. 2022-10-26 03:49:43 +00:00
analysis_server_client Remove domain 'kythe' from DAS. 2022-10-21 17:03:29 +00:00
analyzer Use FooImpl in BarImpl getters/setters, property related. 2022-10-26 03:49:43 +00:00
analyzer_cli Deprecate buildSdkSummary2(), use buildSdkSummary() instead. 2022-10-24 22:32:48 +00:00
analyzer_plugin Extend change builder to support imports with a prefix 2022-10-25 20:59:45 +00:00
analyzer_utilities
async_helper
build_integration
compiler [pkg:js] Rename export and mock transformers and separate them 2022-10-26 16:34:38 +00:00
dart2js_info
dart2js_runtime_metrics
dart2js_tools
dart2native
dart2wasm [pkg:js] Rename export and mock transformers and separate them 2022-10-26 16:34:38 +00:00
dart_internal
dartdev [ CLI ] Fix dart run --enable-experiment 2022-10-18 13:42:32 +00:00
dds [dds/dap] Allow debug adapters to register multiple mappings for org-dartland-sdk URIs 2022-10-26 14:26:01 +00:00
dds_service_extensions
dev_compiler [pkg:js] Rename export and mock transformers and separate them 2022-10-26 16:34:38 +00:00
expect
front_end [cfe] Handle function calls and null shorting on record types 2022-10-26 14:44:56 +00:00
frontend_server Use NnbdMode.Strong for frontend_server/ binary protocol. 2022-10-19 21:40:13 +00:00
js [pkg:js] Add documentation for @staticInterop, @JSExport, and export APIs 2022-10-26 16:34:38 +00:00
js_ast
js_runtime
js_shared
kernel [pkg:js] Refactor mock creation to export creation 2022-10-24 17:37:09 +00:00
language_versioning_2_7_test
meta
modular_test
native_stack_traces
nnbd_migration Deprecate xyz2 in elements. 2022-10-21 22:07:47 +00:00
scrape
smith [testing] Remove --compiler=none from test.py 2022-10-19 08:09:58 +00:00
sourcemap_testing
status_file
telemetry
test_runner [test_runner] Use constructor to detect async main 2022-10-25 19:33:38 +00:00
testing
vm [vm/aot] Support dynamic record field access in TFA 2022-10-19 17:49:47 +00:00
vm_service
vm_snapshot_analysis
wasm_builder
.gitignore
BUILD.gn
OWNERS
pkg.status
README.md

Package validation

The packages in pkg/ are automatically validated on the LUCI CI bots. The validation is largely done by the tools/package_deps package; it can be tested locally via:

dart tools/package_deps/bin/package_deps.dart

Packages which are published

There are several packages developed in pkg/ which are published to pub. Validation of these packages is particularly important because the pub tools are not used for these packages during development; we get our dependency versions from the DEPS file. Its very easy for the dependencies specified in a package's pubspec file to get out of date wrt the packages and versions actually used.

In order to better ensure we're publishing correct packages, we validate some properties of the pubspec files on our CI system. These validations include:

  • that the dependencies listed in the pubspec are used in the package
  • that all the packages used by the source are listed in the pubspec
  • that we don't use relative path deps to pkg/ or third_party/ packages

Packages which are not published

For packages in pkg/ which we do not intend to be published, we put the following comment in the pubspec.yaml file:

# This package is not intended for consumption on pub.dev. DO NOT publish.
publish_to: none

These pubspecs are still validated by the package validation tool. The contents are more informational as the pubspecs for these packages are not consumed by the pub tool or ecosystem.

We validate:

  • that the dependencies listed in the pubspec are used in the package
  • that all the packages used by the source are listed in the pubspec
  • that a reference to a pkg/ package is done via a relative path dependency