audiobookshelf_api 0.2.0
audiobookshelf_api: ^0.2.0 copied to clipboard

Published 20 months ago Dart 3 compatible

SDKDart Flutter

PlatformAndroid iOS Linux macOS web Windows

→

Metadata

A Dart wrapper for the audiobookshelf API, a self-hosted audiobook and podcast server.

More...

likes

120/ 160

pub points

20%

popularity

We analyzed this package 2 days ago, and awarded it 120 pub points (of a possible 160):

Follow Dart file conventions

30 / 30

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

Issue tracker URL doesn't exist.

At the time of the analysis https://github.com/audiobookshelf-flutter/audiobookshelf_api/issues was unreachable. Make sure that the website is reachable via HEAD requests.

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: GPL-3.0.

Provide documentation

10 / 20

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

197 out of 2633 API elements (7.5 %) 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: audiobookshelf_api, audiobookshelf_api.AudibleSeries, audiobookshelf_api.AudibleSeries.AudibleSeries, audiobookshelf_api.AudibleSeries.AudibleSeries.fromJson, audiobookshelf_api.AudibleSeries.copyWith.

10/10 points: Package has an example

Platform support

20 / 20

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

✓ Android
✓ iOS
✓ Windows
✓ Linux
✓ 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

30 / 50

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

Found 425 issues. Showing the first 2:

WARNING: The annotation 'JsonSerializable' can only be used on classes.

lib/src/models/responses/change_password_response.dart:9:4

  ╷
9 │   @JsonSerializable(includeIfNull: false)
  │    ^^^^^^^^^^^^^^^^
  ╵

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

WARNING: The parameter type of '==' operators should be non-nullable.

lib/src/models/responses/generated/batch_update_item_response.freezed.dart:131:17

    ╷
131 │   bool operator ==(dynamic other) {
    │                 ^^
    ╵

To reproduce make sure you are using the lints_core and run dart analyze lib/src/models/responses/generated/batch_update_item_response.freezed.dart

Support up-to-date dependencies

30 / 40

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

Package	Constraint	Compatible	Latest
`freezed_annotation`	`^2.2.0`	2.4.4	2.4.4
`http`	`^0.13.5`	0.13.6	1.2.2
`http_parser`	`^4.0.2`	4.1.1	4.1.1
`json_annotation`	`^4.8.0`	4.9.0	4.9.0
`mime`	`^1.0.3`	1.0.6	2.0.0
`socket_io_client`	`^2.0.0`	2.0.3+1	3.0.1

Transitive dependencies

Package	Constraint	Compatible	Latest
`async`	-	2.12.0	2.12.0
`collection`	-	1.19.1	1.19.1
`js`	-	0.6.7	0.7.1
`logging`	-	1.3.0	1.3.0
`meta`	-	1.16.0	1.16.0
`path`	-	1.9.1	1.9.1
`socket_io_common`	-	2.0.3	3.0.1
`source_span`	-	1.10.0	1.10.0
`string_scanner`	-	1.4.0	1.4.0
`term_glyph`	-	1.2.1	1.2.1
`typed_data`	-	1.4.0	1.4.0