Adjustments

Author: srtfisher

CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+This library adheres to [Semantic Versioning](https://semver.org/) and [Keep a CHANGELOG](https://keepachangelog.com/en/1.0.0/).
+
+## 0.0.1
+
+- Initial testing release.

PUBLISHING.md

@@ -0,0 +1,43 @@
+# Publishing to NPM
+
+This package is published to NPM as `@alleyinteractive/changelog-extractor`.
+
+## Prerequisites
+
+1. You need to be a member of the `@alleyinteractive` organization on NPM
+2. You need to be logged in: `npm login`
+3. Ensure all tests pass: `npm test`
+
+## Publishing Steps
+
+1. Update the version in `package.json`:
+   ```bash
+   npm version patch  # or minor, or major
+   ```
+
+2. Publish to NPM:
+   ```bash
+   npm publish --access public
+   ```
+
+3. Push the version tag to GitHub:
+   ```bash
+   git push --follow-tags
+   ```
+
+## After Publishing
+
+Users can then use the package via:
+
+```bash
+# Run with npx (no installation)
+npx @alleyinteractive/changelog-extractor
+
+# Or install globally
+npm install -g @alleyinteractive/changelog-extractor
+changelog-extractor
+```
+
+## GitHub Action
+
+The GitHub Action in this repository will continue to work alongside the NPM package. The action uses the parser from `src/parser.js` directly.

README.md

@@ -1,18 +1,24 @@
-# Changelog Extractor Action
+# Changelog Extractor
 
-A GitHub Action that parses [Keep a Changelog](https://keepachangelog.com/) formatted changelog files and extracts structured version information for use in release workflows and other automation.
+Parse and extract structured information from [Keep a
+Changelog](https://keepachangelog.com/) formatted changelogs. Available as both
+a **GitHub Action** and a **CLI tool**.
 
 ## Features
 
-- 📝 Parses Keep a Changelog format (like [Mantle Framework](https://github.com/alleyinteractive/mantle-framework))
-- 🎯 Extract all versions or a specific version
-- 📦 Returns structured data with sections (Added, Changed, Fixed, etc.)
-- 🔄 Supports mixed formats (with and without subsections)
-- ✅ Comprehensive Jest test suite
-- 🚀 Zero build step - pure JavaScript
+- Parses Keep a Changelog format (tested with [Mantle Framework](https://github.com/alleyinteractive/mantle-framework) and others)
+- Extract all versions or filter to a specific one
+- Returns structured data with sections (Added, Changed, Fixed, etc.)
+- Handles mixed formats, including versions without subsections
+- Available as a CLI tool via npx or as a GitHub Action
+- Written in plain JavaScript with no build step required
 
 ## Usage
 
+### As a GitHub Action
+
+#### Extract All Versions
+
 ### Extract All Versions
 
 By default, the action returns all versions in the changelog:
@@ -69,20 +75,20 @@ jobs:
           body: ${{ fromJson(steps.changelog.outputs.result)[0].contents }}
 ```
 
-## Inputs
+#### Action Inputs
 
 | Input | Description | Required | Default |
 |-------|-------------|----------|---------|
 | `changelog-path` | Path to the changelog file | No | `CHANGELOG.md` |
 | `version` | Specific version to extract (e.g., `1.14.0` or `v1.14.0`). Leave empty to return all versions. | No | _(returns all)_ |
 
-## Outputs
+#### Action Outputs
 
 | Output | Description |
 |--------|-------------|
 | `result` | JSON string containing array of parsed version objects |
 
-### Output Structure
+#### Output Structure
 
 The `result` output is a JSON string that can be parsed with `fromJson()`:
 
@@ -105,6 +111,31 @@ The `result` output is a JSON string that can be parsed with `fromJson()`:
 - `sections` - Object with lowercase keys (`added`, `changed`, `fixed`, `deprecated`, `removed`, `security`)
 - `contents` - Full markdown content for the version (all sections combined, without version header)
 
+### As a CLI Tool
+
+Run directly with npx (no installation required):
+
+```bash
+# Extract all versions from CHANGELOG.md
+npx @alleyinteractive/changelog-extractor
+
+# Extract specific version
+npx @alleyinteractive/changelog-extractor CHANGELOG.md 1.14.0
+
+# Count versions
+npx @alleyinteractive/changelog-extractor -l
+
+# Show help
+npx @alleyinteractive/changelog-extractor --help
+```
+
+Or install globally:
+
+```bash
+npm install -g @alleyinteractive/changelog-extractor
+changelog-extractor
+```
+
 ## Supported Changelog Format
 
 This action parses changelogs following the [Keep a Changelog](https://keepachangelog.com/) format:
@@ -137,6 +168,40 @@ This action parses changelogs following the [Keep a Changelog](https://keepachan
 - Fixed
 - Security
 
+## CLI Options
+
+```
+Usage: changelog-extractor [options] [changelog-file] [version]
+
+Options:
+  -l, --list     List the count of versions found and exit
+  -h, --help     Show help message
+
+Arguments:
+  changelog-file  Path to changelog file (default: CHANGELOG.md)
+  version        Specific version to extract (e.g., "1.14.0" or "v1.14.0")
+                 Leave empty to return all versions
+```
+
+## Programmatic Usage
+
+You can also use the parser directly in your Node.js code:
+
+```javascript
+const { parseChangelog } = require('@alleyinteractive/changelog-extractor');
+const fs = require('fs');
+
+const changelog = fs.readFileSync('CHANGELOG.md', 'utf8');
+
+// Get all versions
+const allVersions = parseChangelog(changelog);
+
+// Get specific version
+const v1 = parseChangelog(changelog, '1.14.0');
+
+console.log(JSON.stringify(allVersions, null, 2));
+```
+
 ## Development
 
 ### Prerequisites
@@ -163,27 +228,25 @@ npm run test:coverage
 npm run test:watch
 ```
 
-### Testing Locally
-
-You can test the parser directly:
+### Local Testing
 
-```javascript
-const { parseChangelog } = require('./src/parser');
-const fs = require('fs');
-
-const changelog = fs.readFileSync('CHANGELOG.md', 'utf8');
-const results = parseChangelog(changelog, 'latest');
-console.log(JSON.stringify(results, null, 2));
+```bash
+# Test the CLI locally
+node cli.js
+node cli.js -l
+node cli.js CHANGELOG.md 1.0.0
 ```
 
-## License
+## Changelog
 
-GPL-3.0 - see [LICENSE](LICENSE) for details.
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
 
-## Contributing
+## Credits
 
-Contributions are welcome! Please feel free to submit a Pull Request.
+This project is actively maintained by [Alley Interactive](https://github.com/alleyinteractive).
 
-## Credits
+- [Sean Fisher](https://github.com/srtfisher)
+
+## License
 
-Maintained by [Alley Interactive](https://github.com/alleyinteractive).
+The GNU General Public License (GPL) license. Please see [License File](LICENSE) for more information.

cli.js

@@ -1,34 +1,38 @@
 #!/usr/bin/env node
 
+/**
+ * Changelog Extractor CLI
+ *
+ * Parse and extract structured information from Keep a Changelog formatted files.
+ * Can be run via npx or installed globally.
+ *
+ * @package @alleyinteractive/changelog-extractor
+ * @author Alley Interactive
+ * @license GPL-3.0
+ */
+
 const fs = require('fs');
 const path = require('path');
 const { parseChangelog } = require('./src/parser');
 
-/**
- * CLI for testing the changelog parser
- * Usage: node cli.js [changelog-file] [version]
- */
-
 function printUsage() {
   console.log(`
-Usage: node cli.js [options] [changelog-file] [version]
+Usage: npx @alleyinteractive/changelog-extractor [options]
 
 Options:
-  -l, --list     List the count of versions found and exit
-  -h, --help     Show this help message
-
-Arguments:
-  changelog-file  Path to changelog file (default: CHANGELOG.md)
-  version        Specific version to extract (e.g., "1.14.0" or "v1.14.0")
-                 Leave empty to return all versions (default: all versions)
+  -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
+  -l, --list            List the count of versions found and exit
+  -h, --help            Show this help message
 
 Examples:
-  node cli.js                           # Parse CHANGELOG.md, extract all versions
-  node cli.js -l                        # Count versions in CHANGELOG.md
-  node cli.js CHANGELOG.md              # Same as above
-  node cli.js CHANGELOG.md 1.14.0       # Extract specific version
-  node cli.js /tmp/test-changelog.md    # Parse specific file, all versions
-  node cli.js -l /tmp/test-changelog.md # Count versions in specific file
+  npx @alleyinteractive/changelog-extractor                      # Parse CHANGELOG.md, all versions
+  npx @alleyinteractive/changelog-extractor -l                   # Count versions in CHANGELOG.md
+  npx @alleyinteractive/changelog-extractor -v 1.14.0            # Extract specific version
+  npx @alleyinteractive/changelog-extractor -f /tmp/test.md      # Parse specific file
+  npx @alleyinteractive/changelog-extractor -f CHANGELOG.md -v 1.14.0  # Both options
+  changelog-extractor -l                                         # If installed globally
 `);
 }
 
@@ -41,10 +45,21 @@ if (args.includes('--help') || args.includes('-h')) {
 }
 
 const listMode = args.includes('-l') || args.includes('--list');
-const filteredArgs = args.filter(arg => arg !== '-l' && arg !== '--list');
 
-const changelogFile = filteredArgs[0] || 'CHANGELOG.md';
-const versionArg = filteredArgs[1] || null;
+// Parse file option
+let changelogFile = 'CHANGELOG.md';
+const fileIndex = args.findIndex(arg => arg === '-f' || arg === '--file');
+if (fileIndex !== -1 && args[fileIndex + 1]) {
+  changelogFile = args[fileIndex + 1];
+}
+
+// Parse version option
+let versionArg = null;
+const versionIndex = args.findIndex(arg => arg === '-v' || arg === '--version');
+if (versionIndex !== -1 && args[versionIndex + 1]) {
+  versionArg = args[versionIndex + 1];
+}
+
 const version = versionArg;
 
 // Read changelog file
@@ -74,7 +89,7 @@ try {
 
   if (results.length === 0) {
     console.log('⚠️  No changelog entries found');
-    process.exit(0);
+    process.exit(1);
   }
 
   console.log(`✅ Found ${results.length} version(s)\n`);

package.json

@@ -1,21 +1,47 @@
 {
-  "name": "action-changelog-extractor",
-  "version": "1.0.0",
-  "description": "GitHub Action to parse and extract changelog information",
-  "main": "src/index.js",
+  "name": "@alleyinteractive/changelog-extractor",
+  "version": "0.0.1",
+  "description": "Parse and extract structured information from Keep a Changelog formatted changelogs",
+  "main": "src/parser.js",
+  "bin": {
+    "changelog-extractor": "./cli.js"
+  },
   "scripts": {
     "test": "jest",
     "test:watch": "jest --watch",
-    "test:coverage": "jest --coverage"
+    "test:coverage": "jest --coverage",
+    "version:patch": "npm version patch",
+    "version:minor": "npm version minor",
+    "version:major": "npm version major",
+    "prepublishOnly": "npm test",
+    "release:patch": "npm run version:patch && npm publish --access public && git push --follow-tags",
+    "release:minor": "npm run version:minor && npm publish --access public && git push --follow-tags",
+    "release:major": "npm run version:major && npm publish --access public && git push --follow-tags"
   },
   "keywords": [
-    "github-action",
     "changelog",
     "parser",
-    "release-notes"
+    "keep-a-changelog",
+    "release-notes",
+    "github-action",
+    "cli"
   ],
   "author": "Alley Interactive",
   "license": "GPL-3.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/alleyinteractive/action-changelog-extractor.git"
+  },
+  "bugs": {
+    "url": "https://github.com/alleyinteractive/action-changelog-extractor/issues"
+  },
+  "homepage": "https://github.com/alleyinteractive/action-changelog-extractor#readme",
+  "files": [
+    "src/",
+    "cli.js",
+    "README.md",
+    "LICENSE"
+  ],
   "devDependencies": {
     "@types/jest": "^29.5.12",
     "@types/node": "^20.11.24",