@alleyinteractive/changelog-extractor 0.1.0 → 0.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alleyinteractive/changelog-extractor",
-  "version": "0.1.0",
+  "version": "0.4.0",
   "type": "module",
   "description": "Parse and extract structured information from Keep a Changelog formatted changelogs",
   "main": "src/parser.js",
@@ -15,9 +15,9 @@
     "prepublishOnly": "npm test",
     "prettier:fix": "npx prettier --write .",
     "prettier": "npx prettier --check .",
-    "release:major": "npm run version:major && npm publish --access public && git push --follow-tags",
-    "release:minor": "npm run version:minor && npm publish --access public && git push --follow-tags",
-    "release:patch": "npm run version:patch && npm publish --access public && git push --follow-tags",
+    "release:major": "npm version major && npm publish --access public && git push --follow-tags",
+    "release:minor": "npm version minor && npm publish --access public && git push --follow-tags",
+    "release:patch": "npm version patch && npm publish --access public && git push --follow-tags",
     "test": "NODE_OPTIONS=--experimental-vm-modules NODE_NO_WARNINGS=1 npx jest"
   },
   "keywords": [

package/src/cli.js

@@ -20,6 +20,7 @@ function printUsage() {
 Usage: npx @alleyinteractive/changelog-extractor [options]
 
 Options:
+  --format <type>       Output format (default: "json"). Options: dump, text, json.
   -f, --file <path>     Path to changelog file (default: CHANGELOG.md)
   -v, --version <ver>   Specific version to extract (e.g., "1.14.0" or "v1.14.0")
                         Leave empty to return all versions
@@ -64,6 +65,20 @@ if (versionIndex !== -1 && args[versionIndex + 1]) {
 
 const version = versionArg
 
+// Parse format option.
+let format = 'json'
+const formatIndex = args.findIndex((arg) => arg === '--format')
+if (formatIndex !== -1 && args[formatIndex + 1]) {
+  format = args[formatIndex + 1].toLowerCase()
+}
+
+if (!['json', 'dump', 'text'].includes(format)) {
+  console.error(
+    `❌ Error: Invalid format "${format}". Valid options are: json, dump, text.`
+  )
+  process.exit(1)
+}
+
 // Read changelog file
 const changelogPath = path.resolve(process.cwd(), changelogFile)
 
@@ -86,18 +101,28 @@ try {
     process.exit(0)
   }
 
+  // Default JSON output.
+  if (format === 'json') {
+    process.stdout.write(JSON.stringify(results, null, 2) + '\n')
+    process.exit(0)
+  }
+
   // Parse changelog
-  console.log(`📖 Parsing: ${changelogPath}`)
-  console.log(`🎯 Version: ${versionArg || 'all versions'}`)
-  console.log('')
+  if (format === 'dump') {
+    console.log(`📖 Parsing: ${changelogPath}`)
+    console.log(`🎯 Version: ${versionArg || 'all versions'}`)
+    console.log('')
+  }
 
   if (results.length === 0) {
     console.log('⚠️  No changelog entries found')
     process.exit(1)
   }
 
-  console.log(`✅ Found ${results.length} version(s)\n`)
-  console.log('─'.repeat(80))
+  if (format === 'dump') {
+    console.log(`✅ Found ${results.length} version(s)\n`)
+    console.log('─'.repeat(80))
+  }
 
   // Pretty print results
   results.forEach((entry, index) => {
@@ -126,10 +151,11 @@ try {
     }
   })
 
-  // Output JSON at the end
-  console.log('\n' + '═'.repeat(80))
-  console.log('\n📋 JSON Output:\n')
-  console.log(JSON.stringify(results, null, 2))
+  if (format === 'dump') {
+    console.log('\n' + '═'.repeat(80))
+    console.log('\n📋 JSON Output:\n')
+    process.stdout.write(JSON.stringify(results, null, 2) + '\n')
+  }
 } catch (error) {
   console.error('❌ Error parsing changelog:', error.message)
   process.exit(1)

package/src/parser.js

@@ -1,3 +1,83 @@
+/**
+ * Unwrap text that has been wrapped across multiple lines.
+ * This fixes changelog text that has been hard-wrapped for readability
+ * but should flow as continuous text.
+ *
+ * @param {string} text - The text content to unwrap
+ * @returns {string} The unwrapped text
+ */
+function unwrapText(text) {
+  const lines = text.split('\n')
+  const unwrappedLines = []
+
+  for (let i = 0; i < lines.length; i++) {
+    let currentLine = lines[i]
+
+    // Skip empty lines - preserve them as-is
+    if (currentLine.trim() === '') {
+      unwrappedLines.push(currentLine)
+      continue
+    }
+
+    // Collect continuation lines
+    let j = i + 1
+    while (j < lines.length) {
+      const nextLine = lines[j]
+
+      // Stop if next line is empty
+      if (nextLine.trim() === '') {
+        break
+      }
+
+      const trimmedCurrent = currentLine.trim()
+      const trimmedNext = nextLine.trim()
+
+      // Don't unwrap if current line looks like it ends a sentence/item
+      const endsWithPunctuation = /[.!?:;]$/.test(trimmedCurrent)
+      const endsWithCode = /`$/.test(trimmedCurrent)
+      const endsWithBullet = /[-*+]\s*$/.test(trimmedCurrent)
+
+      // Don't unwrap if next line starts a new bullet point, section, or sentence
+      const startsWithBullet = /^[-*+]\s/.test(trimmedNext)
+      const startsWithNumber = /^\d+\.\s/.test(trimmedNext)
+      const startsWithMarkdown = /^[#>]/.test(trimmedNext)
+
+      // More nuanced check for new sentences
+      const prevEndsWithContinuation =
+        /[,&]$/.test(trimmedCurrent) ||
+        /\b(and|or|but|with|for|to|from|in|on|at|by)$/.test(trimmedCurrent)
+      const startsWithCapitalNewSentence =
+        /^[A-Z]/.test(trimmedNext) &&
+        !prevEndsWithContinuation &&
+        endsWithPunctuation
+
+      // Determine if we should unwrap this line with the next
+      const shouldUnwrap =
+        !endsWithPunctuation &&
+        !endsWithCode &&
+        !endsWithBullet &&
+        !startsWithBullet &&
+        !startsWithNumber &&
+        !startsWithCapitalNewSentence &&
+        !startsWithMarkdown
+
+      if (shouldUnwrap) {
+        // Join the lines, preserving the original indentation of the first line
+        // but removing indentation from continuation lines
+        currentLine = currentLine + ' ' + trimmedNext
+        j++ // Move to next line
+      } else {
+        break // Stop unwrapping
+      }
+    }
+
+    unwrappedLines.push(currentLine)
+    i = j - 1 // Skip the lines we've consumed (j-1 because for loop will increment)
+  }
+
+  return unwrappedLines.join('\n')
+}
+
 /**
  * Parse a Keep a Changelog formatted changelog file.
  *
@@ -98,7 +178,9 @@ export function parseChangelog(changelogContent, version = null) {
 
       const content = currentSectionContent.join('\n')
       if (content.trim()) {
-        currentVersion.sections[currentSection] = content
+        // Unwrap any text that has been hard-wrapped across lines
+        const unwrappedContent = unwrapText(content)
+        currentVersion.sections[currentSection] = unwrappedContent
       }
     }
   }
@@ -120,7 +202,9 @@ export function parseChangelog(changelogContent, version = null) {
 
       const content = trimmedContent.join('\n')
       if (content.trim()) {
-        currentVersion.sections['general'] = content
+        // Unwrap any text that has been hard-wrapped across lines
+        const unwrappedContent = unwrapText(content)
+        currentVersion.sections['general'] = unwrappedContent
       }
       generalContent = []
     }