@jahia/create-module 0.0.10 → 0.5.4

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Jahia Forge - Code Repository
+Copyright (c) 2025 Jahia Forge - Code Repository
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,12 +1,13 @@
 # Javascript Module template create-module project
 
-This project provides an NPM/NPX starter project template to quickly get up and running to create Jahia Javascript modules
+This project provides a Javascript module starter project template to quickly get up and running to create Jahia Javascript modules
 
 ## Usage
 
     npx @jahia/create-module@latest project-name [module-type] [namespace-definitions]
 
-where 
+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.

package/index.js

@@ -1,144 +1,96 @@
 #!/usr/bin/env node
+import fs from "node:fs";
+import path from "node:path";
+import process from "node:process";
+import { fileURLToPath } from "node:url";
+import camelCase from "camelcase";
+import { styleText } from "node:util";
 
-// Usage: npx @jahia/create-module@latest module-name [namespace]
+try {
+  console.log(styleText("bgBlueBright", " Jahia JavaScript Module Creator "), "\n");
+
+  const nodeVersion = Number(process.versions.node.split(".")[0]);
+
+  if (nodeVersion < 22) {
+    console.warn(
+      `You are using ${styleText("redBright", `Node.js ${process.versions.node}`)} which is not officially supported.
+Please upgrade to ${styleText("greenBright", "Node.js 22 or later")} if you encounter any issues.
+Upgrade guide: ${styleText("underline", "https://nodejs.org/en/download")}
+`,
+    );
+  }
+
+  const name = process.argv[2];
 
-import fs from 'fs';
-import path from 'path';
-import {fileURLToPath} from 'url';
-import {replaceInFileSync} from 'replace-in-file';
-import camelCase from 'camelcase';
+  if (!name) {
+    console.error(
+      `No module name provided.
 
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
+  Usage: npm init @jahia/module ${styleText("blueBright", "<module-name>")}
 
-// 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;
+It will create a new module at this location with the provided name:
 
-if (!projectName) {
-    console.log(`\x1B[1m## Usage\x1B[0m
+  ${path.join(process.cwd(), styleText("blueBright", "<module-name>"))}`,
+    );
+    process.exit(1);
+  }
 
-    npx @jahia/create-module@latest project-name [module-type] [namespace-definitions]
+  // Module name and output directory
+  const module = camelCase(name);
+  const output = path.join(process.cwd(), name);
 
-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.
+  console.log(`Creating a new Jahia module project...
+
+  Module name: ${styleText("blueBright", module)}
+  Path:        ${styleText("blueBright", output)}
 `);
-    process.exit(9);
-}
 
-// First let's do some version checks
-console.log('Node version detected:', process.versions.node);
-
-// 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, 'template');
-const isTemplatesSet = moduleType === 'templatesSet';
-fs.cpSync(templateDir, projectDir, {
-    recursive: true,
-    filter: src => {
-        // The file template-thumbnail.png is only used for the type templatesSet
-        return (isTemplatesSet || src !== path.join(templateDir, 'settings', 'template-thumbnail.png'));
-    }
-});
+  /** Renames the `dot` directory to dotfiles and dotdirs. */
+  const renameDot = (/** @type {string} */ name) =>
+    name.startsWith(`dot${path.sep}`) ? `.${name.slice(4)}` : name;
 
-// Find and replace all markers with the appropriate substitution values
-// Doing it before renaming the dotfiles so they are not excluded
-const targetFiles = `${projectDir}/**`;
+  /** Replaces `$MODULE` with the actual module name. */
+  const templatify = (/** @type {string} */ str) => str.replaceAll("$MODULE", module);
 
-try {
-    replaceInFileSync({
-        files: targetFiles,
-        from: /\$\$MODULE_TYPE\$\$/g,
-        to: moduleType
-    });
-
-    replaceInFileSync({
-        files: targetFiles,
-        from: /\$\$MODULE_NAME\$\$/g,
-        to: projectName
-    });
-
-    replaceInFileSync({
-        files: targetFiles,
-        from: /\$\$MODULE_NAMESPACE\$\$/g,
-        to: namespace
-    });
+  // Copy the template to the output directory
+  const input = fileURLToPath(new URL("template/", import.meta.url));
+  for (const entry of fs.readdirSync(input, { recursive: true, withFileTypes: true })) {
+    if (entry.isDirectory()) continue;
+
+    const from = path.join(entry.parentPath, entry.name);
+    const to = path.join(output, templatify(renameDot(path.relative(input, from))));
+
+    // Ensure the parent directory exists
+    fs.mkdirSync(path.dirname(to), { recursive: true });
+
+    // Binary files are copied as is, text files are templated
+    if (entry.name.endsWith(".png")) {
+      fs.copyFileSync(from, to);
+    } else {
+      const contents = fs.readFileSync(from, "utf-8");
+      fs.writeFileSync(to, templatify(contents));
+    }
+  }
+
+  console.log(`${styleText("greenBright", "Successfully created a new Jahia module project!")}
+
+Next steps:
+  ${styleText("magentaBright", `cd ${name}`)}
+  ${styleText("magentaBright", "yarn")}  ${styleText("dim", "# Install dependencies")}
+  ${styleText("magentaBright", 'git init && git add . && git commit -m "chore: create module"')}  ${styleText(
+    "dim",
+    "# Commit all files",
+  )}
+  ${styleText("magentaBright", "code .")}  ${styleText("dim", "# Open the project in VSCode")}
+  ${styleText("magentaBright", "yarn dev")}  ${styleText("dim", "# Start the development server")}
+`);
 } catch (error) {
-    console.error('Error occurred:', error);
+  console.error(
+    `${styleText("bgRedBright", "Something went wrong")}
+
+If you believe this is a bug, please report it at:
+  ${styleText("underline", "https://github.com/Jahia/javascript-modules/issues")}
+`,
+    error,
+  );
 }
-
-// It is good practice to have dotfiles stored in the
-// template without the dot (so they do not get picked
-// up by the starter template repository). We can rename
-// the dotfiles after we have copied them over to the
-// new project directory.
-fs.renameSync(
-    path.join(projectDir, 'dotgitignore'),
-    path.join(projectDir, '.gitignore')
-);
-fs.renameSync(
-    path.join(projectDir, 'dotnpmignore'),
-    path.join(projectDir, '.npmignore')
-);
-fs.renameSync(
-    path.join(projectDir, 'dotenv'),
-    path.join(projectDir, '.env')
-);
-fs.renameSync(
-    path.join(projectDir, 'doteslintrc.cjs'),
-    path.join(projectDir, '.eslintrc.cjs')
-);
-
-// Rename the resource file to use the project name
-fs.renameSync(
-    path.join(projectDir, 'settings', 'resources', 'MODULE_NAME.properties'),
-    path.join(projectDir, 'settings', 'resources', projectName + '.properties')
-);
-
-fs.renameSync(
-    path.join(projectDir, 'settings', 'resources', 'MODULE_NAME_fr.properties'),
-    path.join(projectDir, 'settings', 'resources', projectName + '_fr.properties')
-);
-
-fs.renameSync(
-    path.join(projectDir, 'settings', 'content-types-icons', 'MODULE_NAMESPACE_simpleContent.png'),
-    path.join(projectDir, 'settings', 'content-types-icons', namespace + '_simpleContent.png')
-);
-
-// Create empty directories for static resources and configurations
-fs.mkdirSync(path.join(projectDir, 'static', 'css'), {recursive: true});
-fs.mkdirSync(path.join(projectDir, 'static', 'images'), {recursive: true});
-fs.mkdirSync(path.join(projectDir, 'static', 'javascript'), {recursive: true});
-fs.mkdirSync(path.join(projectDir, 'settings', 'configurations'), {recursive: true});
-fs.mkdirSync(path.join(projectDir, 'settings', 'content-editor-forms'), {recursive: true});
-fs.mkdirSync(path.join(projectDir, 'settings', 'content-editor-forms', 'forms'), {recursive: true});
-fs.mkdirSync(path.join(projectDir, 'settings', 'content-editor-forms', 'fieldsets'), {recursive: true});
-
-// Add an empty yarn.lock in case any parent folder is using yarn
-fs.writeFileSync(path.join(projectDir, 'yarn.lock'), '', 'utf8');
-
-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('---');
-console.log('Available project scripts will then be :');
-console.log('  - yarn build : build the project');
-console.log('  - yarn deploy : deploy the project. Make sure you have updated the .env file to match your setup if needed.');
-console.log('  - yarn watch : will build and watch for file modifications, and deploy automatically when changes are detected. Use CTRL+C to stop watching.');
-console.log('  - yarn lint : use to check that your code follows the recommended syntax guidelines. Append --fix to automatically fix most problems.');
-console.log('  - yarn test : to test your project. By default only performs yarn lint but you are encouraged to add your own testing system here.');
-console.log('---');
-console.log('You can also check the documentation available here for more details: https://academy.jahia.com/get-started/developers/templating');

package/package.json

@@ -1,50 +1,39 @@
 {
   "name": "@jahia/create-module",
-  "version": "0.0.10",
-  "license": "MIT",
-  "type": "module",
-  "bin": "./index.js",
+  "version": "0.5.4",
+  "keywords": [
+    "template"
+  ],
+  "homepage": "https://github.com/Jahia/javascript-modules/javascript-create-module",
+  "bugs": {
+    "url": "https://github.com/Jahia/javascript-modules/issues"
+  },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/Jahia/npm-create-module.git"
+    "url": "git+https://github.com:Jahia/javascript-modules.git",
+    "directory": "javascript-create-module"
   },
-  "keywords": [
+  "license": "MIT",
+  "author": "Jahia <support@jahia.com>",
+  "type": "module",
+  "bin": "./index.js",
+  "files": [
     "template"
   ],
-  "author": "Jahia <support@jahia.com>",
-  "bugs": {
-    "url": "https://github.com/Jahia/npm-create-module/issues"
+  "scripts": {
+    "build": "yarn pack --out dist/package.tgz && publint",
+    "lint": "yarn run --top-level lint",
+    "playground-to-template": "rm -rf template && node ./playground-to-template.js",
+    "template-to-playground": "rm -rf playground && create-module playground",
+    "test": "node --test"
   },
-  "homepage": "https://github.com/Jahia/npm-create-module#readme",
   "dependencies": {
-    "camelcase": "^8.0.0",
-    "path": "^0.12.7",
-    "replace-in-file": "^8.2.0",
-    "semver": "^7.5.4",
-    "url": "^0.11.1"
+    "camelcase": "^8.0.0"
   },
   "devDependencies": {
-    "@jahia/eslint-config": "^2.1.2",
-    "@jahia/scripts": "^1.3.7",
-    "eslint": "^8.43.0",
-    "eslint-plugin-jest": "latest",
-    "eslint-plugin-react": "latest",
-    "eslint-plugin-react-hooks": "latest",
-    "jest": "^29.7.0",
-    "jest-each": "^29.7.0",
-    "tar": "^7.4.3"
-  },
-  "scripts": {
-    "lint": "eslint .",
-    "posttest": "yarn lint",
-    "test": "jest tests/"
+    "publint": "^0.3.6"
   },
   "engines": {
-    "node": ">=18.0.0",
-    "yarn": ">=4.0.0"
-  },
-  "jest": {
-    "testTimeout": 60000
-  },
-  "packageManager": "yarn@4.6.0"
-}
+    "node": ">=22.0.0"
+  }
+}

package/template/README.md

@@ -1,4 +1,4 @@
-# $$MODULE_NAME$$
+# Jahia Javascript Module
 
 A simple Jahia Javascript module created using the Javascript module starter project template
 
@@ -10,22 +10,30 @@ If you don't use default configuration for the Docker container name or for Jahi
 
 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
+## Prerequisites
 
-1) Enable Corepack if needed : 
+Yarn is required to build the project.
 
-`enable corepack`
+Please follow the instructions at [Node.js Downloads](https://nodejs.org/en/download) to install Node.js and Yarn. In the dropdown menus, make sure to select Yarn (the _with_) and your operating system (the _for_).
 
-2) Install the dependencies :
+Note: If you are using a Windows machine, you need to run your `yarn` commands in PowerShell (not cmd.exe!). It comes preinstalled on modern Windows versions. In case this is not the case on your machine, [please see Microsoft documentation](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.5).
 
-``yarn``
+## Development
 
-3) Build and run the project :
+1. To compile and package the project:
 
-``yarn watch``
+```
+yarn build
+```
 
-## How to upgrade yarn version to latest stable
+2. To deploy the generated package to your Jahia instance (configured in your [`.env`](.env)):
 
-This command will upgrade yarn  to the latest stable release and update the yarn installer in .yarn/releases
+```
+yarn deploy
+```
 
-``yarn set version stable``
+3. Alternatively, to deploy during development using watch mode:
+
+```
+yarn watch
+```

package/template/{dotenv → dot/env}

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

package/template/dot/github/workflows/build.yml

@@ -0,0 +1,18 @@
+# Build and upload the package on every push
+name: Build
+
+on: push
+
+jobs:
+  build-and-upload:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+      - run: corepack enable
+      - run: yarn install
+      - run: yarn build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: package.tgz
+          path: dist/package.tgz

package/template/dot/gitignore

@@ -0,0 +1,15 @@
+# Intellij
+.idea
+!.idea/jsLinters/**
+!.idea/prettier.xml
+*.iml
+*.ipr
+
+# Node
+dist
+node_modules
+
+#Yarn
+.yarn
+yarn-error.log
+

package/template/dot/idea/prettier.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="PrettierConfiguration">
+    <option name="myConfigurationMode" value="AUTOMATIC" />
+    <option name="myRunOnSave" value="true" />
+  </component>
+</project>

package/template/dot/node-version

@@ -0,0 +1 @@
+v22

package/template/dot/prettierignore

@@ -0,0 +1 @@
+# This file inherits .gitignore, there is no need to copy its content here

package/template/dot/vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["dbaeumer.vscode-eslint", "esbenp.prettier-vscode", "lokalise.i18n-ally"]
+}

package/template/dot/vscode/settings.json

@@ -0,0 +1,8 @@
+{
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.formatOnSave": true,
+  "i18n-ally.extract.keygenStrategy": "random",
+  "i18n-ally.keystyle": "flat",
+  "i18n-ally.localesPaths": ["settings/locales"],
+  "typescript.tsdk": "node_modules/typescript/lib"
+}

package/template/dot/yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

package/template/eslint.config.js

@@ -0,0 +1,25 @@
+// @ts-check
+import { includeIgnoreFile } from "@eslint/compat";
+import eslint from "@eslint/js";
+import tseslint from "typescript-eslint";
+import path from "node:path";
+import globals from "globals";
+import eslintReact from "@eslint-react/eslint-plugin";
+
+export default tseslint.config(
+  {
+    languageOptions: {
+      globals: { ...globals.browser, ...globals.node },
+    },
+  },
+
+  // JS/TS recommended
+  eslint.configs.recommended,
+  { files: ["**/*.ts", "**/*.tsx"], extends: tseslint.configs.recommended },
+
+  // React
+  eslintReact.configs["recommended-typescript"],
+
+  // Ignore the same files as .gitignore
+  includeIgnoreFile(path.resolve(import.meta.dirname, ".gitignore")),
+);

package/template/package.json

@@ -1,61 +1,58 @@
 {
-  "name": "$$MODULE_NAME$$",
-  "version": "0.1.0",
-  "main": "index.js",
-  "license": "MIT",
+  "name": "$MODULE",
+  "version": "0.0.1",
+  "type": "module",
+  "files": [
+    "dist",
+    "src/**/*.cnd",
+    "settings",
+    "static"
+  ],
   "scripts": {
-    "build:development": "webpack --mode=development && jahia-pack",
-    "build:production": "webpack && jahia-pack",
-    "build": "run build:production",
+    "build": "tsc --noEmit && vite build && run package",
     "clean": "rm -rf dist/",
     "deploy": "jahia-deploy",
-    "watch": "webpack --mode=development --watch",
-    "lint": "eslint --ext js,jsx .",
-    "test": "yarn lint"
-  },
-  "jahia": {
-    "snapshot": true,
-    "module-dependencies": "default",
-    "module-type": "$$MODULE_TYPE$$",
-    "module-type-comment": "Use templatesSet in the module type to declare a template set",
-    "server": "main.js",
-    "static-resources": "/icons,/images,/javascript,/locales"
+    "format": "prettier --write --list-different .",
+    "lint": "eslint .",
+    "package": "yarn pack --out dist/package.tgz",
+    "dev": "vite build --watch",
+    "watch": "run dev",
+    "watch:callback": "run package && run deploy"
   },
   "dependencies": {
-    "@jahia/javascript-modules-library": "0.x || ^1.0.0",
-    "graphql": "^16.7.1",
-    "i18next": "^23.10.1",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
-    "react-i18next": "^14.1.0"
+    "canvas-confetti": "^1.9.3",
+    "clsx": "^2.1.1",
+    "modern-normalize": "^3.0.1"
   },
   "devDependencies": {
-    "@babel/cli": "^7.16.0",
-    "@babel/core": "^7.16.0",
-    "@babel/preset-env": "^7.16.4",
-    "@babel/preset-react": "^7.16.0",
-    "@jahia/eslint-config": "^2.1.2",
-    "@jahia/scripts": "^1.3.7",
-    "babel-loader": "^8.2.3",
-    "babel-plugin-transform-react-remove-prop-types": "^0.4.24",
-    "clean-webpack-plugin": "^4.0.0",
-    "copy-webpack-plugin": "^10.0.0",
-    "dotenv-cli": "^4.0.0",
-    "eslint": "^8.43.0",
-    "eslint-plugin-jest": "latest",
-    "eslint-plugin-react": "latest",
-    "eslint-plugin-react-hooks": "latest",
-    "extra-watch-webpack-plugin": "^1.0.3",
-    "styled-jsx": "^5.1.2",
-    "terser-webpack-plugin": "^5.3.10",
-    "typescript": "^5.3.3",
-    "webpack": "^5.64.4",
-    "webpack-cli": "^4.9.1",
-    "webpack-shell-plugin-next": "^2.3.1"
+    "@eslint-react/eslint-plugin": "^1.26.2",
+    "@eslint/compat": "^1.2.6",
+    "@eslint/js": "^9.20.0",
+    "@jahia/javascript-modules-library": "latest",
+    "@jahia/vite-plugin": "latest",
+    "@types/canvas-confetti": "^1.9.0",
+    "@types/react": "^19.0.0",
+    "eslint": "^9.20.1",
+    "eslint-plugin-cypress": "^4.1.0",
+    "globals": "^15.15.0",
+    "i18next": "^23.10.1",
+    "prettier": "^3.5.1",
+    "react-i18next": "^15.4.0",
+    "typescript": "^5.7.3",
+    "typescript-eslint": "^8.24.0",
+    "typescript-plugin-css-modules": "^5.1.0",
+    "vite": "^6.1.0"
   },
+  "packageManager": "yarn@4.7.0",
   "engines": {
-    "node": ">=18.0.0",
+    "node": ">=22.0.0",
     "yarn": ">=4.0.0"
   },
-  "packageManager": "yarn@4.3.1"
+  "jahia": {
+    "snapshot": true,
+    "module-dependencies": "default",
+    "module-type": "templatesSet",
+    "server": "dist/server/index.js",
+    "static-resources": "/dist,/locales,/images,/icons"
+  }
 }

package/template/prettier.config.js

@@ -0,0 +1,8 @@
+/**
+ * @type {import("prettier").Config}
+ * @see https://prettier.io/docs/en/configuration.html
+ */
+export default {
+  quoteProps: "consistent",
+  printWidth: 100,
+};

package/template/settings/README.md

@@ -1,6 +1,7 @@
 # Directory Structure
 
-In this directory, you can directly put: 
+In this directory, you can directly put:
+
 - **Rule files** (`*.drl`, `*.dsl`)
 - **URL rewrite XML files**
 - **import.xml** file
@@ -10,6 +11,7 @@ In this directory, you can directly put:
 ## Configurations Directory
 
 In the `configurations` directory, you can put:
+
 - **OSGi configuration files** (`*.cfg`, `*.yml`)
 
 ## Content Editor Forms Directory

package/template/settings/definitions.cnd

@@ -1,17 +1,12 @@
 <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'>
+<$MODULE = 'https://example.com/$MODULE/1.0'>
 
 // Defining the content types is similar to defining a data model: once deployed, you cannot change the type of a property.
 // If you need to do changes during the development phase, it is possible to remove the definitions from the tools:
 // http://localhost:8080/cms/login?redirect=/modules/tools/definitionsBrowser.jsp however that will remove content created with this type.
 // Learn more about content types definitions here: https://academy.jahia.com/developer/content-types"
 
-
 // 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
-
-[$$MODULE_NAMESPACE$$:simpleContent] > jnt:content, $$MODULE_NAMESPACE$$mix:$$MODULE_NAMESPACE$$Components
- - title (string) = 'Hello world !' i18n
+[$MODULE:component] > jmix:droppableContent, jmix:accessControllableContent mixin