Giới thiệu về Gradle Lint Plugin

Gradle Lint Plugin là một công cụ lint có khả năng mở rộng và cấu hình, được thiết kế để phát hiện và báo cáo các mẫu sử dụng sai hoặc các tính năng đã bị loại bỏ trong các tệp script Gradle. Công cụ này được phát triển dựa trên cảm hứng từ ESLint - một công cụ kiểm tra mã JavaScript phổ biến và gói eslint-friendly-formatter của NPM. Plugin này hỗ trợ các nhóm quản lý công cụ build tập trung trong việc áp dụng và duy trì các tiêu chuẩn viết script build một cách nhất quán trong toàn bộ tổ chức.

Cài đặt và cấu hình nhanh

Thêm plugin vào dự án

Đầu tiên, hãy lấy phiên bản mới nhất của plugin từ Gradle Plugin Portal và thêm vào tệp build.gradle của bạn:

buildscript {
    repositories {
        gradlePluginPortal()
    }
}

plugins {
    id 'com.netflix.nebula.lint' version '<phiên bản mới nhất từ Gradle Plugin Portal>'
}

Áp dụng plugin cho dự án đa module

Trong các dự án có nhiều module, bạn cần áp dụng plugin ít nhất ở dự án gốc:

buildscript {
    repositories {
        maven {
            url "https://plugins.gradle.org/m2/"
        }
    }
    dependencies {
        classpath 'com.netflix.nebula:gradle-lint-plugin:latest.release'
    }
}

subprojects {
    apply plugin: 'nebula.lint'
}

Cấu hình quy tắc kiểm tra

Định nghĩa các quy tắc mà bạn muốn lint kiểm tra:

gradleLint {
    rules = ['dependency-parsing', 'unused-dependency'] // Thêm bất kỳ quy tắc nào bạn muốn
}

Đối với các dự án doanh nghiệp, nên định nghĩa các quy tắc lint trong tệp init.gradle hoặc thông qua cơ chế apply from của Gradle.

Đối với các dự án đa module, nên áp dụng plugin trong khối allprojects:

allprojects {
    apply plugin: 'nebula.lint'
    gradleLint {
        rules = ['all-dependency', 'deprecated-task'] // Thêm các quy tắc cần thiết
    }
}

Trường hợp sử dụng thực tế

Chuẩn hóa quy trình build

Trong một tổ chức lớn, Gradle Lint Plugin giúp đảm bảo tất cả các dự án có cùng phong cách viết script build, giảm thiểu chi phí bảo trì do thiếu đồng nhất trong cách viết mã.

Tự động sửa lỗi cảnh báo

Mặc dù Gradle Lint Plugin hiện không hỗ trợ tự động sửa các script build bằng Kotlin, nhưng với các script Groovy, nó có thể tự động sửa một số cảnh báo phổ biến, giúp tăng hiệu suất phát triển.

Dự án liên quan trong hệ sinh thái

ESLint

Gradle Lint Plugin được phát triển dựa trên cảm hứng từ ESLint - một công cụ kiểm tra mã JavaScript được sử dụng rộng rãi. Kết hợp với ESLint giúp đảm bảo tính nhất quán và chất lượng cho cả mã frontend và backend.

eslint-friendly-formatter

Gói eslint-friendly-formatter của NPM cung cấp định dạng đầu ra thân thiện với người dùng. Khi kết hợp với Gradle Lint Plugin, nó giúp tạo ra các báo cáo build dễ đọc và dễ hiểu hơn.