config

package

v0.8.6 Latest Latest Go to latest Published: Jun 11, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/dscli/dscli

Links

Open Source Insights

Documentation ¶

Overview ¶

Package config 提供 dscli 配置管理，包括全局配置目录 (~/.dscli) 和项目级 .dscli/ 目录的初始化工。

Index ¶

Variables
func EnsureProjectGitignore(projectRoot string) error
func Get(name, defaultValue string, alias ...string) string
func GetBool(name string, defaultValue bool, alias ...string) bool
func GetInt(name string, defaultValue int, alias ...string) int
func Set(name, value string)
type Config
- func New() (*Config, error)
- func NewWithDir(dir string) (*Config, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var (

	// BuildTime is set via ldflags at build time, e.g.
	//   -X github.com/dscli/dscli/internal/config.BuildTime=2026-05-20T08:00:00Z
	BuildTime string
)

View Source

var ConfigDir = func() string {
	return getGlobalConfig().ConfigDir()
}()

ConfigDir 配置目录（向后兼容变量）注意：这是一个函数调用，返回配置目录路径

Functions ¶

func EnsureProjectGitignore ¶ added in v0.8.6

func EnsureProjectGitignore(projectRoot string) error

EnsureProjectGitignore 确保项目级 .dscli/.gitignore 存在。

projectRoot 是项目的根目录（通常为 context.ProjectRoot）。

策略：

仅当 .dscli/ 目录已存在时工作（不因创建 .gitignore 而反创建父目录）
如果 .gitignore 已存在，跳过（保留用户自定义修改）
幂等，可安全重复调用

func Get ¶

func Get(name, defaultValue string, alias ...string) string

Get 获取配置值（向后兼容接口）使用全局配置实例，支持懒加载

func GetBool ¶

func GetBool(name string, defaultValue bool, alias ...string) bool

GetBool 获取布尔配置值支持 strconv.ParseBool 的格式：1/t/T/TRUE/true/True → true，0/f/F/FALSE/false/False → false 未配置或解析失败时返回 defaultValue

func GetInt ¶

func GetInt(name string, defaultValue int, alias ...string) int

GetInt 获取整数配置值未配置或解析失败时返回 defaultValue

func Set ¶

func Set(name, value string)

Set 设置全局配置值（仅内存中，不持久化到文件）。主要用于测试。

Types ¶

type Config ¶

type Config struct {
	// contains filtered or unexported fields
}

Config 配置管理器

func New ¶

func New() (*Config, error)

New 创建新的配置管理器

func NewWithDir ¶

func NewWithDir(dir string) (*Config, error)

NewWithDir 使用指定目录创建配置管理器

func (*Config) ConfigDir ¶

func (c *Config) ConfigDir() string

ConfigDir 返回配置目录

func (*Config) Get ¶

func (c *Config) Get(name, defaultValue string, alias ...string) string

Get 获取配置值

func (*Config) Save ¶

func (c *Config) Save() error

Save 保存配置到文件

func (*Config) Set ¶

func (c *Config) Set(name, value string)

Set 设置配置值（仅内存中）

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL