dartdoc_json 0.3.0
dartdoc_json: ^0.3.0 copied to clipboard

Published 10 months ago •

blue-fire.xyzDart 3 compatible• Latest: 0.4.0

SDKDart Flutter

PlatformAndroid iOS Linux macOS Windows

→

Metadata

Package for rendering dartdocs as JSON files.

More...

likes

120/ 160

pub points

29%

popularity

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

Follow Dart file conventions

20 / 30

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.

Funding URL doesn't exist.

At the time of the analysis https://patreon.com/bluefireoss was unreachable. Make sure that the website is reachable via HEAD requests.

Funding URL doesn't exist.

At the time of the analysis https://www.buymeacoffee.com/bluefire 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

0 / 20

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

0 out of 2 API elements (0.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: dartdoc_json, dartdoc_json.serializeCompilationUnit.

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:dartdoc_json/dartdoc_json.dart that imports:
package:dartdoc_json/src/compilation_unit.dart that imports:
package:dartdoc_json/src/top_level_variable_declaration.dart that imports:
package:dartdoc_json/src/comment.dart that imports:
package:analyzer/dart/ast/ast.dart that imports:
package:analyzer/src/dart/ast/ast.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/reference.dart that imports:
package:analyzer/dart/element/element.dart that imports:
package:analyzer/src/generated/engine.dart that imports:
package:analyzer/error/listener.dart that imports:
package:analyzer/src/dart/element/type.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/generated/element_resolver.dart that imports:
package:analyzer/src/dart/resolver/method_invocation_resolver.dart that imports:
package:analyzer/src/dart/resolver/invocation_inferrer.dart that imports:
package:analyzer/src/dart/element/type_schema.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/summary2/link.dart that imports:
package:analyzer/src/summary2/top_level_inference.dart that imports:
package:analyzer/src/task/strong_mode.dart that imports:
package:analyzer/src/dart/element/inheritance_manager3.dart that imports:
package:analyzer/src/dart/element/member.dart that imports:
package:analyzer/dart/analysis/session.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/stat.dart that imports:
dart:io

0/0 points: WASM compatibility

Package not compatible with runtime wasm

Because:

package:dartdoc_json/dartdoc_json.dart that imports:
package:dartdoc_json/src/compilation_unit.dart that imports:
package:dartdoc_json/src/top_level_variable_declaration.dart that imports:
package:dartdoc_json/src/comment.dart that imports:
package:analyzer/dart/ast/ast.dart that imports:
package:analyzer/src/dart/ast/ast.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/reference.dart that imports:
package:analyzer/dart/element/element.dart that imports:
package:analyzer/src/generated/engine.dart that imports:
package:analyzer/error/listener.dart that imports:
package:analyzer/src/dart/element/type.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/generated/element_resolver.dart that imports:
package:analyzer/src/dart/resolver/method_invocation_resolver.dart that imports:
package:analyzer/src/dart/resolver/invocation_inferrer.dart that imports:
package:analyzer/src/dart/element/type_schema.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/summary2/link.dart that imports:
package:analyzer/src/summary2/top_level_inference.dart that imports:
package:analyzer/src/task/strong_mode.dart that imports:
package:analyzer/src/dart/element/inheritance_manager3.dart that imports:
package:analyzer/src/dart/element/member.dart that imports:
package:analyzer/dart/analysis/session.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/stat.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 3 issues. Showing the first 2:

INFO: 'isDocumentation' is deprecated and shouldn't be used. Do not use; this value is always 'true'.

lib/src/comment.dart:8:35

  ╷
8 │   if (comment == null || !comment.isDocumentation) {
  │                                   ^^^^^^^^^^^^^^^
  ╵

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

INFO: 'extendedType' is deprecated and shouldn't be used. Use onClause instead.

lib/src/extension_declaration.dart:21:21

   ╷
21 │     'on': extension.extendedType.toString(),
   │                     ^^^^^^^^^^^^
   ╵

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

Support up-to-date dependencies

40 / 40

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

Package	Constraint	Compatible	Latest
`analyzer`	`^6.2.0`	6.8.0	6.9.0
`args`	`^2.3.1`	2.5.0	2.5.0
`meta`	`^1.7.0`	1.15.0	1.15.0
`path`	`^1.8.3`	1.9.0	1.9.0

Transitive dependencies

Package	Constraint	Compatible	Latest
`_fe_analyzer_shared`	-	73.0.0	74.0.0
`_macros`	-	0.3.2	0.3.2
`async`	-	2.11.0	2.11.0
`collection`	-	1.19.0	1.19.0
`convert`	-	3.1.1	3.1.1
`crypto`	-	3.0.5	3.0.5
`file`	-	7.0.0	7.0.0
`glob`	-	2.1.2	2.1.2
`macros`	-	0.1.2-main.4	0.1.3-main.0
`package_config`	-	2.1.0	2.1.0
`pub_semver`	-	2.1.4	2.1.4
`source_span`	-	1.10.0	1.10.0
`string_scanner`	-	1.3.0	1.3.0
`term_glyph`	-	1.2.1	1.2.1
`typed_data`	-	1.3.2	1.3.2
`watcher`	-	1.1.0	1.1.0
`yaml`	-	3.1.2	3.1.2