@alleyinteractive/changelog-extractor 0.3.0 → 0.4.0

package/README.md

@@ -21,8 +21,6 @@ as both a **GitHub Action** and a **CLI tool**.
 
 #### Extract All Versions
 
-### Extract All Versions
-
 By default, the action returns all versions in the changelog:
 
 ```yaml
@@ -36,7 +34,7 @@ By default, the action returns all versions in the changelog:
     echo '${{ fromJson(steps.changelog.outputs.result)[0].contents }}'
 ```
 
-### Extract Specific Version
+#### Extract Specific Version
 
 ```yaml
 - name: Extract v1.14.0 Changelog
@@ -47,7 +45,7 @@ By default, the action returns all versions in the changelog:
     version: '1.14.0' # or 'v1.14.0'
 ```
 
-### Create Release from Latest Version
+#### Create Release from Latest Version
 
 ```yaml
 name: Release
@@ -141,6 +139,20 @@ npm install -g @alleyinteractive/changelog-extractor
 changelog-extractor
 ```
 
+By default, the CLI outputs JSON to stdout. You can also specify other output
+formats using the `--format` option:
+
+```bash
+# JSON output (default)
+npx @alleyinteractive/changelog-extractor --format json
+
+# Pretty-printed dump
+npx @alleyinteractive/changelog-extractor --format dump
+
+# Plain text output
+npx @alleyinteractive/changelog-extractor --format text
+```
+
 ## Supported Changelog Format
 
 This action parses changelogs following the

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alleyinteractive/changelog-extractor",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "type": "module",
   "description": "Parse and extract structured information from Keep a Changelog formatted changelogs",
   "main": "src/parser.js",

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)