df_generate_header_comments 0.3.1 copy "df_generate_header_comments: ^0.3.1" to clipboard
df_generate_header_comments: ^0.3.1 copied to clipboard

A tool to generate header comments for your source files.

1
likes
120/ 160
pub points
185
downloads

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

failed
Follow Dart file conventions
20 / 30trigger folding of the section

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.

Failed to verify repository URL.

Please provide a valid repository URL in pubspec.yaml, such that:

  • repository can be cloned,
  • a clone of the repository contains a pubspec.yaml, which:,
    • contains name: df_generate_header_comments,
    • contains a version property, and,
    • does not contain a publish_to property.

pubspec.yaml from the repository URL mismatch: expected https://github.com/robmllze/df_generate_header_comments but got https://github.com/dev_cetera/df_generate_header_comments.

Funding URL doesn't exist.

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

failed
Provide documentation
10 / 20trigger folding of the section

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

1 out of 4 API elements (25.0 %) have documentation comments.

Some symbols that are missing documentation: df_generate_header_comments.generateCommentHeaders, df_generate_header_comments.generateCommentHeadersApp, df_generate_header_comments.langFileCommentStarters.

0/10 points: Package has an example

No example found.

See package layout guidelines on how to add an example.

failed
Platform support
20 / 20trigger folding of the section

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:df_generate_header_comments/df_generate_header_comments.dart that imports:
  • package:df_generate_header_comments/src/_index.g.dart that imports:
  • package:df_generate_header_comments/src/app.dart that imports:
  • package:df_generate_header_comments/src/generate.dart that imports:
  • package:df_gen_core/df_gen_core.dart that imports:
  • package:df_gen_core/src/_index.g.dart that imports:
  • package:df_gen_core/src/insights/dir_insight.dart that imports:
  • package:df_gen_core/src/path_utils/path_explorer.dart that imports:
  • dart:io

0/0 points: WASM compatibility

Package not compatible with runtime wasm

Because:

  • package:df_generate_header_comments/df_generate_header_comments.dart that imports:
  • package:df_generate_header_comments/src/_index.g.dart that imports:
  • package:df_generate_header_comments/src/app.dart that imports:
  • package:df_generate_header_comments/src/generate.dart that imports:
  • package:df_gen_core/df_gen_core.dart that imports:
  • package:df_gen_core/src/_index.g.dart that imports:
  • package:df_gen_core/src/insights/dir_insight.dart that imports:
  • package:df_gen_core/src/path_utils/path_explorer.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.

partial
Pass static analysis
40 / 50trigger folding of the section

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

INFO: The file name 'dfhdr-df.dart' isn't a lower_case_with_underscores identifier.

To reproduce make sure you are using the lints_core and run dart analyze bin/dfhdr-df.dart

INFO: The file name 'dfhdr-v1.dart' isn't a lower_case_with_underscores identifier.

To reproduce make sure you are using the lints_core and run dart analyze bin/dfhdr-v1.dart

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

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

Package Constraint Compatible Latest
args ^2.6.0 2.6.0 2.6.0
df_config ^0.5.3 0.5.5 0.5.5
df_gen_core ^0.4.5 0.4.8 0.5.11
df_log ^0.2.4 0.2.4 0.2.4
path ^1.9.1 1.9.1 1.9.1
Transitive dependencies
Package Constraint Compatible Latest
_fe_analyzer_shared - 76.0.0 79.0.0
_macros - 0.3.3 0.3.3
analyzer - 6.11.0 7.2.0
async - 2.12.0 2.12.0
build - 2.4.2 2.4.2
collection - 1.19.1 1.19.1
convert - 3.1.2 3.1.2
crypto - 3.0.6 3.0.6
dart_style - 2.3.7 3.0.1
df_collection - 0.8.6 0.8.6
df_string - 0.2.4 0.2.4
df_type - 0.7.7 0.8.0
equatable - 2.0.7 2.0.7
file - 7.0.1 7.0.1
glob - 2.1.2 2.1.2
http - 1.3.0 1.3.0
http_parser - 4.1.2 4.1.2
logging - 1.3.0 1.3.0
macros - 0.1.3-main.0 0.1.3-main.0
meta - 1.16.0 1.16.0
package_config - 2.1.1 2.1.1
pub_semver - 2.1.5 2.1.5
source_gen - 1.5.0 2.0.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.1 1.1.1
web - 1.1.0 1.1.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 `^0.4.5` on df_gen_core does not support the stable version `0.5.0`.

Try running dart pub upgrade --major-versions df_gen_core 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.22.18, Dart 3.6.1.

Check the analysis log for details.

1
likes
120
points
185
downloads

Publisher

verified publisherdev-cetera.com

Weekly Downloads

A tool to generate header comments for your source files.

Topics

#source-gen #build-runner #code-generation #comments #header-comments

Documentation

API reference

Funding

Consider supporting this project:

www.buymeacoffee.com

License

MIT (license)

Dependencies

args, df_config, df_gen_core, df_log, path

More

Packages that depend on df_generate_header_comments