lirantal/pie-my-vulns

Feature request: Expose Parsers and Reporters as an API

Open

#50 opened on Mar 28, 2020

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)JavaScript (5 forks)github user discovery
good first issuehacktoberfesthelp wanted

Repository metrics

Stars
 (26 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Is your feature request related to a problem? Please describe. I was thinking it would be great to expose the parsers and potentially reporters too as an API. It would really just require exposing them via the main export file for anyone wanting to use this as a lib instead of a CLI too.

Potentially later we can split to another package but should be an easy start just exposing them straight-out right now.

Describe alternatives you've considered Doing this is ugly and opens many potential issues in the future:

const parser = require('pie-my-vulns/src/Parsers/SeverityTypeParser.js');

Contributor guide

Research direction
Export the parser and reporter modules from the main entry point (e.g., index.js) so they can be required directly by users without deep path imports.
Tech stack
javascriptnodejs
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85