Add issue to markdown script

Author: markerikson

packages/toolkit/scripts/issue-triage/README-github-issue-to-markdown.md

@@ -0,0 +1,106 @@
+# GitHub Issue to Markdown Converter
+
+A standalone TypeScript script that converts GitHub issue JSON files (with comments) into readable Markdown format.
+
+## Features
+
+- Converts GitHub issue JSON to clean Markdown
+- Includes issue metadata (author, date, comment count)
+- Formats all comments with author and date information
+- Highlights author associations (MEMBER, CONTRIBUTOR, etc.)
+- Uses only built-in Node.js modules (no dependencies)
+- Can be run with Bun, Node.js, or ts-node
+
+## Usage
+
+### With Bun (recommended)
+
+```bash
+bun run packages/toolkit/scripts/github-issue-to-markdown.ts <input-json-file> [output-md-file]
+```
+
+### With ts-node
+
+```bash
+npx ts-node packages/toolkit/scripts/github-issue-to-markdown.ts <input-json-file> [output-md-file]
+```
+
+### With Node.js (after compilation)
+
+```bash
+tsc packages/toolkit/scripts/github-issue-to-markdown.ts
+node packages/toolkit/scripts/github-issue-to-markdown.js <input-json-file> [output-md-file]
+```
+
+## Arguments
+
+- `<input-json-file>` (required): Path to the GitHub issue JSON file
+- `[output-md-file]` (optional): Path for the output Markdown file. If not specified, uses the input filename with `.md` extension
+
+## Examples
+
+### Basic usage (auto-generate output filename)
+
+```bash
+bun run packages/toolkit/scripts/github-issue-to-markdown.ts docs/dev-plans/issue-3692-comments.json
+# Creates: docs/dev-plans/issue-3692-comments.md
+```
+
+### Specify output filename
+
+```bash
+bun run packages/toolkit/scripts/github-issue-to-markdown.ts docs/dev-plans/issue-3692-comments.json docs/dev-plans/rtk-query-feedback.md
+```
+
+## Input Format
+
+The script expects a JSON file with the following structure:
+
+```json
+{
+  "number": 3692,
+  "title": "Issue title",
+  "user": {
+    "login": "username",
+    "id": 12345
+  },
+  "created_at": "2023-09-01T17:41:01Z",
+  "updated_at": "2023-09-01T17:41:01Z",
+  "body": "Issue description...",
+  "author_association": "MEMBER",
+  "comments": 106,
+  "comments_data": [
+    {
+      "id": 1703237481,
+      "user": {
+        "login": "commenter",
+        "id": 67890
+      },
+      "created_at": "2023-09-01T19:35:29Z",
+      "updated_at": "2023-09-01T19:35:29Z",
+      "body": "Comment text...",
+      "author_association": "NONE"
+    }
+  ]
+}
+```
+
+## Output Format
+
+The script generates a Markdown file with:
+
+1. Issue header with number and title
+2. Issue metadata (author, date, comment count)
+3. Issue description
+4. All comments with:
+   - Horizontal rule separator
+   - Comment author and date
+   - Author association badge (if not NONE)
+   - Comment body text
+
+## Notes
+
+- Dates are formatted as YYYY-MM-DD
+- The script preserves all Markdown formatting in issue/comment bodies
+- Author associations like MEMBER, CONTRIBUTOR are displayed as emphasized text
+- Comments are separated by horizontal rules (`---`) for readability

packages/toolkit/scripts/issue-triage/github-issue-to-markdown.ts

@@ -0,0 +1,130 @@
+#!/usr/bin/env node
+/**
+ * Converts a GitHub issue JSON file (with comments) to a readable Markdown format.
+ *
+ * Usage:
+ *   bun run github-issue-to-markdown.ts <input-json-file> [output-md-file]
+ *
+ * If output file is not specified, it will use the input filename with .md extension
+ */
+
+import { readFileSync, writeFileSync } from 'fs'
+import { resolve, dirname, basename, extname } from 'path'
+
+interface GitHubUser {
+  login: string
+  id: number
+}
+
+interface GitHubComment {
+  id: number
+  user: GitHubUser
+  created_at: string
+  updated_at: string
+  body: string
+  author_association: string
+}
+
+interface GitHubIssue {
+  number: number
+  title: string
+  user: GitHubUser
+  created_at: string
+  updated_at: string
+  body: string
+  author_association: string
+  comments: number
+  comments_data?: GitHubComment[]
+}
+
+function formatDate(dateString: string): string {
+  const date = new Date(dateString)
+  return date.toISOString().split('T')[0]
+}
+
+function convertIssueToMarkdown(issue: GitHubIssue): string {
+  let markdown = ''
+
+  // Issue header
+  markdown += `# Issue #${issue.number}: ${issue.title}\n\n`
+
+  // Issue metadata
+  markdown += `**Author:** ${issue.user.login}\n`
+  markdown += `**Date:** ${formatDate(issue.created_at)}\n`
+  markdown += `**Comments:** ${issue.comments}\n\n`
+
+  // Issue body
+  markdown += `## Issue Description\n\n`
+  markdown += `${issue.body}\n\n`
+
+  // Comments section
+  if (issue.comments_data && issue.comments_data.length > 0) {
+    markdown += `## Comments (${issue.comments_data.length})\n\n`
+
+    for (const comment of issue.comments_data) {
+      markdown += `---\n\n`
+      markdown += `### Comment by ${comment.user.login} on ${formatDate(comment.created_at)}\n\n`
+
+      if (comment.author_association && comment.author_association !== 'NONE') {
+        markdown += `_${comment.author_association}_\n\n`
+      }
+
+      markdown += `${comment.body}\n\n`
+    }
+  }
+
+  return markdown
+}
+
+function main() {
+  const args = process.argv.slice(2)
+
+  if (args.length === 0) {
+    console.error('Error: No input file specified')
+    console.error(
+      'Usage: bun run github-issue-to-markdown.ts <input-json-file> [output-md-file]',
+    )
+    process.exit(1)
+  }
+
+  const inputFile = resolve(args[0])
+  let outputFile: string
+
+  if (args.length > 1) {
+    outputFile = resolve(args[1])
+  } else {
+    // Generate output filename from input filename
+    const dir = dirname(inputFile)
+    const base = basename(inputFile, extname(inputFile))
+    outputFile = resolve(dir, `${base}.md`)
+  }
+
+  try {
+    // Read and parse JSON file
+    console.log(`Reading ${inputFile}...`)
+    const jsonContent = readFileSync(inputFile, 'utf-8')
+    const issue: GitHubIssue = JSON.parse(jsonContent)
+
+    // Convert to Markdown
+    console.log('Converting to Markdown...')
+    const markdown = convertIssueToMarkdown(issue)
+
+    // Write output file
+    console.log(`Writing to ${outputFile}...`)
+    writeFileSync(outputFile, markdown, 'utf-8')
+
+    console.log('✓ Conversion complete!')
+    console.log(`  Input:  ${inputFile}`)
+    console.log(`  Output: ${outputFile}`)
+    console.log(`  Comments: ${issue.comments_data?.length || 0}`)
+  } catch (error) {
+    if (error instanceof Error) {
+      console.error(`Error: ${error.message}`)
+    } else {
+      console.error('An unknown error occurred')
+    }
+    process.exit(1)
+  }
+}
+
+main()