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

Package ANAlysis for Dart
https://github.com/dart-lang/pana

analysis dart flutter

Last synced: 30 days ago
JSON representation

Package ANAlysis for Dart

• Host: GitHub
• URL: https://github.com/dart-lang/pana
• Owner: dart-lang
• License: bsd-3-clause
• Created: 2015-09-24T21:18:44.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-08-27T09:05:48.000Z (2 months ago)
• Last Synced: 2024-09-29T15:41:08.413Z (about 1 month ago)
• Topics: analysis, dart, flutter
• Language: Dart
• Homepage: https://pub.dev/packages/pana
• Size: 5.87 MB
• Stars: 205
• Watchers: 38
• Forks: 44
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

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

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](https://pub.dev/help/scoring#follow-dart-file-conventions)

* [Provide documentation](https://pub.dev/help/scoring#provide-documentation)

* [Support multiple platforms](https://pub.dev/help/scoring#platform-support)

* [Pass static analysis](https://pub.dev/help/scoring#pass-static-analysis)

* [Support up-to-date dependencies](https://pub.dev/help/scoring#support-up-to-date-dependencies)

Used by the [Dart Package site](https://pub.dev/).

## Use as an executable

### Installation

```console

dart pub global activate pana

```

### Usage

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

```

Usage: pana [] --hosted  []

       pana [] 

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 .

                               (defaults to "https://pub.dev")

  -l, --line-length            The line length to use with dart format.

      --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 ``.

```