Formatted code across project

jeffschwartz · jeffschwartz · commit 60d6cd425db1 · 2024-06-06T10:10:10.000-04:00
diff --git a/README.md b/README.md
@@ -1,16 +1,14 @@
 # Snitch 👉
 
-"A project isn't complete unless it has a CHANGELOG!" -- Jeff Schwartz, aka 4awpawz
-
 ![Static Badge](https://img.shields.io/badge/Markdown-green)
 ![GitHub Release](https://img.shields.io/github/release/4awpawz/snitch/all.svg)
 [![npm version](https://badge.fury.io/js/@4awpawz%2Fsnitch.svg)](https://badge.fury.io/js/@4awpawz%2Fsnitch)
 [![License](https://img.shields.io/badge/license-MIT-%230172ad)](https://github.com/picocss/pico/blob/master/LICENSE.md)
 [![Twitter URL](https://img.shields.io/twitter/url/https/twitter.com/4awpawz.svg?style=social&label=Follow%20%404awpawz)](https://twitter.com/4awpawz)
 
-## A Multi Purpose GitHub Issue Reporting Tool
+## Automated GitHub Issues Reporting
 
-Snitch is a terminal utility that lets you easily create attractive, interactive, and informative reports from GitHub issues that can be used for tracking both open and closed issues by label, assignee and milestone and can provide a timely, accurate, and consolidated view of a project's status.
+Snitch is a terminal utility that automates the creation of interactive and informative reports from a GitHub repository's issues.
 
 [![Snitch milestone report video](https://img.youtube.com/vi/u-7oJJUUdGs/0.jpg)](https://www.youtube.com/watch?v=u-7oJJUUdGs)
 
diff --git a/core/index.mjs b/core/index.mjs
@@ -16,8 +16,10 @@ export async function snitch(args) {
     const issues = JSON.parse(result)
     let output = ""
     if (!config.noHeading && config.heading.length) output +=
-        config.asText ? `${config.heading}\n\n` :
-            renderInteractive(config, `<h1><a href="${config.repo}" target="_blank" title="link to repository ${config.repo}">${config.heading}</a></h1>\n\n`, `<h1>${config.heading}</h1>\n\n`)
+        config.asText ? `${config.heading}` :
+            renderInteractive(config,
+                `<h1><a href="${config.repo}" target="_blank" title="link to repository ${config.repo}">${config.heading}</a></h1>`,
+                `<h1>${config.heading}</h1>`)
     switch (config.reportName) {
         case "list":
             output += issuesReport(config, issues)
@@ -37,9 +39,12 @@ export async function snitch(args) {
         default:
             throw new TypeError(`invalid report type, you entered ${config.reportName}`)
     }
+    const reportEndsWithThreeNewLines = output.endsWith("\n\n\n")
+    console.error("report ends with three spaces: ", reportEndsWithThreeNewLines)
+    if (!config.noAttribution && config.asText) output += "\n\n"
     if (!config.noAttribution) output +=
-        config.asText ? `\n| ${attributionText} @ ${snitchUrl}` :
-            `\n> [${attributionText}](${snitchUrl})`
+        config.asText ? `| ${attributionText} @ ${snitchUrl}` :
+            `<blockquote><a href="${snitchUrl}" target="_blank">${attributionText}</a></blockquote>`
     process.stdout.write(output)
     process.exit(0)
 } 
diff --git a/core/lib/formatIssue.mjs b/core/lib/formatIssue.mjs
@@ -1,4 +1,4 @@
 export function formatIssue({ state, number, title, labels, assignees, milestone }) {
-    const template = `${state} ${number} ${title} ${labels} ${assignees} ${milestone}\n`
+    let template = `${state} ${number} ${title} ${labels} ${assignees} ${milestone}`
     return template
 }
diff --git a/core/services/configure.mjs b/core/services/configure.mjs
@@ -29,6 +29,7 @@ export async function configure(args) {
     config.debug = args.includes("--debug")
     config.noAttribution = args.includes("--no-attribution")
     config.asText = args.includes("--as-text")
+    config.blankLines = args.includes("--blank-lines")
     if (!config.debug && !reportTypes.includes(config.reportName)) {
         console.error("------------------")
         console.error("Pick A Report Type")
diff --git a/core/services/reports/issuesByAssigneeReport.mjs b/core/services/reports/issuesByAssigneeReport.mjs
@@ -6,7 +6,7 @@ import { renderInteractive } from "../../lib/renderInteractive.mjs"
 import { assigneeUrl } from "../../lib/urls.mjs"
 
 function assignee(config, _assignee) {
-    return config.asText ? _assignee.name : renderInteractive(config,
+    return config.asText ? `\n\n${_assignee.name}` : renderInteractive(config,
         `<h2><a href="${assigneeUrl(config, _assignee)}" target="_blank" title="link to assignee ${_assignee.name}">${_assignee.name}</a></h2>`,
         `<h2>${_assignee.name}</h2>`
     )
@@ -30,7 +30,7 @@ function mapReportableAssignee(config, assignee, issues) {
     asgn.id = assignee.id
     asgn.login = assignee.login
     asgn.name = assignee.name
-    asgn.issues = getReportableIssues(config, asgn, issues) + "\n"
+    asgn.issues = getReportableIssues(config, asgn, issues)
     return asgn
 }
 
@@ -63,9 +63,8 @@ export function issuesByAssigneeReport(config, issues) {
     for (let i = 0; i < reportableAssignees.length; i++) {
         const reportableAssignee = reportableAssignees[i]
         let formattedOutput = ""
-        formattedOutput += assignee(config, reportableAssignee) + "\n\n"
+        formattedOutput += assignee(config, reportableAssignee)
         formattedOutput += reportableAssignee.issues
-        if (i < reportableAssignees.length - 1) formattedOutput += "\n"
         output += formattedOutput
     }
     return output
diff --git a/core/services/reports/issuesByLabelReport.mjs b/core/services/reports/issuesByLabelReport.mjs
@@ -6,8 +6,10 @@ import { renderInteractive } from "../../lib/renderInteractive.mjs"
 import { reportUnreportables } from "../../lib/reportUnreportables.mjs"
 
 function label(config, label) {
-    return config.asText ? `${label.name}` :
-        renderInteractive(config, `<h2 style="color: #${label.color};"><a style="color: inherit;" href="${labelUrl(config, label)}" target="_blank" title="link to label ${label.name}">${label.name}</a></h2>`, `<h2 style="color: #${label.color};">${label.name}</h2>`)
+    return config.asText ? `\n\n${label.name}` :
+        renderInteractive(config,
+            `<h2 style="color: #${label.color};"><a style="color: inherit;" href="${labelUrl(config, label)}" target="_blank" title="link to label ${label.name}">${label.name}</a></h2>`,
+            `<h2 style="color: #${label.color};">${label.name}</h2>`)
 }
 
 /*
@@ -58,9 +60,8 @@ export function issuesByLabelReport(config, issues) {
     for (let i = 0; i < reportableLabels.length; i++) {
         const reportableLabel = reportableLabels[i]
         let formattedOutput = ""
-        formattedOutput += label(config, reportableLabel) + "\n\n"
+        formattedOutput += label(config, reportableLabel)
         formattedOutput += reportableLabel.issues
-        if (i < reportableLabels.length - 1) formattedOutput += "\n"
         output += formattedOutput
     }
     return output
diff --git a/core/services/reports/issuesByMilestoneAndLabelReport.mjs b/core/services/reports/issuesByMilestoneAndLabelReport.mjs
@@ -8,13 +8,17 @@ import { renderInteractive } from "../../lib/renderInteractive.mjs"
 function milestone(config, _milestone) {
     let title = _milestone.title
     title = _milestone.dueOn ? `${title} (${_milestone.dueOn.substring(0, 10)})` : title
-    return config.asText ? `${title}\n\n` :
-        renderInteractive(config, `<h2><a href="${milestoneUrl(config, _milestone)}" target="_blank" title="link to milestone ${_milestone.title}">${title}</a></h2>\n\n`, `<h2>${title}</h2>\n\n`)
+    return config.asText ? `\n\n${title}` :
+        renderInteractive(config,
+            `<h2><a href="${milestoneUrl(config, _milestone)}" target="_blank" title="link to milestone ${_milestone.title}">${title}</a></h2>`,
+            `<h2>${title}</h2>`)
 }
 
 function label(config, label) {
-    return config.asText ? `  ${label.name}\n\n` :
-        renderInteractive(config, `<h3 style="color: #${label.color};"><a style="color: inherit;" href="${labelUrl(config, label)}" target="_blank" title="link to label ${label.name}">${label.name}</a></h3>\n\n`, `<h3 style="color: #${label.color};">${label.name}</h3>\n\n`)
+    return config.asText ? `\n\n  ${label.name}` :
+        renderInteractive(config,
+            `<h3 style="color: #${label.color}; margin-left: 2ch;"><a style="color: inherit;" href="${labelUrl(config, label)}" target="_blank" title="link to label ${label.name}">${label.name}</a></h3>`,
+            `<h3 style="color: #${label.color}; margin-left: 2ch;">${label.name}</h3>`)
 }
 
 /*
@@ -23,7 +27,8 @@ function label(config, label) {
 function getReportableIssues(config, milestone, label, issues) {
     const selector = { showState: true, showLabels: false, showAssignees: true, showMilestones: false }
     const milestoneLabelIssues = []
-    issues.forEach(issue => issue.milestone && issue.milestone.number === milestone.number && issue.labels.some(issueLabel => issueLabel.id === label.id && milestoneLabelIssues.push(issue)))
+    issues.forEach(issue =>
+        issue.milestone && issue.milestone.number === milestone.number && issue.labels.some(issueLabel => issueLabel.id === label.id && milestoneLabelIssues.push(issue)))
     const lss = issuesReport(config, milestoneLabelIssues, selector)
     return lss
 }
@@ -84,9 +89,7 @@ export function issuesByMilestoneAndLabelReport(config, issues) {
             const reportableMilestoneLabel = reportableMilestone.labels[ii]
             formattedOutput += label(config, reportableMilestoneLabel)
             formattedOutput += reportableMilestoneLabel.issues
-            if (ii < reportableMilestone.labels.length - 1) formattedOutput += "\n"
         }
-        if (i < reportableMilestones.length - 1) formattedOutput += "\n"
         output += formattedOutput
     }
     return output
diff --git a/core/services/reports/issuesByMilestoneReport.mjs b/core/services/reports/issuesByMilestoneReport.mjs
@@ -8,8 +8,10 @@ import { milestoneUrl } from "../../lib/urls.mjs"
 function milestone(config, _milestone) {
     let title = _milestone.title
     title = _milestone.dueOn ? `${title} (${_milestone.dueOn.substring(0, 10)})` : title
-    return config.asText ? `${title}\n\n` :
-        renderInteractive(config, `<h2><a href="${milestoneUrl(config, _milestone)}" target="_blank" title="link to milestone ${_milestone.title}">${title}</a></h2>\n\n`, `<h2>${title}</h2>\n\n`)
+    return config.asText ? `\n\n${title}` :
+        renderInteractive(config,
+            `<h2><a href="${milestoneUrl(config, _milestone)}" target="_blank" title="link to milestone ${_milestone.title}">${title}</a></h2>`,
+            `<h2>${title}</h2>`)
 }
 
 /*
@@ -30,7 +32,7 @@ function mapReportableMilestone(config, _milestone, issues) {
     ms.title = milestone(config, _milestone)
     ms.number = _milestone.number
     ms.dueOn = Object.hasOwn(_milestone, "dueOn") && _milestone.dueOn || null
-    ms.issues = getReportableIssues(config, ms, issues) + "\n"
+    ms.issues = getReportableIssues(config, ms, issues)
     return ms
 }
 
@@ -64,7 +66,7 @@ export function issuesByMilestoneReport(config, issues) {
         let formattedOutput = ""
         formattedOutput += reportableMilestone.title
         formattedOutput += reportableMilestone.issues
-        if (i < reportableMilestones.length - 1) formattedOutput += "\n"
+        // formattedOutput += !config.blankLines && config.asText && "\n" || ""
         output += formattedOutput
     }
     return output
diff --git a/core/services/reports/issuesReport.mjs b/core/services/reports/issuesReport.mjs
@@ -33,7 +33,9 @@ function milestone(config, milestone) {
     msName += milestone.dueOn ?
         ` (${milestone.dueOn.substring(0, 10)})` :
         ""
-    return config.asText ? msName : renderInteractive(config, `<a href="${milestoneUrl(config, milestone)}" target="_blank" title="link to milestone ${milestone.title}">${msName}</a>`, msName)
+    return config.asText ? msName : renderInteractive(config,
+        `<a href="${milestoneUrl(config, milestone)}" target="_blank" title="link to milestone ${milestone.title}">${msName}</a>`,
+        msName)
 }
 
 function number(number) {
@@ -83,7 +85,7 @@ export function issuesReport(config, issues, opts = { showState: true, showLabel
     if (issues.length === 0) reportAndExit(noIssuesToReport)
     const reportableIssues = getReportableIssues(config, issues)
     if (reportableIssues.length === 0) reportAndExit(noIssuesToReport)
-    let output = ""
+    let output = "\n\n"
     for (let i = 0; i < reportableIssues.length; i++) {
         const reportableIssue = reportableIssues[i]
         output += formatIssue({
@@ -94,7 +96,10 @@ export function issuesReport(config, issues, opts = { showState: true, showLabel
             assignees: opts.showAssignees ? reportableIssue.assignees : "",
             milestone: opts.showMilestones ? reportableIssue.milestone : ""
         })
-        if (i < reportableIssues.length - 1) output += "\n"
+        if (i < reportableIssues.length - 1 && config.blankLines && config.asText) output += "\n\n"
+        if (i < reportableIssues.length - 1 && config.blankLines && !config.asText) output += "<br>\n<br>"
+        if (i < reportableIssues.length - 1 && !config.blankLines && config.asText) output += "\n"
+        if (i < reportableIssues.length - 1 && !config.blankLines && !config.asText) output += "<br>"
     }
     return output
 }

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`export function formatIssue({ state, number, title, labels, assignees, milestone }) {`
`2`		- const template = `${state} ${number} ${title} ${labels} ${assignees} ${milestone}\n`
	`2`	+ let template = `${state} ${number} ${title} ${labels} ${assignees} ${milestone}`
`3`	`3`	`return template`
`4`	`4`	`}`