docs: add JSDoc headers to entry points and key modules

Add @fileoverview documentation to:
- src/index.ts - CLI entry point
- src/cli.ts - Command definitions
- src/templates/claude-md.ts - Template generation with function docs
- src/web/server.ts - Web server and API

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
arkon
2026-01-21 08:37:35 +01:00
co-authored by Claude Opus 4.5
parent 921abd42a3
commit 3782ec2a74
4 changed files with 50 additions and 0 deletions
+9
View File
@@ -1,3 +1,12 @@
/**
* @fileoverview Claudeman CLI command definitions
*
* Defines all CLI commands and subcommands for managing Claude sessions,
* tasks, Ralph loops, and the web server.
*
* @module cli
*/
import { Command } from 'commander';
import chalk from 'chalk';
import { getSessionManager } from './session-manager.js';
+8
View File
@@ -1,4 +1,12 @@
#!/usr/bin/env node
/**
* @fileoverview Claudeman CLI entry point
*
* This is the main executable entry point for the Claudeman CLI.
* It sets up global error handlers and invokes the CLI parser.
*
* @module index
*/
import { program } from './cli.js';
+21
View File
@@ -1,5 +1,26 @@
/**
* @fileoverview CLAUDE.md template generation
*
* Generates CLAUDE.md configuration files for new Claudeman projects.
* Supports custom templates with placeholder substitution.
*
* @module templates/claude-md
*/
import { existsSync, readFileSync } from 'node:fs';
/**
* Generates a CLAUDE.md configuration file for a new project.
*
* Supports custom templates via `templatePath`. If provided and the file exists,
* placeholders ([PROJECT_NAME], [PROJECT_DESCRIPTION], [DATE]) are replaced.
* Falls back to the default template if custom template is unavailable.
*
* @param caseName - The project/case name to use in the template
* @param description - Optional project description (defaults to "A new project")
* @param templatePath - Optional path to a custom template file
* @returns The generated CLAUDE.md content
*/
export function generateClaudeMd(caseName: string, description: string = '', templatePath?: string): string {
const date = new Date().toISOString().split('T')[0];
+12
View File
@@ -1,3 +1,15 @@
/**
* @fileoverview Claudeman web server and REST API
*
* Provides a Fastify-based web server with:
* - REST API for session management, respawn control, and monitoring
* - Server-Sent Events (SSE) for real-time updates at /api/events
* - Static file serving for the web UI
* - 60fps terminal streaming with batched updates
*
* @module web/server
*/
import Fastify, { FastifyInstance, FastifyReply } from 'fastify';
import fastifyStatic from '@fastify/static';
import { join, dirname } from 'node:path';