sample_package 0.0.1

  • Readme
  • Changelog
  • Installing
  • 43

A sample Dart library package. For more details, refer to tutorial which explains the structure of library folders

Usage #

A simple usage example:

import 'package:sample_package/lib1.dart';
import 'package:sample_package/lib2.dart';

main() {
  print('Versio n=$VERSION. Add: 1+2=${Adder().add(1,2)}');

Features and bugs #

Library commands #

Run example dart .\example\sample.dart Run test pub run .\test\test.dart Run publish (dry-run): pub publish --dry-run

1.0.0 #

  • Initial version, created by Stagehand

Use this package as a library

1. Depend on it

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

  sample_package: ^0.0.1

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:sample_package/lib1.dart';
import 'package:sample_package/lib2.dart';
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 Mar 27, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.1
  • pana: 0.13.6

Health issues and suggestions

Document public APIs. (-1 points)

6 out of 6 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.

Format lib/lib1.dart.

Run dartfmt to format lib/lib1.dart.

Format lib/lib2.dart.

Run dartfmt to format lib/lib2.dart.

Format lib/src/adder.dart.

Run dartfmt to format lib/src/adder.dart.

Format lib/src/constants.dart.

Run dartfmt to format lib/src/constants.dart.

Maintenance suggestions

The package description is too short. (-15 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.

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.

Package is getting outdated. (-6.85 points)

The package was last published 55 weeks ago.

Maintain an example.

None of the files in the package's example/ directory matches known example patterns.

Common filename patterns include main.dart, example.dart, and sample_package.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.1.0 <3.0.0
Dev dependencies
pedantic ^1.0.0
test ^1.0.0