Bash OO Framework 使用教程

Bash OO Framework 使用教程

bash-oo-frameworkBash Infinity is a modern standard library / framework / boilerplate for Bash项目地址:https://gitcode.com/gh_mirrors/ba/bash-oo-framework

1. 项目的目录结构及介绍

Bash OO Framework 的目录结构如下：

bash-oo-framework/
├── lib/
│   ├── array.sh
│   ├── checks.sh
│   ├── colors.sh
│   ├── exceptions.sh
│   ├── log.sh
│   ├── stacktrace.sh
│   ├── string.sh
│   ├── system.sh
│   └── ui.sh
├── module/
│   └── exampleModule.sh
├── script/
│   └── exampleScript.sh
├── .gitignore
├── LICENSE
├── README.md
└── bootstrap.sh

目录介绍

• lib/: 包含框架的核心库文件，如数组操作、检查、颜色处理、异常处理、日志、堆栈跟踪、字符串处理、系统操作和用户界面等。
• module/: 包含示例模块文件。
• script/: 包含示例脚本文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• bootstrap.sh: 项目的启动文件。

2. 项目的启动文件介绍

bootstrap.sh 是项目的启动文件，负责加载框架的核心库并初始化环境。以下是 bootstrap.sh 的部分代码示例：

#!/usr/bin/env bash

source "$( cd "${BASH_SOURCE[0]%/*}" && pwd )/lib/oo-bootstrap.sh"

# 示例：加载一个模块
import ./module/exampleModule.sh

# 示例：运行一个脚本
./script/exampleScript.sh

启动文件功能

• 加载核心库: 通过 source 命令加载 lib/oo-bootstrap.sh 文件，该文件进一步加载其他核心库文件。
• 导入模块: 使用 import 命令加载模块文件。
• 运行脚本: 执行示例脚本文件。

3. 项目的配置文件介绍

Bash OO Framework 本身没有明确的配置文件，但可以通过修改库文件或创建自定义的配置文件来实现个性化配置。例如，可以在项目根目录下创建一个 config.sh 文件，并在 bootstrap.sh 中加载该文件：

#!/usr/bin/env bash

source "$( cd "${BASH_SOURCE[0]%/*}" && pwd )/lib/oo-bootstrap.sh"

# 加载自定义配置文件
if [ -f "config.sh" ]; then
    source "config.sh"
fi

# 示例：加载一个模块
import ./module/exampleModule.sh

# 示例：运行一个脚本
./script/exampleScript.sh

配置文件示例

# config.sh

# 设置日志级别
LOG_LEVEL="DEBUG"

# 设置颜色输出
ENABLE_COLORS="true"

通过这种方式，可以灵活地配置项目的运行环境。

bash-oo-frameworkBash Infinity is a modern standard library / framework / boilerplate for Bash项目地址:https://gitcode.com/gh_mirrors/ba/bash-oo-framework