dart2_fix 1.0.1

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • new50

Build Status

A tool to migrate API usage to Dart 2.

What does it do?

dart2_fix is a command line utility that can automatically migrate some Dart 1 API usages in your source code to Dart 2 ones. Currently, it focuses on updating deprecated constant names; for example:

  • update dart:convert's UTF8 to utf8
  • update dart:core's Duration.ZERO to Duration.zero
  • update dart:math's PI to pi

For more information about preparing your code for Dart 2, please see the Dart 2 migration guide.

How do I use it?

To install, run pub global activate dart2_fix. Then, from your project directory, run:

pub global run dart2_fix

When run without any arguments, it will check your project, but will not make changes; it'll indicate what would be changed if asked to make modifications. For example:

test/test/runner/load_suite_test.dart
  line 56 • Duration.ZERO => Duration.zero
  line 60 • Duration.ZERO => Duration.zero
  line 86 • Duration.ZERO => Duration.zero

test/tool/host.dart
  line 169 • JSON => json
  line 173 • JSON => json

Found 5 fixes in 2.3s.

To apply these fixes, run again using the --apply argument.

To actually modify your project source code, run with the --apply argument (pub global run dart2_fix --apply):

Updating test...

test/test/runner/load_suite_test.dart
  3 fixes applied for Duration.ZERO => Duration.zero

test/tool/host.dart
  2 fixes applied for JSON => json

Applied 5 fixes in 1.9s.

What about Flutter code?

To run this tool on Flutter code, use:

flutter packages pub global activate dart2_fix

then - to check your code - run:

flutter packages pub global run dart2_fix

and to apply fixes, run:

flutter packages pub global run dart2_fix --apply

Will this make all of my code Dart 2 compliant?

No. Currently this only fixes the renaming of various deprecated constant names. Some of the less uniform constant renamings are not handled by this tool. For example Endianness.BIG_ENDIAN has been renamed to Endian.big but this will not be caught. After running this tool, remaining issues can be found by running the dart analyzer (or flutter analyze) and fixing any deprecation warnings.

I'm getting new static (or runtime errors) after running dart2_fix, what went wrong?

This tool can't catch conflicts between the new constant names and any fields or local variables that you might have in scope. If you get new analysis warnings or runtime failures after running this tool, check to see whether one of the changes made has caused a naming conflict with something else in scope. The most common cause of this is having a local variable named json in a scope where JSON.decode gets renamed to json.decode. To help with fixing these kinds of conflicts, the following top level members have been added to dart:convert: jsonDecode, jsonEncode, base64Decode, base64Encode, and base64UrlEncode. These top level members are equivalent to json.decode, json.decode, etc, and can be used to avoid naming conflicts where required.

Features and bugs

Please file feature requests and bugs at the issue tracker.

1.0.1

Made the tool work under Dart 2 runtime semantics.

Updated when we print timing info for the tool.

Added an SDK lower bound of 2.0.0-dev.36.0.

Added a --verbose flag.

1.0.0+2

  • Fix an issue converting DateTime.AUGUST.

1.0.0+1

  • Fix an issue converting double.INFINITY.

1.0.0

  • Initial version.

1. Depend on it

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


dependencies:
  dart2_fix: "^1.0.1"

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter packages get

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

Version Uploaded Documentation Archive
1.0.1 Apr 3, 2018 Go to the documentation of dart2_fix 1.0.1 Download dart2_fix 1.0.1 archive
1.0.0+2 Mar 29, 2018 Go to the documentation of dart2_fix 1.0.0+2 Download dart2_fix 1.0.0+2 archive
1.0.0+1 Mar 28, 2018 Go to the documentation of dart2_fix 1.0.0+1 Download dart2_fix 1.0.0+1 archive
1.0.0 Mar 28, 2018 Go to the documentation of dart2_fix 1.0.0 Download dart2_fix 1.0.0 archive

Analysis

We analyzed this package on Apr 23, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.0.0-dev.49.0
  • pana: 0.10.6

Scores

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

Platforms

Detected platforms: Flutter, web, other

No platform restriction found in libraries.

Suggestions

  • The description is too short.

    Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.

  • Maintain an example.

    Create a short demo in the example/ directory to show how to use this package. Common file name patterns include: main.dart, example.dart or you could also use dart2_fix.dart.

  • Fix analysis and formatting issues.

    Analysis or formatting checks reported 2 hints.

    Strong-mode analysis of lib/src/deprecation_analysis_server.dart gave the following hint:

    line: 34 col: 10
    The value of the local variable 'hadServerError' isn't used.

    Strong-mode analysis of lib/src/deprecation_analyzer.dart gave the following hint:

    line: 35 col: 17
    'locateContexts' is deprecated and shouldn't be used.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.36.0 <2.0.0
analysis_server_lib ^0.1.4 0.1.4+1
analyzer 0.31.2-alpha.1 0.31.2-alpha.1
args ^1.4.0 1.4.2
cli_util ^0.1.2 0.1.2+1
intl ^0.15.0 0.15.6
path ^1.5.0 1.5.1
Transitive dependencies
async 2.0.6
charcode 1.1.1
collection 1.14.9
convert 2.0.1
crypto 2.0.2+1
csslib 0.14.1
front_end 0.1.0-alpha.11
glob 1.1.5
html 0.13.3
isolate 1.1.0 2.0.0
kernel 0.3.0-alpha.11
logging 0.11.3+1
meta 1.1.2
package_config 1.0.3
plugin 0.2.0+2
source_span 1.4.0
string_scanner 1.0.2
typed_data 1.1.5
utf 0.9.0+4
watcher 0.9.7+7
yaml 2.1.13
Dev dependencies
test ^0.12.0