Skip to content

Conversation

@jellydn
Copy link

@jellydn jellydn commented Dec 10, 2025

Summary

Adds comprehensive Makefile development shortcuts and updates CLAUDE.md documentation for improved developer experience.

What

  • New Makefile with development shortcuts mirroring npm scripts
  • Updated CLAUDE.md with complete build commands and environment setup
  • Quick commands: make build, make build-and-sync, make sync, make worker-restart, make worker-logs
  • Configurable package manager (defaults to bun, override with NPM=npm)
  • Updated documentation to reflect v7.1.0 PM2→Bun architectural migration

Why

Improves developer experience with shorter commands and familiar Make interface. Reduces typing friction during local development while maintaining full compatibility with existing npm scripts. Ensures documentation reflects latest architecture changes and provides clear guidance on build processes.

How

  • Makefile wraps existing npm/bun scripts with convenient targets
  • CLAUDE.md includes build commands section with common workflows
  • .PHONY targets prevent file conflicts
  • make help shows all available commands
  • Updated help text references Bun worker (not PM2)

Changes

  • Makefile: Added build-and-sync, build, sync, worker-restart, worker-logs targets
  • CLAUDE.md: Added Build Commands section with most common workflows
  • Updated scripts: plugin/scripts/mcp-server.cjs, plugin/scripts/worker-service.cjs
  • Documentation: Clarified Bun-based worker service architecture

Test Plan

  • Run make help to verify all targets listed
  • Test make build-and-sync compiles and syncs successfully
  • Test make worker-restart restarts Bun worker
  • Test make worker-logs displays worker logs
  • Verify NPM=npm make build uses npm instead of bun

🤖 Generated with Claude Code

Provides convenient make targets that wrap existing npm scripts,
improving developer experience with shorter commands.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Haiku 4.5 <[email protected]>
@jellydn jellydn marked this pull request as ready for review December 10, 2025 13:44
@jellydn
Copy link
Author

jellydn commented Dec 10, 2025

Here is how to test. Step 1: build

image

Step 2: add plugin /plugin marketplace add PATH
image

jellydn and others added 8 commits December 13, 2025 11:07
- Update version badge in README from 6.5.0 to 7.1.0
- Update Makefile help text: PM2 -> Bun worker references
- Fix worker-logs-no-flush Makefile target to directly tail logs
- Update What's New section to highlight v7.1.0 architectural migration
- Update development shortcuts documentation
Aligns with v7.1.0 migration to Bun as primary package manager.
Updates:
- src/services/worker/BranchManager.ts: bun install in branch switching and updates
- src/shared/hook-error-handler.ts: bun run worker:restart in error messages
- src/shared/worker-utils.ts: bun run worker:start/restart in startup errors
- src/servers/mcp-server.ts: bun run worker:restart in worker availability check
- scripts/publish.js: bun run build and bun test
- scripts/sync-marketplace.cjs: bun run sync-marketplace:force in user guidance
- CLAUDE.md: All build command examples updated to bun
- README.md: Development setup and troubleshooting examples updated to bun

Aligns with v7.1.0 Bun-based architecture migration.
Creates Architecture Decision Record documenting:
- Context: Why PM2 was problematic (external dependency, platform complexity, auto-install friction)
- Decision: Replace with custom Bun-based ProcessManager using PID file tracking
- Consequences: Reduced dependencies, simpler cross-platform support, manual PID cleanup trade-off
- Alternatives: systemd/launchd (too OS-specific), Node.js child_process (unnecessary complexity)

Adds ADR directory structure and index per adr.github.io format.
- Add make build-and-sync, make build, make sync, and make worker-restart shortcuts
- Add make worker-logs for viewing worker service logs
- Update CLAUDE.md with complete build commands and environment setup
- Update MCP server and worker service scripts
@jellydn jellydn force-pushed the add-makefile-development-shortcuts branch from 2a9a802 to 014606d Compare December 16, 2025 02:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant