JarCastingEmber CLI Gradle Plugin
A plugin for building Ember CLI projects with gradle.
The plugin expects that you have a JS package manager (npm, yarn) on your path and ember-cli as an NPM dependency of your project (default of ember-cli).
Note: This plugin uses the Distribution plugin under the hood to create its zip artifact, so it will inherit tasks from that plugin.
This plugin's task structure mimics that of the Gradle Java Plugin. The build task built into gradle depends on check and assemble. check is responsible for running tests, and `assemble is responsible for creating the build artifacts.
Notes
- As of version 3.2.0, we no longer support the environment configuration property. The build defaults are now the same, but you should switch to using the buildArguments property instead.
- As of version 3.3.0, the default test port is now 0.
- As of version 3.4.0,
trackNodeModulesContents = falseandtrackBowerComponentsContents = falseno longer track the corresponding folders as files. Looking for suggestions here, but wanted to get rid of the deprecation before it was a problem. - As of version 4.0.0 - Bower related tasks are gone. The JavaScript package manager is now configurable (npm vs. yarn).
- As of version 5.0.0 - The project is now deployed to maven central and packaged according to their constraints
Requirements
- As of version 2.0.0, you must have at least ember-cli version 1.13.6 to have parallel builds work correctly. This is due to a breaking change that occurred in Ember CLI.
- A build task is necessary for this plugin to work. If you use Gradle 2.4 or later, you get this task for free as part of the default build lifecycle
- Java 8 or later
Usage
In your build.gradle file...
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath "io.github.benkiefer:ember-cli-gradle-plugin:VERSION_NUMBER"
}
}
apply plugin: "io.github.benkiefer.embercli"
Then run:
./gradlew clean build
If you need to configure the plugin beyond its default settings, you can do so with the following options.
apply plugin: "io.github.benkiefer.embercli"
embercli {
// point to a different npm registry
npmRegistry = "https://my-custom-npm-registry.com"
// use only the presence of the node modules folder to determine up to date status, not all its contents
trackNodeModulesContents = false
// use to override the executable for a JavaScript package install (npm vs. yarn)
jsPackageInstallExecutable = "npm"
// use to override the install command for a JavaScript package install
jsPackageInstallExecutable = "install"
// use to override the command for build
buildCommand = "build"
// use to override the arguments that are provided to the build command
buildArguments = ["--environment=production"]
// use to override the command for testing (ex: exam)
testCommand = "test"
// use to override the arguments that are provided to the test command
testArguments = ["--test-port=1234"]
}
For a more complete example including extraction into a project, check out my sample project.
The Clean Task
An independent task that removes the dist and tmp directories.
Example:
./gradlew clean
The JsPackageInstall Task
Shells out to a JavaScript package installer and executes an install command.
Example:
./gradlew jsPackageInstall
The Test Task
Shells out to Ember CLI and executes the test command. Also executes the JsPackageInstall task. The check task depends on test.
Example:
./gradlew test
The EmberBuild Task
Shells out to Ember CLI and executes the build command with a production environment target. Also executes the Test and JsPackageInstall tasks. The assemble task depends on emberBuild.
Example:
./gradlew emberBuild