| commit | 3602919f26bfce812f128f5ccfda7da21d77214b | [log] [tgz] |
|---|---|---|
| author | Michael Thomsen <mit@google.com> | Mon Sep 13 14:37:50 2021 +0200 |
| committer | Michael Thomsen <mit@google.com> | Mon Sep 13 14:37:50 2021 +0200 |
| tree | 47220c0469c997ed31a585c87acf9167bbef5fa7 | |
| parent | dfbb7392b9c7e36652153d1df7b1782d1b4366ef [diff] |
Expand readme
Support for working with Package Configuration files as described in the Package Configuration v2 design document.
A Dart package configuration file is used to resolve Dart package names (e.g. foobar) to Dart files containing the source code for that package (e.g. file:///Users/myuser/.pub-cache/hosted/pub.dartlang.org/foobar-1.1.0). The standard package configuration file is .dart_tool/package_config.json, and is written by the Dart tool when the command dart pub get is run.
The primary libraries of this package are
package_config.dart: Defines the PackageConfig class and other types needed to use package configurations, and provides functions to find, read and write package configuration files.
package_config_types.dart: Just the PackageConfig class and other types needed to use package configurations. This library does not depend on dart:io.
The package includes deprecated backwards compatible functionality to work with the .packages file. This functionality will not be maintained, and will be removed in a future version of this package.