Skip to main content

New pub package layout

Today, Bob Nystrom, one of the pub engineers, posted details about the new pub package layout. Time to use the new layout for your packages!

Bob writes:


If you live on bleeding_edge, pub now supports the new package layout conventions that avoid the nasty circular symlinks.

Pub also still supports the old style too, simultaneously. It works like this:
  1. When pub is generating a symlink to a package it determines if it's an old style or new style package. The presence of a .dart file at the top level (aside from build.dart) indicates that it's an old style package.
  2. If it's an old style package, pub symlinks to the package's root directory.
  3. If it's a new style package, it looks for a "lib" directory inside that package and symlinks to that.
  4. It will also generate a self link, but only for new style packages.
So, if you have:

myapp/
  pubspec.yaml -> depends on old_style and new_style
  lib/
    app.dart

old_style/
  old_style.dart

new_style/
  lib/
    new_style.dart

You run "pub install" on myapp, and you'll get:

myapp/
  pubspec.yaml -> depends on old_style and new_style
  lib/
    app.dart
  packages/
    myapp/ -> symlink to myapp/lib/
      app.dart
    old_style/ -> symlink to old_style/
      old_style.dart
    new_style/ -> symlink to new_style/lib/
      new_style.dart

Note that inside packages/ everything looks like you want and your imports should be unchanged. What this means is that if some package you depend on migrates from the old to the new style, it's shouldn't affect you. The next time you update that package, it will magically do the right thing.

All of the SDK packages that come with Dart are still using the old style, but we'll be updating those over the next couple of weeks. Around M1, I will remove support for the old layout. If you haven't updated your package by then, it will stop working.

Let me know if you have questions/comments/complaints/sonnets. You can read more about the pub package layout recommendation.


As always, you can join the discussion at the Dart mailing list, and post questions to Stack Overflow.

Popular posts from this blog

Dart in 2016: The fastest growing programming language at Google, 2nd fastest growing in TIOBE Index

Dart was the fastest growing programming language at Google in 2016 with millions of lines of code written. It also made it to TIOBE Index Top 20 this month (see TIOBE's methodology).

It takes time to build something as ambitious as Dart and, in some ways, Dart is still in its infancy. But we're glad the hard work is starting to pay off.

Many thanks to our amazing community!

We're going to celebrate by ... releasing 1.22 next week (as per our usual 6 week release schedule).

AngularDart is going all Dart

Until now, the multiple language flavors of Angular 2 were written as TypeScript source, and then automatically compiled to both JavaScript and Dart. We're happy to announce that we’re splitting the Angular 2 codebase into two flavors – a Dart version and a TypeScript/JavaScript version – and creating a dedicated AngularDart team.

This is amazing news for Dart developers because:

The framework will feel more like idiomatic Dart.It will make use of Dart features that couldn't work with the TypeScript flavor. It will be faster.
This is equally great news for our TypeScript and JavaScript developers, by the way. Cleaner API, performance gains, easier contributions. Read more on the Angular blog.

Angular 2 for Dart is used by many teams at Google. Most famously by the AdWords team, but many other Google teams build large, mobile-friendly web apps. Some of the top requests from these teams were: make the API feel like Dart, provide a faster edit-refresh cycle, and improve applicat…

The new AdWords UI uses Dart — we asked why

Google just announced a re-designed AdWords experience. In case you’re not familiar with AdWords: businesses use it to advertise on google.com and partner websites. Advertising makes up majority of Google’s revenue, so when Google decides to completely redo the customer-facing front end to it, it’s a big deal. The Dart team is proud to say that this new front end is built with Dart and Angular 2. Whenever you asked us whether Google is ‘even using Dart for anything,’ this is what we had in mind but couldn’t say aloud. Until now. We asked Joshy Joseph, the primary technical lead on the project, some questions. Joshy is focusing on things like infrastructure, application latency and development velocity, so he’s the right person to ask about Dart.Q: What exactly did we launch on Monday?It’s a complete redesign of the AdWords customer experience that is rolling out slowly as a test to a small initial set of advertisers. The most noticeable thing is probably the Material Design look and f…