readme 1.0.0

  • Readme
  • Changelog
  • Example
  • Installing
  • 46

readme #

lesnitsky.dev GitHub stars Twitter Follow

Generates a readme for flutter package

Installation #

pubspec.yaml:

dependencies:
  readme: ^1.0.0

or

pub global activate readme

Example #

import 'dart:io';

import 'package:readme/readme.dart';

void main(List<String> args) async {
  final info = getPackageInfo();

  final shiledProps = await ShieldProps.read();

  final readme = new Readme()
    ..packageName = info.name
    ..description = info.description
    ..license = args.length > 0 ? args.first : 'MIT'
    ..example = await getExample()
    ..shields = compileShields(shiledProps);

  stdout.write(readme);
}

From command line

readme <LICENSE_TYPE> # default: MIT

License #

MIT

[0.0.1] - TODO: Add release date. #

  • TODO: Describe initial release.

example/lib/main.dart

import 'dart:io';

import 'package:readme/readme.dart';

void main(List<String> args) async {
  final info = getPackageInfo();

  final shiledProps = await ShieldProps.read();

  final readme = new Readme()
    ..packageName = info.name
    ..description = info.description
    ..license = args.length > 0 ? args.first : 'MIT'
    ..example = await getExample()
    ..shields = compileShields(shiledProps);

  stdout.write(readme);
}

Use this package as an executable

1. Install it

You can install the package from the command line:


$ pub global activate readme

2. Use it

The package has the following executables:


$ readme

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  readme: ^1.0.0

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:readme/readme.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
0
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
80
Overall:
Weighted score of the above. [more]
46
Learn more about scoring.

We analyzed this package on Jul 9, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.8.4
  • pana: 0.13.13
  • Flutter: 1.17.5

Analysis suggestions

Package not compatible with SDK dart

because of import path [readme] that is in a package requiring null.

Package not compatible with runtime flutter-web on web

Because of the import of dart:io via the import chain package:readme/readme.dartpackage:shields/shields.dartpackage:l_cli/question.dartdart:io

Health issues and suggestions

Document public APIs. (-1 points)

34 out of 34 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Maintenance suggestions

The package description is too short. (-20 points)

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.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.7.0 <3.0.0
flutter 0.0.0
fs_extensions ^0.0.8 0.0.10
l_cli ^1.0.2 1.0.2
license ^1.0.0 1.0.1
shields ^1.0.3 1.0.4
tmpl ^1.0.1 1.0.1
yaml ^2.2.0 2.2.1
Transitive dependencies
_fe_analyzer_shared 5.0.0
analyzer 0.39.12
args 1.6.0
async 2.4.2
boolean_selector 2.0.0
charcode 1.1.3
collection 1.14.12 1.14.13
convert 2.1.1
coverage 0.14.0
crypto 2.1.5
csslib 0.16.1
glob 1.2.0
guard 1.0.4
html 0.14.0+3
http 0.12.1
http_multi_server 2.2.0
http_parser 3.1.4
intl 0.16.1
io 0.3.4
js 0.6.2
logging 0.11.4
matcher 0.12.8
meta 1.1.8 1.2.1
mime 0.9.6+3
node_interop 1.1.1
node_io 1.1.1
node_preamble 1.4.12
package_config 1.9.3
path 1.7.0
pedantic 1.9.0 1.9.1
pool 1.4.0
pub_semver 1.4.4
shelf 0.7.7
shelf_packages_handler 2.0.0
shelf_static 0.2.8
shelf_web_socket 0.2.3
sky_engine 0.0.99
source_map_stack_trace 2.0.0
source_maps 0.10.9
source_span 1.7.0
stack_trace 1.9.5
stream_channel 2.0.0
string_scanner 1.0.5
term_glyph 1.1.0
test 1.15.2
test_api 0.2.17
test_core 0.3.10
typed_data 1.1.6 1.2.0
vector_math 2.0.8 2.1.0-nullsafety
vm_service 4.1.0
watcher 0.9.7+15
web_socket_channel 1.1.0
webkit_inspection_protocol 0.7.3
Dev dependencies
flutter_test