Skip to content

📊 AuditWithFormat

使用指定的输出格式执行安全审计。等价于执行 composer audit --format=FORMAT 命令。

何时使用

当你需要控制审计输出的呈现方式时使用。常见格式包括 json(结构化)、table(表格,便于人眼阅读)、plain(纯文本)。如需直接拿到解析后的 Go 结构体,请用 AuditWithJSON

签名

go
func (c *Composer) AuditWithFormat(format string) (string, error)

参数

参数类型说明
formatstring输出格式,如 "json""table""plain"

返回值

返回值类型说明
第一返回值string指定格式的审计输出文本
第二返回值error执行过程中发生错误时返回

示例

go
package main

import (
	"fmt"
	"log"

	"github.com/scagogogo/composer-skills/pkg/composer"
)

func main() {
	comp, err := composer.NewComposer("")
	if err != nil {
		log.Fatalf("初始化失败: %v", err)
	}

	// 以表格形式输出,便于人眼阅读
	output, err := comp.AuditWithFormat("table")
	if err != nil {
		log.Fatalf("执行安全审计失败: %v", err)
	}
	fmt.Println(output)

	// 以纯文本形式输出
	plain, err := comp.AuditWithFormat("plain")
	if err != nil {
		log.Fatalf("执行安全审计失败: %v", err)
	}
	fmt.Println(plain)
}

进阶

  • 想要 JSON 且直接拿到结构体:使用 AuditWithJSON
  • 需要同时指定多个选项(如 no-dev + format):使用 AuditWithOptions(map[string]string)
  • 相关方法:AuditAuditWithoutDev

基于 MIT 许可证发布