w_common 1.17.0

  • README.md
  • Installing
  • Versions
  • 83

w_common #

A collection of helpful utilities for use in Dart projects. Right now, it includes the following:

  • Disposable interface / mixin to assist with cleaning up streams and other data structures that won't necessarily be garbage collected without some manual intervention.
  • A simple typedef that can be parameterized to represent a zero-arity callback that returns a particular type.
  • InvalidationMixin mixin used to mark a class as requiring validation.
  • JsonSerializable interface to indicate that something can be serialized to JSON.
  • A CSS compilation executable that can be run via
    pub run w_common:compile_sass
    
    from the root of your package that depends on w_common.
    • Run
      pub run w_common:compile_sass -h
      
      for more usage details / instructions.

We expect this list to grow as we identify small pieces of code that are useful across a wide variety of Dart projects, especially in cases where there is value in projects sharing a single implementation.

Use this package as a library

1. Depend on it

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


dependencies:
  w_common: ^1.17.0

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:w_common/w_common.dart';
  
Version Uploaded Documentation Archive
1.17.0 Apr 17, 2019 Go to the documentation of w_common 1.17.0 Download w_common 1.17.0 archive
1.16.0 Mar 11, 2019 Go to the documentation of w_common 1.16.0 Download w_common 1.16.0 archive
1.15.1 Feb 15, 2019 Go to the documentation of w_common 1.15.1 Download w_common 1.15.1 archive
1.15.0 Oct 2, 2018 Go to the documentation of w_common 1.15.0 Download w_common 1.15.0 archive
1.14.0 Oct 2, 2018 Go to the documentation of w_common 1.14.0 Download w_common 1.14.0 archive
1.13.0 Jun 19, 2018 Go to the documentation of w_common 1.13.0 Download w_common 1.13.0 archive
1.12.0 May 14, 2018 Go to the documentation of w_common 1.12.0 Download w_common 1.12.0 archive
1.11.2 Mar 9, 2018 Go to the documentation of w_common 1.11.2 Download w_common 1.11.2 archive
1.11.1 Jan 10, 2018 Go to the documentation of w_common 1.11.1 Download w_common 1.11.1 archive
1.11.0 Jan 2, 2018 Go to the documentation of w_common 1.11.0 Download w_common 1.11.0 archive

All 29 versions...

Popularity:
Describes how popular the package is relative to other packages. [more]
90
Health:
Code health derived from static analysis. [more]
89
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
60
Overall:
Weighted score of the above. [more]
83
Learn more about scoring.

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

  • Dart: 2.2.0
  • pana: 0.12.14

Platforms

Detected platforms: web

Primary library: package:w_common/w_common.dart with components: html.

Health suggestions

Fix lib/src/common/disposable.dart. (-4.41 points)

Analysis of lib/src/common/disposable.dart reported 9 hints, including:

line 470 col 12: 'isDisposedOrDisposing' is deprecated and shouldn't be used.

line 490 col 12: 'isDisposedOrDisposing' is deprecated and shouldn't be used.

line 539 col 12: 'isDisposedOrDisposing' is deprecated and shouldn't be used.

line 581 col 12: 'isDisposedOrDisposing' is deprecated and shouldn't be used.

line 587 col 12: 'isDisposedOrDisposing' is deprecated and shouldn't be used.

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

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

line 18 col 9: 'DisposableManager' is deprecated and shouldn't be used.

line 20 col 9: 'DisposableManagerV2' is deprecated and shouldn't be used.

line 22 col 9: 'DisposableManagerV3' is deprecated and shouldn't be used.

line 24 col 9: 'DisposableManagerV4' is deprecated and shouldn't be used.

line 26 col 9: 'DisposableManagerV5' is deprecated and shouldn't be used.

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

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

line 18 col 9: 'DisposableManager' is deprecated and shouldn't be used.

line 20 col 9: 'DisposableManagerV2' is deprecated and shouldn't be used.

line 22 col 9: 'DisposableManagerV3' is deprecated and shouldn't be used.

line 24 col 9: 'DisposableManagerV4' is deprecated and shouldn't be used.

line 26 col 9: 'DisposableManagerV5' is deprecated and shouldn't be used.

Fix lib/src/common/disposable_manager.dart. (-0.50 points)

Analysis of lib/src/common/disposable_manager.dart reported 1 hint:

line 296 col 47: 'DisposableManagerV6' is deprecated and shouldn't be used.

Fix lib/test_utils.dart. (-0.50 points)

Analysis of lib/test_utils.dart reported 1 hint:

line 20 col 71: Use = to separate a named parameter from its default value.

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.

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.

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

Common filename patterns include main.dart, example.dart, and w_common.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 >=1.24.3 <3.0.0
args ^1.5.1 1.5.1
dart2_constant ^1.0.0 1.0.2+dart2
glob ^1.1.7 1.1.7
intl >=0.14.0 <0.16.0 0.15.8
logging ^0.11.0 0.11.3+2
meta ^1.0.4 1.1.7
package_config ^1.0.3 1.0.5
package_resolver ^1.0.2 1.0.10
path ^1.5.1 1.6.2
sass ^1.6.0 1.19.0
source_maps ^0.10.5 0.10.8
Transitive dependencies
async 2.2.0
charcode 1.1.2
cli_repl 0.2.0+1
collection 1.14.11
http 0.12.0+2
http_parser 3.1.3
js 0.6.1+1
matcher 0.12.5
pedantic 1.5.0
quiver 2.0.3
source_span 1.5.5
stack_trace 1.9.3
stream_transform 0.0.17
string_scanner 1.0.4
term_glyph 1.1.0
tuple 1.0.2
typed_data 1.1.6
watcher 0.9.7+10
Dev dependencies
build_runner >=0.6.0 <1.0.0
build_test >=0.9.0 <1.0.0
build_web_compilers >=0.2.0 <1.0.0
dependency_validator ^1.2.2
mockito >=2.2.2 <4.0.0
test >=0.12.34 <2.0.0