Gradle JavaScript 插件使用指南

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: 文件集合对象

gzipJs

• source: 要压缩的文件
• dest: 压缩后输出的文件

jshint

• source: 要检查的文件
• dest: JSHint 输出的文件
• (可选) reporter: 只支持 'checkstyle'
• (可选) ignoreExitCode: 如果为 false，则 JSHint 发现问题时构建失败
• (可选) outputToStdOut: 如果为 true，则输出到标准输出而不是文件
• (可选) jshint.options: 选项映射
• (可选) jshint.predef: 预定义的全局变量映射

jsdoc

• source: 要生成文档的文件
• destinationDir: JSDoc 输出的目录
• (可选) options.options: 选项数组

props2js

• source: 要处理的属性文件
• dest: 输出的目标文件
• props.type: 'js', 'json', 或 'jsonp'
• (可选) props.functionName: 包装 JSONP 的函数名

requireJs

• source: 源 JS 文件
• dest: 输出 JS 文件
• (必须声明此选项或 requirejs.options)** requirejs.buildprofile`: 配置文件引用
• requirejs.options: 选项映射
• (可选) ignoreExitCode: 如果为 false，则 require.js 运行失败时构建失败
• (可选) requirejs.impl: r.js 实现文件

4. 项目安装方式

请按照以上安装指南进行项目的安装。确保在 build.gradle 文件中正确配置插件依赖，并根据需要调整任务和选项。如果遇到任何问题，可以查看项目的贡献者信息和相关问题报告。