❤
npm
Sign UpSign In

github-issue-parser

0.0.2 • Public • Published

GitHub Issue Parser

This module parses github issue templates from markdown into plain JavaScript objects. It understands both markdown headers and list items.

Example:

* **Version**: 1.2.3
* **Operating System:** Mac
 
## Actual Behavior
 
some bad behavior
 
## Expected Behavior
 
some good behavior
const issueParser = require('github-issue-parser')
 
const issueData = fs.readFileSync('/path/to/issue.md', 'utf8')
const jsonBlob = issueParser(issueData)
console.log(jsonBlob)
/*
{
  'Version:': { raw: '1.2.3', html: '1.2.3' },
  'Operating System:': { raw: 'Mac', html: 'Mac },
  'Actual Behavior': {
    raw: 'some bad behavior',
    html: '<p>some bad behavior</p>'
  },
  'Expected Behavior': {
    raw: 'some good behavior',
    html: '<p>some good behavior</p>'
  },
}
*/

Readme

Keywords

none

Package Sidebar

Install

npm i github-issue-parser

Repository

github.com/codebytere/github-issue-parser

Homepage

github.com/codebytere/github-issue-parser#readme

Weekly Downloads

1

Version

0.0.2

License

MIT

Unpacked Size

8.29 kB

Total Files

8

Last publish

Collaborators

  • codebytere
Try on RunKit
Report malware