使用 Gradle 构建 NodeJS

Question

我对 Gradle 很陌生。我昨天开始阅读它。我找到了一个构建节点应用程序的示例 build.gradle。我对文件的内容有点困惑。我不确定哪些是保留字或预定义字。其中一个字符串是node. 它没有在某处使用，但我发现节点插件需要它。

    buildscript {
        repositories {
            mavenCentral()
            maven {
                url 'https://plugins.gradle.org/m2/'
            }
        }

        dependencies {
            classpath 'com.moowork.gradle:gradle-node-plugin:1.2.0'
        }
    }

    apply plugin: 'base'
    apply plugin: 'com.moowork.node' // gradle-node-plugin

    node {
        /* gradle-node-plugin configuration
        https://github.com/srs/gradle-node-plugin/blob/master/docs/node.md

        Task name pattern:
        ./gradlew npm_<command> Executes an NPM command.
        */

        // Version of node to use.
        version = '10.14.1'

        // Version of npm to use.
        npmVersion = '6.4.1'

        // If true, it will download node using above parameters.
        // If false, it will try to use globally installed node.
        download = true
    }

    npm_run_build {
        // make sure the build task is executed only when appropriate files change
        inputs.files fileTree('public')
        inputs.files fileTree('src')

        // 'node_modules' appeared not reliable for dependency change detection (the task was rerun without changes)
        // though 'package.json' and 'package-lock.json' should be enough anyway
        inputs.file 'package.json'
        inputs.file 'package-lock.json'

        outputs.dir 'build'
    }

    // pack output of the build into JAR file
    task packageNpmApp(type: Zip) {
        dependsOn npm_run_build
        baseName 'npm-app'
        extension 'jar'
        destinationDir file("${projectDir}/build_packageNpmApp")
        from('build') {
            // optional path under which output will be visible in Java classpath, e.g. static resources path
            into 'static'
        }
    }

    // declare a dedicated scope for publishing the packaged JAR
    configurations {
        npmResources
    }

    configurations.default.extendsFrom(configurations.npmResources)

    // expose the artifact created by the packaging task
    artifacts {
        npmResources(packageNpmApp.archivePath) {
            builtBy packageNpmApp
            type 'jar'
        }
    }

    assemble.dependsOn packageNpmApp

    String testsExecutedMarkerName = "${projectDir}/.tests.executed"

    task test(type: NpmTask) {
        dependsOn assemble

        // force Jest test runner to execute tests once and finish the process instead of starting watch mode
        environment CI: 'true'

        args = ['run', 'test']

        inputs.files fileTree('src')
        inputs.file 'package.json'
        inputs.file 'package-lock.json'

        // allows easy triggering re-tests
        doLast {
            new File(testsExecutedMarkerName).text = 'delete this file to force re-execution JavaScript tests'
        }
        outputs.file testsExecutedMarkerName
    }

    check.dependsOn test

    clean {
        delete packageNpmApp.archivePath
        delete testsExecutedMarkerName
    }

另外，build.gradle 是如何解析的？我也想知道它是如何神奇地下载 node 和 npm 工具的。

Answer 1

这是一个非常笼统的概要：

• Gradle 旨在向开发人员隐藏逻辑。
• 大多数*.gradle文件包含配置块( closures) 来指定逻辑应如何运行。
• 插件通过更多可配置的逻辑来增强 gradle。
• 此外，“约定优于配置”是 gradle 及其插件中强调的实践，提供合理的默认值以最大程度地减少开发人员的配置工作。
• 该com.moowork.node插件是通过node扩展块配置的。
• 扩展块是 gradle 允许插件向标准 gradle 模型添加更多“保留”字的方式。
• 配置告诉插件在项目的根目录中download = true下载 node ( version = '10.14.1') 和 nmp ( ) （除非您也覆盖其默认值）。npmVersion = '6.4.1'
• 当调用任何插件的任务时，就会下载这些工具。

希望这可以帮助。