iOS 17 Required Reason API Scanner 使用教程

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

ios_17_required_reason_api_scanner/
├── DemoSymbols/
├── .gitignore
├── LICENSE
├── README.md
├── required_reason_api_binary_scanner.sh
├── required_reason_api_text_scanner.sh
└── ripgrep_required_reason_api_text_scanner.sh

• DemoSymbols/: 包含示例代码和符号文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件，采用 MIT 许可证。
• README.md: 项目说明文档。
• required_reason_api_binary_scanner.sh: 二进制扫描脚本。
• required_reason_api_text_scanner.sh: 文本扫描脚本。
• ripgrep_required_reason_api_text_scanner.sh: 基于 ripgrep 的文本扫描脚本。

2. 项目的启动文件介绍

required_reason_api_text_scanner.sh

该脚本用于扫描 Xcode Swift 项目中的 "required reason API" 使用情况。使用方法如下：

sh required_reason_api_text_scanner.sh [directory_name]

示例输出：

Found potentially required reason API usage 'UserDefaults' in ' /ViewController.swift' Line numbers: 28

ripgrep_required_reason_api_text_scanner.sh

该脚本是一个基于 ripgrep 的文本扫描器，速度更快。使用方法如下：

sh ripgrep_required_reason_api_text_scanner.sh [directory_name]

3. 项目的配置文件介绍

.gitignore

该文件用于配置 Git 忽略的文件和目录，避免将不必要的文件提交到版本控制系统中。

LICENSE

项目采用 MIT 许可证，允许用户自由使用、复制、修改、合并、出版发行、散布、再授权及销售软件及其副本。

README.md

项目说明文档，包含项目的介绍、使用方法、贡献指南等信息。

以上是 ios_17_required_reason_api_scanner 项目的基本使用教程，详细内容请参考项目的 GitHub 页面。