@jahia/create-module 0.0.4 → 0.0.5

package/index.js

@@ -14,7 +14,7 @@ const __dirname = path.dirname(__filename);
 
 // 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;
+const [nodeCommand, npxCommand, projectName, moduleType = 'module', namespace = camelCase(projectName || '')] = process.argv;
 
 if (!projectName) {
     console.log(`\x1B[1m## Usage\x1B[0m
@@ -48,7 +48,40 @@ console.log(`Creating a new Jahia module project \x1B[1m${projectName}\x1B[0m of
 // create a `template` folder which will house the template
 // and the files we want to create.
 const templateDir = path.resolve(__dirname, 'template');
-fs.cpSync(templateDir, projectDir, {recursive: true});
+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'));
+    }
+});
+
+// Find and replace all markers with the appropriate substitution values
+// Doing it before renaming the dotfiles so they are not excluded
+const targetFiles = `${projectDir}/**`;
+
+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
+    });
+} catch (error) {
+    console.error('Error occurred:', error);
+}
 
 // It is good practice to have dotfiles stored in the
 // template without the dot (so they do not get picked
@@ -74,48 +107,28 @@ fs.renameSync(
 
 // 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')
+    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')
+    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, 'css'), {recursive: true});
 fs.mkdirSync(path.join(projectDir, 'images'), {recursive: true});
 fs.mkdirSync(path.join(projectDir, 'javascript'), {recursive: true});
-fs.mkdirSync(path.join(projectDir, 'settings/configurations'), {recursive: true});
-fs.mkdirSync(path.join(projectDir, 'settings/jahia-content-editor-forms'), {recursive: true});
-fs.mkdirSync(path.join(projectDir, 'settings/jahia-content-editor-forms/forms'), {recursive: true});
-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 = `${projectDir}/**`;
-
-try {
-    replaceInFileSync({
-        files: targetFiles,
-        from: /\$\$MODULE_TYPE\$\$/g,
-        to: camelCase(moduleType)
-    });
-
-    replaceInFileSync({
-        files: targetFiles,
-        from: /\$\$MODULE_NAME\$\$/g,
-        to: projectName
-    });
-
-    replaceInFileSync({
-        files: targetFiles,
-        from: /\$\$MODULE_NAMESPACE\$\$/g,
-        to: namespace
-    });
-} catch (error) {
-    console.error('Error occurred:', error);
-}
+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});
 
 console.log(`Created \x1B[1m${projectName}\x1B[0m at \x1B[1m${projectDir}\x1B[0m`);
 console.log('Success! Your new project is ready.');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jahia/create-module",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "license": "MIT",
   "type": "module",
   "bin": "./index.js",

package/template/doteslintrc.cjs

@@ -25,5 +25,6 @@ module.exports = {
     },
     ignorePatterns: ['dist', 'css', 'javascript'],
     rules: {
+        'react/prop-types': 'off'
     }
 };

package/template/dotgitignore

@@ -16,3 +16,6 @@ node_modules
 !.yarn/sdks
 !.yarn/versions
 yarn-error.log
+
+# generated .tgz file
+$$MODULE_NAME$$-*.tgz

package/template/package.json

@@ -8,7 +8,7 @@
     "build:production": "webpack --mode=production && jahia-pack",
     "deploy": "jahia-deploy",
     "watch": "webpack --mode=development --watch",
-    "lint": "eslint .",
+    "lint": "eslint --ext js,jsx .",
     "test": "yarn lint"
   },
   "jahia": {
@@ -16,7 +16,7 @@
     "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"
+    "static-resources": "/css,/icons,/images,/javascript,/locales"
   },
   "dependencies": {
     "@jahia/js-server-core": "^0.0.13",

package/template/settings/definitions.cnd

@@ -13,5 +13,5 @@
 // to see in this category.
 [$$MODULE_NAMESPACE$$mix:$$MODULE_NAMESPACE$$Components] > jmix:droppableContent, jmix:accessControllableContent mixin
 
-[$$MODULE_NAMESPACE$$:hello] > jnt:content, $$MODULE_NAMESPACE$$mix:$$MODULE_NAMESPACE$$Components
- - textHello (string) = 'Hello world !' i18n
+[$$MODULE_NAMESPACE$$:simpleContent] > jnt:content, $$MODULE_NAMESPACE$$mix:$$MODULE_NAMESPACE$$Components
+ - title (string) = 'Hello world !' i18n

package/template/settings/resources/MODULE_NAME.properties

@@ -1,3 +1,3 @@
 $$MODULE_NAMESPACE$$mix_$$MODULE_NAMESPACE$$Components = $$MODULE_NAMESPACE$$ Components
-$$MODULE_NAMESPACE$$_hello=Hello
-$$MODULE_NAMESPACE$$_hello.textHello=Hello world !
+$$MODULE_NAMESPACE$$_simpleContent=Simple Content
+$$MODULE_NAMESPACE$$_simpleContent.title=Title

package/template/settings/resources/MODULE_NAME_fr.properties

@@ -1,3 +1,3 @@
 $$MODULE_NAMESPACE$$mix_$$MODULE_NAMESPACE$$Components = Composants $$MODULE_NAMESPACE$$ 
-$$MODULE_NAMESPACE$$_hello=Bonjour
-$$MODULE_NAMESPACE$$_hello.textHello=Bonjour le monde !
+$$MODULE_NAMESPACE$$_simpleContent=Contenu simple
+$$MODULE_NAMESPACE$$_simpleContent.title=Titre

package/template/src/client/index.jsx

@@ -2,4 +2,4 @@
 // Since JS can be aggregated by Jahia on live, the path of the original file is lost
 // Also the context of the server should be handled properly
 // eslint-disable-next-line camelcase, no-undef
-__webpack_public_path__ = `${window.__APPSHELL_INIT_DATA__.moduleBaseUrl}/$$MODULE_NAME$$/javascript/client/`;
+__webpack_public_path__ = `${window.__APPSHELL_INIT_DATA__.moduleBaseUrl}/$$MODULE_NAME$$/javascript/client/`;

package/template/src/server/templates/page/PageHome.jsx

@@ -6,20 +6,22 @@ export const PageHome = () => {
     const {t} = useTranslation();
     const {currentResource} = useServerContext();
     const lang = currentResource.getLocale().getLanguage();
-    return (<html lang={lang}>
-        <head>
-            <AddResources type='css' resources='styles.css' />
-            <title>Home</title>
-        </head>
-        <body>
-            <main>
-                {/* Using i18next defined in locales */}
-                <h1>{t('homeTitle')}</h1>
-                <Area name="pagecontent" />
-            </main>
-        </body>
-    </html>);
-}
+    return (
+        <html lang={lang}>
+            <head>
+                <AddResources type="css" resources="styles.css"/>
+                <title>Home</title>
+            </head>
+            <body>
+                <main>
+                    {/* Using i18next defined in locales */}
+                    <h1>{t('homeTitle')}</h1>
+                    <Area name="pagecontent"/>
+                </main>
+            </body>
+        </html>
+    );
+};
 
 PageHome.jahiaComponent = defineJahiaComponent({
     nodeType: 'jnt:page',

package/template/src/server/views/index.js

@@ -1 +1 @@
-export * from './hello';
+export * from './simpleContent';

package/template/src/server/views/simpleContent/SimpleContentDefault.jsx

@@ -0,0 +1,19 @@
+import React from 'react';
+import {useServerContext, getNodeProps, defineJahiaComponent} from '@jahia/js-server-core';
+
+export const SimpleContentDefault = () => {
+    const {currentNode} = useServerContext();
+    const simpleContent = getNodeProps(currentNode, ['title']);
+    return (
+        <div>
+            <h2>{simpleContent.title}</h2>
+        </div>
+    );
+};
+
+SimpleContentDefault.jahiaComponent = defineJahiaComponent({
+    name: 'default',
+    nodeType: '$$MODULE_NAMESPACE$$:simpleContent',
+    displayName: 'Simple Content (default)',
+    componentType: 'view'
+});

package/template/src/server/views/simpleContent/index.js

@@ -0,0 +1 @@
+export * from './SimpleContentDefault';

package/template/src/server/views/hello/HelloDefault.jsx

@@ -1,19 +0,0 @@
-import React from 'react'
-import {useServerContext, getNodeProps, defineJahiaComponent} from '@jahia/js-server-core'
-
-export const HelloDefault = () => {
-    const { currentNode } = useServerContext();
-    const props = getNodeProps(currentNode, ['textHello']);
-    return (
-        <div>
-            <h2>{props.textHello}</h2>
-        </div>
-    )
-}
-
-HelloDefault.jahiaComponent = defineJahiaComponent({
-    name: 'default',
-    nodeType: '$$MODULE_NAMESPACE$$:hello',
-    displayName: 'Hello (default)',
-    componentType: 'view'
-});

package/template/src/server/views/hello/index.js

@@ -1 +0,0 @@
-export * from './HelloDefault';