README.md

issue

A tool to help cli package authors make raising issues like bug reports more interactive for their users.

Features

• Interactive file based prompts for great UX.
• Ability to break the issue body into separate customizable user-prompts.
• Supports executing cli commands to collect system / project data, like flutter doctor.
• Customizable Issue Tracker. Supports GitHub out-of-the-box (obviously).

Demo

demo.mp4

Usage

Run dart example/issue.dart to experience issue, or checkout the following sample.

import 'package:issue/issue.dart';

void main(List<String> args) async {
  IssueConfig config = IssueConfig(
    template: FlutterBugReportIssueTemplate(
      assignees: ['werainkhatri'],
      labels: ['bug'],
      giveCredits: true,
    ),
    tracker: GitHubIssueTracker(
      organization: 'werainkhatri',
      repository: 'issue',
    ),
  );

  try {
    await buildIssueAndOpen(config);
  } on UserInterruptException catch (e) {
    print(e);
  }
}