Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc] daily update 2024-11-24 #2109

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

[doc] daily update 2024-11-24

e4b582c
Select commit
Loading
Failed to load commit list.
Sign in for the full log view
Open

[doc] daily update 2024-11-24 #2109

[doc] daily update 2024-11-24
e4b582c
Select commit
Loading
Failed to load commit list.
GitHub Actions / Analysis of agora_rtc_engine succeeded Nov 24, 2024 in 1m 24s

Package analysis results for agora_rtc_engine

Score

150/160 points
(93.75%)

Supported platforms

  • Flutter
    • android
    • ios
    • windows
    • macos
    • web

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

1426 out of 1457 API elements (97.9 %) have documentation comments.

Some symbols that are missing documentation: agora_rtc_engine, agora_rtc_engine.AudioEncodedFrameObserverPositionExt, agora_rtc_engine.AudioSessionOperationRestrictionExt, agora_rtc_engine.ScreenCaptureFramerateCapabilityExt, agora_rtc_engine.VideoViewController.addInitializedCompletedListener.

✔ 10/10 points: Package has an example

Platform support (20/20)

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

  • ✓ Android

  • ✓ iOS

  • ✓ Windows

  • ✓ macOS

  • ✓ Web

These platforms are not supported:

Package does not support platform `Linux`.

Because:

  • package:agora_rtc_engine/agora_rtc_engine.dart that declares support for platforms: Android, iOS, Windows, macOS, Web.

✔ 0/0 points: WASM compatibility

This package is compatible with runtime wasm, and will be rewarded additional 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 44 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_base.dart:3414:28

     ╷
3414 │   @JsonKey(name: 'buffer', ignore: true)
     │                            ^^^^^^
     ╵

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

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

lib/src/agora_base.dart:6172:39

     ╷
6172 │   @JsonKey(name: 'encryptionKdfSalt', ignore: true)
     │                                       ^^^^^^
     ╵

To reproduce make sure you are using the lints_core and run flutter analyze lib/src/agora_base.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.12.0 2.12.0
ffi >=1.1.2 2.1.3 2.1.3
flutter flutter 0.0.0 0.0.0
flutter_web_plugins flutter 0.0.0 0.0.0
iris_method_channel >=2.2.0 2.2.2 2.2.2
js >=0.6.3 0.7.1 0.7.1
json_annotation ^4.4.0 4.9.0 4.9.0
meta ^1.7.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