Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support handling for more variability in markdown title lines #7

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Support handling for more variability in markdown title lines #7

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e6b717a
Support handling for more variability in markdown title lines
paulczajka Oct 7, 2022
8a98121
Update to match current final report format
paulczajka Oct 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 30 additions & 11 deletions lib/issues.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,18 @@ exports.severityNames = {
'spec': 'Spec Breaking',
}

// Final report title lines should have a single format:
// ## (H-1) Not good thing
//
// Markdown title lines have more variability:
// ### [H-1] Not good thing
// ## (H-1) Also not good
// **[G-1]** Gassy code
//
// This RegExps will select any of these formats
const ISSUE_TAG_RE = `[\\(\\[<](([CHMLQIG])-[0-9]+)[\\)\\]>]`
const TITLE_LINE_RE = `^(#{1,3} +)?\\*{0,2}${ISSUE_TAG_RE}\\*{0,2} +(.+)`

exports.statusNames = STATUSES

exports.normalize = function normalizeIssue(issue) {
Expand All @@ -70,7 +82,7 @@ exports.normalize = function normalizeIssue(issue) {
}

function parseTitleLine(titleLine) {
const [, tag, severity, title] = titleLine.match(/^## +\((([CHMLQIG])-[0-9]+)\) +(.+)/)
const [,, tag, severity, title] = titleLine.match(new RegExp(TITLE_LINE_RE))
return { tag, severity, title }
}

Expand Down Expand Up @@ -108,39 +120,46 @@ const IMPACT_LABEL_RE = /(?:\*\*)?Impact(?:\*\*)?:(?:\*\*)? ([^\n]+)?/
const CHANCE_LABEL_RE = /(?:\*\*)?Likelihood(?:\*\*)?:(?:\*\*)? ([^\n]+)?/

exports.parseNotionMarkdownIssues = function parseNotionMarkdownIssues(markdown) {
return markdown.split(/(?=##\s+\([CHMLQGI]-\d\))/)
return markdown.split(new RegExp(`(?=${TITLE_LINE_RE})`))
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wasn't able to get the Issue Formatter to work with pasting in multiple issues at once: either before or after these changes. Not sure if this was working yet? I've just been pasting them in one-at-a-time for now.

.filter(x => !x.match(/^[\s\n]*$/))
.map(issueContent => {
issueContent = issueContent.trim()
let impact = ''
let chance = ''

const { severity } = parseTitleLine(issueContent.split('\n')[0])
const [firstLine, ...contentLines] = issueContent.trim().split('\n')
const { tag, severity, title } = parseTitleLine(firstLine)

// Normalize markdown title format for the final report:
// ## [H-1] Not good thing
const issueTitle = `## (${tag}) ${title}`
let issueBody = contentLines.join('\n')

// SORRY WINDOWS
const impactMatch = issueContent.match(IMPACT_LABEL_RE)
const impactMatch = issueBody.match(IMPACT_LABEL_RE)
if (impactMatch) {
impact = impactMatch[1].match(/spec/i) ? 'spec' : impactMatch[1].toLowerCase()
if (!IMPACT_SEVERITIES.includes(impact)) {
throw new Error(`Invalid impact: ${impact}`)
}
issueBody = issueBody.replace(IMPACT_LABEL_RE, '')
}
const chanceMatch = issueContent.match(CHANCE_LABEL_RE)
const chanceMatch = issueBody.match(CHANCE_LABEL_RE)
if (chanceMatch) {
chance = chanceMatch[1].toLowerCase()
if (!CHANCE_SEVERITIES.includes(chance)) {
throw new Error(`Invalid chance: ${chance}`)
}
issueBody = issueBody.replace(CHANCE_LABEL_RE, '')
}

//Remove all empty leading lines
issueBody = issueBody.replace(/^( *\n)+(.*)$/gm, '$2')

return {
impact,
chance,
severity,
content: issueContent
.replace(IMPACT_LABEL_RE, '')
.replace(CHANCE_LABEL_RE, '')
.replace(/(## [^\n]+)\n+/g, '$1\n\n') // Consolidate extra newlines
,
content: issueTitle + '\n\n' + issueBody,
}
})
}
Expand Down