gitcoauthor

A CLI tool to easily add co-authors to your git commits.

Installation

npm install -g gitcoauthor

Usage

After making a commit, run:

gitcoauthor

The tool will:

1. Read your git history (last 250 commits by default)
2. Present you with a list of unique authors
3. Add the selected co-author to your most recent commit

The co-author will be added using the Git co-author convention:

Co-authored-by: Name <[email protected]>

Options

• --depth, -d <number>: Number of commits to search for authors (default: 250)

# Search only the last 50 commits
gitcoauthor --depth 50

# Search the last 1000 commits
gitcoauthor -d 1000

Development

Setup

npm install

Build

npm run build

Test

# Run tests
npm test

Run tests in watch mode

npm run test:watch

Generate coverage report

npm run test:coverage

Testing Strategy

This project uses end-to-end (e2e) testing exclusively. All tests run the actual CLI in real git repositories, providing high confidence that the tool works correctly in production scenarios.

E2E Tests

• Test the actual CLI in real git repositories
• Create temporary git repos with commits
• Verify all functionality: command-line arguments, author detection, co-author addition, edge cases
• Located in src/index.spec.ts
• Run with npm test

Test coverage includes:

• Command-line interface (--help, --depth flag)
• Git repository validation
• Author detection from commits and co-author strings
• Co-author parsing (whitespace, case insensitivity, multiple co-authors)
• Author deduplication
• Co-author addition and duplicate prevention
• Commit message preservation
• Input handling (cancellation, empty input)

Note: Interactive prompt testing (like ESC key handling) is limited because the prompts library requires a real TTY. When input is piped via stdin, the autocomplete behaves differently. Tests verify the CLI handles various inputs gracefully without crashing.

Publishing

The package is automatically published to npm when a new release is created on GitHub. The GitHub Action will:

1. Run tests
2. Build the TypeScript code
3. Publish to npm with provenance

To publish manually:

1. Update the version in package.json
2. Create a git tag: git tag v1.0.0
3. Push the tag: git push origin v1.0.0
4. Create a release on GitHub

License

MIT