issue library
A tool to help cli package authors make raising issues like bug reports more interactive for their users.
Classes
- ActualResultsIssueSection
- AdditionalContextIssueSection
- CodeDetailsIssueSection
- CombinedIssueSection
- Combined user driven issue sections will be shown in one file prompt.
- CreditsIssueSection
- A section that credits the issue package.
- DescriptionIssueSection
- DetailsIssueSection
- DividerIssueSection
- A section that contains a markdown divider.
- ExpectedBehaviorIssueSection
- FlutterBugReportIssueTemplate
-
A bug report issue template for Flutter apps. Along with the conventional
issue template, it also attaches the output for
flutter doctor -v
. - FlutterDoctorIssueSection
- GitHubIssueTracker
- IssueTracker implementation for GitHub.
- IssueConfig
- IssueSection
- A particular section of the issue body, defined by its structure.
- IssueTemplate
- A customizable template of an issue.
- IssueTracker
- A customizable issue tracking website, like GitHub, GitLab, etc.
- SampleDartCodeIssueSection
- SimpleBugReportIssueTemplate
- A simple bug report issue template.
- StepsToReproduceIssueSection
Enums
- DrivenBy
- Who is responsible for populating this section.
Functions
-
buildIssue(
IssueConfig config) → Future< Uri> -
Builds an issue from the given
config
and returns the URI of the issue. -
buildIssueAndOpen(
IssueConfig config) → Future< void> -
Builds an issue from the given
config
and opens it in the browser.
Exceptions / Errors
- CommandFailureException
- Thrown when a IssueSection.command fails to execute / returns non-zero exit code.
- UnexpectedException
- Thrown when an unexpected error occurs.
- UserInterruptException
- Thrown when the user interrupts the process by emptying the file and closing it.