dbstyleguidechecker 2.0.0

A tool that help you verify a project agains code style guide and automatize pull request review.

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

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

license.

Installation for usage everywhere in the system.

pub global activate dbstyleguidechecker

Installation for usage only in the current package.

pub activate dbstyleguidechecker

Usage: dbstyleguidechecker --project-type [project type] [local project directory]

Options:

--code-style specify the code style guide to use (defaults to "analysis_options.yaml")

--project-type specify the type of project to analyze, default to "dart", available options are ["dart", "flutter"]

--reporter-type specify the reporter type, default to 'console', available are ['console', 'file', 'github']

--vcs-url repository to push code style violations on the pull request (currently supported only for reporter type github).

--vcs-pull-request-id to push code style violations on (currently supported only for reporter type github).

--vcs-access-token api access token used to push code style violations on pull request (currently supported only for reporter type github).

--reporter-output-file where code violation will be reported (currently supported only for reporter type file).

--help print help message

Example usage:

Use code style from different location then current project or different file name.

dbstyleguidechecker --project-type dart --code-style [path to code style file] example

Report code style violations to console.

dbstyleguidechecker --project-type dart example

Report code style violations to github

dbstyleguidechecker --project-type dart --reporter-type github --vcs-url https://github.com/bitsydarel/dbstyleguidechecker --vcs-pull-request-id [pull-request-id] --vcs-access-token [github-api-access-token] example

Report code style violations to file.

dbstyleguidechecker --project-type dart --reporter-type file --reporter-output-file example/log.txt example