@@ -73,6 +73,7 @@ export interface RunOptions {
7373 * @param command Array of command parts
7474 * @param options Execution options
7575 * @throws Error if command execution fails
76+ * @returns The process output
7677 */
7778export async function exec (
7879 command : string [ ] ,
@@ -96,6 +97,7 @@ export async function exec(
9697/**
9798 * Format duration in milliseconds to human-readable string
9899 * @param ms Duration in milliseconds
100+ * @returns Formatted string (e.g. "1.5s" or "500ms")
99101 */
100102export function formatDuration ( ms : number ) : string {
101103 if ( ms < 1000 ) {
@@ -109,6 +111,7 @@ export function formatDuration(ms: number): string {
109111/**
110112 * Check if a tool or check is explicitly skipped via environment variable
111113 * @param name Name of the tool/check (will be converted to SKIP_<NAME>)
114+ * @returns True if the tool should be skipped
112115 */
113116export function isSkipped ( name : string ) : boolean {
114117 // Normalize name -> uppercase, replace non-alphanum with underscore, collapse multiple underscores
@@ -122,6 +125,7 @@ export function isSkipped(name: string): boolean {
122125
123126/**
124127 * Check if the current project is a DDEV project
128+ * @returns True if .ddev/config.yaml exists and ddev binary is available
125129 */
126130export async function isDdevProject ( ) : Promise < boolean > {
127131 // Allow explicit disable via env var
@@ -142,6 +146,7 @@ export async function isDdevProject(): Promise<boolean> {
142146
143147/**
144148 * Get the DDEV project name from .ddev/config.yaml
149+ * @returns The project name or null if not found
145150 */
146151async function getDdevProjectName ( ) : Promise < string | null > {
147152 try {
@@ -159,6 +164,7 @@ async function getDdevProjectName(): Promise<string | null> {
159164 * @param command The command parts (e.g. ['php', '-v'])
160165 * @param type The tool type ('node', 'php', 'system')
161166 * @throws Error if DDEV project name cannot be determined
167+ * @returns The modified command array ready for execution
162168 */
163169async function getExecCommand ( command : string [ ] , type : string ) : Promise < string [ ] > {
164170 if ( type !== 'php' ) {
0 commit comments