shelf_open_api_generator 2.0.0 copy "shelf_open_api_generator: ^2.0.0" to clipboard
shelf_open_api_generator: ^2.0.0 copied to clipboard

Published 12 months ago Dart 3 compatible
SDKDart
PlatformLinuxmacOSWindows
→

Metadata

Open api specs generators from dart code for shelf package.

More...

3
likes
130/ 160
pub points
201
downloads

We analyzed this package 2 days ago, and awarded it 130 pub points (of a possible 160):

failed
Follow Dart file conventions
20 / 30trigger folding of the section

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 60 to 180 characters to describe the package, what it does, and its target use case.

Issue tracker URL doesn't exist.

At the time of the analysis https://github.com/BreX900/open_api/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.

OK
Provide documentation
20 / 20trigger folding of the section

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

5 out of 16 API elements (31.3 %) have documentation comments.

Some symbols that are missing documentation: shelf_open_api_generator, shelf_open_api_generator.OpenApiBuilder, shelf_open_api_generator.OpenApiBuilder.OpenApiBuilder, shelf_open_api_generator.OpenApiBuilder.config, shelf_open_api_generator.buildOpenApi.

10/10 points: Package has an example

failed
Platform support
20 / 20trigger folding of the section

20/20 points: Supports 3 of 6 possible platforms (iOS, Android, Web, Windows, macOS, Linux)

  • ✓ Windows

  • ✓ Linux

  • ✓ macOS

These platforms are not supported:

Package not compatible with platform Android

Because:

  • package:shelf_open_api_generator/shelf_open_api_generator.dart that imports:
  • package:source_gen/source_gen.dart that imports:
  • package:source_gen/src/type_checker.dart that imports:
  • dart:mirrors
Package not compatible with platform iOS

Because:

  • package:shelf_open_api_generator/shelf_open_api_generator.dart that imports:
  • package:source_gen/source_gen.dart that imports:
  • package:source_gen/src/type_checker.dart that imports:
  • dart:mirrors
Package not compatible with platform Web

Because:

  • package:shelf_open_api_generator/shelf_open_api_generator.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

0/0 points: WASM compatibility

Package not compatible with runtime wasm

Because:

  • package:shelf_open_api_generator/shelf_open_api_generator.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.

partial
Pass static analysis
40 / 50trigger folding of the section

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

Found 13 issues. Showing the first 2:

INFO: 'enclosingElement' is deprecated and shouldn't be used. Use enclosingElement3 instead.

lib/shelf_open_api_generator.dart:71:74

   ╷
71 │           ConstantReader(_routesType.firstAnnotationOf(executableElement.enclosingElement));
   │                                                                          ^^^^^^^^^^^^^^^^
   ╵

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

INFO: 'enclosingElement' is deprecated and shouldn't be used. Use enclosingElement3 instead.

lib/src/handlers/route_handler.dart:33:34

   ╷
33 │     final classElement = element.enclosingElement as ClassElement;
   │                                  ^^^^^^^^^^^^^^^^
   ╵

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

OK
Support up-to-date dependencies
30 / 40trigger folding of the section

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

Package Constraint Compatible Latest
analyzer >=5.12.0 <7.0.0 6.11.0 7.1.0
build ^2.3.1 2.4.2 2.4.2
collection ^1.17.1 1.19.1 1.19.1
glob ^2.1.1 2.1.2 2.1.2
json_annotation ^4.8.0 4.9.0 4.9.0
open_api_specification ^1.0.0 1.0.0 1.0.0
shelf ^1.4.0 1.4.2 1.4.2
shelf_open_api ^1.0.0 1.1.0 1.1.0
shelf_router ^1.1.3 1.1.4 1.1.4
source_gen ^1.2.7 1.5.0 2.0.0
stream_transform ^2.1.0 2.1.1 2.1.1
Transitive dependencies
Package Constraint Compatible Latest
_fe_analyzer_shared - 76.0.0 78.0.0
_macros - 0.3.3 0.3.3
args - 2.6.0 2.6.0
async - 2.12.0 2.12.0
convert - 3.1.2 3.1.2
crypto - 3.0.6 3.0.6
dart_style - 2.3.7 3.0.1
file - 7.0.1 7.0.1
http - 1.2.2 1.2.2
http_methods - 1.1.1 1.1.1
http_parser - 4.1.1 4.1.1
logging - 1.3.0 1.3.0
macros - 0.1.3-main.0 0.1.3-main.0
meta - 1.16.0 1.16.0
package_config - 2.1.1 2.1.1
path - 1.9.1 1.9.1
pub_semver - 2.1.5 2.1.5
source_span - 1.10.1 1.10.1
stack_trace - 1.12.1 1.12.1
stream_channel - 2.1.3 2.1.3
string_scanner - 1.4.1 1.4.1
term_glyph - 1.2.2 1.2.2
typed_data - 1.4.0 1.4.0
watcher - 1.1.1 1.1.1
web - 1.1.0 1.1.0
yaml - 3.1.3 3.1.3

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

The constraint `>=5.12.0 <7.0.0` on analyzer does not support the stable version `7.0.0`.

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

The constraint `^1.2.7` on source_gen does not support the stable version `2.0.0`, that was published 3 days ago.

When source_gen is 30 days old, this package will no longer be awarded points in this category.

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

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

20/20 points: Compatible with dependency constraint lower bounds

pub downgrade does not expose any static analysis error.

Analyzed with Pana 0.22.17, Dart 3.6.0.

Check the analysis log for details.

← Metadata

3
likes
130
points
201
downloads

Publisher

unverified uploader

Weekly Downloads

Metadata

Open api specs generators from dart code for shelf package.

Repository (GitHub)
View/report issues

Documentation

API reference

License

MIT (license)

Dependencies

analyzer, build, collection, glob, json_annotation, open_api_specification, shelf, shelf_open_api, shelf_router, source_gen, stream_transform

More

Packages that depend on shelf_open_api_generator

Back