shelf_routing_generator 1.0.0 copy "shelf_routing_generator: ^1.0.0" to clipboard
shelf_routing_generator: ^1.0.0 copied to clipboard

Generator for routing class methods with support for path parameters, query parameters, body and headers.

110/ 160
pub points
275
downloads

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

Passed report section
Follow Dart file conventions
30 / 30trigger folding of the section

Passed check 10/10 points: Provide a valid pubspec.yaml

Passed check 5/5 points: Provide a valid README.md

Passed check 5/5 points: Provide a valid CHANGELOG.md

Passed check 10/10 points: Use an OSI-approved license

Detected license: MIT.

Partially passed report section
Provide documentation
10 / 20trigger folding of the section

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

2 out of 40 API elements (5.0 %) 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: routing_builder, routing_builder.RoutingGenerator, routing_builder.RoutingGenerator.RoutingGenerator.new, routing_builder.routingBuilder, shelf_routing_generator.

Passed check 10/10 points: Package has an example

Failed report section
Platform support
20 / 20trigger folding of the section

Passed check 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_routing_generator/shelf_routing_generator.dart that imports:
  • package:shelf_routing_generator/src/route_header_handler.dart that imports:
  • package:source_gen/source_gen.dart that imports:
  • package:source_gen/src/utils.dart that imports:
  • package:build/build.dart that imports:
  • package:build/src/generate/run_post_process_builder.dart that imports:
  • package:build_runner_core/src/generate/run_post_process_builder.dart that declares support for platforms: Windows, Linux, macOS.
Package does not support platform `iOS`.

Because:

  • package:shelf_routing_generator/shelf_routing_generator.dart that imports:
  • package:shelf_routing_generator/src/route_header_handler.dart that imports:
  • package:source_gen/source_gen.dart that imports:
  • package:source_gen/src/utils.dart that imports:
  • package:build/build.dart that imports:
  • package:build/src/generate/run_post_process_builder.dart that imports:
  • package:build_runner_core/src/generate/run_post_process_builder.dart that declares support for platforms: Windows, Linux, macOS.
Package does not support platform `Web`.

Because:

  • package:shelf_routing_generator/shelf_routing_generator.dart that imports:
  • package:shelf_routing_generator/src/route_header_handler.dart that imports:
  • package:source_gen/source_gen.dart that imports:
  • package:source_gen/src/utils.dart that imports:
  • package:build/build.dart that imports:
  • package:build/src/generate/run_post_process_builder.dart that imports:
  • package:build_runner_core/src/generate/run_post_process_builder.dart that declares support for platforms: Windows, Linux, macOS.

Failed check 0/0 points: WASM compatibility

Package not compatible with runtime wasm

Because:

  • package:shelf_routing_generator/shelf_routing_generator.dart that imports:
  • package:shelf_routing_generator/src/route_header_handler.dart that imports:
  • package:source_gen/source_gen.dart that imports:
  • package:source_gen/src/utils.dart that imports:
  • package:build/build.dart that imports:
  • package:build/src/generate/run_post_process_builder.dart that imports:
  • package:build/src/builder/post_process_builder.dart that imports:
  • package:build/src/builder/builder.dart that imports:
  • package:build/src/builder/build_step.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.dev/web/wasm for details.

Partially passed report section
Pass static analysis
40 / 50trigger folding of the section

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

Found 29 issues. Showing the first 2:

INFO: 'package:analyzer/dart/element/element2.dart' is deprecated and shouldn't be used. Import element.dart instead.

lib/routing_builder.dart:3:1

  ╷
3 │ import 'package:analyzer/dart/element/element2.dart';
  │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  ╵

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

INFO: 'getMethod2' is deprecated and shouldn't be used. Use getMethod instead.

lib/routing_builder.dart:23:31

   ╷
23 │     final parserMethod = type.getMethod2('parse');
   │                               ^^^^^^^^^^
   ╵

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

Failed report section
Support up-to-date dependencies
10 / 40trigger folding of the section

Failed check 0/10 points: All of the package dependencies are supported in the latest version

Package Constraint Compatible Latest Notes
analyzer >=7.4.0 <9.0.0 8.2.0 8.2.0
build ^3.0.0 3.1.0 4.0.1
code_builder ^4.0.0 4.11.0 4.11.0
collection ^1.19.1 1.19.1 1.19.1
http_methods ^1.0.0 1.1.1 1.1.1
recase ^4.1.0 4.1.0 4.1.0
shelf ^1.4.2 1.4.2 1.4.2
shelf_router ^1.1.4 1.1.4 1.1.4
shelf_routing ^1.0.0 1.0.0 1.0.0
source_gen ^3.0.0 3.1.0 4.0.1
Transitive dependencies
Package Constraint Compatible Latest Notes
_fe_analyzer_shared - 89.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_config - 1.2.0 1.2.0
build_daemon - 4.0.4 4.0.4
build_resolvers - 3.0.3 3.0.4 Discontinued
build_runner - 2.7.1 2.9.0
build_runner_core - 9.3.1 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
convert - 3.1.2 3.1.2
crypto - 3.0.6 3.0.6
dart_style - 3.1.2 3.1.2
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_multi_server - 3.2.2 3.2.2
http_parser - 4.1.2 4.1.2
io - 1.0.5 1.0.5
json_annotation - 4.9.0 4.9.0
logging - 1.3.0 1.3.0
matcher - 0.12.17 0.12.17
meta - 1.17.0 1.17.0
mime - 2.0.0 2.0.0
package_config - 2.2.0 2.2.0
path - 1.9.1 1.9.1
pool - 1.5.2 1.5.2
pub_semver - 2.2.0 2.2.0
pubspec_parse - 1.5.0 1.5.0
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
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.4 1.1.4
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

To reproduce run dart pub outdated --no-dev-dependencies --up-to-date --no-dependency-overrides.

The constraint `^3.0.0` on build does not support the stable version `4.0.0`.

Try running dart pub upgrade --major-versions build to update the constraint.

The constraint `^3.0.0` on source_gen does not support the stable version `4.0.0`.

Try running dart pub upgrade --major-versions source_gen to update the constraint.

Passed check 10/10 points: Package supports latest stable Dart and Flutter SDKs

Failed check 0/20 points: Compatible with dependency constraint lower bounds

downgrade analysis failed failed with 16 errors:

  • CONST_INITIALIZED_WITH_NON_CONSTANT_VALUE - lib/src/route_header_handler.dart:6:27 - Const variables must be initialized with a constant value.
  • UNDEFINED_METHOD - lib/src/route_header_handler.dart:6:39 - The method 'typeNamed' isn't defined for the type 'TypeChecker'.
  • CONST_INITIALIZED_WITH_NON_CONSTANT_VALUE - lib/src/utils.dart:11:22 - Const variables must be initialized with a constant value.

Run dart pub downgrade and then dart analyze to reproduce the above problem.

You may run dart pub upgrade --tighten to update your dependency constraints, see dart.dev/go/downgrade-testing for details.

Analyzed with Pana 0.22.23, Dart 3.9.3.

Check the analysis log for details.

Weekly downloads

Display as:
By versions:
1
likes
110
points
275
downloads

Publisher

unverified uploader

Weekly Downloads

Generator for routing class methods with support for path parameters, query parameters, body and headers.

Homepage
Repository (GitHub)
View/report issues

Documentation

API reference

License

MIT (license)

Dependencies

analyzer, build, code_builder, collection, http_methods, recase, shelf, shelf_router, shelf_routing, source_gen

More

Packages that depend on shelf_routing_generator