dart-lang/pana

Build Status

A library for analyzing Dart packages. It invokes executables from the Dart SDK (or from the Flutter SDK if the package uses Flutter).

Reports are created in the following categories:

• Follow Dart conventions
• Provide documentation
• Support multiple platforms
• Pass static analysis
• Support up-to-date dependencies

Used by the Dart Package site.

Use as an executable

Installation

dart pub global activate pana

Usage

You can specify either a package (+ version) or a local directory to analyze:

Usage: pana [<options>] --hosted <published package name> [<version>]
       pana [<options>] <local directory>

Options:
      --dart-sdk               The directory of the Dart SDK.
      --flutter-sdk            The directory of the Flutter SDK.
      --exit-code-threshold    The exit code will indicate if (max - granted points) > threshold.
  -j, --json                   Output log records and full report as JSON.
      --hosted-url             The server that hosts <package>.
                               (defaults to "https://pub.dev")
      --hosted                 Download and analyze a hosted package (from https://pub.dev).
      --[no-]dartdoc           Run dartdoc and score the package on documentation coverage.
                               (defaults to on)
      --dartdoc-version        The dartdoc version to use: `sdk`, `latest` (default) or `<version constraint>`.
      --license-data           The path to the directory containing the SPDX license data.
      --project-root           The root directory path of the project (pub workspace or otherwise). Use this when the package is located in a subdirectory so pana can copy and analyze the entire project tree.