LicenseToolsPlugin 使用教程

1. 项目目录结构及介绍

LicenseToolsPlugin/
├── github/workflows/
├── gradle/wrapper/
├── plugin/
├── sample/
├── .gitignore
├── CHANGELOG.md
├── LICENSE
├── README.md
├── build.gradle
├── gradle.properties
├── gradlew
├── gradlew.bat
├── renovate.json
└── settings.gradle

目录结构介绍

• github/workflows/: 包含GitHub Actions的工作流配置文件。
• gradle/wrapper/: 包含Gradle Wrapper的配置文件。
• plugin/: 包含插件的核心代码。
• sample/: 包含插件的使用示例。
• .gitignore: Git忽略文件配置。
• CHANGELOG.md: 项目更新日志。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• build.gradle: 项目的Gradle构建脚本。
• gradle.properties: Gradle属性配置文件。
• gradlew: Gradle Wrapper的Unix脚本。
• gradlew.bat: Gradle Wrapper的Windows脚本。
• renovate.json: Renovate配置文件。
• settings.gradle: Gradle设置文件。

2. 项目启动文件介绍

gradlew 和 gradlew.bat

• gradlew: 这是Gradle Wrapper的Unix脚本，用于在Unix系统上启动Gradle构建。
• gradlew.bat: 这是Gradle Wrapper的Windows脚本，用于在Windows系统上启动Gradle构建。

使用方法

在项目根目录下运行以下命令来启动Gradle构建：

• 在Unix系统上：

  ./gradlew <task>
  

• 在Windows系统上：

  gradlew.bat <task>
  

其中<task>是你想要执行的Gradle任务，例如checkLicenses、generateLicensePage等。

3. 项目的配置文件介绍

build.gradle

这是项目的主要配置文件，包含了插件的依赖和任务配置。

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'com.cookpad.android.licensetools:license-tools-plugin:1.7.0'
    }
}

apply plugin: 'com.cookpad.android.licensetools'

licenseTools {
    outputHtml = "licenses_output.html"
}

配置项介绍

• repositories: 定义了插件的仓库地址。
• dependencies: 定义了插件的依赖。
• apply plugin: 应用LicenseToolsPlugin插件。
• licenseTools: 配置插件的输出文件名等选项。

gradle.properties

这是Gradle的属性配置文件，用于定义一些全局属性。

org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8

settings.gradle

这是Gradle的设置文件，用于配置项目的模块和子项目。

include ':plugin', ':sample'

LICENSE

这是项目的许可证文件，定义了项目的开源许可证类型。

Copyright (c) 2014 by Bart Kiers
license: apache_2

README.md

这是项目的介绍和使用说明文件，包含了项目的概述、安装方法、使用示例等内容。

# LicenseToolsPlugin

This plugin helps you manage open source licenses in your Android projects.

## Installation

Add the following to your `build.gradle`:

```groovy
buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'com.cookpad.android.licensetools:license-tools-plugin:1.7.0'
    }
}

apply plugin: 'com.cookpad.android.licensetools'

Usage

Run the following tasks:

./gradlew checkLicenses
./gradlew generateLicensePage

以上是`LicenseToolsPlugin`项目的目录结构、启动文件和配置文件的详细介绍。希望这些信息能帮助你更好地理解和使用该项目。