dart_doc_pilot 1.0.3 
dart_doc_pilot: ^1.0.3 copied to clipboard
mypackeges.tkA powerful Flutter project documentation generator with rich UI and CLI experience
We analyzed this package 16 hours ago, and awarded it 120 pub points (of a possible 160):
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.
0/10 points: 20% or more of the public API has dartdoc comments
23 out of 154 API elements (14.9 %) 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: cli.DartDocPilotCLI, cli.DartDocPilotCLI.DartDocPilotCLI.new, cli.DartDocPilotCLI.run, exporters.Exporter.Exporter.new, exporters.Exporter.export.
0/10 points: Package has an example
No example found.
See package layout guidelines on how to add an example.
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:dart_doc_pilot/dart_doc_pilot.dartthat declares support for platforms:Windows,Linux,macOS.
Package does not support platform `iOS`.
Because:
package:dart_doc_pilot/dart_doc_pilot.dartthat declares support for platforms:Windows,Linux,macOS.
Package does not support platform `Web`.
Because:
package:dart_doc_pilot/dart_doc_pilot.dartthat declares support for platforms:Windows,Linux,macOS.
These issues are present but do not affect the score, because they may not originate in your package:
Package does not support platform `Linux`.
Because:
package:dart_doc_pilot/dart_doc_pilot.dartthat imports:package:dart_doc_pilot/cli.dartthat imports:package:mason_logger/mason_logger.dartthat imports:package:mason_logger/src/mason_logger.dartthat imports:package:mason_logger/src/terminal_overrides.dartthat imports:package:mason_logger/src/ffi/terminal.dartthat imports:package:mason_logger/src/ffi/windows_terminal.dartthat imports:package:win32/win32.dartthat declares support for platforms:Windows.
Package does not support platform `macOS`.
Because:
package:dart_doc_pilot/dart_doc_pilot.dartthat imports:package:dart_doc_pilot/cli.dartthat imports:package:mason_logger/mason_logger.dartthat imports:package:mason_logger/src/mason_logger.dartthat imports:package:mason_logger/src/terminal_overrides.dartthat imports:package:mason_logger/src/ffi/terminal.dartthat imports:package:mason_logger/src/ffi/windows_terminal.dartthat imports:package:win32/win32.dartthat declares support for platforms:Windows.
40/50 points: code has no errors, warnings, lints, or formatting issues
Found 4 issues. Showing the first 2:
INFO: Statements in an if should be enclosed in a block.
lib/cli.dart:369:7
╷
369 │ return ContentType('image', 'jpeg');
│ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
╵
To reproduce make sure you are using the lints_core and run dart analyze lib/cli.dart
INFO: Missing type annotation.
lib/cli.dart:386:25
╷
386 │ void _printStatistics(doc) {
│ ^^^
╵
To reproduce make sure you are using the lints_core and run dart analyze lib/cli.dart
0/10 points: All of the package dependencies are supported in the latest version
| Package | Constraint | Compatible | Latest | Notes |
|---|---|---|---|---|
analyzer |
^6.2.0 |
6.4.1 | 13.0.0 | |
args |
^2.4.2 |
2.7.0 | 2.7.0 | |
cli_util |
^0.4.0 |
0.4.2 | 0.5.1 | |
markdown |
^7.1.1 |
7.3.1 | 7.3.1 | |
mason_logger |
^0.2.11 |
0.2.16 | 0.3.5 | |
path |
^1.8.3 |
1.9.1 | 1.9.1 | |
yaml |
^3.1.2 |
3.1.3 | 3.1.3 |
Transitive dependencies
| Package | Constraint | Compatible | Latest | Notes |
|---|---|---|---|---|
_fe_analyzer_shared |
- | 67.0.0 | 100.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 | |
ffi |
- | 2.2.0 | 2.2.0 | |
file |
- | 7.0.1 | 7.0.1 | |
glob |
- | 2.1.3 | 2.1.3 | |
io |
- | 1.0.5 | 1.0.5 | |
meta |
- | 1.18.2 | 1.18.2 | |
package_config |
- | 2.2.0 | 2.2.0 | |
pub_semver |
- | 2.2.0 | 2.2.0 | |
source_span |
- | 1.10.2 | 1.10.2 | |
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.2.1 | 1.2.1 | |
win32 |
- | 5.15.0 | 6.2.0 |
To reproduce run dart pub outdated --no-dev-dependencies --up-to-date --no-dependency-overrides.
Found 3 issues. Showing the first 2:
The constraint `^6.2.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 `^0.4.0` on cli_util does not support the stable version `0.5.0`, that was published 16 days ago.
When cli_util is 30 days old, this package will no longer be awarded points in this category.
Try running dart pub upgrade --major-versions cli_util 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.23.12, Dart 3.11.5.
Check the analysis log for details.
Weekly downloads
Metadata
Documentation
Publisher
Weekly Downloads
Metadata
A powerful Flutter project documentation generator with rich UI and CLI experience
Repository (GitHub)
View/report issues
License
MIT (license)
Dependencies
analyzer, args, cli_util, markdown, mason_logger, path, yaml
