Pecker 项目常见问题解决方案

Pecker 项目常见问题解决方案

Pecker CodePecker is a tool to detect unused Swift code. 项目地址: https://gitcode.com/gh_mirrors/pe/Pecker

Pecker 是一个用于检测 Swift 项目中未使用代码的工具，它基于 IndexStoreDB 和 SwiftSyntax 开发。该项目的编程语言主要是 Swift。

新手常见问题及解决步骤

问题一：如何安装 Pecker？

问题描述： 新手在使用 Pecker 时，可能不清楚如何正确安装这个工具。

解决步骤：

1. 使用 Homebrew 安装：

   brew install woshiccm/homebrew-tap/pecker
   

2. 使用 CocoaPods 安装： 在 Podfile 文件中添加：

   pod 'Pecker'
   

   然后，运行 pod install 命令。

3. 使用 Mint 安装：

   mint install woshiccm/Pecker
   

4. 从源代码编译安装：

   git clone https://github.com/woshiccm/Pecker.git
   cd Pecker
   make install
   

问题二：如何在 Xcode 中集成 Pecker？

问题描述： 用户可能不清楚如何在 Xcode 项目中集成 Pecker，以在 IDE 中直接显示警告和错误。

解决步骤：

1. 打开你的 Xcode 项目。
2. 选择你的 Target。
3. 在 Build Phases 选项卡中，点击 “+” 号，选择 “New Run Script Phase”。
4. 在新增的脚本框中输入以下内容：

   if which pecker >/dev/null
   then
     pecker
   else
     echo "warning: Pecker not installed, download from https://github.com/woshiccm/Pecker"
   fi
   

   如果你通过 CocoaPods 安装了 Pecker，脚本应该修改为：

   $[PODS_ROOT]/Pecker/bin/pecker
   

问题三：如何在终端使用 Pecker？

问题描述： 用户可能不知道如何在终端中使用 Pecker 检测未使用的代码。

解决步骤：

1. 打开终端。
2. 使用 -i 或 --index-store-path 参数设置项目索引路径。
3. 设置报告格式为 JSON，并指定输出文件路径（相对或绝对路径）。
4. 运行 Pecker 命令：

   pecker -i /path/to/index/path -r json -o /path/to/output_file
   

   如果未指定输出文件路径，默认为项目目录下的 pecker_result.json 文件。

Pecker CodePecker is a tool to detect unused Swift code. 项目地址: https://gitcode.com/gh_mirrors/pe/Pecker