XcodeIssueGenerator 项目常见问题解决方案

XcodeIssueGenerator 项目常见问题解决方案

XcodeIssueGenerator An executable that can be called from a Run Script Build Phase that makes comments such as // TODO: or // SERIOUS: appear in Xcode's Issue Navigator giving them project-wide visibility. 项目地址: https://gitcode.com/gh_mirrors/xc/XcodeIssueGenerator

项目基础介绍

XcodeIssueGenerator 是一个开源项目，旨在帮助开发者通过在 Xcode 中使用特定的注释（如 // TODO: 或 // SERIOUS:）来生成项目范围内的可见性问题。这些注释可以在 Xcode 的 Issue Navigator 中显示，从而帮助开发者更好地管理和跟踪项目中的待办事项和重要问题。该项目主要使用 Swift 编程语言编写，适用于 Xcode 8 及更高版本，并且支持 Swift 3 及以上版本。

新手使用注意事项及解决方案

1. 安装问题：无法通过 Homebrew 安装

问题描述：新手在尝试通过 Homebrew 安装 XcodeIssueGenerator 时，可能会遇到安装失败的情况。

解决步骤：

• 检查 Homebrew 安装：确保 Homebrew 已经正确安装在系统中。可以通过在终端中运行 brew --version 来检查。
• 更新 Homebrew：运行 brew update 命令来确保 Homebrew 是最新版本。
• 重新安装：运行以下命令重新尝试安装：

  brew tap doubleencore/tap
  brew install xcodeissuegenerator
  

2. 配置问题：Run Script 未正确添加

问题描述：新手在 Xcode 项目中添加 Run Script 时，可能会遇到脚本未正确执行的问题。

解决步骤：

• 检查 Run Script 位置：确保 Run Script 添加在正确的 Build Phase 中。选择目标项目，进入 Build Phases，点击 + 按钮添加新的 Run Script 阶段。
• 确认脚本内容：确保 Run Script 内容正确，例如：

  if which XcodeIssueGenerator >/dev/null; then
      XcodeIssueGenerator -b DEBUG -w "WARNING, SERIOUS, TODO" -x "Vendor/, Third Party/"
  fi
  

• 清理并重新构建：在 Xcode 中选择 Product -> Clean Build Folder，然后重新构建项目。

3. 注释识别问题：注释未在 Issue Navigator 中显示

问题描述：新手在使用项目时，可能会发现添加的注释（如 // TODO:）未在 Xcode 的 Issue Navigator 中显示。

解决步骤：

• 检查注释格式：确保注释格式正确，例如 // TODO: 需要完成的功能。
• 确认注释位置：确保注释位于 Swift 文件中，并且注释内容不为空。
• 检查配置：确认在 Run Script 中配置的注释类型（如 WARNING, SERIOUS, TODO）与实际使用的注释类型一致。
• 重新运行脚本：在 Xcode 中重新运行 Run Script，确保脚本正确执行。

通过以上步骤，新手可以更好地理解和使用 XcodeIssueGenerator 项目，解决常见的问题。

XcodeIssueGenerator An executable that can be called from a Run Script Build Phase that makes comments such as // TODO: or // SERIOUS: appear in Xcode's Issue Navigator giving them project-wide visibility. 项目地址: https://gitcode.com/gh_mirrors/xc/XcodeIssueGenerator