mineral 1.3.0
mineral: ^1.3.0 copied to clipboard

Published 2 years ago •

mineral-foundation.orgDart 3 compatible• Latest: 3.2.0 / Prerelease: 4.0.0-dev.5

SDKDart

PlatformLinux macOS Windows

outdated

→

Metadata

Mineral is a Discord framework for designing discord bots in Dart.

More...

likes

110/ 160

pub points

52%

popularity

We analyzed this package 39 hours ago, and awarded it 110 pub points (of a possible 160):

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

0 / 20

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

170 out of 1179 API elements (14.4 %) 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: api.Activity, api.Activity.Activity, api.Activity.Activity.from, api.Activity.applicationId, api.Activity.createdAt.

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 3 of 6 possible platforms (iOS, Android, Web, Windows, macOS, Linux)

✓ Windows
✓ Linux
✓ macOS

These platforms are not supported:

Package does not support platform `Android`.

Because:

package:mineral/api.dart that declares support for platforms: Windows, Linux, macOS.

Package does not support platform `iOS`.

Because:

package:mineral/api.dart that declares support for platforms: Windows, Linux, macOS.

Package does not support platform `Web`.

Because:

package:mineral/api.dart that declares support for platforms: Windows, Linux, macOS.

These issues are present but do not affect the score, because they may not originate in your package:

Package does not support platform `Linux`.

Because:

package:mineral/api.dart that imports:
package:mineral/src/internal/extensions/collection.dart that imports:
package:mineral/src/exceptions/not_exist.dart that imports:
package:mineral/console.dart that imports:
package:mineral/core.dart that imports:
package:mineral/src/internal/kernel.dart that imports:
package:mineral/src/commands/make_store.dart that imports:
package:interact/interact.dart that imports:
package:interact/src/spinner.dart that imports:
package:interact/src/utils/utils.dart that imports:
package:interact/src/framework/framework.dart that imports:
package:dart_console/dart_console.dart that imports:
package:dart_console/src/console.dart that imports:
package:dart_console/src/ffi/win/termlib_win.dart that imports:
package:win32/win32.dart that declares support for platforms: Windows.

Package does not support platform `macOS`.

Because:

package:mineral/api.dart that imports:
package:mineral/src/internal/extensions/collection.dart that imports:
package:mineral/src/exceptions/not_exist.dart that imports:
package:mineral/console.dart that imports:
package:mineral/core.dart that imports:
package:mineral/src/internal/kernel.dart that imports:
package:mineral/src/commands/make_store.dart that imports:
package:interact/interact.dart that imports:
package:interact/src/spinner.dart that imports:
package:interact/src/utils/utils.dart that imports:
package:interact/src/framework/framework.dart that imports:
package:dart_console/dart_console.dart that imports:
package:dart_console/src/console.dart that imports:
package:dart_console/src/ffi/win/termlib_win.dart that imports:
package:win32/win32.dart that declares support for platforms: Windows.

0/0 points: WASM compatibility

Package not compatible with runtime wasm

Because:

package:mineral/api.dart that imports:
package:mineral/src/internal/extensions/collection.dart that imports:
package:mineral/src/exceptions/not_exist.dart that imports:
package:mineral/src/internal/managers/reporter_manager.dart that imports:
dart:io

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

30 / 50

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

Found 194 issues. Showing the first 2:

WARNING: Unused import: 'package:mineral/src/api/emoji.dart'.

lib/src/api/forum_tag.dart:2:8

  ╷
2 │ import 'package:mineral/src/api/emoji.dart';
  │        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  ╵

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

WARNING: The value of the field '_emojiId' isn't used.

lib/src/api/forum_tag.dart:8:19

  ╷
8 │   final Snowflake _emojiId;
  │                   ^^^^^^^^
  ╵

To reproduce make sure you are using the lints_core and run dart analyze lib/src/api/forum_tag.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
`args`	`^2.3.1`	2.6.0	2.6.0
`collection`	`^1.16.0`	1.19.1	1.19.1
`http`	`^0.13.4`	0.13.6	1.2.2
`interact`	`^2.1.1`	2.2.0	2.2.0
`mineral_ioc`	`^1.0.0`	1.0.0	2.0.0
`path`	`^1.8.2`	1.9.1	1.9.1

Transitive dependencies

Package	Constraint	Compatible	Latest
`async`	-	2.12.0	2.12.0
`characters`	-	1.3.1	1.3.1
`clock`	-	1.1.2	1.1.2
`dart_console`	-	1.2.0	4.1.1
`ffi`	-	2.1.3	2.1.3
`http_parser`	-	4.1.1	4.1.1
`intl`	-	0.18.1	0.20.0
`meta`	-	1.16.0	1.16.0
`source_span`	-	1.10.0	1.10.0
`string_scanner`	-	1.4.0	1.4.0
`term_glyph`	-	1.2.1	1.2.1
`tint`	-	2.0.1	2.0.1
`typed_data`	-	1.4.0	1.4.0
`win32`	-	5.8.0	5.8.0