shelf_api_builder 1.2.3
shelf_api_builder: ^1.2.3 copied to clipboard

Published 2 months ago •

skycoder42.de

SDKDart

PlatformLinux macOS Windows

→

Metadata

A code generator to create RESTful API endpoints to be integrated with shelf.

More...

likes

140/ 160

pub points

downloads

We analyzed this package 15 hours ago, and awarded it 140 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: BSD-3-Clause.

Provide documentation

20 / 20

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

2 out of 3 API elements (66.7 %) have documentation comments.

Some symbols that are missing documentation: shelf_api_builder.

10/10 points: Package has 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:shelf_api_builder/shelf_api_builder.dart that declares support for platforms: Windows, Linux, macOS.

Package does not support platform `iOS`.

Because:

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

Package does not support platform `Web`.

Because:

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

0/0 points: WASM compatibility

Package not compatible with runtime wasm

Because:

package:shelf_api_builder/shelf_api_builder.dart that imports:
package:shelf_api_builder/src/endpoint_generator.dart that imports:
package:shelf_api_builder/src/readers/shelf_api_reader.dart that imports:
package:shelf_api_builder/src/readers/middleware_reader.dart that imports:
package:shelf_api_builder/src/models/opaque_constant.dart that imports:
package:shelf_api_builder/src/models/opaque_type.dart that imports:
package:build/build.dart that imports:
package:build/src/generate/run_post_process_builder.dart that imports:
package:build/src/asset/reader.dart that imports:
package:glob/glob.dart that imports:
package:glob/src/list_tree.dart that imports:
package:file/file.dart that imports:
package:file/src/interface.dart that imports:
package:file/src/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.cn/web/wasm for details.

Pass static analysis

40 / 50

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

Found 49 issues. Showing the first 2:

INFO: 'ClassElement' is deprecated and shouldn't be used. Use ClassElement2 instead.

lib/src/analyzers/api_class_analyzer.dart:20:5

   ╷
20 │     ClassElement clazz,
   │     ^^^^^^^^^^^^
   ╵

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

INFO: 'MethodElement' is deprecated and shouldn't be used. Use MethodElement2 instead.

lib/src/analyzers/body_analyzer.dart:24:37

   ╷
24 │   Future<EndpointBody?> analyzeBody(MethodElement method) async {
   │                                     ^^^^^^^^^^^^^
   ╵

To reproduce make sure you are using the lints_core and run dart analyze lib/src/analyzers/body_analyzer.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
`analyzer`	`^7.6.0`	7.7.1	8.2.0
`build`	`^2.5.4`	2.5.4	4.0.1
`build_config`	`^1.1.2`	1.1.2	1.2.0
`code_builder`	`^4.10.1`	4.11.0	4.11.0
`meta`	`^1.16.0`	1.17.0	1.17.0
`path`	`^1.9.1`	1.9.1	1.9.1
`shelf`	`^1.4.2`	1.4.2	1.4.2
`shelf_api`	`^1.3.3`	1.3.3	1.3.3
`source_gen`	`^2.0.0`	2.0.0	4.0.1
`source_helper`	`^1.3.6`	1.3.7	1.3.8

Transitive dependencies

Package	Constraint	Compatible	Latest	Notes
`_fe_analyzer_shared`	-	85.0.0	89.0.0
`args`	-	2.7.0	2.7.0
`async`	-	2.13.0	2.13.0
`boolean_selector`	-	2.1.2	2.1.2
`build_daemon`	-	4.0.4	4.0.4
`build_resolvers`	-	2.5.4	3.0.4	Discontinued
`build_runner`	-	2.5.4	2.9.0
`build_runner_core`	-	9.1.2	9.3.2	Discontinued
`built_collection`	-	5.1.1	5.1.1
`built_value`	-	8.12.0	8.12.0
`checked_yaml`	-	2.0.4	2.0.4
`collection`	-	1.19.1	1.19.1
`convert`	-	3.1.2	3.1.2
`crypto`	-	3.0.6	3.0.6
`dart_style`	-	3.1.1	3.1.2
`dio`	-	5.9.0	5.9.0
`dio_web_adapter`	-	2.1.1	2.1.1
`file`	-	7.0.1	7.0.1
`fixnum`	-	1.1.1	1.1.1
`frontend_server_client`	-	4.0.0	4.0.0
`glob`	-	2.1.3	2.1.3
`graphs`	-	2.3.2	2.3.2
`http`	-	1.5.0	1.5.0
`http_methods`	-	1.1.1	1.1.1
`http_multi_server`	-	3.2.2	3.2.2
`http_parser`	-	4.1.2	4.1.2
`io`	-	1.0.5	1.0.5
`js`	-	0.7.2	0.7.2	Discontinued
`json_annotation`	-	4.9.0	4.9.0
`logging`	-	1.3.0	1.3.0
`matcher`	-	0.12.17	0.12.17
`mime`	-	2.0.0	2.0.0
`package_config`	-	2.2.0	2.2.0
`pool`	-	1.5.2	1.5.2
`pub_semver`	-	2.2.0	2.2.0
`pubspec_parse`	-	1.5.0	1.5.0
`riverpod`	-	2.6.1	3.0.1
`riverpod_annotation`	-	2.6.1	3.0.1
`rxdart`	-	0.28.0	0.28.0
`shelf_router`	-	1.1.4	1.1.4
`shelf_web_socket`	-	3.0.0	3.0.0
`source_span`	-	1.10.1	1.10.1
`stack_trace`	-	1.12.1	1.12.1
`state_notifier`	-	1.0.0	1.0.0
`stream_channel`	-	2.1.4	2.1.4
`stream_transform`	-	2.1.1	2.1.1
`string_scanner`	-	1.4.1	1.4.1
`term_glyph`	-	1.2.2	1.2.2
`test_api`	-	0.7.7	0.7.7
`timing`	-	1.0.2	1.0.2
`typed_data`	-	1.4.0	1.4.0
`watcher`	-	1.1.3	1.1.3
`web`	-	1.1.1	1.1.1
`web_socket`	-	1.0.1	1.0.1
`web_socket_channel`	-	3.0.3	3.0.3
`yaml`	-	3.1.3	3.1.3