Command-line tool to provide null-safety percentage info of a project

by Flutter Awesome

null_safety_percentage

Command-line tool to provide null-safety percentage info of a project. Track your migration progress on mixed-version programs that execute with unsound null safety.

Important links

Motivation

A Dart program can contain some libraries that are null safe and some that aren’t. These mixed-version programs execute with unsound null safety. – Dart: Unsound null safety

For smaller projects, migrating to null safety can be done in a matter of minutes.
Unfortunately, if you are not satisfied with the automatically migrated code and you want to do the migration on your own, the migration of large code-bases can take a while.

This command-line tool lets you track your progress of your null-safety migration.

Installation

Install the null_safety_percentage command-line tool either globally or as a dev dependency.

Global installation

If you install null_safety_percentage globally, you can execute it simply by typing null_safety_percentage lib test.

# Install globally
dart pub global activate null_safety_percentage
# or: flutter pub global activate null_safety_percentage

# Verify installation was successful
null_safety_percentage --help

As dev dependency

You can run Dart scripts from your dependencies using the dart run or flutter run command.

Flutter project

  1. Add null_safety_percentage to your dev_dependencies: flutter pub add -d null_safety_percentage.
  2. Run the script flutter run null_safety_percentage lib test. See more example in the “Usage” section below.

Dart project

  1. Add null_safety_percentage to your dev_dependencies: dart pub add -d null_safety_percentage.
  2. Run the script dart run null_safety_percentage lib test. See more example in the “Usage” section below.

Usage

Keep in mind that how you invoke the null_safety_percentage depends on how you installed it and whether you are using it from a Flutter or Dart project.
The usage examples below assume you installed the package globally.

# See usage and other info about the package
null_safety_percentage --help
null_safety_percentage -h

# One folder
null_safety_percentage lib

# Multiple folders
null_safety_percentage lib test

# Custom output format: JSON
null_safety_percentage --output-format=json lib test
null_safety_percentage --output-format json lib test

# Custom output format: ASCII (perfect with UNIX/Shell tools)
null_safety_percentage --output-format ascii lib test

# Get version info
null_safety_percentage --version

The tool supports multiple output formats, so for example if you want to add a check in your CI/CD tool to ensure that your “null-safety coverage percentage” metrics are not getting worse, you can use the “ascii” format, then take the metric you are interested in.

Caveats

The tool is in its early phases and is written so that it runs correctly on the projects I am working on.

Currently, the way the tool decides whether a file counts as migrated or not is pretty rudimentary.
I assume there must be better ways to get this information, but this approach worked well enough for me.
Improvements, recommendations are welcome.

The tool is not going to work on totally unmigrated libraries. I didn’t want to add safe-guards against that, so please make sure that the “input” project is at least partially migrated.

example

Don’t forget the project’s example folder for a project where you can test the command-line tool.

GitHub

View Github