Documentation
¶
Index ¶
- func AddBackticks(s string) string
- func BuildMarkdownTable(scripts []ScriptInfo) string
- func ExecuteWithArgs(fn func(...string))
- func GetExtraArgs() []string
- func GetWorkingDirectory() string
- func NewScriptRunner(scriptsDir ...string) *scriptRunner
- func SectionUpdate(args ...string)
- func TrimHashPrefix(s string) string
- type DevScriptsReadmeUpdater
- type Devbashscripts
- type MdTable
- func (mt *MdTable) AddRow(row []string)
- func (mt *MdTable) Generate() string
- func (mt *MdTable) SetColumnFormatter(colIndex int, formatter func(string) string)
- func (mt *MdTable) SetEmptyPlaceholder(colIndex int, placeholder string)
- func (mt *MdTable) SetMaxColumnWidth(colIndex, width int)
- func (mt *MdTable) SetMinColumnWidth(colIndex, width int)
- func (mt *MdTable) SetRows(rows [][]string)
- type ScriptChain
- type ScriptInfo
- type ScriptParser
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AddBackticks ¶ added in v0.0.47
Helper formatters that can be used with SetColumnFormatter
func BuildMarkdownTable ¶ added in v0.0.47
func BuildMarkdownTable(scripts []ScriptInfo) string
BuildMarkdownTable creates a markdown table from script info using the MdTable API This function provides backward compatibility and a simple interface for common use cases
func ExecuteWithArgs ¶ added in v0.0.47
func ExecuteWithArgs(fn func(...string))
ExecuteWithArgs ejecuta una función después de cambiar al directorio especificado El primer argumento siempre debe ser el directorio de trabajo Los argumentos restantes se pasan a la función
func GetExtraArgs ¶ added in v0.0.47
func GetExtraArgs() []string
GetExtraArgs retorna los argumentos adicionales (después del directorio)
func GetWorkingDirectory ¶ added in v0.0.47
func GetWorkingDirectory() string
GetWorkingDirectory retorna el directorio de trabajo del primer argumento
func NewScriptRunner ¶
func NewScriptRunner(scriptsDir ...string) *scriptRunner
NewScriptRunner creates a handler for scripts using an optional scripts directory parameter. If no directory is provided, it uses the current working directory.
func SectionUpdate ¶ added in v0.0.47
func SectionUpdate(args ...string)
SectionUpdate is a small CLI-style entry calls mdgo directly.
Args order: sectionID (required), afterLine (optional), content (required), readmeFile (optional, default: `README.md`).
func TrimHashPrefix ¶ added in v0.0.47
Types ¶
type DevScriptsReadmeUpdater ¶ added in v0.0.47
type DevScriptsReadmeUpdater struct {
// contains filtered or unexported fields
}
DevScriptsReadmeUpdater handles updating README.md with scripts documentation
func NewDevScriptsReadmeUpdater ¶ added in v0.0.47
func NewDevScriptsReadmeUpdater(scriptsDir string) *DevScriptsReadmeUpdater
NewDevScriptsReadmeUpdater creates a new DevScriptsReadmeUpdater
func (*DevScriptsReadmeUpdater) GenerateScriptsSection ¶ added in v0.0.47
func (dru *DevScriptsReadmeUpdater) GenerateScriptsSection() (string, error)
GenerateScriptsSection generates a markdown section for README with scripts table
func (*DevScriptsReadmeUpdater) UpdateReadme ¶ added in v0.0.47
func (dru *DevScriptsReadmeUpdater) UpdateReadme(readmePath string) error
UpdateReadme updates the README file with the scripts section using sectionUpdate
func (*DevScriptsReadmeUpdater) UpdateReadmeIfNeeded ¶ added in v0.0.47
func (dru *DevScriptsReadmeUpdater) UpdateReadmeIfNeeded(readmePath string) (bool, error)
UpdateReadmeIfNeeded updates README and returns true if changes were made
type MdTable ¶ added in v0.0.47
type MdTable struct {
// contains filtered or unexported fields
}
MdTable handles creation of markdown tables
func NewMdTable ¶ added in v0.0.47
NewMdTable creates a new MdTable with headers
func (*MdTable) SetColumnFormatter ¶ added in v0.0.47
SetColumnFormatter sets a formatter function for a column (0-based index)
func (*MdTable) SetEmptyPlaceholder ¶ added in v0.0.47
SetEmptyPlaceholder sets placeholder text for empty cells in a column (0-based index)
func (*MdTable) SetMaxColumnWidth ¶ added in v0.0.47
SetMaxColumnWidth sets maximum width for a column (0-based index)
func (*MdTable) SetMinColumnWidth ¶ added in v0.0.47
SetMinColumnWidth sets minimum width for a column (0-based index)
type ScriptChain ¶ added in v0.0.4
type ScriptChain struct {
// contains filtered or unexported fields
}
ScriptChain represents a chain of scripts to be executed in sequence
func (*ScriptChain) Error ¶ added in v0.0.4
func (sc *ScriptChain) Error() error
Error returns the error of the last executed script
func (*ScriptChain) Execute ¶ added in v0.0.4
func (sc *ScriptChain) Execute() (int, string, error)
Execute runs all scripts in the chain until one fails
func (*ScriptChain) ExitCode ¶ added in v0.0.4
func (sc *ScriptChain) ExitCode() int
ExitCode returns the exit code of the last executed script
func (*ScriptChain) Output ¶ added in v0.0.4
func (sc *ScriptChain) Output() string
Output returns the output of the last executed script
func (*ScriptChain) Then ¶ added in v0.0.4
func (sc *ScriptChain) Then(scriptName string, args ...string) *ScriptChain
Then adds a script to the execution chain
type ScriptInfo ¶ added in v0.0.47
ScriptInfo represents information about a shell script
type ScriptParser ¶ added in v0.0.47
type ScriptParser struct {
// contains filtered or unexported fields
}
ScriptParser handles parsing of shell scripts
func NewScriptParser ¶ added in v0.0.47
func NewScriptParser(scriptsDir string) *ScriptParser
NewScriptParser creates a new ScriptParser
func (*ScriptParser) GetScriptNames ¶ added in v0.0.47
func (sp *ScriptParser) GetScriptNames() ([]string, error)
GetScriptNames obtiene los nombres de los scripts .sh en el directorio
func (*ScriptParser) ParseScripts ¶ added in v0.0.47
func (sp *ScriptParser) ParseScripts() ([]ScriptInfo, error)
ParseScripts obtiene las descripciones de los scripts