@d-dev/changelog-darwin-x64 0.4.1 → 1.0.0

package/README.md

@@ -1,269 +1,168 @@
-# Changelog
+# changelog
 
-Git-based changelog manager for JavaScript, Python, and Go projects using [semantic versioning](https://semver.org/) and git.
+Changelog is a CLI tool for managing changelogs. Individual changelog entries are stored as files, eliminating merge conflicts and enabling CI enforcement.
 
-## Usage
+[Full documentation](https://dworthen.github.io/changelog)
 
-```shell
-$ changelog help
+## Installation
 
-Git-based changelog manager for JavaScript, Python, and Go projects.
+<!-- tabs:start -->
 
-Usage:
-  changelog [command]
+#### **npm**
 
-Available Commands:
-  add         Add a changelog entry.
-  apply       Apply changelog entries.
-  check       Check that the current branch or last commit contains a changelog entry. Useful for CI workflows to enforce the presence of changelog entries.
-  help        Help about any command
-  init        Initialize project to use changelog.
-  update      Update to the latest version of changelog
-  version     Print the current version of changelog
+Install globally:
 
-Flags:
-      --cwd string   project directory for changelog. (default ".")
-  -h, --help         help for changelog
-      --verbose      enable verbose logging.
-
-Use "changelog [command] --help" for more information about a command.
-```
-
-## Init
-
-```shell
-changelog init
+```bash
+npm install -g @d-dev/changelog
 ```
 
-Walks through creating a `.changelog` directory with the following files.
-
-### `config.yaml`
-
-Changelog configuration:
-
-```yaml
-# Example config.yaml
-
-# Current version of the project.
-# This gets bumped, along with the files listed below,
-# when running `changelog apply`
-version: 0.1.0
-changelogFile: CHANGELOG.md # Changelog file to manage
-
-# A list of files containing versions to bump when running
-# `changelog apply`.
-# Uses RegExp patterns for matching and replacing the actual version.
-# The RegExp must contain 1 capture group with the version portion to replace.
-# View https://pkg.go.dev/regexp/syntax@go1.24.1 for RegExp syntax
-# Use https://regex101.com/ with GoLang selected to test patterns.
-# Examples for Node package.json and python pyproject.toml below.
-files:
-    - path: package.json
-      pattern: '"version":\s*"(\d+\.\d+\.\d+)"'
-    - path: pyproject.toml
-      pattern: 'version\s*=\s*"(\d+\.\d+\.\d+)"'
-
-# Configures `changelog add` command
-onAdd:
-    # commit staged files + added changelog entry
-    # Uses the provided description as the commit message.
-    commitFiles: true
-
-# Configure `changelog apply` command
-onApply:
-    commitFiles: true
-    tagCommit: true
-    tagFormat: v{{version}}
-    # A list of commands to run after bumping version files
-    # and before committing and tagging.
-    # Often useful to run install/sync commands that may update
-    # lock files.
-    commands:
-        - npm install
-        - uv sync
+Or as a dev dependency:
 
+```bash
+npm install -D @d-dev/changelog
 ```
 
-### `changelogTemplate.hbs`
-
-A [Handlebars](https://handlebarsjs.com/) template used for adding new entries to the changelog file specified in the `.changelog/config.yaml` file.
-
-Default template:
+Or run with `npx`
 
+```bash
+npx @d-dev/changelog
 ```
-## {{version}}
-{{#if majorChanges}}
 
-### Major Changes
-
-{{#each majorChanges}}
-- {{shortSha}}: {{description}}
-{{/each}}
-{{/if}}
-{{#if minorChanges}}
-
-### Minor Changes
-
-{{#each minorChanges}}
-- {{shortSha}}: {{description}}
-{{/each}}
-{{/if}}
-{{#if patchChanges}}
-
-### Patch Changes
-
-{{#each patchChanges}}
-- {{shortSha}}: {{description}}
-{{/each}}
-{{/if}}
+#### **PyPI**
 
+Install with pip:
 
+```bash
+pip install changesets
 ```
 
-**Available Variables**
+Install with uv.
 
-- version: The new version of the project.
-- oldVersion: The previous version of the project.
-- majorChanges, minorChanges, patchChanges: A list of change descriptions.
-  - **Change Description:**
-    - Sha: The git Sha associated with the change commit.
-    - shortSha: The git short Sha associated with the change commit.
-    - change: `patch|minor|major`
-    - description: The description of the change
-
-## Add
-
-```shell
-changelog add
+```bash
+uv tool install changesets
 ```
 
-![changelog add](docs/images/changelog-add.gif)
+Or as a dev dependency
 
-Creates a timestamped `.md` changelog entry file in the `.changelog` directory ready to be added to source control and applied at a later time. The changelog entry contains the type of change (`patch|minor|major`) along with the provided description.
-
-Example changelog entry:
-
-```
----
-change: "major"
----
-A major change.
+```bash
+uv add --dev changesets
 ```
 
-Depending on how changelog is configured, the `add` command also adds the timestamped file to the git staging area and then commit all staged files using the provided description as the commit message.
-
-> [!NOTE]
-> As a best practice, commit the timestamp file with the set of files the changelog entry describes. For example, run `git add <FILES...>` prior to running `changelog add`.
-
-## Apply
-
-The apply command...
-
-- Runs in dry mode by default. The command shows a preview of the changes and ask for confirmation prior to applying any changes.
-- gathers previously created changelog entries from the `.changelog` directory and prepends the info to the `CHANGELOG.md` file according to the `.changelog/changelogTemplate.hbs` template file.
-- Bumps semantic version numbers in specified files according to `.changelog/config.yaml`.
-- run any commands listed in `.changelog/config.yaml`.
+Or run directly with uvx (no install required):
 
 ```bash
-changelog apply
+uvx --from changesets changelog <command>
 ```
 
-![changelog apply](docs/images/changelog-apply.gif)
+#### **GitHub Releases**
 
-If `.changelog/config.yaml` is configured to commit and tag files when running `changelog apply` then `git log` and `git tag` should show the commit and associated tag.
+Download pre-built binaries from [GitHub Releases](https://github.com/dworthen/changelog/releases).
 
-## TODO
+Available platforms:
 
-- Add support for prereleases
+| Platform     | Architecture |
+| ------------ | ------------ |
+| Linux        | x64, arm64   |
+| Linux (musl) | x64, arm64   |
+| macOS        | x64, arm64   |
+| Windows      | x64          |
 
-## Install
+<!-- tabs:end -->
 
-### NPM
+## Initialize
 
-https://www.npmjs.com/package/@d-dev/changelog
+Run `changelog init` in your project root to set up the `.changelog` directory:
 
-```shell
-npm install @d-dev/changelog
-# or globally
-npm install @d-dev/changelog -g
+```bash
+changelog init
 ```
 
-### Python
-
-https://pypi.org/project/changesets/
+You'll be prompted for:
 
-```shell
-pip install changesets
-# Or with UV
-uv add changesets --dev
-# package is called changesets but command is still changelog
+```
+? Current version: 0.1.0
+? Changelog file path: CHANGELOG.md
+? Main git branch: main
+Enter post-apply commands (leave blank to finish):
+? Post-apply command: npm install
+? Post-apply command (1 added):
+✓ Initialized .changelog directory
 ```
 
-### Golang
-
-https://pkg.go.dev/github.com/dworthen/changelog
-
-With go version `1.24.x` you can add the package as a tool to your project with
+This creates the following structure:
 
-```shell
-go get -tool github.com/dworthen/changelog@latest
+```
+.changelog/
+├── config.yaml
+├── next/
+│   └── .gitkeep
+├── releases/
+│   └── .gitkeep
+└── templates/
+    ├── header.md
+    ├── body.eta
+    └── footer.md
 ```
 
-and use with
+## Add an Entry
 
-```shell
-go tool changelog help
+When you make a notable change, run `changelog add`:
+
+```bash
+changelog add
 ```
 
-Prior to 1.24
+Select a change type and provide a description:
 
 ```
-go install github.com/dworthen/changelog
+? Change type: Add - Add a new feature. Minor version bump.
+? Description: Support for YAML configuration files
+✓ Added changelog entry: .changelog/next/1740000000000.yaml
+✓ Updated CHANGELOG.md
 ```
 
-### Binaries
-
-#### Windows
+A YAML file is created in `.changelog/next/`:
 
-Requires the newer [powershell core](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.5).
-
-```powershell
-curl -sSfL https://raw.githubusercontent.com/dworthen/changelog/main/scripts/install.ps1 | pwsh -Command -
+```yaml
+timestamp: 1740000000000
+type: Add
+description: Support for YAML configuration files
 ```
 
-This will install `changelog` to `~/bin`, be sure to export the location in the user or machine `$PATH` or use the `-to` flag to specify a download location.
+The changelog file is automatically regenerated with an **Unreleased** section so you can preview changes at any time.
 
-Running the installer with additional flags:
+## Apply a Release
 
-```powershell
-curl -sSfL https://raw.githubusercontent.com/dworthen/changelog/main/scripts/install.ps1 -o install.ps1 &&
-pwsh -File install.ps1 -force -tag v0.0.1 -to ~/bin &&
-rm install.ps1
-```
-
-#### Linux/Darwin
+When you're ready to release, run `changelog apply`:
 
 ```bash
-curl -sSfL https://raw.githubusercontent.com/dworthen/changelog/main/scripts/install.sh | bash
+changelog apply
 ```
 
-This will install `changelog` to `~/bin`, be sure to export the location in the user `$PATH` or use the `-to` flag to specify a download location.
-
-Running the installer with additional flags:
+This computes the version bump, creates the release, and updates your project:
 
-```bash
-curl -sSfL https://raw.githubusercontent.com/dworthen/changelog/main/scripts/install.sh | bash -s -- --force --tag v0.0.1 --to ~/bin
+```
+✓ Updated version in package.json to 0.2.0
+✓ Applied version 0.2.0
+✓ Updated CHANGELOG.md
+Running post-apply command: npm install
+? Commit changes and tag the commit? Yes
+✓ Committed and tagged version 0.2.0
 ```
 
-### Prebuilt Binaries
+The version bump is determined by the change types present:
 
-https://github.com/dworthen/changelog/releases
+| Change Types   | Bump  |
+| -------------- | ----- |
+| Change, Remove | Major |
+| Add, Deprecate | Minor |
+| Fix            | Patch |
+| Internal       | None  |
 
-### From Source with [Go](https://go.dev/)
+After applying, push the commit and tag:
 
 ```bash
-git clone https://github.com/dworthen/changelog.git
-cd changelog
-go mod tidy
-go build ./main.go
+git push origin main --follow-tags
 ```
+
+[Full documentation](https://dworthen.github.io/changelog)

package/index.js

@@ -1,7 +1,11 @@
-import path from "node:path";
 
-export default function run() {
-  const dirname = import.meta.dirname;
-  const bin = path.join(dirname, "bin", "changelog");
-  return bin;
+import { join } from "node:path";
+import { existsSync } from "node:fs";
+
+export function getBinPath() {
+  const binPath = join(import.meta.dirname, "bin", "changelog");
+  if (!existsSync(binPath)) {
+    throw new Error(`Binary not found at expected path:  ${binPath}`);
+  }
+  return binPath;
 }

package/package.json

@@ -1,39 +1,26 @@
 {
   "name": "@d-dev/changelog-darwin-x64",
-  "version": "0.4.1",
-  "type": "module",
-  "author": "Derek Worthen <worthend.derek@gmail.com>",
+  "version": "1.0.0",
+  "description": "A CLI tool for managing changelogs in your project",
   "license": "MIT",
-  "repository": "github:dworthen/changelog",
-  "description": "Git-based changelog manager for JavaScript, Python, and Go projects.",
-  "keywords": [
-    "changelog",
-    "git",
-    "javascript",
-    "python",
-    "go"
-  ],
-  "main": "index.js",
+  "type": "module",
   "exports": {
     ".": {
       "import": "./index.js"
     },
     "./package.json": "./package.json"
   },
+  "files": [
+    "package.json",
+    "index.js",
+    "README.md",
+    "LICENSE",
+    "bin"
+  ],
   "os": [
     "darwin"
   ],
   "cpu": [
     "x64"
-  ],
-  "files": [
-    "package.json",
-    "README.md",
-    "license",
-    "bin",
-    "index.js"
-  ],
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  }
+  ]
 }