@jahia/create-module 0.0.1 → 0.0.3

package/handlebars/.yarnrc.yml

@@ -0,0 +1,3 @@
+nodeLinker: node-modules
+
+yarnPath: .yarn/releases/yarn-4.3.1.cjs

package/handlebars/README.md

@@ -9,3 +9,23 @@ If you don't use default configuration for the Docker container name or for Jahi
 ## Documentation
 
 You can find the documentation on how to use this module on the [Jahia Academy](https://academy.jahia.com/get-started/developers/templating) templating tutorial.
+
+## Run
+
+1) Enable Corepack if needed : 
+
+`enable corepack`
+
+2) Install the dependencies :
+
+``yarn``
+
+3) Build and run the project :
+
+``yarn watch``
+
+## How to upgrade yarn version to latest stable
+
+This command will upgrade yarn  to the latest stable release and update the yarn installer in .yarn/releases
+
+``yarn set version stable``

package/handlebars/dotgitignore

@@ -7,9 +7,12 @@
 dist
 node_modules
 
-# yarn v2
-.yarn/cache
-.yarn/unplugged
-.yarn/build-state.yml
-.yarn/install-state.gz
-.pnp.*
+#Yarn
+.yarn/*
+!.yarn/cache
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+yarn-error.log

package/handlebars/package.json

@@ -3,18 +3,18 @@
   "version": "1.0.0",
   "license": "MIT",
   "scripts": {
-    "build": "webpack --mode=development",
+    "build": "webpack --mode=development --env pack",
+    "build:production": "webpack --mode=production --env pack",
     "deploy": "jahia-deploy",
-    "watch": "yarn build --env deploy=true --watch",
+    "watch": "webpack --mode=development --env deploy --watch",
     "lint": "eslint .",
-    "test": "yarn lint", 
-    "postinstall": "yarn dlx @yarnpkg/sdks vscode"    
+    "test": "yarn lint"
   },
   "jahia": {
-    "module-dependencies" : "default",
+    "module-dependencies": "default",
     "module-type": "templatesSet",
-    "server": "dist/main.js", 
-    "static-resources" : "/css,/images,/javascript"
+    "server": "dist/main.js",
+    "static-resources": "/css,/images,/javascript"
   },
   "devDependencies": {
     "@jahia/eslint-config": "^2.1.2",
@@ -31,11 +31,12 @@
     "webpack-shell-plugin-next": "^2.3.1"
   },
   "dependencies": {
-    "handlebars": "^4.7.7",
-    "@jahia/js-server-core" : "^0.0.4"
+    "@jahia/js-server-core": "^0.0.13",
+    "handlebars": "^4.7.7"
   },
   "engines": {
     "node": ">=16.0.0",
-    "yarn": ">=3.0.0"
-  }
+    "yarn": ">=4.0.0"
+  },
+  "packageManager": "yarn@4.3.1"
 }

package/handlebars/webpack.config.js

@@ -3,6 +3,8 @@ const WebpackShellPluginNext = require('webpack-shell-plugin-next');
 const ExtraWatchWebpackPlugin = require('extra-watch-webpack-plugin');
 
 module.exports = env => {
+    // Unique config for jahia's server-side source code (components using server side rendering)
+    // Those components have access to jahia's custom types and functions (https://academy.jahia.com/documentation/jahia/jahia-8/developer/javascript-module-development/javascript-modules-reference-documentation)
     const config = {
         entry: {
             main: path.resolve(__dirname, 'src/index')
@@ -11,10 +13,12 @@ module.exports = env => {
             path: path.resolve(__dirname, 'dist')
         },
         externals: {
+            // Those libraries are supplied to webpack at runtime (by the npm-module-engine project), and are not packaged in the output bundle
             '@jahia/js-server-core': 'jsServerCoreLibraryBuilder.getLibrary()',
             handlebars: 'jsServerCoreLibraryBuilder.getSharedLibrary(\'handlebars\')'
         },
         plugins: [
+            // This plugin help you to attach extra files or dirs to webpack's watch system
             new ExtraWatchWebpackPlugin({
                 files: [
                     'src/**/*',
@@ -35,11 +39,25 @@ module.exports = env => {
         devtool: 'inline-source-map'
     };
 
+    // 'jahia-pack' is a custom jahia script that makes a tgz package of the module's bundle
+    if (env.pack) {
+        config.plugins.push(
+            // This plugin allows you to run any shell commands before or after webpack builds.
+            new WebpackShellPluginNext({
+                onAfterDone: {
+                    scripts: ['yarn jahia-pack']
+                }
+            })
+        );
+    }
+
+    // 'jahia-deploy' is a custom jahia script that makes a tgz package of the module's bundle and deploy it to jahia via curl.
     if (env.deploy) {
         config.plugins.push(
+            // This plugin allows you to run any shell commands before or after webpack builds.
             new WebpackShellPluginNext({
                 onAfterDone: {
-                    scripts: ['yarn jahia-deploy pack']
+                    scripts: ['yarn jahia-deploy']
                 }
             })
         );