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

Viren Khatri

Last update: Oct 18, 2022

Related tags

Overview

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);
  }
}

A CLI tool and Dart package that can scrape file and directory URLs from h5ai instances.

h5ai scraper A CLI tool and Dart package that can scrape file and directory URLs from h5ai instances. Usage This tool requires the Dart SDK. It can be

Jan 4, 2023

Additional alignments to help make your layouts more readable (TopLeft, TopRight, etc)

extra alignments Why should Center get all the love? This package adds additional alignments to help make your layouts more readable. The full set inc

Jan 6, 2023

:bug: Flutter debug helper widget with common and custom actions

Debug Friend Flutter debug helper widget with common and custom actions This helps you reduce the development and testing time of new features Show so

Dec 7, 2022

Bug reporting SDK for Flutter apps.

Shake for Flutter Flutter plugin for Shake. How to use Install Shake Add Shake to your pubspec.yaml file. dependencies: shake_flutter: ^15.0.0 I

Oct 18, 2022

A cross-platform Flutter home workout app that respects your privacy. THIS IS A GITLAB MIRROR, file issues and contribute there.

Feeel Feeel is an open-source workout app for doing simple at-home exercises. This is a rewrite of the original app in Flutter, to make development ea

Dec 26, 2022

Ozzie is your testing friend. Ozzie will take an screenshot during integration tests whenever you need. Ozzie will capture performance reports for you.

ozzie.flutter Ozzie is your testing friend. Ozzie will take an screenshot during integration tests whenever you need. Ozzie will capture performance r

Nov 3, 2022

Comments

`Flutter doctor` not generated in Ubuntu

Describe the bug

Ubuntu didn't generate flutter doctor -v

Steps to reproduce

run issue creation on Ubuntu.

Expected behavior

See flutter information on the issue.

Actual results

No flutter information.

Additional context

Screencast from 18-10-22 16:11:18.webm

This issue was created using issue.

Flutter doctor -v

[✓] Flutter (Channel stable, 3.3.4, on Ubuntu 22.04.1
    LTS 5.15.0-50-generic, locale en_US.UTF-8)
    • Flutter version 3.3.4 on channel stable at
      /home/bri/sdk/flutter-stable
    • Upstream repository
      https://github.com/flutter/flutter.git
    • Framework revision eb6d86ee27 (2 weeks ago),
      2022-10-04 22:31:45 -0700
    • Engine revision c08d7d5efc
    • Dart version 2.18.2
    • DevTools version 2.15.0

[✓] Android toolchain - develop for Android devices (Android SDK version 32.1.0-rc1)
    • Android SDK at /home/bri/Android/Sdk
    • Platform android-32, build-tools 32.1.0-rc1
    • Java binary at: /home/bri/app/android-studio/jre/bin/java
    • Java version Java(TM) SE Runtime Environment (build 17.0.1+12-LTS-39)
    • All Android licenses accepted.

[✓] Chrome - develop for the web
    • Chrome at google-chrome

[✓] Linux toolchain - develop for Linux desktop
    • Ubuntu clang version 14.0.0-1ubuntu1
    • cmake version 3.22.1
    • ninja version 1.10.1
    • pkg-config version 0.29.2

[✓] Android Studio (version 2021.2)
    • Android Studio at /home/bri/app/android-studio
    • Flutter plugin version 70.2.2
    • Dart plugin version 212.5744
    • Java version Java(TM) SE Runtime Environment (build 17.0.1+12-LTS-39)

[✓] VS Code (version 1.71.2)
    • VS Code at /usr/share/code
    • Flutter extension version 3.50.0

[✓] Connected device (2 available)
    • Linux (desktop) • linux  • linux-x64      • Ubuntu 22.04.1 LTS 5.15.0-50-generic
    • Chrome (web)    • chrome • web-javascript • Google Chrome 105.0.5195.125

[✓] HTTP Host Availability
    • All required HTTP hosts are available

• No issues found!

bug

opened by BrianCraig 2

Distribute as a CLI.
Describe the bug

For using this package i had to:

Clone the repository

run dart pub get on root folder.

run dart ./example/issue.dart on root

Expected usage

Installing global locally as a tool.

Run from any location (preferably using a cwd file as the configuration file, example default-issue.json)

This issue was created using issue.
unplanned
opened by BrianCraig 1
v1.0.0
[ ] make this a gh project?

[ ] add BlankIssueTemplate.

[ ] test entire flow in linux and windows.

[ ] find out if the file prompt handler function (that uses Process) can be mocked so that it can be tested e2e.

[ ] add ci/cd steps.

[ ] handle usecase where IssueTemplate contains only command driven issue sections.

[ ] support for custom editor as per package user / end user's choice. use this to get the commands for all.

[ ] feature for end user to select an editor from available editors from the terminal at runtime.

[ ] add customizability for package author to choose if a section should have an interact.Choose prompt before the file prompt.

[ ] add custom prompt text support for command driven issue sections.

[ ] pretify using ansi_styles.

[ ] find out and handle the max url length, if any.

[ ] see if downloading and parsing a github issue template would work.

[ ] find how to handle exceptions with nice stdout w/o stacktrace.

[ ] make publishable

[ ] document public APIs.

[ ] add customizability for which template to be used based on user choice. User can choose which type of issue is to be raised (bug, feature request, etc) and the the template is decided.

[ ] "Steps to reproduce" should mention if there's a Code Sample step coming up.

[ ] enable Dependabot.

[ ] automate package version management.

documentation enhancement
opened by werainkhatri 0

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

Related tags

Overview

issue

Features

Demo

Usage

You might also like...

Comments

Describe the bug

Steps to reproduce

Expected behavior

Actual results

Additional context

This issue was created using issue.

Describe the bug

Expected usage

This issue was created using issue.

Owner

Viren Khatri

Breathe is a mental health blogging app where users can join communities of doctors and other users from around the world and both share their problems as well as lend a ear to and help others

A tool for digitizing medical history, prescriptions, and reports.

Academic master is E-learning app where students can share their doubts wiith their peers they can chat and also they can find their notes

A platform for car sharing where users can book any car that suits their needs and wants for their intended journey, from the closest hosts in the community.

Atlas is a Blogging app made using Flutter and Firebase. Users can register on the app, start creating blog posts about almost anything that comes to their mind. Users can also search for other people present on the app, and the content that they have posted.

It is a Mobile Application built with Flutter to help Instructors reach their students with the material needed for their course (Videos, PDFs, Exams)

A Flutter Augmented Reality based Furniture App which can help users to virtually try on furniture to their smartphone with personalized instructions

MQuote provides you +700 Motivational & Inspirational quotes by famous authors, celebrities. Powered by Flutter

flutter app to manage books and authors data using graphql on hasura.io

An Interactive tool for visualization of data reported by the Amiga Tractor onto the panoramic cluster display of Liquid Galaxy.