cli_readme_builder 2.0.0
cli_readme_builder: ^2.0.0 copied to clipboard

Published 2 years ago

SDKDart

PlatformWindows

→

Metadata

A builder to automate the process of creating a README for Dart console applications

More...

likes

140/ 160

pub points

1.45k

downloads

We analyzed this package 24 hours ago, and awarded it 140 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: BSD-3-Clause.

Provide documentation

20 / 20

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

16 out of 21 API elements (76.2 %) have documentation comments.

Some symbols that are missing documentation: builder.cliReadmeBuilder, builder.logger, readme_builder_from_command_runner, readme_builder_from_command_runner.ReadmeBuilderFromCommandRunner.ReadmeBuilderFromCommandRunner.new, readme_builder_from_command_runner.ReadmeBuilderFromCommandRunner.generateReadme.

10/10 points: Package has an example

Platform support

20 / 20

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

✓ Windows

These platforms are not supported:

Package does not support platform `Android`.

Because:

package:cli_readme_builder/readme_builder.dart that imports:
package:cli_readme_builder/src/system_shell.dart that imports:
package:mason_logger/mason_logger.dart that imports:
package:mason_logger/src/mason_logger.dart that imports:
package:mason_logger/src/terminal_overrides.dart that imports:
package:mason_logger/src/ffi/terminal.dart that imports:
package:mason_logger/src/ffi/windows_terminal.dart that imports:
package:win32/win32.dart that declares support for platforms: Windows.

Package does not support platform `iOS`.

Because:

package:cli_readme_builder/readme_builder.dart that imports:
package:cli_readme_builder/src/system_shell.dart that imports:
package:mason_logger/mason_logger.dart that imports:
package:mason_logger/src/mason_logger.dart that imports:
package:mason_logger/src/terminal_overrides.dart that imports:
package:mason_logger/src/ffi/terminal.dart that imports:
package:mason_logger/src/ffi/windows_terminal.dart that imports:
package:win32/win32.dart that declares support for platforms: Windows.

Package does not support platform `Linux`.

Because:

package:cli_readme_builder/readme_builder.dart that imports:
package:cli_readme_builder/src/system_shell.dart that imports:
package:mason_logger/mason_logger.dart that imports:
package:mason_logger/src/mason_logger.dart that imports:
package:mason_logger/src/terminal_overrides.dart that imports:
package:mason_logger/src/ffi/terminal.dart that imports:
package:mason_logger/src/ffi/windows_terminal.dart that imports:
package:win32/win32.dart that declares support for platforms: Windows.

Package does not support platform `macOS`.

Because:

package:cli_readme_builder/readme_builder.dart that imports:
package:cli_readme_builder/src/system_shell.dart that imports:
package:mason_logger/mason_logger.dart that imports:
package:mason_logger/src/mason_logger.dart that imports:
package:mason_logger/src/terminal_overrides.dart that imports:
package:mason_logger/src/ffi/terminal.dart that imports:
package:mason_logger/src/ffi/windows_terminal.dart that imports:
package:win32/win32.dart that declares support for platforms: Windows.

Package does not support platform `Web`.

Because:

package:cli_readme_builder/readme_builder.dart that imports:
package:cli_readme_builder/src/system_shell.dart that imports:
package:mason_logger/mason_logger.dart that imports:
package:mason_logger/src/mason_logger.dart that imports:
package:mason_logger/src/terminal_overrides.dart that imports:
package:mason_logger/src/ffi/terminal.dart that imports:
package:mason_logger/src/ffi/windows_terminal.dart that imports:
package:win32/win32.dart that declares support for platforms: Windows.

Pass static analysis

40 / 50

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

INFO: Angle brackets will be interpreted as HTML.

lib/src/help_model/help_model.dart:8:63

  ╷
8 │   /// Entire help output (ie.. all the output to console when <command> --help is ran)
  │                                                               ^^^^^^^^^
  ╵

To reproduce make sure you are using the lints_core and run dart analyze lib/src/help_model/help_model.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
`args`	`^2.4.1`	2.7.0	2.7.0
`build`	`^2.1.0`	2.5.4	4.0.3
`mason_logger`	`^0.2.5`	0.2.16	0.3.3
`meta`	`^1.7.0`	1.17.0	1.17.0
`path`	`^1.8.2`	1.9.1	1.9.1
`process_run`	`^0.13.0`	0.13.3+1	1.2.4
`pubspec_parse`	`^1.0.0`	1.5.0	1.5.0

Transitive dependencies

Package	Constraint	Compatible	Latest	Notes
`_fe_analyzer_shared`	-	85.0.0	93.0.0
`analyzer`	-	7.7.1	10.0.0
`async`	-	2.13.0	2.13.0
`boolean_selector`	-	2.1.2	2.1.2
`build_config`	-	1.1.2	1.2.0
`build_daemon`	-	4.1.1	4.1.1
`build_resolvers`	-	2.5.4	3.0.4	Discontinued
`build_runner`	-	2.5.4	2.10.4
`build_runner_core`	-	9.1.2	9.3.2	Discontinued
`built_collection`	-	5.1.1	5.1.1
`built_value`	-	8.12.1	8.12.1
`checked_yaml`	-	2.0.4	2.0.4
`code_builder`	-	4.11.1	4.11.1
`collection`	-	1.19.1	1.19.1
`convert`	-	3.1.2	3.1.2
`crypto`	-	3.0.7	3.0.7
`dart_style`	-	3.1.1	3.1.3
`ffi`	-	2.1.5	2.1.5
`file`	-	7.0.1	7.0.1
`fixnum`	-	1.1.1	1.1.1
`frontend_server_client`	-	4.0.0	4.0.0
`glob`	-	2.1.3	2.1.3
`graphs`	-	2.3.2	2.3.2
`http`	-	1.6.0	1.6.0
`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
`logging`	-	1.3.0	1.3.0
`matcher`	-	0.12.18	0.12.18
`mime`	-	2.0.0	2.0.0
`package_config`	-	2.2.0	2.2.0
`pool`	-	1.5.2	1.5.2
`pub_semver`	-	2.2.0	2.2.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.9	0.7.9
`timing`	-	1.0.2	1.0.2
`typed_data`	-	1.4.0	1.4.0
`watcher`	-	1.2.1	1.2.1
`web`	-	1.1.1	1.1.1
`web_socket`	-	1.0.1	1.0.1
`web_socket_channel`	-	3.0.3	3.0.3
`win32`	-	5.15.0	5.15.0
`yaml`	-	3.1.3	3.1.3