revali_swagger 1.0.0
revali_swagger: ^1.0.0 copied to clipboard

Published 3 days ago

SDKDart Flutter

PlatformAndroid iOS Linux macOS Windows

→

Metadata

A Revali construct that generates OpenAPI 3.0 (Swagger) documentation from route metadata

More...

likes

120/ 160

pub points

downloads

We analyzed this package 2 days ago, and awarded it 120 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: MIT.

Provide documentation

0 / 20

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

4 out of 89 API elements (4.5 %) 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: openapi_builder, openapi_builder.buildOpenApiSpec, output_format, output_format.OutputFormat, param_location.

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 not compatible with platform Web

Because:

package:revali_swagger/builders/openapi_builder.dart that imports:
package:revali_swagger/models/swagger_server.dart that imports:
package:revali_swagger/models/swagger_controller.dart that imports:
package:revali_swagger/models/swagger_method.dart that imports:
package:revali_swagger/models/swagger_type.dart that imports:
package:revali_construct/revali_construct.dart that imports:
package:revali_construct/utils/type_from_iterable.dart that imports:
package:analyzer/dart/element/type.dart that imports:
package:analyzer/src/dart/element/type.dart that imports:
package:analyzer/src/utilities/extensions/element.dart that imports:
package:analyzer/src/dart/element/member.dart that imports:
package:analyzer/src/generated/utilities_dart.dart that imports:
package:analyzer/src/dart/element/element.dart that imports:
package:analyzer/src/summary2/linked_element_factory.dart that imports:
package:analyzer/src/summary2/export.dart that imports:
package:analyzer/src/summary2/library_builder.dart that imports:
package:analyzer/src/summary2/types_builder.dart that imports:
package:analyzer/src/summary2/link.dart that imports:
package:analyzer/src/summary2/variance_builder.dart that imports:
package:analyzer/src/summary2/record_type_builder.dart that imports:
package:analyzer/src/dart/element/type_visitor.dart that imports:
package:analyzer/src/summary2/named_type_builder.dart that imports:
package:analyzer/src/dart/element/type_system.dart that imports:
package:analyzer/src/generated/inference_log.dart that imports:
package:analyzer/src/generated/resolver.dart that imports:
package:analyzer/src/util/ast_data_extractor.dart that imports:
package:analyzer/dart/element/element.dart that imports:
package:analyzer/src/dart/resolver/scope.dart that imports:
package:analyzer/src/generated/engine.dart that imports:
package:analyzer/src/dart/analysis/analysis_options.dart that imports:
package:analyzer/src/lint/registry.dart that imports:
package:analyzer/src/analysis_rule/rule_context.dart that imports:
package:analyzer/analysis_rule/analysis_rule.dart that imports:
package:analyzer/src/analysis_rule/analysis_rule.dart that imports:
package:analyzer/src/lint/pub.dart that imports:
package:analyzer/source/file_source.dart that imports:
package:analyzer/file_system/file_system.dart that imports:
package:watcher/watcher.dart that imports:
package:watcher/src/file_watcher/polling.dart that imports:
package:watcher/src/polling.dart that imports:
dart:io

Pass static analysis

40 / 50

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

INFO: 'isSynthetic' is deprecated and shouldn't be used. Use isOriginX instead.

lib/models/swagger_type.dart:310:18

    ╷
310 │           !field.isSynthetic &&
    │                  ^^^^^^^^^^^
    ╵

To reproduce make sure you are using the lints_core and run dart analyze lib/models/swagger_type.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`	`^10.0.0`	10.2.0	14.0.0
`revali_construct`	`^2.2.0`	2.2.0	2.2.0
`revali_router_annotations`	`^2.2.0`	2.2.0	2.2.0
`revali_swagger_annotations`	`^1.0.0`	1.0.0	1.0.0

Transitive dependencies

Package	Constraint	Compatible	Latest
`_fe_analyzer_shared`	-	96.0.0	104.0.0
`async`	-	2.13.1	2.13.1
`collection`	-	1.19.1	1.19.1
`convert`	-	3.1.2	3.1.2
`crypto`	-	3.0.7	3.0.7
`equatable`	-	2.0.8	2.0.8
`file`	-	7.0.1	7.0.1
`glob`	-	2.1.3	2.1.3
`hotreloader`	-	4.4.0	4.4.0
`http_parser`	-	4.1.2	4.1.2
`json_annotation`	-	4.12.0	4.12.0
`logging`	-	1.3.0	1.3.0
`meta`	-	1.18.3	1.18.3
`mime`	-	2.0.0	2.0.0
`package_config`	-	2.2.0	3.0.0
`path`	-	1.9.1	1.9.1
`pub_semver`	-	2.2.0	2.2.0
`revali_annotations`	-	2.0.2	2.0.2
`revali_core`	-	1.6.0	1.6.0
`revali_router_core`	-	2.3.0	2.3.0
`source_span`	-	1.10.2	1.10.2
`stream_transform`	-	2.1.1	2.1.1
`string_scanner`	-	1.4.1	1.4.1
`term_glyph`	-	1.2.2	1.2.2
`typed_data`	-	1.4.0	1.4.0
`vm_service`	-	15.2.0	15.2.0
`watcher`	-	1.2.1	1.2.1
`yaml`	-	3.1.3	3.1.3