Sam Rawlins
8546b2e4e6
The Spelunker class is only used by analyzer_testing's PubPackageResolutionTest class, and by a utility script. So I believe the best place for this class is in analyzer_testing, for two reasons: * Would we also move the utility script (`pkg/linter/tool/spelunk.dart`)? This is a script that lets you see a visual tree of the syntax nodes of a Dart script. It has been helpful to people writing lint rules, as it helps you understand how you need to walk up or down the tree to check conditions. Therefore, it will be at least as helpful to people writing analysis rules in analyzer plugins (the primary consumers of PubPackageResolutionTest). It doesn't need to live in `bin` (though that's one possibility). It can live in `analyzer_testing/tool`. * Then if the utility script lives in analyzer_testing, and PubPackageResolutionTest lives in analyzer_testing, and these are the sole consumers of Spelunker, it makes sense to move it into analyzer_testing. It does not need to be public API; just live in the source code. Change-Id: Id607091b35ab83c96b8cd73f0ece63923c934fb4 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/444240 Commit-Queue: Samuel Rawlins <srawlins@google.com> Reviewed-by: Paul Berry <paulberry@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>.