Giter VIP home page Giter VIP logo

bugbuddy's Introduction

Important

What you are seeing here is an in-progress implementation of our thesis paper. While you are free to use this, it remains unanswered if this is effective while no testing has been conducted yet.

BugBuddy

BugBuddy is a tool for making programming errors less scary and more friendly, making debugging more easy-to-learn. Powered by ErrgoEngine.

Features

  • Translates programming errors into human-readable messages
  • Provides a run command to execute the current file in BugBuddy
  • Supports multiple programming languages
  • Supports multiple text editors / IDEs (via Language Server Protocol)

Usage

To use BugBuddy, a program should be running on top of it. With that, you may use the bugbuddy -- command:

# Syntax
$ bugbuddy -- <command [ARGS]>

# Example for java
$ bugbuddy -- java HelloWorld

# Example for python
$ bugbuddy -- python hello_world.py

# Example for programs compiled in compiled languages (eg. C, C++, C#, Go, etc.)
$ bugbuddy -- ./hello_world
$ bugbuddy -- ./hello_world.exe # For Windows users

The bugbuddy -- is also useful during compilation! Simply append bugbuddy -- to your compiler:

# This will capture the compiler error/s from your Java compiler (javac)
$ bugbuddy -- javac HelloWorld.java

To be able to see the enhanced errors, a BugBuddy extension should be installed in your text editor / IDE:

Note

BugBuddy implements the Language Server Protocol (LSP) so any LSP-supported text editor / IDE is also supported. However, you will have a reduced experience as it implements additional features outside the LSP spec that your editor might not support of. If you still want to use it, simply connect the bugbuddy lsp command to your editor.

Paper

  • TODO

Copyright and license

(c) 2023 by the BugBuddy / ErrgoEngine Authors. Code released under the MIT License.

bugbuddy's People

Contributors

nedpals avatar norg-ned avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

bugbuddy's Issues

Daemon

Description

The daemon server is the heart of the BugBuddy system. This is where all of the processing happens including the processing of error messages which is powered by ErrgoEngine. Is only run once and in the background. Can be started by the user or by the clients (LSP or executors) when there are no existing instances running. It should be able to terminate itself when there are no clients connected to it in a certain amount of time.

Features

Server

  • Establish server connection

  • Handle multiple clients (regardless if executor or LSP)

  • Propagate/send processed errors to clients

  • Process incoming errors to errgoengine

  • Handle virtual file management

  • Add

  • Update

  • Delete

  • Tests

LSP Server

Description

Responsible for being the middleman between the daemon server and the editors. Communicates any incoming requests from the editors via the LSP protocol and sends them to the daemon server through JSON-RPC.

Feature Checklist

LSP

  • Establish connection
  • Add documents
  • Update documents
  • Delete documents
  • Send diagnostics

BugBuddy Daemon <-> LSP

  • Establish connection
  • Add files to daemon
  • Update files to daemon
  • Delete files to daemon
  • Received processed errors from daemon

Custom

  • Instruct client to display error explanation on error underline

Not sure

  • Check if client supports rendering on markdown

VSCode Implementation

Implementation Checklist

  • Establish successful connection to BugBuddy LSP
  • Able to read incoming errors on currently running program
    • NOTE: Relies on typing via integrated terminal. No "run program" button similar to NetBeans.
  • Able to display underline as an error
  • Able to display error explanation details.

NetBeans Implementation

Implementation Checklist

  • Establish successful connection to BugBuddy LSP
  • Able to read incoming errors on currently running program
    • Blocker: Cannot intercept running application inside NetBeans
      • NOTE: Currently exploring hooking directly to the current project output window to scan the error. Still stuck in watching for current project.
  • Able to display underline as an error (nope)
  • Able to display error explanation details.

Information Logging

  • Create table for logging information
    • Participant ID
    • Executed command
    • Received error code
    • Received error message
    • Offending source code
  • Create function for generating unique ID

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.