Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dart-lang/pub

The pub command line tool
https://github.com/dart-lang/pub

Last synced: about 2 months ago
JSON representation

The pub command line tool

Awesome Lists containing this project

README 

        
[![Build Status](https://github.com/dart-lang/pub/workflows/Dart%20CI/badge.svg)](https://github.com/dart-lang/pub/actions/workflows/test.yaml?query=workflow%3A%22Dart+CI%22+branch%3Amaster)



Pub is the package manager for Dart.



# Contributing to pub



Thanks for being interested in contributing to pub! Contributing to a new

project can be hard: there's a lot of new code and practices to learn. This

document is intended to get you up and running as quickly as possible. For

more information, see the

[pub tool documentation](https://dart.dev/tools/pub/cmd).



The first step towards contributing is to contact the pub dev team and let us

know what you're working on, so we can be sure not to start working on the same

thing at the same time. Open an [issue](http://github.com/dart-lang/pub/issues/new)

letting us know that you're interested in contributing and what you plan on working on.

This will also let us give you specific advice about where to start.



## Organization



Pub isn't a package, but it's organized like one. It has four top-level

directories:



* `lib/` contains the implementation of pub. Currently, it's all in `lib/src/`,

  since there are no libraries intended for public consumption.



* `test/` contains the tests for pub.



* `bin/` contains `pub.dart`, the entrypoint script that's run whenever a user

  types "pub" on the command line or runs it in the Dart editor. This is usually

  run through shell scripts in `sdk/bin` at the root of the Dart repository.



It's probably easiest to start diving into the codebase by looking at a

particular pub command. Each command is encapsulated in files in

`lib/src/command/`.



## Running pub



To run pub from the Git repository, run:



    dart bin/pub.dart



## Testing pub



Before any change is made to pub, all tests should pass. To run a pub test, run:



    dart tool/test.dart test/path/to_test.dart



To run all tests at once, run:



    dart tool/test.dart



Changes to pub should be accompanied by one or more tests that exercise the new

functionality. When adding a test, the best strategy is to find a similar test

in `test/` and follow the same patterns.



Pub tests come in two basic forms. The first, which is usually used to unit test

classes and libraries internal to pub, has many tests in a single file. This is

used when each test will take a short time to run. For example,

`test/version_test.dart` contains unit tests for pub's Version class.



The other form, used by most pub tests, is usually used for integration tests of

user-visible pub commands. Each test has a file to itself, which is named after

the test description. This is used when tests can take a long time to run to

avoid having the tests time out when running on the build bots. For example,

`tests/get/hosted/get_transitive_test.dart` tests the resolution of transitive

hosted dependencies when using `dart pub get`/`flutter pub get`.



## Landing your patch



All patches to official Dart packages, including to pub, need to undergo code

review before they're submitted. The full process for putting up your patch for

review is [documented elsewhere][contributing].



[contributing]: https://github.com/dart-lang/sdk/blob/main/CONTRIBUTING.md