dbstyleguidechecker 1.0.4

  • Readme
  • Changelog
  • Example
  • Installing
  • new50

A command-line tool that help you verify that a project follow a specific code style guideline.

It's also help you automate your code style guideline check on github pull requests.

license.

Usage: dbstyleguidechecker --style-guide [path to analysis_options.yaml] [local project directory]

Options: -s, --style-guide specify the code style guide to use (defaults to "analysis_options.yaml")

-f, --[no-]flutter should be added if it's flutter project

-g, --github-repo github repository to push style guide violation on the pull request (defaults to "")

-p, --github-pull-request-id github pull request id

-t, --github-api-token github api access token (defaults to "")

-h, --[no-]help print help message

1.0.0 #

  • Initial version, with check code style guideline feature.
  • Push code style violation as pull request review comments.

1.0.1 #

  • Updated package name to match dbstyleguidechecker.

1.0.2 #

  • Changed executable package name to match dbstyleguidechecker.

1.0.3 #

  • Added support for running the program using just dbstyleguidechecker.

1.0.4 #

  • Removed stack trace in error message

example/lib/example.dart

void main() {
  List.generate(10, (index) => SomeConstClass(7))
      .map((some) => print(some.immutableNumber));

  final as_sdf34 = "bad viarable name and unsued";

  // should be awaited
  runAndForget();

  final String kingLongName = "dhbahsdhbashfhsdvhfvahsvhvdhfasvfhvasfhvhvahsvdhahsvf";
}

Future runAndForget() {
  return Future.value(56);
}

class SomeConstClass {
  const SomeConstClass(this.immutableNumber);

  final int immutableNumber;
}

Use this package as an executable

1. Install it

You can install the package from the command line:


$ pub global activate dbstyleguidechecker

2. Use it

The package has the following executables:


$ dbstyleguidechecker

Use this package as a library

1. Depend on it

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


dependencies:
  dbstyleguidechecker: ^1.0.4

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

Alternatively, your editor might support pub get or 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:dbstyleguidechecker/dbstyleguidechecker.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
0
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
50
Learn more about scoring.

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

  • Dart: 2.5.1
  • pana: 0.12.21

Platforms

Detected platforms: Flutter, other

Primary library: package:dbstyleguidechecker/dbstyleguidechecker.dart with components: io.

Health suggestions

Format lib/src/utils/file_utils.dart.

Run dartfmt to format lib/src/utils/file_utils.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.4.0 <3.0.0
args ^1.5.2 1.5.2
http ^0.12.0+2 0.12.0+2
io ^0.3.3 0.3.3
meta ^1.1.7 1.1.7
path ^1.6.4 1.6.4
Transitive dependencies
async 2.4.0
charcode 1.1.2
collection 1.14.12
http_parser 3.1.3
pedantic 1.8.0+1
source_span 1.5.5
string_scanner 1.0.5
term_glyph 1.1.0
typed_data 1.1.6
Dev dependencies
flutter_code_style ^1.6.3
test ^1.8.0