stanza 0.0.3

stanza #

Use this package as a library

1. Depend on it

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


dependencies:
  stanza: ^0.0.3

2. Install it

You can install packages from the command line:

with pub:


$ pub get

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

3. Import it

Now in your Dart code, you can use:


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

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

  • Dart: 2.5.1
  • pana: 0.12.21

Platforms

Detected platforms: other

Primary library: package:stanza/stanza.dart with components: io, mirrors.

Health issues and suggestions

Document public APIs. (-1 points)

55 out of 55 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/src/shared/where_clause.dart. (-4.41 points)

Analysis of lib/src/shared/where_clause.dart reported 9 hints, including:

line 29 col 54: Use = to separate a named parameter from its default value.

line 29 col 80: Use = to separate a named parameter from its default value.

line 30 col 9: Use isNotEmpty instead of length

line 38 col 52: Use = to separate a named parameter from its default value.

line 38 col 78: Use = to separate a named parameter from its default value.

Fix lib/src/stanza.dart. (-2.96 points)

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

line 34 col 12: Don't type annotate initializing formals.

line 34 col 54: Don't type annotate initializing formals.

line 36 col 64: Use = to separate a named parameter from its default value.

line 36 col 81: Use = to separate a named parameter from its default value.

line 54 col 67: Use = to separate a named parameter from its default value.

Fix lib/src/shared/where_operations.dart. (-1.99 points)

Analysis of lib/src/shared/where_operations.dart reported 4 hints:

line 91 col 51: Use = to separate a named parameter from its default value.

line 98 col 54: Use = to separate a named parameter from its default value.

line 105 col 52: Use = to separate a named parameter from its default value.

line 112 col 52: Use = to separate a named parameter from its default value.

Fix additional 23 files with analysis or formatting issues. (-4.50 points)

Additional issues in the following files:

  • lib/src/select/order_by_clause.dart (2 hints)
  • lib/src/select_query.dart (2 hints)
  • lib/src/insert_query.dart (1 hint)
  • lib/src/name_converter.dart (1 hint)
  • lib/src/query.dart (1 hint)
  • lib/src/query_result.dart (1 hint)
  • lib/src/update_query.dart (1 hint)
  • lib/annotations.dart (Run dartfmt to format lib/annotations.dart.)
  • lib/src/adapter_field.dart (Run dartfmt to format lib/src/adapter_field.dart.)
  • lib/src/annotations.dart (Run dartfmt to format lib/src/annotations.dart.)
  • lib/src/exception.dart (Run dartfmt to format lib/src/exception.dart.)
  • lib/src/field.dart (Run dartfmt to format lib/src/field.dart.)
  • lib/src/insert/insert_clause.dart (Run dartfmt to format lib/src/insert/insert_clause.dart.)
  • lib/src/postgres_credentials.dart (Run dartfmt to format lib/src/postgres_credentials.dart.)
  • lib/src/query_clause.dart (Run dartfmt to format lib/src/query_clause.dart.)
  • lib/src/select/group_by_clause.dart (Run dartfmt to format lib/src/select/group_by_clause.dart.)
  • lib/src/select/limit_clause.dart (Run dartfmt to format lib/src/select/limit_clause.dart.)
  • lib/src/select/select_clause.dart (Run dartfmt to format lib/src/select/select_clause.dart.)
  • lib/src/shared/where_package.dart (Run dartfmt to format lib/src/shared/where_package.dart.)
  • lib/src/table.dart (Run dartfmt to format lib/src/table.dart.)
  • lib/src/update/set_clause.dart (Run dartfmt to format lib/src/update/set_clause.dart.)
  • lib/src/value_substitution.dart (Run dartfmt to format lib/src/value_substitution.dart.)
  • lib/stanza.dart (Run dartfmt to format lib/stanza.dart.)

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.

Support latest dependencies. (-10 points)

The version constraint in pubspec.yaml does not support the latest published versions for 1 dependency (json_annotation).

The package description is too short. (-20 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

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 stanza.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
bottom_line ^0.0.3 0.0.4
json_annotation ^2.4.0 2.4.0 3.0.0
pool ^1.4.0 1.4.0
postgres ^2.0.0-dev1.0 2.0.0-dev1.0
Transitive dependencies
async 2.4.0
buffer 1.0.6
charcode 1.1.2
collection 1.14.12
convert 2.1.1
crypto 2.1.3
path 1.6.4
stack_trace 1.9.3
typed_data 1.1.6
uuid 2.0.2
Dev dependencies
build_runner any
json_serializable ^3.0.0