git-chopstick-core 0.1.6 → 0.1.7

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.1.7] — 2026-06-13
+
+### Added
+- **Documentation included in package**: Added `docs/` to the `files` array in `package.json`. The migration guide (`docs/exec-to-git-migration.md`) and release skill (`docs/skills/release.md`) now ship with the installed package.
+
+---
+
 ## [0.1.6] — 2026-06-13
 
 ### Fixed
@@ -120,6 +127,7 @@
 [0.1.2]: https://github.com/parkiyong/git-chopstick-core/releases/tag/v0.1.2
 [0.1.1]: https://github.com/parkiyong/git-chopstick-core/releases/tag/v0.1.1
 [0.1.0]: https://github.com/parkiyong/git-chopstick-core/releases/tag/v0.1.0
+[0.1.7]: https://github.com/parkiyong/git-chopstick-core/releases/tag/v0.1.7
 [0.1.6]: https://github.com/parkiyong/git-chopstick-core/releases/tag/v0.1.6
 [0.1.5]: https://github.com/parkiyong/git-chopstick-core/releases/tag/v0.1.5
 [0.1.4]: https://github.com/parkiyong/git-chopstick-core/releases/tag/v0.1.4
@@ -127,4 +135,4 @@
 [0.1.2]: https://github.com/parkiyong/git-chopstick-core/releases/tag/v0.1.2
 [0.1.1]: https://github.com/parkiyong/git-chopstick-core/releases/tag/v0.1.1
 [0.1.0]: https://github.com/parkiyong/git-chopstick-core/releases/tag/v0.1.0
-[Unreleased]: https://github.com/parkiyong/git-chopstick-core/compare/v0.1.5...HEAD
+[Unreleased]: https://github.com/parkiyong/git-chopstick-core/compare/v0.1.7...HEAD

package/docs/exec-to-git-migration.md

@@ -0,0 +1,75 @@
+# Migration Guide: `exec` → `git()`
+
+> **Applies to:** Upgrading from `git-chopstick-core@0.1.4` to `0.1.5+`
+
+In v0.1.4, `exec()` was briefly exposed as a public function. Starting in **v0.1.5**, `exec()` is no longer part of the public API — `git()` is the single function for running Git commands.
+
+## Why?
+
+`exec()` and `git()` did the same thing with different semantics:
+
+| Aspect | `exec()` | `git()` |
+|--------|----------|---------|
+| `successExitCodes` | ❌ No — raw exit code | ✅ Yes — configurable set |
+| Error parsing | ❌ No | ✅ Yes — 50-code `GitError` enum |
+| Throws on bad exit | ❌ No — returns raw result | ✅ Yes — throws `GitError` |
+| Hook interception | ❌ No | ✅ Yes — `interceptHooks` option |
+| Buffer output | ✅ Yes — `encoding: 'buffer'` | ✅ Yes — `{ encoding: 'buffer' }` |
+
+`git()` does everything `exec()` did, plus error handling, typed error codes, and hook support. Maintaining both was confusing.
+
+## Before → After
+
+### Raw git execution (basic)
+
+```typescript
+// Before (v0.1.4)
+import { exec } from 'git-chopstick-core/git'
+const result = await exec(['rev-parse', '--show-toplevel'], '/path/to/repo')
+
+// After (v0.1.5+)
+import { git } from 'git-chopstick-core'
+const result = await git(['rev-parse', '--show-toplevel'], '/path/to/repo', 'my-op')
+```
+
+### Buffer output (binary diffs)
+
+```typescript
+// Before
+import { exec } from 'git-chopstick-core/git'
+const result = await exec(['diff', '--binary', sha], path, { encoding: 'buffer' })
+
+// After
+import { git } from 'git-chopstick-core'
+const result = await git(['diff', '--binary', sha], path, 'my-op', { encoding: 'buffer' })
+```
+
+### Ignoring non-zero exit codes
+
+```typescript
+// Before — exec doesn't filter, so you check exitCode manually
+const result = await exec(['symbolic-ref', '--short', 'HEAD'], path)
+const branch = result.exitCode === 0 ? result.stdout.toString().trim() : undefined
+
+// After — git() accepts successExitCodes, returns result or throws
+const result = await git(['symbolic-ref', '--short', 'HEAD'], path, 'getBranch', {
+  successExitCodes: new Set([0, 128]),
+})
+const branch = result.exitCode === 0 ? result.stdout.trim() : undefined
+
+// Or just use the built-in helper:
+import { getCurrentBranch } from 'git-chopstick-core'
+const branch = await getCurrentBranch(path)
+```
+
+## What stayed public?
+
+The following from `exec.ts` remain in the public API because they serve different purposes:
+
+| Export | Purpose |
+|--------|---------|
+| `spawnGit(args, path, options?)` | Returns a `ChildProcess` for streaming git access — useful for long-running operations where you want direct process control |
+| `parseError(stderr)` | Parse git stderr into a `GitError` enum value for manual error inspection |
+| `parseBadConfigValueErrorInfo(stderr)` | Extract key/value from bad config value errors |
+| `ExecError` (class) | Error thrown when maxBuffer is exceeded |
+| `GitError` (enum) | 50+ typed error codes (available as `GitErrorCodes` from root barrel) |

package/docs/skills/release.md

@@ -0,0 +1,81 @@
+---
+name: release
+description: Automated release workflow for git-chopstick-core — version bump, changelog, build, validation, and npm publish.
+---
+
+# Release: git-chopstick-core
+
+> Loaded via `skill("release")`. Run this whenever you need to publish a new release.
+
+## Process
+
+### 1. Read current state
+
+Read `package.json`, `CHANGELOG.md`, and run `git log --oneline -5` to understand what has changed since the last release.
+
+### 2. Determine version bump
+
+Check what has changed:
+
+- **Breaking API changes** (removed exports, changed signatures) → minor bump (0.x.0)
+- **New features** (new functions, new exports) → patch bump (0.0.x)
+- **Bug fixes, docs, internal refactoring** → patch bump (0.0.x)
+
+Current version: read from `package.json`. Bump accordingly.
+
+### 3. Update `CHANGELOG.md`
+
+Insert a new `## [VERSION] — YYYY-MM-DD` section at the top (below the `# Changelog` heading) with:
+
+- `### Added` — new features, exports, helpers
+- `### Changed` — behavioral changes, renames, config changes
+- `### Fixed` — bug fixes
+
+Then update the link references at the bottom:
+
+- Add `[VERSION]: https://github.com/parkiyong/git-chopstick-core/releases/tag/vVERSION`
+- Update `[Unreleased]: .../compare/vVERSION...HEAD`
+
+### 4. Bump `package.json`
+
+Update `"version"` field.
+
+### 5. Build and validate
+
+Run all of these (use parallel agents):
+
+- `npm run typecheck` — must pass with zero errors
+- `npm run build` — must produce a clean `dist/`
+- `npm test` — all integration tests must pass
+- `npm pack --dry-run` — confirm all of:
+  - `dist/` is included (expect ~351 files, ~700kB)
+  - `CHANGELOG.md` and `docs/` appear in the file list
+  - `package.json`, `README.md`, `LICENSE` are present (npm includes these automatically)
+  - No unexpected files are leaking through (check for test artifacts, `.ts` sources outside `dist/`)
+
+If any fail, fix before proceeding.
+
+### 6. Stage and commit
+
+```
+git add -A
+git commit -m "vVERSION: <short summary of changes>"
+```
+
+### 7. Push and publish
+
+```
+git push origin main
+npm publish
+```
+
+### 8. Verify
+
+- Confirm npm shows the new version: `npm view git-chopstick-core version`
+- Confirm the tag exists on GitHub: `git tag -l`
+- Suggest followup tasks
+
+## Notes
+
+- `prepublishOnly` runs `npm run typecheck && npm run build` automatically, so no need to build before publish — but validate first anyway.
+- If this is the first release in a session, run `setup-matt-pocock-skills` first to configure issue tracker context.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "git-chopstick-core",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -32,7 +32,8 @@
   },
   "files": [
     "dist",
-    "CHANGELOG.md"
+    "CHANGELOG.md",
+    "docs"
   ],
   "description": "Git backend library extracted from GitHub Desktop",
   "scripts": {