Gradle JavaScript 插件使用指南

2024-12-24 19:49:57作者：董宙帆

1. 安装指南

Gradle 2.1+

在 build.gradle 文件中添加以下插件依赖：

plugins {
  id "com.eriwen.gradle.js" version "2.14.1"
}

Gradle 2.0-

对于 Gradle 2.0 以下版本，需要先配置 buildscript：

buildscript {
  repositories {
    jcenter()
  }
  dependencies {
    classpath "com.eriwen:gradle-js-plugin:1.12.1"
  }
}

apply plugin: "com.eriwen.gradle.js"

2. 项目使用说明

本项目旨在为 Gradle 构建过程中提供一种简单的方式来管理 JavaScript 文件。以下是一些基本使用示例：

声明源文件

javascript.source {
    dev {
        js {
            srcDir jsSrcDir
            include "*.js"
            exclude "*.min.js"
        }
    }
    prod {
        js {
            srcDir jsSrcDir
            include "*.min.js"
        }
    }
}

合并文件

combineJs {
    encoding = "UTF-8"
    source = javascript.source.dev.js.files
    dest = file("${buildDir}/all.js")
}

压缩文件

minifyJs {
    source = combineJs
    dest = file("${buildDir}/all-min.js")
    closure {
        warningLevel = 'QUIET'
    }
}

压缩文件并 GZip

gzipJs {
    source = minifyjs
    dest = file("${buildDir}/all-min.js")
}

使用 JSHint 进行代码质量检查

jshint {
    source = javascript.source.dev.js.files
    dest = file("${buildDir}/jshint.out")
    reporter = 'checkstyle'
    jshint.options = [expr: "true", unused: "true"]
}

使用 JSDoc 生成文档

jsdoc {
    source = ["${projectDir}/js/file1.js", "${projectDir}/js/file2.js"]
    destinationDir = file("${buildDir}/jsdoc")
}

将 Java 属性文件转换为 JavaScript

props2js {
    source = file("${projectDir}/src/test/resources/test.properties")
    dest = file("${buildDir}/props.jsonp")
    props {
        type = 'jsonp'
        functionName = 'fn'
    }
}

使用 require.js

requireJs {
    source = javascript.source.dev.js.files
    dest = file("${buildDir}/out.js")
    requirejs.buildprofile = new File("src/main/resources/requirejs-config.js")
}

3. 项目API使用文档

请参考以下任务和选项的说明，以便更好地使用项目 API。

combineJs

source: 要合并的文件路径集合
dest: 合并后输出的文件

minifyJs

source: 要压缩的文件
dest: 压缩后输出的文件
(可选) sourcemap: 源码映射文件
(可选) closure.compilationLevel: 编译级别，可选值有 'WHITESPACE_ONLY', 'SIMPLE_OPTIMIZATIONS', 'ADVANCED_OPTIMIZATIONS'
(可选) closure.warningLevel: 警告级别，可选值有 'QUIET', 'DEFAULT', 'VERBOSE'
(可选) closure.compilerOptions: 编译器选项对象
(可选) closure.externs: 文件集合对象