wiggly_circle 1.0.0

  • Readme
  • Changelog
  • Installing
  • 46

wiggly_circle #

A custom paint widget that draws a wiggly circle.

Getting Started #

This project is a starting point for a Dart package, a library module containing code that can be shared easily across multiple Flutter or Dart projects.

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

1.0.0 - Initial release #

  • Initial release

Use this package as a library

1. Depend on it

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


dependencies:
  wiggly_circle: ^1.0.0

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support 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:wiggly_circle/wiggly_circle.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
5
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
69
Overall:
Weighted score of the above. [more]
46
Learn more about scoring.

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

  • Dart: 2.8.4
  • pana: 0.13.13
  • Flutter: 1.17.5

Analysis suggestions

Package not compatible with SDK dart

because of import path [wiggly_circle] that is in a package requiring null.

Maintenance issues and suggestions

Make sure dartdoc successfully runs on your package's source files. (-10 points)

exitCode: 255 stdout: Documenting wiggly_circle... Initialized dartdoc with 519 libraries in 100.8 seconds Generating docs for library wiggly_circle from package:wiggly_circle/wiggly_circle.dart... Generating docs for library wiggly_circle from package:wiggly_circle/movement_rule.dart... Validating docs... Documented 2 public libraries in 21.0 seconds stderr: warning: wiggly_circle has no library level documentation comments, from wiggly_circle: (file:///tmp/pub-dartlang-dartdocURTMPP/pkg/lib/movement_rule.dart:1:9) error: failed to write file at: wiggly_circle/wiggly_circle-library.html for symbol wiggly_circle: (file:///tmp/pub-dartlang-dartdocURTMPP/pkg/lib/movement_rule.dart:1:9) conflicting with file already generated by wiggly_circle: (file:///tmp/pub-dartlang-dartdocURTMPP/pkg/lib/wiggly_circle.dart:1:1) Dartdoc generates a path and filename to write to for each symbol. wiggly_circle conflicts with another symbol in the generated path, and therefore can not be written out. Changing the name, library name, or class name (if appropriate) of one of the conflicting items can resolve the conflict. Alternatively, use the @nodoc tag in one symbol's documentation comments to hide it. warning: unresolved doc reference [Equatables] from wiggly_circle.WigglyCircleMovementRule.props: (file:///tmp/pub-dartlang-dartdocURTMPP/pkg/lib/movement_rule.dart:25:20) in documentation inherited from equatable.Equatable.props: (file:///tmp/pub-cache-dirKEXEPN/hosted/pub.dartlang.org/equatable-1.2.0/lib/src/equatable.dart:22:20) warning: dartdoc generated a broken link to: wiggly_circle/WigglyCircle-class.html (from index.json) warning: dartdoc generated a broken link to: wiggly_circle/WigglyCircle/WigglyCircle.html (from index.json) warning: dartdoc generated a broken link to: wiggly_circle/WigglyCircle/color.html (from index.json) warning: dartdoc generated a broken link to: wiggly_circle/WigglyCircle/createState.html (from index.json) warning: dartdoc generated a broken link to: wiggly_circle/WigglyCircle/movementRule.html (from index.json) warning: dartdoc generated a broken link to: wiggly_circle/WigglyCircle/numberOfPoints.html (from index.json) warning: dartdoc generated a broken link to: wiggly_circle/WigglyCircle/strokeWidth.html (from index.json) found 9 warnings and 1 error Unhandled exception: dartdoc encountered 1 errors while processing. #0 Dartdoc.generateDocs (package:dartdoc/dartdoc.dart:225:9)

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 wiggly_circle.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.7.0 <3.0.0
equatable ^1.2.0 1.2.0
flutter 0.0.0
Transitive dependencies
collection 1.14.12 1.14.13
meta 1.1.8 1.2.1
sky_engine 0.0.99
typed_data 1.1.6 1.2.0
vector_math 2.0.8 2.1.0-nullsafety
Dev dependencies
flutter_test
mockito ^4.1.1
test any