doc_widget_builder 0.4.0
doc_widget_builder: ^0.4.0 copied to clipboard

Published 20 months ago •

isacjunior.devDart 3 compatible

[unknown platforms]

→

Metadata

The code generator to generate the documentation for doc_widget package.

More...

likes

100/ 160

pub points

48%

popularity

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

Follow Dart file conventions

30 / 30

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.

Provide documentation

0 / 20

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: doc_widget_builder, doc_widget_builder.docWidgetBuilder.

0/10 points: Package has an example

No example found.

See package layout guidelines on how to add an example.

Platform support

0 / 20

0/20 points: Supports 0 of 6 possible platforms (iOS, Android, Web, Windows, macOS, Linux)

These platforms are not supported:

Package not compatible with platform Android

Because:

package:doc_widget_builder/doc_widget_builder.dart that imports:
package:source_gen/source_gen.dart that imports:
package:source_gen/src/type_checker.dart that imports:
dart:mirrors

Package not compatible with platform iOS

Because:

package:doc_widget_builder/doc_widget_builder.dart that imports:
package:source_gen/source_gen.dart that imports:
package:source_gen/src/type_checker.dart that imports:
dart:mirrors

Package not compatible with platform Windows

Because:

package:doc_widget_builder/doc_widget_builder.dart that imports:
package:source_gen/source_gen.dart that imports:
package:source_gen/src/type_checker.dart that imports:
dart:mirrors

Package not compatible with platform Linux

Because:

package:doc_widget_builder/doc_widget_builder.dart that imports:
package:source_gen/source_gen.dart that imports:
package:source_gen/src/type_checker.dart that imports:
dart:mirrors

Package not compatible with platform macOS

Because:

package:doc_widget_builder/doc_widget_builder.dart that imports:
package:source_gen/source_gen.dart that imports:
package:source_gen/src/type_checker.dart that imports:
dart:mirrors

Package not compatible with platform Web

Because:

package:doc_widget_builder/doc_widget_builder.dart that imports:
package:source_gen/source_gen.dart that imports:
package:source_gen/src/utils.dart that imports:
package:build/build.dart that imports:
package:build/src/generate/run_post_process_builder.dart that imports:
package:build/src/builder/post_process_builder.dart that imports:
package:build/src/builder/builder.dart that imports:
package:build/src/builder/build_step.dart that imports:
package:build/src/asset/reader.dart that imports:
package:glob/glob.dart that imports:
package:glob/src/list_tree.dart that imports:
package:file/file.dart that imports:
package:file/src/interface.dart that imports:
package:file/src/io.dart that imports:
dart:io

Pass static analysis

40 / 50

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

INFO: Statements in an if should be enclosed in a block.

lib/src/library.dart:199:7

    ╷
199 │ ┌       return hasDocumentation
200 │ │           ? removeDocumentationComment(field.documentationComment)
201 │ └           : null;
    ╵

To reproduce make sure you are using the lints_core and run flutter analyze lib/src/library.dart

Support up-to-date dependencies

30 / 40

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

Package	Constraint	Compatible	Latest
`analyzer`	`>=4.4.0 <6.0.0`	5.13.0	6.5.2
`build`	`>=2.3.1 <3.0.0`	2.4.1	2.4.1
`build_config`	`>=1.1.0 <3.0.0`	1.1.1	1.1.1
`code_builder`	`>=4.3.0 <6.0.0`	4.10.0	4.10.0
`dart_style`	`>=2.2.4 <6.0.0`	2.3.2	2.3.6
`doc_widget_annotation`	`^0.2.8`	0.2.8	0.2.8
`flutter`	`flutter`	0.0.0	0.0.0
`source_gen`	`^1.2.3`	1.5.0	1.5.0

Transitive dependencies

Package	Constraint	Compatible	Latest
`_fe_analyzer_shared`	-	61.0.0	70.0.0
`args`	-	2.5.0	2.5.0
`async`	-	2.11.0	2.11.0
`boolean_selector`	-	2.1.1	2.1.1
`built_collection`	-	5.1.1	5.1.1
`built_value`	-	8.9.2	8.9.2
`characters`	-	1.3.0	1.3.0
`checked_yaml`	-	2.0.3	2.0.3
`collection`	-	1.18.0	1.18.0
`convert`	-	3.1.1	3.1.1
`crypto`	-	3.0.3	3.0.3
`file`	-	7.0.0	7.0.0
`fixnum`	-	1.1.0	1.1.0
`glob`	-	2.1.2	2.1.2
`json_annotation`	-	4.9.0	4.9.0
`logging`	-	1.2.0	1.2.0
`matcher`	-	0.12.16+1	0.12.16+1
`material_color_utilities`	-	0.8.0	0.12.0
`meta`	-	1.12.0	1.15.0
`package_config`	-	2.1.0	2.1.0
`path`	-	1.9.0	1.9.0
`pub_semver`	-	2.1.4	2.1.4
`pubspec_parse`	-	1.3.0	1.3.0
`sky_engine`	-	0.0.99	0.0.99
`source_span`	-	1.10.0	1.10.0
`stack_trace`	-	1.11.1	1.11.1
`stream_channel`	-	2.1.2	2.1.2
`string_scanner`	-	1.2.0	1.2.0
`term_glyph`	-	1.2.1	1.2.1
`test_api`	-	0.7.0	0.7.2
`typed_data`	-	1.3.2	1.3.2
`vector_math`	-	2.1.4	2.1.4
`watcher`	-	1.1.0	1.1.0
`yaml`	-	3.1.2	3.1.2