https://github.com/werainkhatri/issue

A tool to help cli package authors make raising issues like bug reports more interactive for their users.
https://github.com/werainkhatri/issue

cli dart issue

Last synced: 8 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/werainkhatri/issue
• Owner: werainkhatri
• License: mit
• Created: 2022-10-09T06:31:30.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-10-18T23:49:56.000Z (over 3 years ago)
• Last Synced: 2025-03-30T14:02:02.255Z (about 1 year ago)
• Topics: cli, dart, issue
• Language: Dart
• Homepage: https://pub.dev/packages/issue
• Size: 45.9 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          

# issue

[![pub package](https://img.shields.io/pub/v/issue.svg)](https://pub.dev/packages/issue)

[![pub points](https://img.shields.io/pub/points/issue?color=2E8B57&label=pub%20points)](https://pub.dev/packages/issue/score)

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

https://user-images.githubusercontent.com/44755140/195989524-01e523be-4b6d-4894-aa95-80bd5f162450.mp4

## Usage

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

```dart

import 'package:issue/issue.dart';

void main(List 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);

  }

}

```