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

package/README.md

@@ -1,216 +1,168 @@
-# Changelog
+# changelog
 
-Simple changelog management for 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.
 
-## Example
+[Full documentation](https://dworthen.github.io/changelog)
 
-### Add
+## Installation
 
-Add a changelog entry describing a set of changes.
+<!-- tabs:start -->
 
-```bash
-changelog add
-```
-
-![changelog add](docs/images/changelog-add.gif)
-
-This creates a timestamped file in the `.changelog` directory ready to be added to source control and applied at a later time. 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
+#### **npm**
 
-The apply command gathers previously created change descriptions from the `.changelog` directory and prepends the descriptions to the `CHANGELOG.md` file. The command also bumps semantic version numbers in specified files.
+Install globally:
 
 ```bash
-changelog apply
-```
-
-![changelog apply](docs/images/changelog-apply.gif)
-
-The resulting `CHANGELOG.md` file.
-
-```md
-## 0.2.0
-
-### Minor Changes
-
-- a07c8dd: Describe a minor change.
+npm install -g @d-dev/changelog
 ```
 
-Running `git tag` shows that a new tag, `v0.2.0` has been applied.
-
-## Features
-
-- Store and track changelog descriptions per commit
-- Apply changelog entries to `CHANGELOG.md`
-- Sync version fields in specified JSON files such as the version field in a package.json file.
-
-## TODO
-
-- Add support for prereleases
-- Add support for monorepos
-- Add support for other version file formats (yaml, toml, etc.)
-
-## Install
-
-### NPM
+Or as a dev dependency:
 
+```bash
+npm install -D @d-dev/changelog
 ```
-npm install @d-dev/changelog -g
-```
-
-### Binaries
 
-#### Windows
+Or run with `npx`
 
-```powershell
-curl -sSfL https://raw.githubusercontent.com/dworthen/changelog/main/scripts/install.ps1 | pwsh -Command -
+```bash
+npx @d-dev/changelog
 ```
 
-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.
+#### **PyPI**
 
-Running the installer with additional flags:
+Install with pip:
 
-```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
+```bash
+pip install changesets
 ```
 
-#### Linux/Darwin
+Install with uv.
 
 ```bash
-curl -sSfL https://raw.githubusercontent.com/dworthen/changelog/main/scripts/install.sh | bash
+uv tool install changesets
 ```
 
-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:
+Or as a dev dependency
 
 ```bash
-curl -sSfL https://raw.githubusercontent.com/dworthen/changelog/main/scripts/install.sh | bash -s -- --force --tag v0.0.1 --to ~/bin
+uv add --dev changesets
 ```
 
-### From Source with [Go](https://go.dev/)
+Or run directly with uvx (no install required):
 
 ```bash
-go install github.com/dworthen/changelog@latest
+uvx --from changesets changelog <command>
 ```
 
-## Getting Started
+#### **GitHub Releases**
 
-Within a project directory, run `changelog init`.
+Download pre-built binaries from [GitHub Releases](https://github.com/dworthen/changelog/releases).
 
-### 1. Current Version
+Available platforms:
 
-![changelog version](docs/images/changelog-version.png)
+| Platform     | Architecture |
+| ------------ | ------------ |
+| Linux        | x64, arm64   |
+| Linux (musl) | x64, arm64   |
+| macOS        | x64, arm64   |
+| Windows      | x64          |
 
-Specifies the current version of the project. This version is tracked by `changelog` and considered the source of truth for project version. The version is bumped accordingly when `changelog` applies updates. The bumped version is then used to update specified version files. More on version files below.
+<!-- tabs:end -->
 
-### 2. Commit changelog entries
+## Initialize
 
-![changelog commit entries](docs/images/changelog-commit-entries.png)
+Run `changelog init` in your project root to set up the `.changelog` directory:
 
-If yes, `changelog add` creates a changelog entry, adds the file to the git staging area and then commits all staged files using the changelog description as the commit message. If using this option, be sure to run `git add <FILES...>` prior to running `changelog add` to associate the new changelog entry with the files it describes.
-
-If no, then `changelog add` creates a changelog entry but does not commit the files or run any git commands.
-
-### 3. Commit changelog apply
-
-![changelog commit apply](docs/images/changelog-commit-apply.png)
-
-`changelog apply` updates `CHANGELOG.md` and associated version files. If yes, then `changelog apply` will commit the changed files using the commit description `chore: apply changelog`.
-
-### 4. Tag commit (not presented if previous answer == No)
-
-![changelog tag](docs/images/changelog-tag.png)
-
-If yes, `changelog apply` tags the commit created. This option is ignored if the answer to the previous question is No.
-
-### 5. Tag format (not presented if either of the previous two answers == No)
+```bash
+changelog init
+```
 
-![changelog tag format](docs/images/changelog-tag-format.png)
+You'll be prompted for:
 
-Specify the tag to apply. This string is evaluated using handlebars and has access to the new version. Defaults to `v{{version}}`. This option is ignored if either of the previous two answers is No.
+```
+? 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
+```
 
-### 6. Version files
+This creates the following structure:
 
-![changelog version files](docs/images/changelog-version-files.png)
+```
+.changelog/
+├── config.yaml
+├── next/
+│   └── .gitkeep
+├── releases/
+│   └── .gitkeep
+└── templates/
+    ├── header.md
+    ├── body.eta
+    └── footer.md
+```
 
-Specify JSON files containing fields that should match the project version. The JSON path can point to a nested field using dot notation. After `changelog apply` bumps the current package version it updates all the specified JSON files and fields.
+## Add an Entry
 
-> [!WARNING]
-> Currently, only JSON files are supported.
+When you make a notable change, run `changelog add`:
 
-### Config
+```bash
+changelog add
+```
 
-`changelog init` creates a `.changelog` directory and the following two files.
+Select a change type and provide a description:
 
-**config.json**
+```
+? 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
+```
 
-Describes the config the `init` command walks through.
+A YAML file is created in `.changelog/next/`:
 
-```json
-{
-  "version": "1.0.0",
-  "bumpFiles": [
-    {
-      "file": "package.json",
-      "path": "version"
-    },
-    {
-      "file": "some-json-file.json",
-      "path": "path.to.nested"
-    }
-  ],
-  "onAdd": {
-    "commitFiles": true
-  },
-  "onApply": {
-    "commitFiles": true,
-    "tagCommit": true,
-    "tagFormat": "v{{version}}"
-  }
-}
+```yaml
+timestamp: 1740000000000
+type: Add
+description: Support for YAML configuration files
 ```
 
-**changelogTemplate.hbs**
+The changelog file is automatically regenerated with an **Unreleased** section so you can preview changes at any time.
 
-A handlebars file describing the template to use when adding entries to `CHANGELOG.md`. Users have full control of how the changelog entries are formatted. The following handlebars variables are available.
+## Apply a Release
 
-- **version**: The new project version after `changelog apply` finishes.
-- **oldVersion**: The previous project version prior to `changelog apply`.
-- **patchChanges|minorChanges|majorChanges**: A list of changes grouped by the level of change (patch, minor, or major). The variable is available if there is a change of that type present in the current update, otherwise its null.
-  - **sha**: The full git commit hash for the change.
-  - **shortSha**: The short git commit hash for the change.
-  - **description**: Changelog description.
+When you're ready to release, run `changelog apply`:
 
-```md
-## {{version}}
-{{#if majorChanges}}
+```bash
+changelog apply
+```
 
-### Major Changes
+This computes the version bump, creates the release, and updates your project:
 
-{{#each majorChanges}}
-- {{shortSha}}: {{description}}
-{{~/each}}
-{{/if}}
-{{#if minorChanges}}
+```
+✓ 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
+```
 
-### Minor Changes
+The version bump is determined by the change types present:
 
-{{#each minorChanges}}
-- {{shortSha}}: {{description}}
-{{~/each}}
-{{/if}}
-{{#if patchChanges}}
+| Change Types   | Bump  |
+| -------------- | ----- |
+| Change, Remove | Major |
+| Add, Deprecate | Minor |
+| Fix            | Patch |
+| Internal       | None  |
 
-### Patch Changes
+After applying, push the commit and tag:
 
-{{#each patchChanges}}
-- {{shortSha}}: {{description}}
-{{/each}}
-{{~/if}}
+```bash
+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.0",
-  "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"
-  }
+  ]
 }