Slack Gradle 插件使用教程

1. 项目目录结构及介绍

slack-gradle-plugin/
├── agp-handlers/
│   └── agp-handler-api/
├── config/
├── docs/
├── gradle/
├── sgp-common/
├── skate-plugin/
├── skippy/
├── slack-plugin/
├── spotless/
├── tracing/
├── .gitattributes
├── .gitignore
├── CHANGELOG.md
├── LICENSE.txt
├── README.md
├── RELEASING.md
├── build.gradle.kts
├── deploy_website.sh
├── gradle.properties
├── gradlew
├── gradlew.bat
└── mkdocs.yml

目录结构介绍

• agp-handlers/: 包含与Android Gradle Plugin (AGP) 相关的处理程序。
• config/: 项目配置文件目录。
• docs/: 项目文档目录。
• gradle/: Gradle 构建脚本目录。
• sgp-common/: 通用 Gradle 插件代码。
• skate-plugin/: 特定功能的 Gradle 插件。
• skippy/: 可能包含与项目相关的工具或脚本。
• slack-plugin/: Slack 自定义 Gradle 插件的核心代码。
• spotless/: 代码格式化工具配置。
• tracing/: 可能包含与性能追踪相关的代码。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• CHANGELOG.md: 项目变更日志。
• LICENSE.txt: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• RELEASING.md: 发布流程文档。
• build.gradle.kts: 主构建脚本。
• deploy_website.sh: 部署网站的脚本。
• gradle.properties: Gradle 属性配置文件。
• gradlew: Gradle 包装器脚本（Unix）。
• gradlew.bat: Gradle 包装器脚本（Windows）。
• mkdocs.yml: MkDocs 配置文件，用于生成文档网站。

2. 项目启动文件介绍

build.gradle.kts

这是项目的主构建脚本，使用 Kotlin 编写。它定义了项目的依赖、插件应用、任务配置等。

// build.gradle.kts 示例
plugins {
    id("com.android.application")
    id("slack.auto-apply.spotless")
    id("slack.auto-apply.detekt")
}

android {
    compileSdkVersion(30)
    defaultConfig {
        applicationId = "com.example.app"
        minSdkVersion(21)
        targetSdkVersion(30)
        versionCode = 1
        versionName = "1.0"
    }
    buildTypes {
        getByName("release") {
            isMinifyEnabled = false
            proguardFiles(getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro")
        }
    }
}

dependencies {
    implementation("androidx.core:core-ktx:1.3.2")
    implementation("androidx.appcompat:appcompat:1.2.0")
    implementation("com.google.android.material:material:1.3.0")
    implementation("androidx.constraintlayout:constraintlayout:2.0.4")
}

gradlew 和 gradlew.bat

这两个文件是 Gradle 包装器脚本，分别用于 Unix 和 Windows 系统。它们允许你在没有安装 Gradle 的情况下运行 Gradle 任务。

# 使用 gradlew 运行任务
./gradlew build

:: 使用 gradlew.bat 运行任务
gradlew.bat build

3. 项目配置文件介绍

gradle.properties

这个文件包含 Gradle 构建的属性配置，例如 SDK 版本、插件版本等。

# gradle.properties 示例
slack.compileSdkVersion=30
slack.targetSdkVersion=30
slack.minSdkVersion=21

# 插件配置
slack.test.retry.pluginType=GE

.gitignore

这个文件定义了 Git 应该忽略的文件和目录，避免将不必要的文件提交到版本控制中。

# .gitignore 示例
/build
/.idea
/*.iml

mkdocs.yml

这个文件是 MkDocs 的配置文件，用于生成项目的文档网站。

# mkdocs.yml 示例
site_name: Slack Gradle Plugin
nav:
  - Home: index.md
  - Usage: usage.md
  - Configuration: configuration.md
theme: readthedocs

通过以上配置文件和启动文件的介绍，你可以更好地理解和使用 Slack Gradle 插件。