pen_api 0.2.3

  • Installing
  • Versions
  • 37

pen_api #

A programmatic API for pen. (a pubspec authoring tool)

This is intended for programatically handling the pubspec.yaml files of your packages with the development aid (and/or automatization) in mind.

Just go to the docs and begin!

Forked from den_api

0.1.2 #

  • improvements
  • maintenance
  • fixed bug in tests

0.1.1 #

  • fork from den_api original package

Use this package as a library

1. Depend on it

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

  pen_api: ^0.2.3

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 flutter packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:

import 'package:pen_api/pen_api.dart';
Version Uploaded Documentation Archive
0.2.3 Sep 3, 2018 Go to the documentation of pen_api 0.2.3 Download pen_api 0.2.3 archive
0.2.2 Sep 3, 2018 Go to the documentation of pen_api 0.2.2 Download pen_api 0.2.2 archive
0.2.1 Sep 3, 2018 Go to the documentation of pen_api 0.2.1 Download pen_api 0.2.1 archive
0.1.2 Dec 9, 2017 Go to the documentation of pen_api 0.1.2 Download pen_api 0.1.2 archive
0.1.1 Dec 2, 2017 Go to the documentation of pen_api 0.1.1 Download pen_api 0.1.1 archive
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
Learn more about scoring.

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

  • Dart: 2.2.0
  • pana: 0.12.14


Detected platforms: Flutter, other

Primary library: package:pen_api/pen_api.dart with components: io.

Health suggestions

Fix lib/src/pubspec.dart. (-1 points)

Analysis of lib/src/pubspec.dart reported 2 hints:

line 227 col 42: Use = to separate a named parameter from its default value.

line 283 col 42: Use = to separate a named parameter from its default value.

Fix lib/src/version_status.dart. (-1 points)

Analysis of lib/src/version_status.dart reported 2 hints:

line 15 col 21: Use = to separate a named parameter from its default value.

line 15 col 42: Use = to separate a named parameter from its default value.

Fix lib/src/bump.dart. (-0.50 points)

Analysis of lib/src/bump.dart reported 1 hint:

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

Fix additional 5 files with analysis or formatting issues.

Additional issues in the following files:

  • lib/pen_api.dart (Run dartfmt to format lib/pen_api.dart.)
  • lib/src/github_repo_description.dart (Run dartfmt to format lib/src/github_repo_description.dart.)
  • lib/src/package_dep.dart (Run dartfmt to format lib/src/package_dep.dart.)
  • lib/src/release_type.dart (Run dartfmt to format lib/src/release_type.dart.)
  • lib/src/yaml_edit.dart (Run dartfmt to format lib/src/yaml_edit.dart.)

Maintenance issues and suggestions

Prefer published dependencies. (-100 points)

The source code in a git repository is mutable and could disappear.

Use constrained dependencies. (-20 points)

The pubspec.yaml contains 1 dependency without version constraints. Specify version ranges for the following dependencies: github.

The package description is too short. (-11 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 pen_api.dart. Packages with multiple examples should provide example/

For more information see the pub package layout conventions.


Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.60.2 <3.0.0
contrast2 ^0.2.0 0.2.0+1
convert ^2.0.1 2.1.1
github 4.1.0
path >=1.3.0 <2.0.0 1.6.2
pub_package_data2 ^0.2.0 0.2.0
pub_semver >=1.1.0 <2.0.0 1.4.2
source_span >=1.0.3 <2.0.0 1.5.5
yaml >=2.0.1+1 <3.0.0 2.1.15
Transitive dependencies
async 2.2.0
charcode 1.1.2
collection 1.14.11
http 0.11.3+17 0.12.0+2
http_parser 3.1.3
json_annotation 2.2.0
logging 0.11.3+2
meta 1.1.7
string_scanner 1.0.4
term_glyph 1.1.0
typed_data 1.1.6
Dev dependencies
test ^1.3.0