dice-roller/rpg-dice-roller

Split output to separate module / library

Open

#132 opened on May 18, 2020

View on GitHubContributor guide
 (1 comment) (2 reactions) (0 assignees)JavaScript (68 forks)auto 404
enhancementhelp wantedsuggestion

Repository metrics

Stars
 (279 stars)
PR merge metrics
 (PR metrics pending)

Description

Is your feature request related to a problem? Please describe. The roll output, that returns the string version of the roll log, is currently built in to the individual classes and is not easily changeable. It could be helpful if the output was built as a separate module, so that it can be easily swapped out for a different output type. This would enable easier modification of the output and allow things like HTML output.

Describe the solution you'd like Move the output functionality into it's own set of classes that can handle the various objects that need to be output.

It may be beneficial for this to be it's own library, rather than built in to the dice roller itself. The alternative is to simply build it inside the library as it's own set of modules.

Contributor guide

Research direction
Explore the current roll classes to understand how output strings are generated, then design an abstract output class or module that can be easily extended for different formats like HTML or plain text.
Tech stack
javascript
Domain
backendtooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70