Add JSDoc documentation to CLI lifecycle functions - #43
Conversation
Co-authored-by: clduab11 <185000089+clduab11@users.noreply.github.com>
Co-authored-by: clduab11 <185000089+clduab11@users.noreply.github.com>
Co-authored-by: clduab11 <185000089+clduab11@users.noreply.github.com>
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: df375fbc52
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| "resolved": "https://registry.npmjs.org/ws/-/ws-8.18.3.tgz", | ||
| "integrity": "sha512-PEIGCY5tSlUt50cqyMXfCzX+oOPqN0vuGqWzbcJ2xvnkzkq46oOpz7dQaTDBdfICb4N14+GARUDw2XV2N4tvzg==", | ||
| "license": "MIT", | ||
| "peer": true, |
There was a problem hiding this comment.
Revert peer-only flag on direct runtime dependency
The lockfile now marks ws as "peer": true even though the root package declares it in dependencies; Arborist trusts this metadata from package-lock.json, and npm ci/npm install explicitly support --omit=peer to skip peer-typed nodes, so installs in that mode will incorrectly omit ws (and zod in the same commit) from disk. This turns a documentation-only change into a dependency graph regression for environments that use peer omission.
Useful? React with 👍 / 👎.
… status reporting [PAP-17] (#42) * Fix codex-synaptic launch blockers * Document launch readiness fixes * Update docs/runbooks/autoscaler-daemon-coordination.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Update src/cli/index.ts Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Add JSDoc documentation to CLI lifecycle functions (#43) * Initial plan * Initial plan for adding docstrings Co-authored-by: clduab11 <185000089+clduab11@users.noreply.github.com> * Add JSDoc docstrings for CLI functions Co-authored-by: clduab11 <185000089+clduab11@users.noreply.github.com> * Consolidate docstring for resolveCliAutoShutdown Co-authored-by: clduab11 <185000089+clduab11@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: clduab11 <185000089+clduab11@users.noreply.github.com> * Add JSDoc documentation to satisfy 80% docstring coverage threshold (#44) * Initial plan * Add comprehensive JSDoc documentation to CLI functions - Added 45+ JSDoc docstrings to previously undocumented functions - Documented all lifecycle functions (loadEnvFile, bootstrapCliEnv, etc.) - Documented all rendering functions (renderAgentTable, renderMeshStatus, etc.) - Documented all interactive menu functions (interactiveSystemMenu, etc.) - Documented all utility functions (parseInteger, formatBytes, tokenizeCliArgs, etc.) - Documented helper functions (shouldAutoAttachCodexContext, shouldRequireConsensus, etc.) - All docstrings follow JSDoc format with @param, @returns, and @remarks tags - Improves docstring coverage toward 80% threshold requirement Co-authored-by: clduab11 <185000089+clduab11@users.noreply.github.com> * Add JSDoc documentation to OpenAI and core utility functions - Added docstrings to OpenAI credential resolution functions - Added docstrings to model catalog functions (getStaticOpenAIModelCatalog, mergeModelInventory) - Added docstrings to inference functions (inferModalitiesFromIdentifier, inferCapabilitiesFromIdentifier) - Added docstrings to core system helper functions (cloneCodexContext, cloneCodexEnvelope, cloneFileTreeNode) - All docstrings follow JSDoc format with @param, @returns, and @remarks tags - Further improves docstring coverage across modified files Co-authored-by: clduab11 <185000089+clduab11@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: clduab11 <185000089+clduab11@users.noreply.github.com> * Refactor complex hive-mind spawn handler to resolve CodeFactor complexity warnings (#45) * Initial plan * Refactor complex hive-mind spawn command into helper functions Co-authored-by: clduab11 <185000089+clduab11@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: clduab11 <185000089+clduab11@users.noreply.github.com> * Update src/cli/index.ts Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --------- Co-authored-by: Chris Dukes <chrisdukes@iMac.attlocal.net> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: clduab11 <185000089+clduab11@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Added missing JSDoc documentation to functions introduced in the launch readiness fixes PR to satisfy documentation coverage requirements.
Functions documented:
resolveCliAutoShutdown()- InterpretsCODEX_CLI_AUTO_SHUTDOWNenvironment variable with default behavior and supported values ('0', 'false', 'no')renderBackgroundDaemonStatus()- Renders daemon status including PID, start time, interface mode/tieruseSystem()- System lifecycle management with updatedoptionsparameter for auto-shutdown controlUseSystemOptionstype - Configuration options for system lifecycle behaviorAll documentation follows established JSDoc conventions with
@param,@returns, and@remarkstags.💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.
Continue Tasks:▶️ 5 queued — View all