json_ast 1.0.5

json_ast #

Build Status

A forgettable port of this javascript library. It is not elegant, it doesn't bring any pride to humanity.

Builds the AST (Abstract Syntax Tree) of a JSON string.

The good #

  • It works.
  • It is battle tested.
  • It could be worse (like not having anything at all).

The bad #

This library is a port from an existing javascript library. I wanted it to work but I wasn't aiming for perfection, that means:

  • Types are flimsy
  • Algorithms are not a jewel of modern programming.
  • I ported this library to use only one feature.

The ugly #

  • I would re-write the whole thing if I had any serious interest in this.

Use this package as a library

1. Depend on it

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


dependencies:
  json_ast: ^1.0.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:json_ast/json_ast.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
35
Health:
Code health derived from static analysis. [more]
95
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
70
Overall:
Weighted score of the above. [more]
60
Learn more about scoring.

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

  • Dart: 2.4.0
  • pana: 0.12.19

Platforms

Detected platforms: Flutter, web, other

No platform restriction found in primary library package:json_ast/json_ast.dart.

Health issues and suggestions

Document public APIs. (-0.77 points)

126 out of 127 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Fix lib/parse.dart. (-2.96 points)

Analysis of lib/parse.dart reported 6 hints, including:

line 17 col 19: Use isNotEmpty instead of length

line 55 col 18: Use contains instead of indexOf

line 326 col 7: Don't explicitly initialize variables to null.

line 337 col 17: Avoid using null in if null operators.

line 339 col 19: Avoid using null in if null operators.

Fix lib/error.dart. (-1 points)

Analysis of lib/error.dart reported 2 hints:

line 14 col 7: Don't explicitly initialize variables to null.

line 69 col 34: Equality operator == invocation with references of unrelated types.

Maintenance issues and suggestions

Provide a file named CHANGELOG.md. (-20 points)

Changelog entries help developers follow the progress of your package. See the example generated by stagehand.

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and json_ast.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.0.0 <3.0.0
grapheme_splitter ^1.0.0 1.0.0
Dev dependencies
path ^1.5.1
test ^1.3.0