api_guide 1.1.7
api_guide: ^1.1.7 copied to clipboard

Published 8 months ago Dart 3 compatible• Latest: 1.1.8

SDKFlutter

PlatformAndroid iOS Linux macOS web Windows

→

Metadata

API Guide is package to generate API calls documentations like OpenAPI schema.

More...

likes

140/ 160

pub points

popularity

We analyzed this package in the last hour, and awarded it 140 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/Eng-Mouaz-M-AlShahmeh/api_guide/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: MIT.

Provide documentation

20 / 20

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

376 out of 378 API elements (99.5 %) have documentation comments.

Some symbols that are missing documentation: api_guide, api_guide.APIGuideFAQ.

10/10 points: Package has an example and has no issues with screenshots

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

Package not compatible with runtime wasm

Because:

package:api_guide/api_guide.dart that imports:
package:api_guide/src/presentation/presentation.dart that imports:
package:api_guide/src/presentation/widgets/helpers/markdown_widget.dart that imports:
package:flutter_markdown/flutter_markdown.dart that imports:
package:flutter_markdown/src/widget.dart that imports:
package:flutter_markdown/src/_functions_io.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

40 / 50

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

Found 20 issues. Showing the first 2:

INFO: 'MaterialStateProperty' is deprecated and shouldn't be used. Use WidgetStateProperty instead. Moved to the Widgets layer to make code available outside of Material. This feature was deprecated after v3.19.0-0.3.pre.

lib/src/presentation/widgets/helpers/close_dialog_btn.dart:19:24

   ╷
19 │       backgroundColor: MaterialStateProperty.all(
   │                        ^^^^^^^^^^^^^^^^^^^^^
   ╵

To reproduce make sure you are using the lints_core and run flutter analyze lib/src/presentation/widgets/helpers/close_dialog_btn.dart

lib/src/presentation/widgets/helpers/close_dialog_btn.dart:25:24

   ╷
25 │       foregroundColor: MaterialStateProperty.all(
   │                        ^^^^^^^^^^^^^^^^^^^^^
   ╵

To reproduce make sure you are using the lints_core and run flutter analyze lib/src/presentation/widgets/helpers/close_dialog_btn.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
`flutter`	`flutter`	0.0.0	0.0.0
`flutter_markdown`	`^0.6.20+1`	0.6.23	0.7.4+1
`flutter_riverpod`	`^2.4.10`	2.6.1	2.6.1
`markdown`	`^7.2.1`	7.2.2	7.2.2
`url_launcher`	`^6.2.5`	6.3.1	6.3.1

Transitive dependencies

Package	Constraint	Compatible	Latest
`args`	-	2.6.0	2.6.0
`characters`	-	1.3.0	1.3.1
`collection`	-	1.18.0	1.19.1
`flutter_web_plugins`	-	0.0.0	0.0.0
`material_color_utilities`	-	0.11.1	0.12.0
`meta`	-	1.15.0	1.16.0
`path`	-	1.9.1	1.9.1
`plugin_platform_interface`	-	2.1.8	2.1.8
`riverpod`	-	2.6.1	2.6.1
`sky_engine`	-	0.0.99	0.0.99
`stack_trace`	-	1.12.0	1.12.0
`state_notifier`	-	1.0.0	1.0.0
`url_launcher_android`	-	6.3.14	6.3.14
`url_launcher_ios`	-	6.3.1	6.3.1
`url_launcher_linux`	-	3.2.1	3.2.1
`url_launcher_macos`	-	3.2.1	3.2.1
`url_launcher_platform_interface`	-	2.3.2	2.3.2
`url_launcher_web`	-	2.3.3	2.3.3
`url_launcher_windows`	-	3.1.3	3.1.3
`vector_math`	-	2.1.4	2.1.4
`web`	-	1.1.0	1.1.0