dart_doc_markdown_generator 1.0.2 copy "dart_doc_markdown_generator: ^1.0.2" to clipboard
dart_doc_markdown_generator: ^1.0.2 copied to clipboard

A tool for creating Markdown documentation from Dart files in a Dart/Flutter project.

125/ 160
pub points
47
downloads

We analyzed this package 45 hours ago, and awarded it 125 pub points (of a possible 160):

Failed report section
Follow Dart file conventions
25 / 30trigger folding of the section

Passed check 10/10 points: Provide a valid pubspec.yaml

Passed check 5/5 points: Provide a valid README.md

Failed check 0/5 points: Provide a valid CHANGELOG.md

`CHANGELOG.md` does not contain reference to the current version ("1.0.2").

Changelog entries help developers follow the progress of your package. Check out the Dart conventions for Maintaining a package changelog.

Passed check 10/10 points: Use an OSI-approved license

Detected license: MIT.

Failed report section
Provide documentation
10 / 20trigger folding of the section

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

7 out of 9 API elements (77.8 %) have documentation comments.

Some symbols that are missing documentation: cli_config, dart_doc_markdown_generator.

Failed check 0/10 points: Package has an example

No example found.

See package layout guidelines on how to add an example.

Failed report section
Platform support
20 / 20trigger folding of the section

Passed check 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:dart_doc_markdown_generator/dart_doc_markdown_generator.dart that imports:
  • package:dart_doc_markdown_generator/src/markdown_generator.dart that imports:
  • dart:io

Failed check 0/0 points: WASM compatibility

Package not compatible with runtime wasm

Because:

  • package:dart_doc_markdown_generator/dart_doc_markdown_generator.dart that imports:
  • package:dart_doc_markdown_generator/src/markdown_generator.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.

Partially passed report section
Pass static analysis
40 / 50trigger folding of the section

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

Found 6 issues. Showing the first 2:

/tmp/pana_MNHFCC/bin/dart_doc_markdown_generator.dart doesn't match the Dart formatter.

To format your files run: dart format .

/tmp/pana_MNHFCC/lib/dart_doc_markdown_generator.dart doesn't match the Dart formatter.

To format your files run: dart format .

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

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

Package Constraint Compatible Latest Notes
analyzer ^7.2.0 7.7.1 8.2.0
very_good_analysis ^7.0.0 7.0.0 10.0.0
Transitive dependencies
Package Constraint Compatible Latest Notes
_fe_analyzer_shared - 85.0.0 89.0.0
async - 2.13.0 2.13.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.3 2.1.3
meta - 1.17.0 1.17.0
package_config - 2.2.0 2.2.0
path - 1.9.1 1.9.1
pub_semver - 2.2.0 2.2.0
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.3 1.1.3
yaml - 3.1.3 3.1.3

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

The constraint `^7.2.0` on analyzer does not support the stable version `8.0.0`.

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

The constraint `^7.0.0` on very_good_analysis does not support the stable version `8.0.0`.

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

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

Passed check 20/20 points: Compatible with dependency constraint lower bounds

pub downgrade does not expose any static analysis error.

Analyzed with Pana 0.22.23, Dart 3.9.3.

Check the analysis log for details.

Weekly downloads

Display as:
By versions:
0
likes
125
points
47
downloads

Publisher

verified publishersplendidendeavors.com

Weekly Downloads

A tool for creating Markdown documentation from Dart files in a Dart/Flutter project.

Repository (GitHub)
View/report issues

Documentation

API reference

License

MIT (license)

Dependencies

analyzer, very_good_analysis

More

Packages that depend on dart_doc_markdown_generator