dbstyleguidechecker library
Classes
- CodeStyleViolationsChecker
- Code Style Violations Checker.
- CodeStyleViolationsParser
- Code style violations parser.
- CodeStyleViolationsReporter
- Code style violations reporter.
- ConsoleCodeStyleViolationsReporter
- Create CodeStyleViolationsReporter that report violation to the console.
- DartAnalyzerViolationParser
- Dart analyzer violation parser.
- DartProjectStyleGuideChecker
- Dart project style guide linter.
- FileCodeStyleViolationsReporter
- File CodeStyleViolationsReporter
- FlutterProjectStyleGuideChecker
- Flutter project style guide linter.
- GithubPullRequestStyleGuideCheckReporter
- Github pull request style guide check reporter.
- JsonCodeStyleViolationReporter
- ScriptArgument
- DBStyleGuideChecker script arguments.
- VcsArgument
- VCS Argument provided to the script by the user.
Constants
- dartProjectType → const String
-
Script parameter used for
_projectTypeParameterparameter to specify that the script is run on a dart project. - dependenciesOverridden → const String
- Dependencies overridden message.
- exitFileDiffParsingError → const int
- Process exit because file diff parsing error.
- exitGithubApiError → const int
- Process exit because of github server api error.
- exitInvalidArgument → const int
- Process exit code for invalid command line argument.
- exitMissingRequiredArgument → const int
- Process exit code for missing required command line argument.
- exitPackageUpdatedFailed → const int
- Process exit code when flutter packages get or pub get failed.
- exitParsingViolationFailed → const int
- Process exit code when parsing violations failed.
- exitUnexpectedError → const int
- Process exit code when an unexpected error occurred.
- flutterProjectType → const String
-
Script parameter used for
_projectTypeParameterparameter to specify that the script is run on a flutter project. - helpParameter → const String
- Script parameter used to print help.
- reporterOfTypeConsole → const String
-
Script parameter used for the
_reporterTypeParameterparameter to specify code violation reporter that will print violations to the console. - reporterOfTypeFile → const String
-
Script parameter used for the
_reporterTypeParameterparameter to specify code violation reporter that will print violations to a file specified by_reporterOutputFileParameter. - reporterOfTypeGithub → const String
-
Script parameter used for the
_reporterTypeParameterparameter to specify code violation reporter that will print violations to a github pull request. - reporterOfTypeJson → const String
-
Script parameter used for the
_reporterTypeParameterparameter to specify code violation reporter that will print violations to the console as json. -
supportedProjectType
→ const List<
String> - List of project type supported by the script.
Properties
- argumentParser → ArgParser
-
DBStyleGuideChecker script argument parser.
final
Functions
-
getGithubRepoName(
String repoUrl) → String -
Get the github repository name from
repoUrl. -
getGithubRepoOwner(
String repoUrl) → String -
Get the github repository owner name from
repoUrl. -
printHelpMessage(
[String? message]) → void - Print help message to the console.
Exceptions / Errors
- UnrecoverableException
- A class that represent a exception that can't be recovered.