@jahia/create-module 0.0.3 → 0.0.4

package/.yarnrc.yml

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

package/README.md

@@ -4,7 +4,12 @@ This project provides an NPM/NPX starter project template to quickly get up and
 
 ## Usage
 
-    npx @jahia/create-module@latest my-module-name my-module-type
-
-where `my-module-name` can be anything you want to call your project
-and `my-module-type`is jsx or handlebars
+    npx @jahia/create-module@latest project-name [module-type] [namespace-definitions]
+
+where 
+- `project-name` (mandatory) can be anything you want to call your project
+- `module-type` (optional) Can be one of:
+  - `templatesSet`: A collection of templates and components. A template set is required when creating a website.
+  - `module`: Standard Jahia module. This is the default value.
+  - `system`: Critical module for the whole platform.
+- `namespace-definitions` (optional) The namespace used for content definitions. Default is the project name in camel case.

package/index.js

@@ -5,53 +5,49 @@
 import fs from 'fs';
 import path from 'path';
 import {fileURLToPath} from 'url';
-import replace from 'replace-in-file';
+import {replaceInFileSync} from 'replace-in-file';
 import camelCase from 'camelcase';
 import {execSync} from 'child_process';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 
-// The first argument will be the project name.
-// The second argument will be the project type (handlebars or jsx)
-// The third argument is optional, it will be the namespace of the module.
-if (process.argv.length < 3) {
-    console.error('Missing module-name parameter. Ex: npx @jahia/create-module@latest module-name module-type [namespace]');
+// Show help if no argment is provided
+// eslint-disable-next-line no-unused-vars
+const [nodeCommand, npxCommand, projectName, moduleType = 'module', namespace = camelCase(projectName)] = process.argv;
+
+if (!projectName) {
+    console.log(`\x1B[1m## Usage\x1B[0m
+
+    npx @jahia/create-module@latest project-name [module-type] [namespace-definitions]
+
+where 
+- \x1B[1mproject-name\x1B[0m (mandatory) can be anything you want to call your project
+- \x1B[1mmodule-type\x1B[0m (optional) Can be one of:
+  - \x1B[3mtemplatesSet\x1B[0m A collection of templates and components. A template set is required when creating a website.
+  - \x1B[3mmodule\x1B[0m sStandard Jahia module. This is the default value. 
+  - \x1B[3msystem\x1B[0m Critical module for the whole platform . 
+- \x1B[1mnamespace-definitions\x1B[0m (optional) The namespace used for content definitions. Default is the project name in camel case.
+`);
     process.exit(9);
 }
 
-const projectName = process.argv[2];
-const camelProjectName = camelCase(projectName);
-
 // First let's do some version checks
 console.log('Node version detected:', process.versions.node);
 const yarnVersion = execSync('yarn --version', {encoding: 'utf8'});
 console.log('Yarn version:', yarnVersion);
 
-let projectType;
-if (process.argv[3] === 'handlebars' || process.argv[3] === 'jsx') {
-    projectType = process.argv[3];
-} else {
-    console.error(`Invalid module-type parameter, should be handlebars or jsx, got:${process.argv[3]}. Ex: npx @jahia/create-module@latest module-name module-type [namespace]`);
-    process.exit(9);
-}
-
-let namespace;
-if (process.argv.length > 4) {
-    namespace = process.argv[4];
-} else {
-    namespace = camelProjectName;
-}
-
 // Create a project directory with the project name.
 const currentDir = process.cwd();
 const projectDir = path.resolve(currentDir, projectName);
 fs.mkdirSync(projectDir, {recursive: true});
 
+console.log(`Creating a new Jahia module project \x1B[1m${projectName}\x1B[0m of type \x1B[1m${moduleType}\x1B[0m and definitions namespace \x1B[1m${namespace}\x1B[0m`);
+
 // A common approach to building a starter template is to
 // create a `template` folder which will house the template
 // and the files we want to create.
-const templateDir = path.resolve(__dirname, projectType);
+const templateDir = path.resolve(__dirname, 'template');
 fs.cpSync(templateDir, projectDir, {recursive: true});
 
 // It is good practice to have dotfiles stored in the
@@ -78,23 +74,15 @@ fs.renameSync(
 
 // Rename the resource file to use the project name
 fs.renameSync(
-    path.join(projectDir, 'resources/MODULE_NAME.properties'),
-    path.join(projectDir, 'resources/' + projectName + '.properties')
+    path.join(projectDir, 'settings/resources/MODULE_NAME.properties'),
+    path.join(projectDir, 'settings/resources/' + projectName + '.properties')
 );
 
 fs.renameSync(
-    path.join(projectDir, 'resources/MODULE_NAME_fr.properties'),
-    path.join(projectDir, 'resources/' + projectName + '_fr.properties')
+    path.join(projectDir, 'settings/resources/MODULE_NAME_fr.properties'),
+    path.join(projectDir, 'settings/resources/' + projectName + '_fr.properties')
 );
 
-// Rename the resource file to use the project name
-if (process.argv[3] === 'handlebars') {
-    fs.renameSync(
-        path.join(projectDir, 'components/MODULE_NAMESPACE'),
-        path.join(projectDir, 'components/' + namespace)
-    );
-}
-
 // Create empty directories for static resources and configurations
 fs.mkdirSync(path.join(projectDir, 'css'), {recursive: true});
 fs.mkdirSync(path.join(projectDir, 'images'), {recursive: true});
@@ -105,52 +93,31 @@ fs.mkdirSync(path.join(projectDir, 'settings/jahia-content-editor-forms/forms'),
 fs.mkdirSync(path.join(projectDir, 'settings/jahia-content-editor-forms/fieldsets'), {recursive: true});
 
 // Find and replace all markers with the appropriate substitution values
-const targetFiles = [
-    path.join(projectDir, 'README.md'),
-    path.join(projectDir, 'import.xml'),
-    path.join(projectDir, 'package.json'),
-    path.join(projectDir, 'definitions.cnd'),
-    path.join(projectDir, 'resources/' + projectName + '.properties'),
-    path.join(projectDir, 'resources/' + projectName + '_fr.properties')
-];
-
-if (projectType === 'jsx') {
-    targetFiles.push(path.join(projectDir, 'src/server/templates/page/PageHome.jsx'));
-    targetFiles.push(path.join(projectDir, 'src/server/views/hello/HelloDefault.jsx'));
-    targetFiles.push(path.join(projectDir, 'src/client/index.jsx'));
-    targetFiles.push(path.join(projectDir, 'webpack.config.js'));
-}
-
-if (projectType === 'handlebars') {
-    targetFiles.push(path.join(projectDir, 'components/' + namespace + '/hello/hello.cnd'));
-}
+const targetFiles = `${projectDir}/**`;
 
 try {
-    replace.sync({
+    replaceInFileSync({
         files: targetFiles,
-        from: /\$\$CAMEL_MODULE_NAME\$\$/g,
-        to: camelProjectName,
-        disableGlobs: true // This is required otherwise the replaces fail under Windows (see https://jira.jahia.org/browse/BACKLOG-21353)
+        from: /\$\$MODULE_TYPE\$\$/g,
+        to: camelCase(moduleType)
     });
 
-    replace.sync({
+    replaceInFileSync({
         files: targetFiles,
         from: /\$\$MODULE_NAME\$\$/g,
-        to: projectName,
-        disableGlobs: true // This is required otherwise the replaces fail under Windows (see https://jira.jahia.org/browse/BACKLOG-21353)
+        to: projectName
     });
 
-    replace.sync({
+    replaceInFileSync({
         files: targetFiles,
         from: /\$\$MODULE_NAMESPACE\$\$/g,
-        to: namespace,
-        disableGlobs: true // This is required otherwise the replaces fail under Windows (see https://jira.jahia.org/browse/BACKLOG-21353)
+        to: namespace
     });
 } catch (error) {
     console.error('Error occurred:', error);
 }
 
-console.log(`Created ${projectName} at ${projectDir}`);
+console.log(`Created \x1B[1m${projectName}\x1B[0m at \x1B[1m${projectDir}\x1B[0m`);
 console.log('Success! Your new project is ready.');
 console.log('You can now change into your project and launch "yarn" to install everything to get started.');
 console.log('---');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jahia/create-module",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "license": "MIT",
   "type": "module",
   "bin": "./index.js",
@@ -19,13 +19,13 @@
   "dependencies": {
     "camelcase": "^8.0.0",
     "path": "^0.12.7",
-    "replace-in-file": "^7.0.1",
+    "replace-in-file": "^8.2.0",
     "semver": "^7.5.4",
     "url": "^0.11.1"
   },
   "devDependencies": {
     "@jahia/eslint-config": "^2.1.2",
-    "@jahia/scripts": "^1.3.3",
+    "@jahia/scripts": "^1.3.5",
     "eslint": "^8.43.0",
     "eslint-plugin-jest": "latest",
     "eslint-plugin-react": "latest",
@@ -34,14 +34,11 @@
   "scripts": {
     "lint": "eslint .",
     "posttest": "yarn lint",
-    "test-hbs": "rm -rf test-project-hbs && node index.js test-project-hbs handlebars && cd test-project-hbs && yarn && yarn build && yarn lint && yarn test && cd ..",
-    "test-jsx": "rm -rf test-project-jsx && node index.js test-project-jsx jsx && cd test-project-jsx && yarn && yarn build && yarn lint && yarn test && cd ..",
-    "test": "yarn test-hbs && yarn test-jsx",
-    "version": "git add README.md"
+    "test": "rm -rf test-project && node index.js test-project && cd test-project && yarn && yarn build && yarn lint && yarn test && cd .."
   },
   "engines": {
     "node": ">=18.0.0",
     "yarn": ">=4.0.0"
   },
-  "packageManager": "yarn@4.4.0"
+  "packageManager": "yarn@4.5.0"
 }

package/template/.babelrc

@@ -0,0 +1,9 @@
+{
+  "presets": [
+    "@babel/preset-env",
+    "@babel/preset-react"
+  ],
+  "plugins": [
+    "styled-jsx/babel"
+  ]
+}

package/{jsx → template}/dotnpmignore

@@ -6,5 +6,5 @@
 .vscode
 webpack.config.js
 README.md
-settings/README.txt
+settings/README.md
 src

package/{jsx → template}/package.json

@@ -13,7 +13,7 @@
   },
   "jahia": {
     "module-dependencies": "default",
-    "module-type": "",
+    "module-type": "$$MODULE_TYPE$$",
     "module-type-comment": "Use templatesSet in the module type to declare a template set",
     "server": "dist/main.js",
     "static-resources": "/css,/images,/javascript,/locales"
@@ -32,7 +32,7 @@
     "@babel/preset-env": "^7.16.4",
     "@babel/preset-react": "^7.16.0",
     "@jahia/eslint-config": "^2.1.2",
-    "@jahia/scripts": "^1.3.3",
+    "@jahia/scripts": "^1.3.5",
     "babel-loader": "^8.2.3",
     "clean-webpack-plugin": "^4.0.0",
     "copy-webpack-plugin": "^10.0.0",

package/template/settings/README.md

@@ -0,0 +1,30 @@
+# Directory Structure
+
+In this directory, you can directly put: 
+- **Rule files** (`*.drl`, `*.dsl`)
+- **URL rewrite XML files**
+- **import.xml** file
+- **definitions.cnd** file
+- **template-thumbnail.png** file to associate a preview image with the current module (in case it's a template module)
+
+## Configurations Directory
+
+In the `configurations` directory, you can put:
+- **OSGi configuration files** (`*.cfg`, `*.yml`)
+
+## Content Editor Forms Directory
+
+In the `content-editor-forms` directory, you can put content editor form and field set overrides.
+See examples here: [Jahia Content Editor Form Examples](https://academy.jahia.com/documentation/jahia/jahia-8/developer/extending-and-customizing-jahia-ui/customizing-content-editor-forms/examples-of-content-definition-json-overrides)
+
+## Content Types Icons Directory
+
+In the `content-types-icons` directory, you can put content type icons following the naming convention: `namespace_type.png`
+
+## Locales Directory
+
+In the `locales` directory, you can put locale files (e.g., `en.json`, `fr.json`) used for internationalization in JavaScript views.
+
+## Resources Directory
+
+In the `resources` directory, you can put resource bundles for content types internationalization.

package/{jsx → template}/src/server/templates/page/PageHome.jsx

@@ -1,27 +1,29 @@
 import React from 'react';
-import {Area, AddResources, defineJahiaComponent} from '@jahia/js-server-core';
+import {Area, AddResources, defineJahiaComponent, useServerContext} from '@jahia/js-server-core';
 import {useTranslation} from 'react-i18next';
 
 export const PageHome = () => {
     const {t} = useTranslation();
-    return (<>
+    const {currentResource} = useServerContext();
+    const lang = currentResource.getLocale().getLanguage();
+    return (<html lang={lang}>
         <head>
             <AddResources type='css' resources='styles.css' />
             <title>Home</title>
         </head>
         <body>
-            {/* Using i18next defined in locales */}
-            <h1>{t('homeTitle')}</h1>
             <main>
+                {/* Using i18next defined in locales */}
+                <h1>{t('homeTitle')}</h1>
                 <Area name="pagecontent" />
             </main>
         </body>
-    </>);
+    </html>);
 }
 
 PageHome.jahiaComponent = defineJahiaComponent({
-    nodeType: 'jnt:page', 
-    name: 'home', 
-    displayName: 'Home page', 
+    nodeType: 'jnt:page',
+    name: 'home',
+    displayName: 'Home page',
     componentType: 'template'
 });

package/{jsx → template}/webpack.config.js

@@ -142,6 +142,9 @@ module.exports = (env, mode) => {
     // Also an additional sleep is added to avoid watch triggering too much in a short time
     // (Feel free to adjust the sleep time according to your needs)
     if (mode.watch) {
+        // Sleep time in seconds, can be adjusted
+        const sleepTime = 5;
+
         configs.push({
             name: 'watch',
             mode: 'development',
@@ -171,7 +174,7 @@ module.exports = (env, mode) => {
                         scripts: [
                             'yarn jahia-pack',
                             'yarn jahia-deploy',
-                            'sleep 5' // Sleep for 5 seconds, can be adjusted
+                            process.platform === 'win32' ? 'timeout ' + sleepTime : 'sleep ' + sleepTime
                         ],
                         blocking: true,
                         parallel: false

package/babel.config.cjs.disabled

@@ -1,3 +0,0 @@
-module.exports = {
-    presets: ['@babel/preset-env', '@babel/preset-react']
-};

package/handlebars/components/MODULE_NAMESPACE/hello/hello.cnd

@@ -1,6 +0,0 @@
-<jnt = 'http://www.jahia.org/jahia/nt/1.0'>
-<jmix = 'http://www.jahia.org/jahia/mix/1.0'>
-<$$MODULE_NAMESPACE$$ = 'http://www.acme.org/$$MODULE_NAME$$/nt/1.0'>
-
-[$$MODULE_NAMESPACE$$:hello] > jnt:content, jmix:droppableContent
- - textHello (string) = 'Hello world !' i18n

package/handlebars/components/MODULE_NAMESPACE/hello/hello.default.hbs

@@ -1 +0,0 @@
-<h1>{{currentContent.properties.textHello}}</h1>

package/handlebars/components/jnt/page/page.home.hbs

@@ -1,18 +0,0 @@
-<!DOCTYPE html>
-<html lang="en" class="no-js">
-
-<head>
-    <meta charset="utf-8">
-    <meta http-equiv="X-UA-Compatible" content="IE=edge">
-    <meta name="viewport" content="width=device-width, initial-scale=1">
-    <title>Home Template</title>
-</head>
-
-<body>
-    <h1>Home Template</h1>
-    <main>
-        {{jArea name="pagecontent"}}
-    </main>
-</body>
-
-</html>

package/handlebars/components/jnt/page/page.home.properties

@@ -1,2 +0,0 @@
-name=Home page
-componentType=template

package/handlebars/definitions.cnd

@@ -1,8 +0,0 @@
-<jnt = 'http://www.jahia.org/jahia/nt/1.0'>
-<jmix = 'http://www.jahia.org/jahia/mix/1.0'>
-<$$MODULE_NAMESPACE$$ = 'http://www.acme.org/$$MODULE_NAME$$/nt/1.0'>
-<$$MODULE_NAMESPACE$$mix = 'http://www.acme.org/$$MODULE_NAME$$/mix/1.0'>
-
-// This mixin creates a category to regroup types in the content type selector UI. Apply it to any definition you want
-// to see in this category.
-[$$MODULE_NAMESPACE$$mix:$$MODULE_NAMESPACE$$Components] > jmix:droppableContent, jmix:accessControllableContent mixin

package/handlebars/dotenv

@@ -1,4 +0,0 @@
-JAHIA_USER=root:root1234
-JAHIA_HOST=http://localhost:8080
-JAHIA_DOCKER_NAME=jahia-ee-dev
-JAHIA_DEPLOY_METHOD=curl

package/handlebars/doteslintrc.cjs

@@ -1,29 +0,0 @@
-module.exports = {
-    root: true,
-    env: {
-        browser: true,
-        es2021: true
-    },
-    extends: '@jahia',
-    overrides: [
-        {
-            env: {
-                node: true
-            },
-            files: [
-                '.eslintrc.{js,cjs}'
-            ],
-            parserOptions: {
-                sourceType: 'script'
-            }
-        }
-    ],
-    parserOptions: {
-        requireConfigFile: false,
-        ecmaVersion: 'latest',
-        sourceType: 'module'
-    },
-    ignorePatterns: ['dist'],
-    rules: {
-    }
-};

package/handlebars/dotnpmignore

@@ -1,4 +0,0 @@
-.env
-.eslintrc.cjs
-.idea
-*.tgz

package/handlebars/import.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<content xmlns:j="http://www.jahia.org/jahia/1.0" xmlns:jcr="http://www.jcp.org/jcr/1.0">
-    <modules jcr:primaryType="jnt:modules">
-        <$$MODULE_NAME$$>
-            <home j:isHomePage="true" j:templateName="home" jcr:primaryType="jnt:page" />
-        </$$MODULE_NAME$$>
-    </modules>
-</content>

package/handlebars/locales/de.json

@@ -1,3 +0,0 @@
-{
-  "greeting": "Hallo !"
-}

package/handlebars/locales/en.json

@@ -1,3 +0,0 @@
-{
-  "greeting": "Hello !"
-}

package/handlebars/locales/fr.json

@@ -1,3 +0,0 @@
-{
-  "greeting": "Salut !"
-}

package/handlebars/package.json

@@ -1,42 +0,0 @@
-{
-  "name": "$$MODULE_NAME$$",
-  "version": "1.0.0",
-  "license": "MIT",
-  "scripts": {
-    "build": "webpack --mode=development --env pack",
-    "build:production": "webpack --mode=production --env pack",
-    "deploy": "jahia-deploy",
-    "watch": "webpack --mode=development --env deploy --watch",
-    "lint": "eslint .",
-    "test": "yarn lint"
-  },
-  "jahia": {
-    "module-dependencies": "default",
-    "module-type": "templatesSet",
-    "server": "dist/main.js",
-    "static-resources": "/css,/images,/javascript"
-  },
-  "devDependencies": {
-    "@jahia/eslint-config": "^2.1.2",
-    "@jahia/scripts": "^1.3.3",
-    "eslint": "^8.43.0",
-    "eslint-plugin-jest": "latest",
-    "eslint-plugin-react": "latest",
-    "eslint-plugin-react-hooks": "latest",
-    "extra-watch-webpack-plugin": "latest",
-    "handlebars-loader": "^1.7.3",
-    "typescript": "^5.3.3",
-    "webpack": "^5.88.1",
-    "webpack-cli": "^5.1.4",
-    "webpack-shell-plugin-next": "^2.3.1"
-  },
-  "dependencies": {
-    "@jahia/js-server-core": "^0.0.13",
-    "handlebars": "^4.7.7"
-  },
-  "engines": {
-    "node": ">=16.0.0",
-    "yarn": ">=4.0.0"
-  },
-  "packageManager": "yarn@4.3.1"
-}

package/handlebars/resources/MODULE_NAME.properties

@@ -1,2 +0,0 @@
-$$MODULE_NAMESPACE$$_hello=Hello
-$$MODULE_NAMESPACE$$_hello.textHello=Hello world !

package/handlebars/resources/MODULE_NAME_fr.properties

@@ -1,2 +0,0 @@
-$$MODULE_NAMESPACE$$_hello=Bonjour
-$$MODULE_NAMESPACE$$_hello.textHello=Bonjour le monde !

package/handlebars/settings/README.txt

@@ -1,9 +0,0 @@
-In this directory you can put directly : 
-- Rule files (*.drl, *.dsl)
-- URL rewrite XML files
-
-In the configurations directory you can put : 
-- OSGi configuration files (*.cfg, *.yml)
-
-In the jahia-content-editor-forms you can put content editor form and field set overrides, 
-see examples here : https://academy.jahia.com/documentation/jahia/jahia-8/developer/extending-and-customizing-jahia-ui/customizing-content-editor-forms/examples-of-content-definition-json-overrides 

package/handlebars/webpack.config.js

@@ -1,67 +0,0 @@
-const path = require('path');
-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')
-        },
-        output: {
-            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/**/*',
-                    'components/**/*',
-                    'views/**/*',
-                    'images/**/*',
-                    'css/**/*',
-                    'javascript/**/*',
-                    'locales/**/*.json',
-                    'resources/**/*.properties',
-                    'settings/**/*',
-                    'definitions.cnd',
-                    'import.xml',
-                    'package.json'
-                ]
-            })
-        ],
-        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']
-                }
-            })
-        );
-    }
-
-    return config;
-};