modrinth_api 0.1.0
modrinth_api: ^0.1.0 copied to clipboard

Published 2 years ago •

hihiqy1.nlDart 3 compatible

SDKDart Flutter

PlatformAndroid iOS Linux macOS web Windows

→

Metadata

An unofficial Modrinth library for Dart.

More...

likes

120/ 160

pub points

downloads

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

Follow Dart file conventions

20 / 30

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

The package description is too short.

Add more detail to the description field of pubspec.yaml. Use 50 to 180 characters to describe the package, what it does, and its target use case.

Issue tracker URL doesn't exist.

At the time of the analysis https://github.com/hihiqy1/modrinth_api_dart/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: Apache-2.0.

Provide documentation

10 / 20

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

226 out of 361 API elements (62.6 %) have documentation comments.

Some symbols that are missing documentation: modrinth_api, modrinth_api.Badges.Badges.new, modrinth_api.Badges.alphaTester, modrinth_api.Badges.contributor, modrinth_api.Badges.earlyModpackAdopter.

0/10 points: Package has an example

No example found.

See package layout guidelines on how to add 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

40 / 50

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

Found 32 issues. Showing the first 2:

INFO: 'bodyUrl' is deprecated and shouldn't be used. The link to the long description of the project. Always null, only kept for legacy compatibility.

lib/src/core/project/project.dart:173:398

    ╷
173 │     return "Project(slug: $slug, title: $title, description: $description, categories: $categories, clientSide: $clientSide, serverSide: $serverSide, body: $body, issuesUrl: $issuesUrl, sourceUrl: $sourceUrl, wikiUrl: $wikiUrl, discordUrl: $discordUrl, donationUrls: $donationUrls, type: $type, downloads: $downloads, iconUrl: $iconUrl, color: $color, id: $id, team: $team, bodyUrl (DEPRECATED): $bodyUrl, moderatorMessage: $moderatorMessage, published: $published, updated: $updated, approved: $approved, followers: $followers, status: $status, license: $license, versions: $versions, gameVersions: $gameVersions, loaders: $loaders, gallery: $gallery)";
    │                                                                                                                                                                                                                                                                                                                                                            
[...]

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

INFO: 'changelogUrl' is deprecated and shouldn't be used. A link to the changelog for this version. Always null, only kept for legacy compatibility.

lib/src/core/version/version.dart:110:398

    ╷
110 │     return "Version(name: $name, versionNumber: $versionNumber, changelog: $changelog, dependencies: $dependencies, gameVersions: $gameVersions, releaseChannel: $releaseChannel, loaders: $loaders, featured: $featured, status: $status, requestedStatus: $requestedStatus, id: $id, projectId: $projectId, authorId: $authorId, published: $published, downloads: $downloads, changelogUrl (DEPRECATED): $changelogUrl, files: $files)";
    │                                                                                                                                                                                                                                                                                                                                                                                                              ^^^^^^^^^^^^
    ╵

To reproduce make sure you are using the lints_core and run dart analyze lib/src/core/version/version.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	Notes
`collection`	`^1.17.1`	1.19.1	1.19.1
`http`	`^0.13.5`	0.13.6	1.4.0

Transitive dependencies

Package	Constraint	Compatible	Latest
`async`	-	2.13.0	2.13.0
`http_parser`	-	4.1.2	4.1.2
`meta`	-	1.17.0	1.17.0
`path`	-	1.9.1	1.9.1
`source_span`	-	1.10.1	1.10.1
`string_scanner`	-	1.4.1	1.4.1
`term_glyph`	-	1.2.2	1.2.2
`typed_data`	-	1.4.0	1.4.0