gh-poi 项目使用教程

gh-poi 项目使用教程

gh-poi✨ Safely clean up your local branches项目地址:https://gitcode.com/gh_mirrors/gh/gh-poi

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

gh-poi 项目的目录结构如下：

gh-poi/
├── .github/
│   └── workflows/
│       └── ci.yml
├── bin/
│   └── gh-poi
├── lib/
│   └── gh-poi.rb
├── spec/
│   └── gh-poi_spec.rb
├── .gitignore
├── .rspec
├── .ruby-version
├── Gemfile
├── LICENSE
├── README.md
└── gh-poi.gemspec

目录结构介绍

• .github/workflows/: 包含 GitHub Actions 的工作流配置文件，用于自动化测试和部署。
• bin/: 包含可执行文件 gh-poi，用于启动 gh-poi 工具。
• lib/: 包含 gh-poi 的核心代码文件 gh-poi.rb。
• spec/: 包含测试文件 gh-poi_spec.rb，用于测试 gh-poi 的功能。
• .gitignore: 指定 Git 忽略的文件和目录。
• .rspec: 包含 RSpec 测试框架的配置。
• .ruby-version: 指定项目使用的 Ruby 版本。
• Gemfile: 指定项目依赖的 Ruby 库。
• LICENSE: 项目的开源许可证。
• README.md: 项目的介绍和使用说明。
• gh-poi.gemspec: 包含项目的 gem 规范文件，用于打包和发布。

2. 项目的启动文件介绍

gh-poi 的启动文件位于 bin/ 目录下，文件名为 gh-poi。该文件是一个可执行脚本，用于启动 gh-poi 工具。

启动文件内容

#!/usr/bin/env ruby

require 'gh-poi'

GhPoi::CLI.start(ARGV)

启动文件介绍

• #!/usr/bin/env ruby: 指定使用 Ruby 解释器来执行该脚本。
• require 'gh-poi': 加载 gh-poi 的核心库。
• GhPoi::CLI.start(ARGV): 启动 gh-poi 的命令行界面，并传递命令行参数。

3. 项目的配置文件介绍

gh-poi 项目中没有显式的配置文件，但可以通过命令行参数和环境变量来进行配置。

常用命令行参数

• --dry-run: 模拟删除操作，不实际删除分支。
• --debug: 启用调试日志，输出详细的调试信息。
• protect : 保护指定的本地分支，防止被删除。
• unprotect : 解除对指定本地分支的保护。

环境变量

gh-poi 可以通过环境变量来配置一些行为，例如：

• GH_POI_DRY_RUN: 设置为 true 时，启用模拟删除操作。
• GH_POI_DEBUG: 设置为 true 时，启用调试日志。

通过这些配置，用户可以根据自己的需求来定制 gh-poi 的行为。

---

以上是 gh-poi 项目的使用教程，希望对您有所帮助。

gh-poi✨ Safely clean up your local branches项目地址:https://gitcode.com/gh_mirrors/gh/gh-poi