documentation_builder 1.1.0 copy "documentation_builder: ^1.1.0" to clipboard
documentation_builder: ^1.1.0 copied to clipboard

Generates documentation files that can import other files or Dart documentation comments.

9
likes
160/ 160
pub points
366
downloads

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

Partially passed report section
Follow Dart file conventions
30 / 30trigger folding of the section

Partially passed check 10/10 points: Provide a valid pubspec.yaml

Issue tracker URL doesn't exist.

At the time of the analysis https://github.com/domain-centric/documentation_builder/pulls was unreachable. Make sure that the website is reachable via HEAD requests.

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

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

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

Detected license: BSD-3-Clause.

Passed report section
Provide documentation
20 / 20trigger folding of the section

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

519 out of 1101 API elements (47.1 %) have documentation comments.

Some symbols that are missing documentation: builder, documentation_builder, documentation_builder.AllGitHubBadges.AllGitHubBadges.new, documentation_builder.AllGitHubBadges.createMarkdownDocumentation, documentation_builder.AllGitHubBadges.createMarkdownExamples.

Passed check 10/10 points: Package has an example

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

Passed check 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:documentation_builder/documentation_builder.dart that imports:
  • package:documentation_builder/src/engine/function/util/table_of_contents.dart that imports:
  • package:build/build.dart that imports:
  • package:build/src/generate/run_post_process_builder.dart that imports:
  • package:build_runner_core/build_runner_core.dart that declares support for platforms: Windows, Linux, macOS.
Package does not support platform `iOS`.

Because:

  • package:documentation_builder/documentation_builder.dart that imports:
  • package:documentation_builder/src/engine/function/util/table_of_contents.dart that imports:
  • package:build/build.dart that imports:
  • package:build/src/generate/run_post_process_builder.dart that imports:
  • package:build_runner_core/build_runner_core.dart that declares support for platforms: Windows, Linux, macOS.
Package does not support platform `Web`.

Because:

  • package:documentation_builder/documentation_builder.dart that imports:
  • package:documentation_builder/src/engine/function/util/table_of_contents.dart that imports:
  • package:build/build.dart that imports:
  • package:build/src/generate/run_post_process_builder.dart that imports:
  • package:build_runner_core/build_runner_core.dart that declares support for platforms: Windows, Linux, macOS.

Failed check 0/0 points: WASM compatibility

Package not compatible with runtime wasm

Because:

  • package:documentation_builder/documentation_builder.dart that imports:
  • package:documentation_builder/src/engine/template_engine.dart that imports:
  • package:template_engine/template_engine.dart that imports:
  • package:template_engine/src/template.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.

Passed report section
Pass static analysis
50 / 50trigger folding of the section

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

Partially passed report section
Support up-to-date dependencies
40 / 40trigger folding of the section

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

Package Constraint Compatible Latest Notes
analyzer ^7.4.4 7.5.2 7.5.2
build ^2.3.1 2.5.4 2.5.4
build_config ^1.1.0 1.1.2 1.1.2
collection ^1.19.1 1.19.1 1.19.1
crypto ^3.0.6 3.0.6 3.0.6
fluent_regex ^1.0.3 1.0.3 1.0.3
glob ^2.1.3 2.1.3 2.1.3
http ^1.2.0 1.4.0 1.4.0
logging ^1.0.2 1.3.0 1.3.0
package_config ^2.2.0 2.2.0 2.2.0
petitparser ^6.1.0 6.1.0 7.0.0
process_run ^1.2.4 1.2.4 1.2.4
resource_portable ^3.1.2 3.1.2 3.1.2
template_engine ^1.5.2 1.5.2 1.5.2
yaml_magic ^1.0.6 1.0.6 1.0.6
Transitive dependencies
Package Constraint Compatible Latest Notes
_fe_analyzer_shared - 85.0.0 85.0.0
args - 2.7.0 2.7.0
async - 2.13.0 2.13.0
boolean_selector - 2.1.2 2.1.2
build_daemon - 4.0.4 4.0.4
build_resolvers - 2.5.4 2.5.4
build_runner - 2.5.4 2.5.4
build_runner_core - 9.1.2 9.1.2
built_collection - 5.1.1 5.1.1
built_value - 8.10.1 8.10.1
checked_yaml - 2.0.4 2.0.4
code_builder - 4.10.1 4.10.1
convert - 3.1.2 3.1.2
dart_style - 3.1.0 3.1.0
file - 7.0.1 7.0.1
fixnum - 1.1.1 1.1.1
frontend_server_client - 4.0.0 4.0.0
graphs - 2.3.2 2.3.2
http_multi_server - 3.2.2 3.2.2
http_parser - 4.1.2 4.1.2
io - 1.0.5 1.0.5
js - 0.7.2 0.7.2 Discontinued
json_annotation - 4.9.0 4.9.0
matcher - 0.12.17 0.12.17
meta - 1.17.0 1.17.0
mime - 2.0.0 2.0.0
path - 1.9.1 1.9.1
pool - 1.5.1 1.5.1
pub_semver - 2.2.0 2.2.0
pubspec_parse - 1.5.0 1.5.0
recase - 4.1.0 4.1.0
shelf - 1.4.2 1.4.2
shelf_web_socket - 3.0.0 3.0.0
source_span - 1.10.1 1.10.1
stack_trace - 1.12.1 1.12.1
stream_channel - 2.1.4 2.1.4
stream_transform - 2.1.1 2.1.1
string_scanner - 1.4.1 1.4.1
synchronized - 3.4.0 3.4.0
term_glyph - 1.2.2 1.2.2
test_api - 0.7.6 0.7.6
timing - 1.0.2 1.0.2
typed_data - 1.4.0 1.4.0
watcher - 1.1.2 1.1.2
web - 1.1.1 1.1.1
web_socket - 1.0.1 1.0.1
web_socket_channel - 3.0.3 3.0.3
xml - 6.5.0 6.6.0
yaml - 3.1.3 3.1.3

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

The constraint `^6.1.0` on petitparser does not support the stable version `7.0.0`, that was published 11 days ago.

When petitparser is 30 days old, this package will no longer be awarded points in this category.

Try running dart pub upgrade --major-versions petitparser 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.21, Dart 3.8.1.

Check the analysis log for details.

Weekly downloads

Display as:
By versions:
9
likes
160
points
366
downloads

Publisher

unverified uploader

Weekly Downloads

Generates documentation files that can import other files or Dart documentation comments.

Repository (GitHub)
View/report issues

Topics

#documentation #code-generation #markdown #dart #build-system

Documentation

Documentation
API reference

License

BSD-3-Clause (license)

Dependencies

analyzer, build, build_config, collection, crypto, fluent_regex, glob, http, logging, package_config, petitparser, process_run, resource_portable, template_engine, yaml_magic

More

Packages that depend on documentation_builder