New tests

Author: ban-mi

.github/workflows/graaljs-gradle-webpack-guide.yml

@@ -0,0 +1,43 @@
+name: Test GraalJS Gradle and Maven Webpack Guide
+
+on:
+  push:
+    paths:
+      - 'graaljs/graaljs-webpack-guide/**'
+      - '.github/workflows/graaljs-webpack-guide.yml'
+  pull_request:
+    paths:
+      - 'graaljs/graaljs-webpack-guide/**'
+      - '.github/workflows/graaljs-webpack-guide.yml'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+jobs:
+  run:
+    name: 'graaljs-webpack-guide'
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    steps:
+      - uses: actions/checkout@v4
+      - uses: graalvm/setup-graalvm@v1
+        with:
+          java-version: '24.0.1'
+          distribution: 'graalvm'
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          cache: 'gradle'
+      - name: Build and run Gradle example
+        run: |
+          cd graaljs/graaljs-webpack-guide
+          ./gradlew build
+          ./gradlew run --args="https://www.graalvm.org/javascript"
+      - uses: graalvm/setup-graalvm@v1
+        with:
+          java-version: '24.0.1'
+          distribution: 'graalvm'
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          cache: 'maven'
+      - name: Build and run Maven example
+        run: |
+          ./mvnw --no-transfer-progress package
+          ./mvnw --no-transfer-progress exec:java -Dexec.mainClass=com.example.App -Dexec.args="https://www.graalvm.org/javascript"

.github/workflows/graaljs-maven-webpack-guide.yml

@@ -4,12 +4,12 @@
 
 - [Introduction](#introduction)
 - [Prerequisites](#prerequisites)
-- [1. Setting Up the Java Project](#1-setting-up-the-java-project)
-  - [Create a new Gradle Java Project](#create-a-new-gradle-java-project)
-  - [Create a new Maven Java Project](#create-a-new-maven-java-project)
-- [2. Setting Up the JavaScript Build](#2-setting-up-the-javascript-build)
-- [3. Using the JavaScript Library from Java](#3-using-the-javascript-library-from-java)
-- [4. Building and Running the Application](#4-building-and-running-the-application)
+- [1. Set Up the Java Project](#1-set-up-the-java-project)
+  - [Create a New Gradle Java Project](#create-a-new-gradle-java-project)
+  - [Create a New Maven Java Project](#create-a-new-maven-java-project)
+- [2. Set Up the JavaScript Build](#2-set-up-the-javascript-build)
+- [3. Use the JavaScript Library from Java](#3-use-the-javascript-library-from-java)
+- [4. Build and Run the Application](#4-build-and-run-the-application)
 - [Conclusion](#conclusion)
 
 ## Introduction
@@ -34,18 +34,15 @@ You will need:
 - Gradle 8.0 or later, or Maven 3.6.3 or later
 - A decent text editor or IDE
 
----
 
-## 1. Setting Up the Java Project
+## 1. Set Up the Java Project
 
 You can use either **Gradle** or **Maven** to set up your Java project:
 
 - for Gradle projects, navigate to the Gradle folder with `cd gradle`
 - for Maven projects, navigate to the Maven folder with `cd maven`
 
-Create a New Gradle Java Project
-
-You can start with any Gradle Java project.
+### Create a New Gradle Java Project
 
 Run the following command to create a new project with Gradle:
 
@@ -55,9 +52,9 @@ gradle init --type java-application
 
 #### Add the GraalJS Dependencies
 
-Add the following required GraalJS dependencies to the `dependencies` block of your `build.gradle` file:
+Add the following required GraalJS dependencies to the `dependencies` block of your _build.gradle_ file:
 
-`build.gradle`
+_build.gradle_
 
 ```gradle
 dependencies {
@@ -77,9 +74,9 @@ The Node.js ecosystem has conventions about the filesystem layout of installed p
 Use a bundler to repackage all dependencies into a single file and simplify integration.
 You can use the [`com.github.node-gradle.node`](https://github.com/node-gradle/gradle-node-plugin) plugin to manage the download, installation, and bundling for you.
 
-Configure the Gradle Node plugin in the `build.gradle` with the following:
+Configure the Gradle Node plugin in the _build.gradle_ file with the following:
 
-`build.gradle`
+_build.gradle_
 
 ```gradle
 plugins {
@@ -111,11 +108,11 @@ processResources.dependsOn tasks.webpackBuild // ④
 
 ❷ Configures Node.js and npm versions, download settings, and working directories.
 
-❸ Registers a 'webpackBuild' task to run 'npm run build' in the frontend directory. It ensures dependencies are installed first and sets the output directory.
+❸ Registers a `webpackBuild` task to run `npm run build` in the frontend directory. It ensures dependencies are installed first and sets the output directory.
 
 ❹ Ensures that the `webpackBuild` task is executed before the processResources task, so the bundled JavaScript is included in your JAR file.
 
-### Create a new Maven Java Project
+### Create a New Maven Java Project
 
 You can start with any Maven application that runs on JDK 21 or newer.
 To follow this guide, generating the application from the [Maven Quickstart Archetype](https://maven.apache.org/archetypes/maven-archetype-quickstart/) is sufficient:
@@ -125,11 +122,11 @@ mvn archetype:generate -DarchetypeGroupId=org.apache.maven.archetypes -Darchetyp
 cd qrdemo
 ```
 
-#### Adding the GraalJS Dependencies
+#### Add the GraalJS Dependencies
 
 Add the following required GraalJS dependencies to the `<dependencies>` section of your POM file:
 
-`pom.xml`
+_pom.xml_
 
 ```xml
 <!-- <dependencies> -->
@@ -161,9 +158,9 @@ The Node.js ecosystem has conventions about the filesystem layout of installed p
 Use a bundler to repackage all dependencies into a single file and simplify integration.
 You can use the [`frontend-maven-plugin`](https://github.com/eirslett/frontend-maven-plugin) plugin to manage the download, installation, and bundling for you.
 
-Configure the Maven Frontend plugin in your `pom.xml` file to automate Node.js and JavaScript bundling steps:
+Configure the Maven Frontend plugin in your _pom.xml_ file to automate Node.js and JavaScript bundling steps:
 
-`pom.xml`
+_pom.xml_
 
 ```xml
 <!-- <build> -->
@@ -215,9 +212,7 @@ Configure the Maven Frontend plugin in your `pom.xml` file to automate Node.js a
 
 ❸ Runs `webpack` to build a bundle of the JS sources in _target/classes/bundle_, which will be later included in the application's JAR file and can be loaded as a resource.
 
----
-
-## 2. Setting Up the JavaScript Build
+## 2. Set Up the JavaScript Build
 
 Create the directory for your JavaScript sources:
 
@@ -234,9 +229,9 @@ You can manually set up the build environment with these steps:
 4. Run `npm install --save qrcode` to install and add the `qrcode` dependency.
 5. Run `npm install --save assert util stream-browserify browserify-zlib fast-text-encoding` to install the polyfill packages to build with the webpack configuration below.
 
-Alternatively, you can use the following `package.json` file to define your dependencies and build scripts:
+Alternatively, you can use the following _package.json_ file to define your dependencies and build scripts:
 
-`package.json`
+_package.json_
 
 ```json
 {
@@ -270,9 +265,9 @@ Alternatively, you can use the following `package.json` file to define your depe
 }
 ```
 
-Create a `webpack.config.js` file, or open the one created by `webpack-cli init`, and fill it with the following contents:
+Create a _webpack.config.js_ file, or open the one created by `webpack-cli init`, and fill it with the following contents:
 
-`webpack.config.js`
+_webpack.config.js_
 
 ```js
 const path = require('path');
@@ -326,9 +321,7 @@ import 'fast-text-encoding';
 export * as QRCode from 'qrcode';
 ```
 
----
-
-## 3. Using the JavaScript Library from Java
+## 3. Use the JavaScript Library from Java
 
 After reading the [qrcode](https://www.npmjs.com/package/qrcode) docs, you can write Java interfaces that match the [JavaScript types](https://www.npmjs.com/package/@types/qrcode) you want to use and methods you want to call on them.
 GraalJS makes it easy to access JavaScript objects via these interfaces.
@@ -421,9 +414,7 @@ You can cast the exported `QRCode` object to the declared `QRCode` interface so
 
 ❹ Invoke the `then` method of the `Promise` to eventually obtain the QRCode string and print it to `stdout`.
 
----
-
-## 4. Building and Running the Application
+## 4. Build and Run the Application
 
 If using Gradle, run the following commands to build and run your application:
 
@@ -459,14 +450,12 @@ Successfully generated QR code for "https://www.graalvm.org/".
     ▀▀▀▀▀▀▀ ▀ ▀▀▀▀     ▀▀▀▀▀▀
 ```
 
----
-
 ## Conclusion
 
 By following this guide, you've learned how to:
 
 - Use GraalJS and the GraalVM Polyglot API to embed a JavaScript library in your Java application.
-- Use Webpack to bundle an NPM package into a self-contained _.mjs_ file, including its dependencies and polyfills for Node.js core modules that may be required to run on GraalJS.
+- Use Webpack to bundle an NPM package into a self-contained _.mjs_ file, including its dependencies and `polyfills` for Node.js core modules that may be required to run on GraalJS.
 - Integrate the JavaScript build into your Java project using either Gradle or Maven.
 
-Feel free to use this demo as inspiration and a starting point for your own applications!
+Feel free to use this demo as inspiration or as a starting point for your own applications!