Skip to content
test

docs: improve readme for pub dev #34

Sign in to view logs

docs: improve readme for pub dev

docs: improve readme for pub dev #34

GitHub Actions / Analysis of sbb_maps_flutter succeeded Nov 20, 2024 in 1m 23s

Package analysis results for sbb_maps_flutter

Score

145/160 points
(90.625%)

Supported platforms

  • Flutter
    • android
    • ios

Details

Follow Dart file conventions (25/30)

✔ 10/10 points: Provide a valid pubspec.yaml

❌ 0/5 points: Provide a valid README.md

Links in `README.md` should be well formed Unable to parse 4 image links.

README.md:2:62

  ╷
2 │ It is built on top of MapLibre and meant as a client for the <a href="(https://developer.sbb.ch/apis/journey-maps/information)">Journey Maps API</a>.
  │                                                              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  ╵

✔ 5/5 points: Provide a valid CHANGELOG.md

✔ 10/10 points: Use an OSI-approved license

Detected license: MIT.

Provide documentation (20/20)

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

244 out of 559 API elements (43.6 %) have documentation comments.

Some symbols that are missing documentation: sbb_maps_flutter, sbb_maps_flutter.AnnotationException, sbb_maps_flutter.AnnotationException.AnnotationException, sbb_maps_flutter.AnnotationException.msg, sbb_maps_flutter.MapCreatedCallback.

✔ 10/10 points: Package has an example

Platform support (20/20)

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

  • ✓ Android

  • ✓ iOS

These platforms are not supported:

Package does not support platform `Windows`.

Because:

  • package:sbb_maps_flutter/sbb_maps_flutter.dart that declares support for platforms: Android, iOS.
Package does not support platform `Linux`.

Because:

  • package:sbb_maps_flutter/sbb_maps_flutter.dart that declares support for platforms: Android, iOS.
Package does not support platform `macOS`.

Because:

  • package:sbb_maps_flutter/sbb_maps_flutter.dart that declares support for platforms: Android, iOS.
Package does not support platform `Web`.

Because:

  • package:sbb_maps_flutter/sbb_maps_flutter.dart that declares support for platforms: Android, iOS.

These issues are present but do not affect the score, because they may not originate in your package:

Package does not support platform `Android`.

Because:

  • package:sbb_maps_flutter/sbb_maps_flutter.dart that imports:
  • package:sbb_maps_flutter/src/sbb_map/sbb_map.dart that imports:
  • package:sbb_maps_flutter/src/sbb_map_locator/sbb_map_locator_impl.dart that imports:
  • package:sbb_maps_flutter/src/sbb_map_locator/geolocator_facade.dart that imports:
  • package:geolocator/geolocator.dart that imports:
  • package:geolocator_web/web_settings.dart that declares support for platforms: Web.
Package does not support platform `iOS`.

Because:

  • package:sbb_maps_flutter/sbb_maps_flutter.dart that imports:
  • package:sbb_maps_flutter/src/sbb_map/sbb_map.dart that imports:
  • package:sbb_maps_flutter/src/sbb_map_locator/sbb_map_locator_impl.dart that imports:
  • package:sbb_maps_flutter/src/sbb_map_locator/geolocator_facade.dart that imports:
  • package:geolocator/geolocator.dart that imports:
  • package:geolocator_web/web_settings.dart that declares support for platforms: Web.

❌ 0/0 points: WASM compatibility

Package not compatible with runtime wasm

Because:

  • package:sbb_maps_flutter/sbb_maps_flutter.dart that imports:
  • package:sbb_maps_flutter/src/sbb_map/sbb_map.dart that imports:
  • package:sbb_maps_flutter/src/sbb_map_poi/controller/sbb_rokas_poi_controller_impl.dart that imports:
  • dart:io

This package is not compatible with runtime wasm, and will not be rewarded full points in a future version of the scoring model.

See https://dart.dev/web/wasm for details.

Pass static analysis (40/50)

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

Found 14 issues. Showing the first 2:

/tmp/pana_DQXRLP/lib/src/sbb_map/sbb_map_properties.dart doesn't match the Dart formatter.

To format your files run: dart format .

/tmp/pana_DQXRLP/lib/src/sbb_map_annotator/rokas_icons/rokas_icon_identifier.dart doesn't match the Dart formatter.

To format your files run: dart format .

Support up-to-date dependencies (40/40)

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

Package Constraint Compatible Latest
collection ^1.17.1 1.18.0 1.19.1
flutter flutter 0.0.0 0.0.0
geolocator >=12.0.0 <14.0.0 13.0.2 13.0.2
logger ^2.0.2+1 2.5.0 2.5.0
maplibre_gl ^0.20.0 0.20.0 0.20.0
Transitive dependencies
Package Constraint Compatible Latest
archive - 3.6.1 3.6.1
characters - 1.3.0 1.3.1
crypto - 3.0.6 3.0.6
fixnum - 1.1.1 1.1.1
flutter_web_plugins - 0.0.0 0.0.0
geolocator_android - 4.6.1 4.6.1
geolocator_apple - 2.3.8+1 2.3.8+1
geolocator_platform_interface - 4.2.4 4.2.4
geolocator_web - 4.1.1 4.1.1
geolocator_windows - 0.2.3 0.2.3
image - 4.3.0 4.3.0
js - 0.7.1 0.7.1
maplibre_gl_platform_interface - 0.20.0 0.20.0
maplibre_gl_web - 0.20.0 0.20.0
material_color_utilities - 0.11.1 0.12.0
meta - 1.15.0 1.16.0
path - 1.9.1 1.9.1
petitparser - 6.0.2 6.0.2
plugin_platform_interface - 2.1.8 2.1.8
sky_engine - 0.0.99 0.0.99
sprintf - 7.0.0 7.0.0
typed_data - 1.4.0 1.4.0
uuid - 4.5.1 4.5.1
vector_math - 2.1.4 2.1.4
web - 1.1.0 1.1.0
xml - 6.5.0 6.5.0

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

✔ 20/20 points: Compatible with dependency constraint lower bounds

pub downgrade does not expose any static analysis error.

Versions

View more details on GitHub Actions