pubviz 2.5.5

  • Readme
  • Changelog
  • Installing
  • 50

Visualize package dependencies in your Dart project #

Build Status

Make sure you run pub get or pub upgrade in your target project directory.

Example #

Here's an example of pubviz run on itself.

Installing #

Activate pubviz.

$ pub global activate pubviz

Use #

If you have configured your PATH correctly, you can run pubviz directly.

$ pubviz

Otherwise you can use the pub global command.

$ pub global run pubviz

Generate and open an html file for the package on the current path. #

$ pubviz open

Should open your default browser to something like:

sample

$ pubviz --format=dot print /path/to/http_package

You should see output something like:

digraph G {
  node [fontname=Helvetica];
  edge [fontname=Helvetica, fontcolor=gray];

  http [label="http
0.9.2+3",fontsize=18,style=bold,shape=box,margin="0.25,0.15"];
  http -> path [label=">=0.9.0 <2.0.0",penwidth=2];
  http -> stack_trace [label=">=0.9.1 <0.10.0",penwidth=2];
  http -> unittest [label=">=0.9.0 <0.10.0",penwidth=2,style=dashed];

  path [label="path
1.0.0",shape=box,margin="0.25,0.15",style=bold];

  stack_trace [label="stack_trace
0.9.1",shape=box,margin="0.25,0.15",style=bold];
  stack_trace -> path [label=">=1.0.0-rc.1 <2.0.0"];

  unittest [label="unittest
0.9.3",style=bold];
  unittest -> stack_trace [label=">=0.9.0 <0.10.0",color=gray];
}

pubviz -? prints help

$ pubviz -?
Usage: pubviz [<args>] <command> [<package path>]

Commands:
  open   Populate a temporary file with the content and open it.
  print  Print the output to stdout.

Arguments:
  -f, --format=<format>
            [dot]               Generate a GraphViz dot file
            [html] (default)    Wrap the GraphViz dot format in an HTML template which renders it.

  -i, --ignore-packages         A comma seperated list of packages to exclude in the output.
  -o, --[no-]flag-outdated      Check pub.dev for lasted packages and flag those that are outdated.
  -?, --help                    Print this help content.

If <package path> is omitted, the current directory is used.

2.5.5 #

  • Update dependencies.

2.5.4 #

  • Improve the package description.

  • Update some dependencies.

2.5.3 #

  • Support Dart 2 stable.

2.5.2 #

  • Fixes for Dart 2 type system.

2.5.1 #

  • Stop using deprecated HTTP constants.

2.5.0 #

  • Use pkg:pubspec_parse package.

  • Stop using deprecated constants.

  • Improve handling of pre-release packages.

2.4.5 #

  • Fix for latest Flutter SDK.

2.4.4 #

  • Fixed code organization to eliminate warning during pub global activate.

2.4.3 #

  • Improvements in CLI error handling and help.

2.4.2 #

  • Updated output format.

  • And other cleanup...

2.4.1 #

  • Using nodesep=0.2 on the graph to make it tighter.

  • Hosted code

    • Much more robust handling of node clicks to add/remove.

    • Make it clear that nodes can be clicked by changing the cursor.

2.4.0 #

  • Better error output if a subprocess fails.

  • Try to handle flutter packages.

2.3.11 #

  • Better hover-over behavior for outdated dependencies.

2.3.10 #

  • Update gviz.

  • Support larger dependency graphs.

  • Update version of viz.js.

  • Use viz-lite.js – smaller download.

    • Continue to host vis.js so we don't break existing installations.

2.3.9+1 #

  • Use gviz package. Get out of the GraphViz formatting business.

2.3.9 #

  • Updated dependencies.

  • Fix case where we're pulling in a pre-release version that is after the latest stable version.

2.3.8 #

  • Send a descriptive user agent to the server.

  • Added retry logic for HTTP requests.

  • Sort the output.

2.3.7 #

  • Better stack trace on errors.

2.3.6 #

  • Cleanup, handled some deprecations, improve load time.

2.3.5 #

  • Tweaks test code, examples, dependencies.

2.3.4 #

  • Properly escape the latest version for outdated dependencies.

  • Add a reasonable tool-tip for the entire graph.

  • Don't show the root node as outdated.

2.3.3 #

  • Using CSS animations for effects. Hosting style on GitHub.

2.3.2 #

  • All fancy with mouse-over effects.

2.3.1+1 #

  • Fix README.md.

2.3.1 #

  • With --flag-outdated (-o) do version lookup in parallel. MUCH faster.

2.3.0 #

  • Allow ignoring packages via --ignore-packages. Thanks, Günter!

  • A fix for running on Windows. Thanks, Oliver!

  • A fix for formatting packages with hyphens. Thanks, Bryon!

Use this package as an executable

1. Install it

You can install the package from the command line:


$ pub global activate pubviz

2. Use it

The package has the following executables:


$ pubviz

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  pubviz: ^2.5.5

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:pubviz/pubviz.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
0
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
50
Learn more about scoring.

We analyzed this package on Oct 20, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.5.1
  • pana: 0.12.21

Platforms

Detected platforms: Flutter, other

Primary library: package:pubviz/pubviz.dart with components: io.

Maintenance suggestions

Maintain an example.

None of the files in the package's example/ directory matches known example patterns.

Common filename patterns include main.dart, example.dart, and pubviz.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.2.0 <3.0.0
args ^1.4.1 1.5.2
build_cli_annotations ^1.0.0 1.1.0
collection ^1.0.0 1.14.12
gviz ^0.3.0 0.3.0
http >=0.11.1+3 <0.13.0 0.12.0+2
io ^0.3.2+1 0.3.3
path ^1.0.0 1.6.4
pub_semver ^1.0.0 1.4.2
pubspec_parse ^0.1.0 0.1.5
stack_trace ^1.6.0 1.9.3
yaml ^2.0.0 2.2.0
Transitive dependencies
async 2.4.0
charcode 1.1.2
checked_yaml 1.0.2
http_parser 3.1.3
json_annotation 3.0.0
meta 1.1.7
source_span 1.5.5
string_scanner 1.0.5
term_glyph 1.1.0
typed_data 1.1.6
Dev dependencies
build_cli ^1.2.1
build_runner ^1.0.0
build_verify ^1.0.0
build_web_compilers >=1.0.0 <3.0.0
js ^0.6.1
pedantic ^1.1.0 1.8.0+1
test ^1.0.0
test_descriptor ^1.0.3
test_process ^1.0.1