@zappinginc/zm2 6.0.14

package/CLAUDE.md

@@ -0,0 +1,84 @@
+# CLAUDE.md - PM2 Project Guide
+
+## Project Overview
+
+PM2 is a production process manager for Node.js/Bun applications with a built-in load balancer. Version 6.0.14, licensed under AGPL-3.0. Minimum Node.js version: 16.
+
+## Quick Commands
+
+```bash
+npm test              # Run all tests (e2e + unit)
+npm run test:unit     # Unit tests only (bash test/unit.sh)
+npm run test:e2e      # E2E tests only (bash test/e2e.sh)
+pm2 update            # Restart daemon after modifying Daemon.js, God.js, God/*, Watcher.js
+```
+
+## Architecture
+
+- **Entry points**: `index.js` (programmatic API), `bin/pm2` (CLI)
+- **API** (`lib/API.js`): Main programmatic interface, ~1900 lines
+- **Daemon** (`lib/Daemon.js`): Daemon lifecycle, uses pm2-axon for RPC/messaging
+- **God** (`lib/God.js` + `lib/God/`): Core process monitoring — ClusterMode, ForkMode, Reload, ActionMethods
+- **Client** (`lib/Client.js`): RPC client for daemon communication
+- **CLI** (`lib/binaries/CLI.js`): Commander.js-based CLI with 90+ options
+- **Process containers**: `ProcessContainer.js` (Node), `ProcessContainerBun.js` (Bun)
+- **API modules** (`lib/API/`): Dashboard, Deploy, Log, Startup, Modules, pm2-plus, etc.
+- **Tools** (`lib/tools/`): Utility functions (Config, json5, sexec, which, etc.)
+
+## Key Directories
+
+```
+bin/          CLI entry points (pm2, pm2-dev, pm2-docker, pm2-runtime)
+lib/          Core source code
+lib/API/      Extended API modules (Deploy, Log, Startup, Modules, etc.)
+lib/God/      Process management submodules (ClusterMode, ForkMode, Reload)
+lib/binaries/ CLI implementations
+lib/tools/    Utility functions
+lib/templates/ Config templates & init scripts (systemd, upstart, launchd)
+test/         Tests
+test/programmatic/  Unit tests (Mocha + Should.js)
+test/e2e/     End-to-end tests (bash scripts)
+test/fixtures/ Test fixtures
+types/        TypeScript definitions
+examples/     Example applications
+```
+
+## PM2 Runtime Files
+
+Located at `$HOME/.pm2/`:
+- `pm2.log`, `pm2.pid` — daemon log and PID
+- `rpc.sock`, `pub.sock` — IPC sockets
+- `dump.pm2` — process list dump for resurrection
+- `logs/`, `pids/` — app logs and PIDs
+- `modules/` — installed PM2 modules
+
+## Code Style
+
+- **Indentation**: 2 spaces (tabs for Makefiles)
+- **Line endings**: LF
+- **Charset**: UTF-8
+- **Trailing whitespace**: trimmed
+- **Final newline**: yes
+- No linter configured; follow existing patterns
+
+## Test Configuration (Mocha)
+
+- Timeout: 10000ms
+- Bail: true (exit on first failure)
+- Retries: 2
+- UI: BDD
+- Exit: true
+
+## Commit Message Convention
+
+Prefix commits with: `fix:`, `hotfix:`, `feat:`, `docs:`, `BREAKING:`, `refactor:`, `perf:`, `style:`, `test:`, `chore:`
+
+Keep description under 50 chars, lowercase except proper nouns/acronyms.
+
+## CI
+
+GitHub Actions on push/PR — tests on Node 16.x and 24.x, plus separate Bun tests. Requires Python 3 and PHP CLI for some e2e tests. 30-minute timeout.
+
+## Key Dependencies
+
+- `commander` (CLI), `async`, `pm2-axon`/`pm2-axon-rpc` (IPC), `chokidar` (file watching), `croner` (cron), `pidusage` (process monitoring), `vizion` (VCS), `js-yaml`, `@pm2/io`, `@pm2/agent`

package/CONTRIBUTING.md

@@ -0,0 +1,124 @@
+# Contributing
+
+## Cloning PM2 development
+
+```bash
+$ git clone https://github.com/Unitech/pm2.git
+$ cd pm2
+$ git checkout development
+$ npm install
+```
+
+I recommend having a pm2 alias pointing to the development version to make it easier to use pm2 development:
+
+```
+$ cd pm2/
+$ echo "alias pm2='`pwd`/bin/pm2'" >> ~/.bashrc
+```
+
+You are now able to use pm2 in dev mode:
+
+```
+$ pm2 update
+$ pm2 ls
+```
+
+## Project structure
+
+```
+.
+├── bin      // pm2, pmd, pm2-dev, pm2-docker are there
+├── examples // examples files
+├── lib      // source files
+├── pres     // presentation files
+├── test     // test files
+└── types    // TypeScript definition files
+```
+
+## Modifying the Daemon
+
+When you modify the Daemon (lib/Daemon.js, lib/God.js, lib/God/*, lib/Watcher.js), you must restart the pm2 Daemon by doing:
+
+```
+$ pm2 update
+```
+
+## Commit rules
+
+### Commit message
+
+A good commit message should describe what changed and why.
+
+It should :
+  * contain a short description of the change (preferably 50 characters or less)
+  * be entirely in lowercase with the exception of proper nouns, acronyms, and the words that refer to code, like function/variable names
+  * be prefixed with one of the following word
+    * fix : bug fix
+    * hotfix : urgent bug fix
+    * feat : new or updated feature
+    * docs : documentation updates
+    * BREAKING : if commit is a breaking change
+    * refactor : code refactoring (no functional change)
+    * perf : performance improvement
+    * style : UX and display updates
+    * test : tests and CI updates
+    * chore : updates on build, tools, configuration ...
+    * Merge branch : when merging branch
+    * Merge pull request : when merging PR
+
+## Tests
+
+There are two tests type. Programmatic and Behavioral.
+The main test command is `npm test`
+
+### Programmatic
+
+Programmatic tests are runned by doing
+
+```
+$ bash test/pm2_programmatic_tests.sh
+```
+
+This test files are located in test/programmatic/*
+
+### Behavioral
+
+Behavioral tests are runned by doing:
+
+```
+$ bash test/e2e.sh
+```
+
+This test files are located in test/e2e/*
+
+## File of interest
+
+- `$HOME/.pm2` contain all PM2 related files
+- `$HOME/.pm2/logs` contain all applications logs
+- `$HOME/.pm2/pids` contain all applications pids
+- `$HOME/.pm2/pm2.log` PM2 logs
+- `$HOME/.pm2/pm2.pid` PM2 pid
+- `$HOME/.pm2/rpc.sock` Socket file for remote commands
+- `$HOME/.pm2/pub.sock` Socket file for publishable events
+
+## Generate changelog
+
+### requirements
+
+```
+npm install git-changelog -g
+```
+
+### usage
+
+Edit .changelogrc
+Change "version_name" to the next version to release (example 1.1.2).
+Change "tag" to the latest existing tag (example 1.1.1).
+
+Run the following command into pm2 directory
+```
+git-changelog
+```
+
+It will generate currentTagChangelog.md file.
+Just copy/paste the result into changelog.md