Files
fn_registry/functions/shell/extract_script_description.md
T
egutierrez 93ef4b8010 feat: add Go extract_script_description function
Funcion Go pura del dominio shell que extrae la descripcion de un script Bash
parseando el header del archivo. Busca comentarios con formato estandar y
retorna la primera linea de descripcion encontrada. Util para indexar scripts
automaticamente.
2026-04-12 13:54:48 +02:00

1.6 KiB

name, kind, lang, domain, version, purity, signature, description, tags, uses_functions, uses_types, returns, returns_optional, error_type, imports, params, output, tested, tests, test_file_path, file_path, source_repo, source_license, source_file
name kind lang domain version purity signature description tags uses_functions uses_types returns returns_optional error_type imports params output tested tests test_file_path file_path source_repo source_license source_file
extract_script_description function go shell 1.0.0 impure func ExtractScriptDescription(scriptPath string) string Parsea un archivo de script y extrae la primera linea de comentario util como descripcion. Salta shebangs y lineas vacias. Si no encuentra descripcion, usa el nombre del archivo.
shell
script
description
parse
comment
metadata
false error_go_core
bufio
os
path/filepath
strings
name desc
scriptPath ruta al archivo de script (.sh, .ps1, .bat)
descripcion extraida del primer comentario, o nombre del archivo humanizado false
functions/shell/extract_script_description.go https://gitea-dgg044oo04woo4ggcsws4gk0.organic-machine.com/egutierrez/DevLauncher.git MIT launcher/middleware/reader.go

Ejemplo

// Dado un script con:
// #!/bin/bash
// # Analisis completo de DNS para un dominio
desc := shell.ExtractScriptDescription("/path/to/analisis_dns.sh")
// desc == "Analisis completo de DNS para un dominio"

// Sin comentario util
desc2 := shell.ExtractScriptDescription("/path/to/instalar_go.sh")
// desc2 == "instalar go" (fallback del nombre)

Notas

Busca en las primeras 5 lineas. Remueve prefijos comunes como "Script:", "Descripción:", "Description:" del comentario. Si el archivo no existe o no tiene comentarios utiles, genera una descripcion a partir del nombre del archivo reemplazando underscores por espacios.