Skip to content
Schedule run ci internal

First commit for RTM 2.x #21

Sign in to view logs

First commit for RTM 2.x

First commit for RTM 2.x #21

GitHub Actions / Analysis of agora_rtm succeeded Aug 12, 2024 in 1m 12s

Package analysis results for agora_rtm

Score

130/160 points
(81.25%)

Supported platforms

  • Flutter
    • android
    • ios

Details

Follow Dart file conventions (20/30)

❌ 0/10 points: Provide a valid pubspec.yaml

The package has a git dependency.

pubspec.yaml:19:5

   ╷
19 │ ┌     git:
20 │ │       url: https://github.com/AgoraIO-Extensions/iris_method_channel_flutter.git
21 │ │       ref: littlegnal/exception-builder
22 │ └ 
   ╵

The pub site doesn't allow git dependencies.

Failed to verify repository URL.

Please provide a valid repository URL in pubspec.yaml, such that:

  • repository can be cloned,
  • a clone of the repository contains a pubspec.yaml, which:,
    • contains name: agora_rtm,
    • contains a version property, and,
    • does not contain a publish_to property.

pubspec.yaml from the repository URL mismatch: expected https://github.com/AgoraIO-Extensions/Agora-Flutter-RTM-SDK but got https://github.com/AgoraIO/Flutter-RTM.

✔ 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 (10/20)

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

23 out of 559 API elements (4.1 %) have documentation comments.

Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API. Document at least 20% of the public API elements.

To highlight public API members missing documentation consider enabling the public_member_api_docs lint.

Some symbols that are missing documentation: agora_rtm, agora_rtm.AcquireLockResult, agora_rtm.AcquireLockResult.AcquireLockResult, agora_rtm.AcquireLockResult.channelName, agora_rtm.AcquireLockResult.channelType.

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

Because:

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

Because:

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

Because:

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

Pass static analysis (40/50)

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

Found 11 issues. Showing the first 2:

INFO: 'ignore' is deprecated and shouldn't be used. Use `includeFromJson` and `includeToJson` with a value of `false` instead.

lib/src/agora_rtm_base.dart:1170:36

     ╷
1170 │   @JsonKey(name: 'encryptionSalt', ignore: true)
     │                                    ^^^^^^
     ╵

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

INFO: 'ignore' is deprecated and shouldn't be used. Use `includeFromJson` and `includeToJson` with a value of `false` instead.

lib/src/agora_rtm_client.dart:137:29

    ╷
137 │   @JsonKey(name: 'message', ignore: true)
    │                             ^^^^^^
    ╵

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

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
async >=2.8.2 2.11.0 2.11.0
ffi >=1.1.2 2.1.2 2.1.2
flutter flutter 0.0.0 0.0.0
iris_method_channel littlegnal/exception-builder 2.1.1 2.1.1
json_annotation ^4.4.0 4.9.0 4.9.0
meta >=1.7.0 1.15.0 1.15.0
Transitive dependencies
Package Constraint Compatible Latest
characters - 1.3.0 1.3.0
collection - 1.18.0 1.19.0
flutter_web_plugins - 0.0.0 0.0.0
js - 0.7.1 0.7.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