egutierrez
cfdf515228
- .claude/CLAUDE.md - .claude/commands/subagentes.md - .claude/rules/INDEX.md - .mcp.json - bash/functions/cybersecurity/analyze_dns.md - bash/functions/cybersecurity/audit_http_headers.md - bash/functions/cybersecurity/audit_ssh_config.md - bash/functions/cybersecurity/check_firewall.md - bash/functions/cybersecurity/detect_suspicious_users.md - bash/functions/cybersecurity/encrypt_file.md - ... Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
47 lines
1.6 KiB
Markdown
47 lines
1.6 KiB
Markdown
---
|
|
name: extract_script_description
|
|
kind: function
|
|
lang: go
|
|
domain: shell
|
|
version: "1.0.0"
|
|
purity: impure
|
|
signature: "func ExtractScriptDescription(scriptPath string) string"
|
|
description: "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."
|
|
tags: [shell, script, description, parse, comment, metadata, pendiente-usar]
|
|
uses_functions: []
|
|
uses_types: []
|
|
returns: []
|
|
returns_optional: false
|
|
error_type: "error_go_core"
|
|
imports: [bufio, os, path/filepath, strings]
|
|
params:
|
|
- name: scriptPath
|
|
desc: "ruta al archivo de script (.sh, .ps1, .bat)"
|
|
output: "descripcion extraida del primer comentario, o nombre del archivo humanizado"
|
|
tested: false
|
|
tests: []
|
|
test_file_path: ""
|
|
file_path: "functions/shell/extract_script_description.go"
|
|
source_repo: "https://gitea-dgg044oo04woo4ggcsws4gk0.organic-machine.com/egutierrez/DevLauncher.git"
|
|
source_license: "MIT"
|
|
source_file: "launcher/middleware/reader.go"
|
|
---
|
|
|
|
## Ejemplo
|
|
|
|
```go
|
|
// 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.
|