shx

package module
v1.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 22, 2026 License: MIT Imports: 15 Imported by: 0

README

Shx

Go Version License Gitee

一个基于 mvdan.cc/sh/v3 的纯 Go Shell 命令执行库

🏠 仓库地址 • 📖 API 文档

项目简介

Shx 是一个基于 mvdan.cc/sh/v3 的纯 Go Shell 命令执行库，不依赖系统 shell，提供跨平台一致的命令执行体验。

  • 纯 Go 实现 — 不依赖系统 shell，Windows/Linux/macOS 行为一致
  • Bash 方言默认 — 支持 [[ ]]、function、select 等 Bash 特有语法
  • 脚本文件执行 — 原生支持执行 .sh 脚本文件
  • 链式调用 API — 流畅的方法链，支持工作目录、环境变量、超时等配置

安装

go get gitee.com/MM-Q/shx@latest

Go 版本要求：1.25.0 或更高

核心特性

特性 说明
纯 Go 实现 基于 mvdan.cc/sh/v3，不依赖系统 shell
Bash 方言默认 默认使用 Bash 方言解析器，支持 [[ ]]、function、select 等 Bash 特有语法
脚本文件执行 原生支持执行 .sh 脚本文件
链式调用 支持流畅的方法链配置
超时控制 支持上下文超时和超时参数
输入输出重定向 灵活的标准输入输出配置
退出码检测 IsExitStatus 可提取命令退出码
结构体字面量 导出字段支持直接通过结构体配置

使用示例

package main

import (
    "fmt"
    "log"
    "time"

    "gitee.com/MM-Q/shx"
)

func main() {
    // ---- 便捷函数 ----
    shx.Run("echo hello")                        // 简单执行
    shx.RunToTerminal("ls -la")                  // 输出到终端

    output, _ := shx.Out("date")                 // 获取输出
    fmt.Println(string(output))

    shx.RunWith("sleep 10", 5*time.Second)       // 超时执行

    // ---- 链式配置 ----
    out, err := shx.New("echo hello").
        WithTimeout(5 * time.Second).
        WithDir("/tmp").
        WithEnv("FOO", "bar").
        ExecOutput()
    if err != nil {
        log.Fatal(err)
    }
    fmt.Println(string(out))

    // ---- 使用上下文 ----
    ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
    defer cancel()
    err = shx.New("long-command").WithContext(ctx).Exec()

    // ---- 自定义输入输出 ----
    var stdout, stderr bytes.Buffer
    stdin := strings.NewReader("input")
    err = shx.New("cat").
        WithStdin(stdin).
        WithStdout(&stdout).
        WithStderr(&stderr).
        Exec()

    // ---- 执行脚本文件 ----
    shx.RunScript("deploy.sh")
    output, err = shx.OutScript("build.sh")

    out, err = shx.NewScript("test.sh").
        WithDir("/project").
        WithEnv("MODE", "ci").
        WithTimeout(30 * time.Second).
        ExecOutput()

    // ---- 检查退出码 ----
    err = shx.Run("exit 5")
    if code, ok := shx.IsExitStatus(err); ok {
        fmt.Printf("Exit code: %d\n", code)
    }
}

注意事项

  • Shx 对象的配置方法（WithXxx）不是并发安全的，不要在多个 goroutine 中并发配置
  • mvdan/sh 是同步执行的，不提供异步 API，如需异步请使用 goroutine 包装
  • 不支持进程控制（无 PID、Kill、Signal），只能通过 context 取消
  • 默认使用 Bash 方言解析（syntax.LangBash），支持 [[ ]]、function、select 等 Bash 特有语法

如果这个项目对您有帮助，请给它一个 ⭐ Star！

⬆顶部

Documentation

Overview

Package shx 提供了基于 mvdan.cc/sh/v3 的纯 Go shell 命令执行功能。

它使用 mvdan.cc/sh/v3 进行命令解析和执行, 不依赖系统 shell。

主要特性:

  • 纯 Go 实现, 不依赖系统 shell
  • 更好的跨平台一致性 (Windows/Linux/macOS 行为一致)
  • 链式调用 API, 支持流畅的方法链
  • 支持超时控制和上下文取消
  • 支持执行 .sh 脚本文件

基本用法: 

import "gitee.com/MM-Q/shx"

// 简单执行
err := shx.Run("echo hello world")

// 获取输出
output, err := shx.Out("ls -la")

// 链式配置
output, err := shx.New("echo hello").
	WithTimeout(5 * time.Second).
	WithDir("/tmp").
	ExecOutput()

// 使用上下文
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
err := shx.New("long-running-command").WithContext(ctx).Exec()

// 执行脚本文件
err = shx.RunScript("deploy.sh")

注意事项:

  • Shx 对象的配置方法 (WithXxx) 不是并发安全的, 不要在多个 goroutine 中并发配置
  • mvdan/sh 是同步执行的, 不提供异步 API, 如需异步请使用 goroutine 包装
  • 不支持进程控制 (无 PID、Kill、Signal) , 只能通过 context 取消

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ErrNilContext 表示上下文为 nil
	ErrNilContext = errors.New("context cannot be nil")
)

预定义错误

Functions

func CheckScriptSyntax 

func CheckScriptSyntax(filePath string) error

CheckScriptSyntax 检查 shell 脚本文件的语法

参数：

  • filePath: 脚本文件路径

返回：

  • error: 语法正确或文件不存在时返回错误信息

示例： 

err := shx.CheckScriptSyntax("deploy.sh")
if err != nil {
    fmt.Println(err)
}

func CheckSyntax 

func CheckSyntax(script string) error

CheckSyntax 检查 shell 命令字符串的语法

参数：

  • script: shell 命令字符串

返回：

  • error: 语法错误时返回错误信息

示例： 

err := shx.CheckSyntax("echo hello")
if err != nil {
    fmt.Println(err)
}

func FindCmd 

func FindCmd(name string) (string, error)

FindCmd 查找命令

增强版，在标准库 exec.LookPath 基础上增加了以下能力：

  • 处理 Go 1.19+ 的 ErrDot 安全限制（当前目录程序）
  • 返回绝对路径
  • Windows 上检查可执行文件扩展名

参数:

  • name: 命令名称

返回:

  • string: 命令的绝对路径
  • error: 错误信息

func FindCommandPath 

func FindCommandPath(name string) string

FindCommandPath 查找单个命令的绝对路径

供其他包复用，只返回第一个匹配的路径 优先使用标准库 exec.LookPath, 处理 ErrDot 情况，找不到则返回空字符串

参数:

  • name: 命令名称

返回:

  • string: 命令的绝对路径，如果找不到则返回空字符串

func Format 

func Format(script string) (string, error)

Format 使用默认选项格式化 shell 命令字符串

参数：

  • script: shell 命令字符串

返回：

  • string: 格式化后的字符串
  • error: 解析错误或系统错误

示例： 

formatted, err := shx.Format("for i in 1 2 3;do echo $i;done")
if err != nil {
    log.Fatal(err)
}
fmt.Println(formatted)

默认格式：

  • 缩进: 4 空格
  • case 语句缩进: 启用
  • 注释保留: 启用

func FormatScript 

func FormatScript(filePath string) (string, error)

FormatScript 使用默认选项格式化 shell 脚本文件

参数：

  • filePath: 脚本文件路径

返回：

  • string: 格式化后的脚本内容
  • error: 解析错误或系统错误

示例： 

formatted, err := shx.FormatScript("deploy.sh")
if err != nil {
    log.Fatal(err)
}
fmt.Println(formatted)

func FormatScriptWithOptions added in v1.0.1 

func FormatScriptWithOptions(filePath string, opts FormatOptions) (string, error)

FormatScriptWithOptions 使用指定选项格式化 shell 脚本文件

参数：

  • filePath: 脚本文件路径
  • opts: 格式化选项

返回：

  • string: 格式化后的脚本内容
  • error: 解析错误或系统错误

示例： 

formatted, err := shx.FormatScriptWithOptions("deploy.sh", shx.DefaultFormatOptions())
if err != nil {
    log.Fatal(err)
}
fmt.Println(formatted)

func FormatWithOptions added in v1.0.1 

func FormatWithOptions(script string, opts FormatOptions) (string, error)

FormatWithOptions 使用指定选项格式化 shell 命令字符串

参数：

  • script: shell 命令字符串
  • opts: 格式化选项

返回：

  • string: 格式化后的字符串
  • error: 解析错误或系统错误

示例： 

formatted, err := shx.FormatWithOptions("for i in 1 2 3;do echo $i;done", shx.DefaultFormatOptions())
if err != nil {
    log.Fatal(err)
}
fmt.Println(formatted)

func IsExitStatus 

func IsExitStatus(err error) (uint8, bool)

IsExitStatus 检查错误是否是退出状态错误

参数：

  • err: 错误对象

返回：

  • uint8: 退出码
  • bool: 是否是退出状态错误

func Out 

func Out(cmd string) ([]byte, error)

Out 执行并获取输出

参数：

  • cmd: 命令字符串

返回：

  • []byte: 命令输出
  • error: 执行错误

示例： 

output, err := shx.Out("ls -la")

func OutCtx 

func OutCtx(ctx context.Context, cmd string) ([]byte, error)

OutCtx 使用上下文执行并获取输出

参数：

  • ctx: 上下文
  • cmd: 命令字符串

返回：

  • []byte: 命令输出
  • error: 执行错误

示例： 

ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
output, err := shx.OutCtx(ctx, "ls -la")

func OutCtxScript 

func OutCtxScript(ctx context.Context, filePath string) ([]byte, error)

OutCtxScript 使用上下文执行 bash 脚本文件并获取输出

参数：

  • ctx: 上下文
  • filePath: 脚本文件路径

返回：

  • []byte: 命令输出
  • error: 执行错误

示例： 

ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
defer cancel()
output, err := shx.OutCtxScript(ctx, "build.sh")

func OutScript 

func OutScript(filePath string) ([]byte, error)

OutScript 执行 bash 脚本文件并获取输出

参数：

  • filePath: 脚本文件路径

返回：

  • []byte: 命令输出
  • error: 执行错误

示例： 

output, err := shx.OutScript("deploy.sh")

func OutScriptWith 

func OutScriptWith(filePath string, timeout time.Duration) ([]byte, error)

OutScriptWith 超时执行 bash 脚本文件并获取输出

参数：

  • filePath: 脚本文件路径
  • timeout: 超时时间

返回：

  • []byte: 命令输出
  • error: 执行错误

示例： 

output, err := shx.OutScriptWith("build.sh", 60*time.Second)

func OutScriptWithIO 

func OutScriptWithIO(filePath string, stdin io.Reader, stdout, stderr io.Writer) ([]byte, error)

OutScriptWithIO 使用自定义输入输出执行 bash 脚本文件并获取输出

参数：

  • filePath: 脚本文件路径
  • stdin: 标准输入
  • stdout: 标准输出
  • stderr: 标准错误

返回：

  • []byte: 命令输出
  • error: 执行错误

示例： 

var buf bytes.Buffer
output, err := shx.OutScriptWithIO("script.sh", strings.NewReader("input"), &buf, os.Stderr)

func OutWith 

func OutWith(cmd string, timeout time.Duration) ([]byte, error)

OutWith 超时执行并获取输出

参数：

  • cmd: 命令字符串
  • timeout: 超时时间

返回：

  • []byte: 命令输出
  • error: 执行错误

示例： 

output, err := shx.OutWith("sleep 5", 10*time.Second)

func OutWithIO 

func OutWithIO(cmd string, stdin io.Reader, stdout, stderr io.Writer) ([]byte, error)

OutWithIO 使用自定义输入输出执行并获取输出

参数：

  • cmd: 命令字符串
  • stdin: 标准输入
  • stdout: 标准输出
  • stderr: 标准错误

返回：

  • []byte: 命令输出
  • error: 执行错误

示例： 

var buf bytes.Buffer
output, err := shx.OutWithIO("cat", strings.NewReader("hello"), &buf, os.Stderr)

func Run 

func Run(cmd string) error

Run 执行命令

参数：

  • cmd: 命令字符串

返回：

  • error: 执行错误

示例： 

err := shx.Run("echo hello")

func RunCtx 

func RunCtx(ctx context.Context, cmd string) error

RunCtx 使用上下文执行

参数：

  • ctx: 上下文
  • cmd: 命令字符串

返回：

  • error: 执行错误

示例： 

ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
err := shx.RunCtx(ctx, "sleep 10")

func RunCtxScript 

func RunCtxScript(ctx context.Context, filePath string) error

RunCtxScript 使用上下文执行 bash 脚本文件

参数：

  • ctx: 上下文
  • filePath: 脚本文件路径

返回：

  • error: 执行错误

示例： 

ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
defer cancel()
err := shx.RunCtxScript(ctx, "long_task.sh")

func RunScript 

func RunScript(filePath string) error

RunScript 执行 bash 脚本文件

参数：

  • filePath: 脚本文件路径

返回：

  • error: 执行错误

示例： 

err := shx.RunScript("deploy.sh")

func RunScriptToTerminal 

func RunScriptToTerminal(filePath string) error

RunScriptToTerminal 执行 bash 脚本文件并输出到终端

参数：

  • filePath: 脚本文件路径

返回：

  • error: 执行错误

示例： 

err := shx.RunScriptToTerminal("deploy.sh")

func RunScriptWith 

func RunScriptWith(filePath string, timeout time.Duration) error

RunScriptWith 超时执行 bash 脚本文件

参数：

  • filePath: 脚本文件路径
  • timeout: 超时时间

返回：

  • error: 执行错误

示例： 

err := shx.RunScriptWith("long_task.sh", 30*time.Second)

func RunScriptWithIO 

func RunScriptWithIO(filePath string, stdin io.Reader, stdout, stderr io.Writer) error

RunScriptWithIO 使用自定义输入输出执行 bash 脚本文件

参数：

  • filePath: 脚本文件路径
  • stdin: 标准输入
  • stdout: 标准输出
  • stderr: 标准错误

返回：

  • error: 执行错误

示例： 

var buf bytes.Buffer
err := shx.RunScriptWithIO("script.sh", strings.NewReader("input"), &buf, os.Stderr)

func RunToTerminal 

func RunToTerminal(cmd string) error

RunToTerminal 执行命令并输出到终端

参数：

  • cmd: 命令字符串

返回：

  • error: 执行错误

示例： 

err := shx.RunToTerminal("echo hello")

func RunWith 

func RunWith(cmd string, timeout time.Duration) error

RunWith 超时执行

参数：

  • cmd: 命令字符串
  • timeout: 超时时间

返回：

  • error: 执行错误

示例： 

err := shx.RunWith("sleep 10", 5*time.Second)

func RunWithIO 

func RunWithIO(cmd string, stdin io.Reader, stdout, stderr io.Writer) error

RunWithIO 使用自定义输入输出执行

参数：

  • cmd: 命令字符串
  • stdin: 标准输入
  • stdout: 标准输出
  • stderr: 标准错误

返回：

  • error: 执行错误

示例： 

var buf bytes.Buffer
err := shx.RunWithIO("cat", strings.NewReader("hello"), &buf, os.Stderr)

func Split 

func Split(cmdStr string) []string

Split 将命令字符串拆分为命令切片，支持引号处理(单引号、双引号、反引号)

功能：

  • 智能拆分 Shell 命令字符串为参数数组
  • 支持单引号、双引号、反引号包裹的内容
  • 正确处理转义字符和特殊字符
  • 自动处理命令分隔符(;|&&||)

参数:

  • cmdStr: 要拆分的命令字符串

返回值:

  • []string: 拆分后的命令切片 (最佳结果)

注意：

  • 此函数忽略拆分错误，返回最佳拆分结果。如需错误信息，请使用 SplitE 函数。
  • 转义字符保持原样，不进行解释处理
  • 支持多字符操作符如 &&、||、>>、<< 等

func SplitE 

func SplitE(cmdStr string) ([]string, error)

SplitE 将命令字符串拆分为命令切片（带错误信息），支持引号处理(单引号、双引号、反引号)

功能：

  • 智能拆分 Shell 命令字符串为参数数组
  • 支持单引号、双引号、反引号包裹的内容
  • 正确处理转义字符和特殊字符
  • 自动处理命令分隔符(;|&&||)
  • 检测并返回拆分过程中的错误

参数:

  • cmdStr: 要拆分的命令字符串

返回值:

  • []string: 拆分后的命令切片
  • error: 拆分错误，成功时为 nil

错误类型：

  • UnclosedQuoteError: 未闭合的引号错误
  • 其他可能的语法错误

注意：

  • 转义字符保持原样，不进行解释处理
  • 支持多字符操作符如 &&、||、>>、<< 等

Types

type ExitStatus 

type ExitStatus struct {
	Code uint8
	// contains filtered or unexported fields
}

ExitStatus 包装退出状态错误

通过 Unwrap() 支持错误链，可使用 errors.Is(err, interp.ExitStatus(N)) 检测。

func (ExitStatus) Error 

func (e ExitStatus) Error() string

Error 实现 error 接口

func (ExitStatus) Unwrap 

func (e ExitStatus) Unwrap() error

Unwrap 返回原始错误，支持 errors.Is/As 遍历错误链

type FormatOptions added in v1.0.1 

type FormatOptions struct {
	Indent           uint // 缩进空格数（0 表示使用 tab）
	SwitchCaseIndent bool // case 语句体是否缩进
	KeepComments     bool // 是否保留注释
	BinaryNextLine   bool // &&、|| 等二元操作符是否换行显示
	FunctionNextLine bool // 函数体 { 是否换行
	SpaceRedirects   bool // 重定向符前后是否加空格
	SingleLine       bool // 是否单行输出
	Minify           bool // 是否最小化输出（压缩模式）
}

FormatOptions 控制 shell 脚本格式化的行为选项

func DefaultFormatOptions added in v1.0.1 

func DefaultFormatOptions() FormatOptions

DefaultFormatOptions 返回默认格式化选项

返回：

  • FormatOptions: 默认格式化选项

默认启用：

  • 缩进: 4 空格
  • case 语句缩进: 启用
  • 注释保留: 启用

type Shx 

type Shx struct {
	// 导出字段（可通过结构体字面量或 WithXxx 方法配置）
	Env     expand.Environ  // 环境变量
	Dir     string          // 工作目录
	Timeout time.Duration   // 超时时间
	Ctx     context.Context // 上下文
	Stdin   io.Reader       // 标准输入
	Stdout  io.Writer       // 标准输出
	Stderr  io.Writer       // 标准错误
	// contains filtered or unexported fields
}

Shx 表示一个待执行的 shell 命令或脚本文件

支持两种输入方式：

  • 命令字符串（通过 New/NewArgs/NewCmds 创建）
  • bash 脚本文件（通过 NewScript 创建）

字段可通过结构体字面量或 WithXxx 方法配置： 

cmd := &Shx{
    Dir:     "/tmp",
    Timeout: 5 * time.Second,
}

func New 

func New(cmdStr string) *Shx

New 从字符串创建命令

参数:

  • cmdStr: 命令字符串

返回:

  • *Shx: 命令对象

示例: 

cmd := shx.New("echo hello world")
cmd := shx.New("ls -la | grep .go")

func NewArgs 

func NewArgs(cmd string, args ...string) *Shx

NewArgs 从命令名和可变参数创建命令

参数:

  • cmd: 命令名
  • args: 可变参数列表

返回:

  • *Shx: 命令对象

示例: 

cmd := shx.NewArgs("ls", "-la", "/tmp")
cmd := shx.NewArgs("git", "commit", "-m", "message")

func NewCmds 

func NewCmds(cmds []string) *Shx

NewCmds 从命令切片创建命令

参数:

  • cmds: 命令切片，每个元素是一个完整的命令部分

返回:

  • *Shx: 命令对象

示例: 

cmd := shx.NewCmds([]string{"ls", "-la", "|", "grep", ".go"})
cmd := shx.NewCmds([]string{"echo", "hello", ">", "output.txt"})

func NewScript 

func NewScript(filePath string) *Shx

NewScript 从 bash 脚本文件创建命令

参数:

  • filePath: 脚本文件路径，必须以 .sh 结尾

返回:

  • *Shx: 命令对象

示例: 

cmd := shx.NewScript("deploy.sh")
cmd := shx.NewScript("/path/to/script.sh")

注意:

  • 如果 filePath 为空或不是 .sh 后缀, 会 panic

func (*Shx) Exec 

func (s *Shx) Exec() error

Exec 执行命令

返回:

  • error: 执行过程中的错误, 不包含退出码错误

示例: 

err := shx.New("echo hello").Exec()
if err != nil {
    log.Fatal(err)
}

func (*Shx) ExecContext 

func (s *Shx) ExecContext(ctx context.Context) error

ExecContext 在指定上下文中执行命令

参数:

  • ctx: 上下文 (用于取消执行)

返回:

  • error: 执行过程中的错误

注意:

  • 此方法会覆盖之前通过 WithContext 设置的上下文
  • 此方法不受 WithTimeout 影响 (上下文的超时优先)

func (*Shx) ExecContextOutput 

func (s *Shx) ExecContextOutput(ctx context.Context) ([]byte, error)

ExecContextOutput 在指定上下文中执行并返回输出

参数:

  • ctx: 上下文

返回:

  • []byte: 命令输出
  • error: 执行过程中的错误

func (*Shx) ExecOutput 

func (s *Shx) ExecOutput() ([]byte, error)

ExecOutput 执行命令并返回输出

返回:

  • []byte: 命令输出 (stdout 和 stderr 合并)
  • error: 执行过程中的错误

注意:

  • 内部会自动捕获 stdout 和 stderr
  • 如果需要区分 stdout 和 stderr, 请使用 WithStdout 和 WithStderr 自定义

func (*Shx) Raw 

func (s *Shx) Raw() string

Raw 获取原始命令字符串

返回:

  • string: 原始命令字符串

func (*Shx) WithContext 

func (s *Shx) WithContext(ctx context.Context) *Shx

WithContext 设置上下文

参数:

  • ctx: 上下文

返回:

  • *Shx: 命令对象 (支持链式调用)

注意:

  • 设置的上下文会完全覆盖 WithTimeout 设置的超时

func (*Shx) WithDir 

func (s *Shx) WithDir(dir string) *Shx

WithDir 设置工作目录

参数:

  • dir: 工作目录路径

返回:

  • *Shx: 命令对象 (支持链式调用)

注意:

  • 如果目录不存在或不是目录, 会 panic

func (*Shx) WithEnv 

func (s *Shx) WithEnv(key, value string) *Shx

WithEnv 设置环境变量

参数:

  • key: 环境变量名
  • value: 环境变量值

返回:

  • *Shx: 命令对象 (支持链式调用)

注意:

  • 如果 key 为空, 会 panic

func (*Shx) WithEnvs 

func (s *Shx) WithEnvs(envs []string) *Shx

WithEnvs 批量设置环境变量

参数:

  • envs: 环境变量切片, 每个元素格式为 "key=value"

返回:

  • *Shx: 命令对象 (支持链式调用)

注意:

  • 格式错误的项会被忽略
  • 同名的变量, 后出现的会覆盖先出现的

func (*Shx) WithStderr 

func (s *Shx) WithStderr(w io.Writer) *Shx

WithStderr 设置标准错误

参数:

  • w: 错误输出写入器

返回:

  • *Shx: 命令对象 (支持链式调用)

func (*Shx) WithStdin 

func (s *Shx) WithStdin(r io.Reader) *Shx

WithStdin 设置标准输入

参数:

  • r: 输入读取器

返回:

  • *Shx: 命令对象 (支持链式调用)

func (*Shx) WithStdout 

func (s *Shx) WithStdout(w io.Writer) *Shx

WithStdout 设置标准输出

参数:

  • w: 输出写入器

返回:

  • *Shx: 命令对象 (支持链式调用)

func (*Shx) WithTimeout 

func (s *Shx) WithTimeout(d time.Duration) *Shx

WithTimeout 设置超时时间

参数:

  • d: 超时时间

返回:

  • *Shx: 命令对象 (支持链式调用)

注意:

  • 如果 d <= 0, 则忽略 (不设置超时)

type SyntaxError 

type SyntaxError struct {
	File    string // 文件名（如果来自文件则为文件路径，否则为空字符串）
	Line    int    // 错误行号（从 1 开始）
	Column  int    // 错误列号（从 1 开始）
	Message string // 错误描述
}

SyntaxError 表示 shell 语法错误

当解析 shell 脚本遇到语法错误时，返回此类型，包含错误位置和描述信息。

func (*SyntaxError) Error 

func (e *SyntaxError) Error() string

Error 实现 error 接口

type UnclosedQuoteError 

type UnclosedQuoteError struct {
	QuoteType rune // 未闭合的引号类型 (', ", 或 `)
}

UnclosedQuoteError 表示命令字符串中存在未闭合的引号

func (*UnclosedQuoteError) Error 

func (e *UnclosedQuoteError) Error() string

func (*UnclosedQuoteError) GetQuoteType 

func (e *UnclosedQuoteError) GetQuoteType() rune

QuoteType 返回未闭合的引号类型

Source Files

View all Source files

Directories

Path Synopsis
cmd
shck command
shck 是一个 shell 语法检查工具
 shck 是一个 shell 语法检查工具
shfmt command
shfmt 是一个 shell 脚本格式化工具
 shfmt 是一个 shell 脚本格式化工具
shx command
shx 是一个轻量级命令行工具，用于测试执行 shx 库。
 shx 是一个轻量级命令行工具，用于测试执行 shx 库。

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.