Plugin that makes it easy to create SPA applications with Java back end. It connects JVM and Node.js based projects.
It maps typical java tasks to npm tasks (build, test, clean, etc). The build result is packed into a jar file, so it can be imported as a dependency by a java project.
- This plugin builds frontend submodules. It can be also used to build a webjar libraries. See sample usage.
- Tested with gradle version >= 7.1
Add to your build.gradle:
plugins {
id 'com.coditory.webjar' version '1.3.1'
}When the project is build (./gradlew buid),
produced jar contains all front end resources.
| Gradle Task | Npm Task | Runs before | Description |
|---|---|---|---|
webjarClean |
clean |
gradle clean |
Cleans output directory |
webjarLint |
lint |
gradle check |
Checkstyle sources |
webjarTest |
test |
java test |
Run tests |
webjarBuild |
build |
java processResources |
Build Project |
webjarWatch |
watch |
- | Run in watch mode. Should be run with --no-daemon in order to stop the process on ctrl+c |
There is also webjarInit that:
- downloads Node and NPM
- creates
package.jsonandpackage-lock.jsonif missing
Why should I use gradle tasks instead of npm tasks Gradle tasks runs using embedded node.
npm run watchuses system Node and NPM./gradlew webjarWatch --no-daemonuses project Node and NPM
Frontend projects take a lot of time to build. You can skip frontend build with:
./gradlew build -PskipWebjar- project propertySKIP_WEBJAR=true ./gradlew build- system environment variable
All presented values are defaults.
webjar {
// Directory where npm puts the result
distDir = "dist"
// Directory with npm results in the jar
webjarDir = "static"
// NPM Task names
taskNames {
clean = "clean"
build = "build"
test = "test"
lint = "lint"
watch = "watch"
}
// Caching options
cache {
enabled = true
cacheTest = true
cacheLint = true
// Some timestamp files used for gradle caching
testTimestampFile = "test/timestamp"
lintTimestampFile = "lint/timestamp"
// Location of src and dest input files
src = listOf("src")
test = listOf("tests")
}
}Webjar plugin uses great gradle-node-plugin.
You can configure Node and NPM with:
node {
// Version of node to use.
version = '16.5.0'
// Version of npm to use.
npmVersion = '7.19.1'
// Base URL for fetching node distributions (change if you have a mirror).
// Or set to null if you want to add the repository on your own.
distBaseUrl = 'https://nodejs.org/dist'
// If true, it will download node using above parameters.
// If false, it will try to use globally installed node.
download = true
// Set the work directory for unpacking node
workDir = file("${project.buildDir}/.node/node")
// Set the work directory for NPM
npmWorkDir = file("${project.buildDir}/.node/npm")
// Set the work directory where node_modules should be located
nodeModulesDir = file("${project.projectDir}")
}All values from above example are defaults setup by webjar plugin.
There is a sample project with two submodules:
my-project
|- backend
|- frontend
Backend project depends on frontend project:
dependencies {
implementation(project(":frontend"))
}Frontend project uses webjar plugin to map npm tasks to gradle.
When frontend is built all frontend resources are available on backend classpath under /static folder.
Building webjar library
Creating a webjar library for webjars.org,
requires specifying standardized webjarDir
webjar {
webjarDir = "META-INF/resources/webjars/${project.name}/${project.version}"
}
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent