Paul Berry
3e195c913f
Some time ago, the analyzer team decided to adopt the convention of using `TODO` comments to document long term issues that should persist in the codebase, and `FIXME` comments to document short term issues that need immediate attention. Accordingly, it makes sense to suppress `TODO` comments from being surfaced to the IDE "problems" view (since there can be a lot of them, and they're not immediately actionable). This makes VSCode's "problems" view much more usable in "tree" mode. Previous CLs that have made this change in other packages: - https://dart-review.googlesource.com/c/sdk/+/295662 - https://dart-review.googlesource.com/c/sdk/+/325121 - https://dart-review.googlesource.com/c/sdk/+/358980 - https://dart-review.googlesource.com/c/sdk/+/410060 - https://dart-review.googlesource.com/c/sdk/+/440546 - https://dart-review.googlesource.com/c/sdk/+/442167 - https://dart-review.googlesource.com/c/sdk/+/443633 Change-Id: Ia7c7ce5e0ab0ac32d61d8a93319c363c6a6a6964 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/506321 Commit-Queue: Paul Berry <paulberry@google.com> Reviewed-by: Brian Wilkerson <brianwilkerson@google.com>
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. It's 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
Adding new packages
Run gclient sync to re-generate .dart_tool/package_config.json after adding
a new package.
Testing packages
Currently dart test can't be used to run the tests, use test.py as usual.
E.g. the command ./tools/test.py -n...<path> runs all tests with prefix
<path>.