phoenix_wings 1.0.2 copy "phoenix_wings: ^1.0.2" to clipboard
phoenix_wings: ^1.0.2 copied to clipboard

Phoenix Channel client for Dart

11
likes
105/ 140
pub points
81%
popularity

We analyzed this package 4 days ago, and awarded it 105 pub points (of a possible 140):

failed
Follow Dart file conventions
15 / 30trigger folding of the section

0/10 points: Provide a valid pubspec.yaml

The package description is too short.

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.

0/5 points: Provide a valid README.md

Links in `README.md` should be secure. 1 link is insecure.

README.md:74:1

   ╷
74 │ <a href="http://graemehill.ca/websocket-clients-and-phoenix-channels/">here</a> for more
   │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   ╵

Use https URLs instead.

5/5 points: Provide a valid CHANGELOG.md

10/10 points: Use an OSI-approved license

Detected license: MIT.

failed
Provide documentation
10 / 20trigger folding of the section

10/10 points: 20% or more of the public API has dartdoc comments

32 out of 150 API elements (21.3 %) have documentation comments.

Some symbols that are missing documentation: html, html.PhoenixHtmlConnection.close, html.PhoenixHtmlConnection.closeNormal, html.PhoenixHtmlConnection.isConnected, html.PhoenixHtmlConnection.onClose.

0/10 points: Package has an example

No example found.

See package layout guidelines on how to add an example.

OK
Platform support
20 / 20trigger folding of the section

20/20 points: Supports 5 of 6 possible platforms (iOS, Android, Web, Windows, macOS, Linux)

  • ✓ Android
  • ✓ iOS
  • ✓ Windows
  • ✓ Linux
  • ✓ macOS

These platforms are not supported:

Package not compatible with platform Web

Because:

  • package:phoenix_wings/phoenix_wings.dart that imports:
  • package:phoenix_wings/src/phoenix_socket.dart that imports:
  • package:phoenix_wings/src/phoenix_io_connection.dart that imports:
  • dart:io
partial
Pass static analysis
40 / 50trigger folding of the section

40/50 points: code has no errors, warnings, lints, or formatting issues

Found 10 issues. Showing the first 2:

INFO: Use the generic function type syntax in 'typedef's.

lib/src/phoenix_channel.dart:253:14

    ╷
253 │ typedef void PhoenixMessageCallback(Map? payload, String? ref, String? joinRef);
    │              ^^^^^^^^^^^^^^^^^^^^^^
    ╵

To reproduce make sure you are using the lints_core and run dart analyze lib/src/phoenix_channel.dart

INFO: Use the generic function type syntax in 'typedef's.

lib/src/phoenix_connection.dart:3:27

  ╷
3 │ typedef PhoenixConnection PhoenixConnectionProvider(String endpoint);
  │                           ^^^^^^^^^^^^^^^^^^^^^^^^^
  ╵

To reproduce make sure you are using the lints_core and run dart analyze lib/src/phoenix_connection.dart

OK
Support up-to-date dependencies
20 / 20trigger folding of the section

10/10 points: All of the package dependencies are supported in the latest version

No dependencies.

To reproduce run dart pub outdated --no-dev-dependencies --up-to-date --no-dependency-overrides.

10/10 points: Package supports latest stable Dart and Flutter SDKs

Analyzed with Pana 0.22.3, Dart 3.3.3.

Check the analysis log for details.

11
likes
105
pub points
81%
popularity

Publisher

unverified uploader

Phoenix Channel client for Dart

Repository (GitHub)
View/report issues

Documentation

API reference

License

MIT (LICENSE)

More

Packages that depend on phoenix_wings