dartdoc_json 0.5.0 dartdoc_json: ^0.5.0 copied to clipboard
Package for rendering dartdocs as JSON files.
We analyzed this package 15 days ago, and awarded it 130 pub points (of a possible 160):
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
.
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.
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/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/reference.dart
that imports:package:analyzer/dart/element/element2.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/task/options.dart
that imports:package:analyzer/src/plugin/options.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/variable_type_provider.dart
that imports:package:analyzer/dart/element/type.dart
that imports:package:analyzer/dart/element/element.dart
that imports:package:analyzer/src/dart/constant/evaluation.dart
that imports:package:analyzer/src/dart/element/type_algebra.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/summary2/link.dart
that imports:package:analyzer/src/summary2/top_level_inference.dart
that imports:package:analyzer/src/summary2/library_builder.dart
that imports:package:analyzer/src/summary2/metadata_resolver.dart
that imports:package:analyzer/src/summary2/ast_resolver.dart
that imports:package:analyzer/dart/analysis/analysis_options.dart
that imports:package:analyzer/src/lint/linter.dart
that imports:package:analyzer/src/workspace/workspace.dart
that imports:package:analyzer/src/workspace/blaze.dart
that imports:package:analyzer/src/workspace/blaze_watcher.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/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/reference.dart
that imports:package:analyzer/dart/element/element2.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/task/options.dart
that imports:package:analyzer/src/plugin/options.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/variable_type_provider.dart
that imports:package:analyzer/dart/element/type.dart
that imports:package:analyzer/dart/element/element.dart
that imports:package:analyzer/src/dart/constant/evaluation.dart
that imports:package:analyzer/src/dart/element/type_algebra.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/summary2/link.dart
that imports:package:analyzer/src/summary2/top_level_inference.dart
that imports:package:analyzer/src/summary2/library_builder.dart
that imports:package:analyzer/src/summary2/metadata_resolver.dart
that imports:package:analyzer/src/summary2/ast_resolver.dart
that imports:package:analyzer/dart/analysis/analysis_options.dart
that imports:package:analyzer/src/lint/linter.dart
that imports:package:analyzer/src/workspace/workspace.dart
that imports:package:analyzer/src/workspace/blaze.dart
that imports:package:analyzer/src/workspace/blaze_watcher.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.
50/50 points: code has no errors, warnings, lints, or formatting issues
10/10 points: All of the package dependencies are supported in the latest version
Package | Constraint | Compatible | Latest |
---|---|---|---|
analyzer |
^7.0.0 |
7.1.0 | 7.1.0 |
args |
^2.6.0 |
2.6.0 | 2.6.0 |
meta |
^1.16.0 |
1.16.0 | 1.16.0 |
path |
^1.9.1 |
1.9.1 | 1.9.1 |
Transitive dependencies
Package | Constraint | Compatible | Latest |
---|---|---|---|
_fe_analyzer_shared |
- | 78.0.0 | 78.0.0 |
_macros |
- | 0.3.3 | 0.3.3 |
async |
- | 2.12.0 | 2.12.0 |
collection |
- | 1.19.1 | 1.19.1 |
convert |
- | 3.1.2 | 3.1.2 |
crypto |
- | 3.0.6 | 3.0.6 |
file |
- | 7.0.1 | 7.0.1 |
glob |
- | 2.1.2 | 2.1.2 |
macros |
- | 0.1.3-main.0 | 0.1.3-main.0 |
package_config |
- | 2.1.1 | 2.1.1 |
pub_semver |
- | 2.1.5 | 2.1.5 |
source_span |
- | 1.10.1 | 1.10.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 |
watcher |
- | 1.1.1 | 1.1.1 |
yaml |
- | 3.1.3 | 3.1.3 |
To reproduce run dart pub outdated --no-dev-dependencies --up-to-date --no-dependency-overrides
.
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.