Skip to content
Tests

Improve documentation #115

Sign in to view logs

Improve documentation

Improve documentation #115

GitHub Actions / Analysis of glance succeeded Oct 22, 2024 in 1m 5s

Package analysis results for glance

Score

160/160 points
(100.0%)

Supported platforms

  • Flutter
    • android
    • ios

Details

Follow Dart file conventions (30/30)

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

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

✔ 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

27 out of 32 API elements (84.4 %) have documentation comments.

Some symbols that are missing documentation: glance, glance.Glance.instance, glance.GlanceReporter.report, glance.GlanceWidgetBinding.onCheckJank, glance.GlanceWidgetBinding.traceFunctionCall.

✔ 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:glance/glance.dart that declares support for platforms: Android, iOS.
Package does not support platform `Linux`.

Because:

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

Because:

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

Because:

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

❌ 0/0 points: WASM compatibility

Package not compatible with runtime wasm

Because:

  • package:glance/glance.dart that imports:
  • package:glance/src/glance.dart that imports:
  • package:glance/src/glance_impl.dart that imports:
  • package:glance/src/sampler.dart that imports:
  • package:glance/src/collect_stack.dart that imports:
  • package:ffi/ffi.dart that imports:
  • package:ffi/src/utf8.dart that imports:
  • dart:ffi

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 (50/50)

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

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
ffi >=1.1.2 2.1.3 2.1.3
flutter flutter 0.0.0 0.0.0
meta >=1.8.0 1.15.0 1.16.0
Transitive dependencies
Package Constraint Compatible Latest
characters - 1.3.0 1.3.1
collection - 1.18.0 1.19.1
material_color_utilities - 0.11.1 0.12.0
sky_engine - 0.0.99 0.0.99
vector_math - 2.1.4 2.1.4

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