SwiftInfo使用手册

SwiftInfo使用手册

SwiftInfo 📊 Extract and analyze the evolution of an iOS app's code. 项目地址: https://gitcode.com/gh_mirrors/sw/SwiftInfo

SwiftInfo是一款强大的命令行工具，专注于提取并分析iOS应用代码演进过程中的关键指标。本指南旨在帮助您理解其内部结构、如何启动以及配置SwiftInfo以满足您的项目需求。

1. 项目目录结构及介绍

SwiftInfo的仓库遵循标准的Git仓库结构，主要关注点在于以下几个核心文件和目录：

• ExampleProject: 包含一个示例项目，用于演示SwiftInfo的功能。通过运行此项目并执行相应命令，您可以直观地看到SwiftInfo的输出。

• Formula 和 Sources: 这些目录存放着SwiftInfo的核心源码。Formula目录可能涉及构建过程中的某些配方或配置脚本，而Sources则包含了实际实现功能的Swift源代码文件。

• Tests: 单元测试套件，确保SwiftInfo的功能按预期工作。

• .gitignore, CHANGELOG.md, LICENSE, Makefile: 标准的Git忽略文件、变更日志、许可证信息和构建脚本。

• SwiftInfo.podspec: CocoaPods的规格文件，允许您将SwiftInfo作为依赖项添加到自己的项目中。

• README.md: 项目的主要说明文档，提供了安装、配置和使用SwiftInfo的基本指导。

• CREATING_CUSTOM_PROVIDERS.md: 指导如何创建自定义提供者（即监控或分析新的特定指标）的文档。

2. 项目的启动文件介绍

SwiftInfo作为一个CLI工具，并没有一个传统的“启动文件”，而是通过命令行调用来激活。您可以在终端中使用以下命令来启动SwiftInfo:

swiftinfo

不过，实际使用时，您需要确保正确设置了项目相关的配置（比如Infofile.swift），并且可能需要通过Fastlane或其他方式准备必要的构建日志。

3. 项目的配置文件介绍

Infofile.swift

配置的核心是位于项目根目录下的Infofile.swift（在您的项目中创建）。这个文件是SwiftInfo进行定制配置的关键所在。示例如下：

import SwiftInfoCore

// 配置日志路径
let buildLogFilePath = "build/build_log/YourAppName-YourConfig.log"
let testLogFilePath = "build/tests_log/YourAppName-YourConfig.log"

// 创建项目信息实例
let projectInfo = ProjectInfo(xcodeproj: "YourApp.xcodeproj", target: "YourTarget", configuration: "YourConfig")

// 初始化SwiftInfo实例
let api = SwiftInfo(projectInfo: projectInfo)

// 提取并组合所需的指标数据
let output = api.extract(IPASizeProvider.self) + 
             api.extract(WarningCountProvider.self) +
             // 添加更多指标...

// 处理输出结果，可以打印、发送至Slack或保存
if isInPullRequestMode {
    api.print(output: output)
} else {
    api.sendToSlack(output: output, webhookUrl: url)
    api.save(output: output)
}

在这个文件中，您可以指定项目细节、所需跟踪的指标、处理日志文件的位置以及最终结果的处理方式（如打印、发送至Slack或保存至版本控制系统）。

请注意，根据您的具体需求调整projectInfo参数、选择监控的指标（如IPA大小、警告计数等），并通过SwiftInfo的API方法灵活配置您的分析流程。此外，确保您的环境已准备好支持这些操作，包括安装必要的依赖（如CocoaPods）、配置Slack webhook URL等。

SwiftInfo 📊 Extract and analyze the evolution of an iOS app's code. 项目地址: https://gitcode.com/gh_mirrors/sw/SwiftInfo