mtrust_api_guard 3.0.0
mtrust_api_guard: ^3.0.0 copied to clipboard

Published 2 days ago •

mtrust.io

SDKDart Flutter

PlatformAndroid iOS Linux macOS Windows

→

Metadata

A package to generate and compare API docs

More...

likes

120/ 160

pub points

340

downloads

We analyzed this package 30 hours 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.

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

142 out of 386 API elements (36.8 %) have documentation comments.

Some symbols that are missing documentation: api_change, api_change.ApiChange.annotation, api_change.ApiChange.changedValue, api_change.ApiChange.component, api_change.ApiChange.getMagnitude.

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

✓ Android
✓ iOS
✓ Windows
✓ Linux
✓ macOS

These platforms are not supported:

Package does not support platform `Web`.

Because:

package:mtrust_api_guard/mtrust_api_guard.dart that imports:
package:mtrust_api_guard/changelog_generator/changelog_generator.dart that imports:
package:mtrust_api_guard/logger.dart that imports:
package:mason_logger/mason_logger.dart that imports:
package:mason_logger/src/mason_logger.dart that imports:
package:mason_logger/src/terminal_overrides.dart that imports:
package:mason_logger/src/ffi/terminal.dart that imports:
package:mason_logger/src/ffi/windows_terminal.dart that imports:
package:win32/win32.dart that declares support for platforms: Windows.

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

Package does not support platform `Android`.

Because:

package:mtrust_api_guard/mtrust_api_guard.dart that imports:
package:mtrust_api_guard/changelog_generator/changelog_generator.dart that imports:
package:mtrust_api_guard/logger.dart that imports:
package:mason_logger/mason_logger.dart that imports:
package:mason_logger/src/mason_logger.dart that imports:
package:mason_logger/src/terminal_overrides.dart that imports:
package:mason_logger/src/ffi/terminal.dart that imports:
package:mason_logger/src/ffi/windows_terminal.dart that imports:
package:win32/win32.dart that declares support for platforms: Windows.

Package does not support platform `iOS`.

Because:

package:mtrust_api_guard/mtrust_api_guard.dart that imports:
package:mtrust_api_guard/changelog_generator/changelog_generator.dart that imports:
package:mtrust_api_guard/logger.dart that imports:
package:mason_logger/mason_logger.dart that imports:
package:mason_logger/src/mason_logger.dart that imports:
package:mason_logger/src/terminal_overrides.dart that imports:
package:mason_logger/src/ffi/terminal.dart that imports:
package:mason_logger/src/ffi/windows_terminal.dart that imports:
package:win32/win32.dart that declares support for platforms: Windows.

Package does not support platform `Linux`.

Because:

package:mtrust_api_guard/mtrust_api_guard.dart that imports:
package:mtrust_api_guard/changelog_generator/changelog_generator.dart that imports:
package:mtrust_api_guard/logger.dart that imports:
package:mason_logger/mason_logger.dart that imports:
package:mason_logger/src/mason_logger.dart that imports:
package:mason_logger/src/terminal_overrides.dart that imports:
package:mason_logger/src/ffi/terminal.dart that imports:
package:mason_logger/src/ffi/windows_terminal.dart that imports:
package:win32/win32.dart that declares support for platforms: Windows.

Package does not support platform `macOS`.

Because:

package:mtrust_api_guard/mtrust_api_guard.dart that imports:
package:mtrust_api_guard/changelog_generator/changelog_generator.dart that imports:
package:mtrust_api_guard/logger.dart that imports:
package:mason_logger/mason_logger.dart that imports:
package:mason_logger/src/mason_logger.dart that imports:
package:mason_logger/src/terminal_overrides.dart that imports:
package:mason_logger/src/ffi/terminal.dart that imports:
package:mason_logger/src/ffi/windows_terminal.dart that imports:
package:win32/win32.dart that declares support for platforms: Windows.

Pass static analysis

40 / 50

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

INFO: Missing type annotation.

bin/mtrust_api_guard.dart:11:1

   ╷
11 │ main(List<String> args) async {
   │ ^^^^
   ╵

To reproduce make sure you are using the lints_core and run dart analyze bin/mtrust_api_guard.dart

Running dart format failed:

Changed /tmp/pana_JHLWST/lib/doc_generator/detect_target_files.dart
Changed /tmp/pana_JHLWST/lib/models/doc_items.g.dart
Changed /tmp/pana_JHLWST/test/helpers/test_helpers.dart
Formatted 41 files (3 changed) in 0.07 seconds.
Could not format because the source could not be parsed:

line 16, column 44 of ../../pana_JHLWST/test/fixtures/app_v110/lib/src/api.dart: Expected an initializer.
   ╷
16 │   User.fromJson(Map<String, dynamic> json) :
   │                                            ^```

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
`analyzer`	`^7.4.5`	7.7.1	10.0.0
`args`	`^2.4.0`	2.7.0	2.7.0
`build`	`^2.4.1`	2.4.2	4.0.3
`build_config`	`^1.1.1`	1.2.0	1.2.0
`code_builder`	`^4.8.0`	4.11.1	4.11.1
`collection`	`^1.19.1`	1.19.1	1.19.1
`conventional`	`^0.4.0`	0.4.0	0.4.0
`crypto`	`^3.0.7`	3.0.7	3.0.7
`dart_style`	`^3.1.0`	3.1.1	3.1.3
`glob`	`^2.1.3`	2.1.3	2.1.3
`http`	`^1.4.0`	1.6.0	1.6.0
`json_annotation`	`^4.9.0`	4.9.0	4.9.0
`mason_logger`	`^0.3.3`	0.3.3	0.3.3
`path`	`^1.9.1`	1.9.1	1.9.1
`pub_semver`	`^2.2.0`	2.2.0	2.2.0
`yaml`	`^3.1.3`	3.1.3	3.1.3
`yaml_edit`	`^2.2.2`	2.2.3	2.2.3

Transitive dependencies

Package	Constraint	Compatible	Latest
`_fe_analyzer_shared`	-	85.0.0	93.0.0
`async`	-	2.13.0	2.13.0
`boolean_selector`	-	2.1.2	2.1.2
`built_collection`	-	5.1.1	5.1.1
`built_value`	-	8.12.1	8.12.1
`checked_yaml`	-	2.0.4	2.0.4
`convert`	-	3.1.2	3.1.2
`equatable`	-	2.0.8	2.0.8
`ffi`	-	2.1.5	2.1.5
`file`	-	7.0.1	7.0.1
`fixnum`	-	1.1.1	1.1.1
`http_parser`	-	4.1.2	4.1.2
`io`	-	1.0.5	1.0.5
`logging`	-	1.3.0	1.3.0
`matcher`	-	0.12.18	0.12.18
`meta`	-	1.17.0	1.17.0
`package_config`	-	2.2.0	2.2.0
`petitparser`	-	6.1.0	7.0.1
`pubspec_parse`	-	1.5.0	1.5.0
`source_span`	-	1.10.1	1.10.1
`stack_trace`	-	1.12.1	1.12.1
`stream_channel`	-	2.1.4	2.1.4
`string_scanner`	-	1.4.1	1.4.1
`term_glyph`	-	1.2.2	1.2.2
`test_api`	-	0.7.9	0.7.9
`typed_data`	-	1.4.0	1.4.0
`watcher`	-	1.2.1	1.2.1
`web`	-	1.1.1	1.1.1
`win32`	-	5.15.0	5.15.0