npm - @jahia/create-module - Versions diffs - 0.0.10 → 0.5.4 - Mend

@jahia/create-module 0.0.10 → 0.5.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (91) hide show

package/LICENSE +1 -1
package/README.md +3 -2
package/index.js +82 -130
package/package.json +26 -37
package/template/README.md +19 -11
package/template/{dotenv → dot/env} +1 -1
package/template/dot/github/workflows/build.yml +18 -0
package/template/dot/gitignore +15 -0
package/template/dot/idea/prettier.xml +7 -0
package/template/dot/node-version +1 -0
package/template/dot/prettierignore +1 -0
package/template/dot/vscode/extensions.json +3 -0
package/template/dot/vscode/settings.json +8 -0
package/template/dot/yarnrc.yml +1 -0
package/template/eslint.config.js +25 -0
package/template/package.json +45 -48
package/template/prettier.config.js +8 -0
package/template/settings/README.md +3 -1
package/template/settings/content-types-icons/$MODULE_HelloCard.png +0 -0
package/template/settings/content-types-icons/$MODULE_HelloWorld.png +0 -0
package/template/settings/content-types-icons/$MODULE_LanguageSwitcher.png +0 -0
package/template/settings/content-types-icons/$MODULE_component.png +0 -0
package/template/settings/definitions.cnd +2 -7
package/template/settings/import.xml +104 -8
package/template/settings/locales/en.json +11 -4
package/template/settings/locales/fr.json +11 -4
package/template/settings/resources/$MODULE.properties +15 -0
package/template/settings/resources/$MODULE_fr.properties +15 -0
package/template/src/components/HelloCard/component.module.css +14 -0
package/template/src/components/HelloCard/default.server.tsx +18 -0
package/template/src/components/HelloCard/definition.cnd +3 -0
package/template/src/components/HelloWorld/Celebrate.client.tsx +30 -0
package/template/src/components/HelloWorld/component.module.css +105 -0
package/template/src/components/HelloWorld/default.server.tsx +85 -0
package/template/src/components/HelloWorld/definition.cnd +3 -0
package/template/src/components/LanguageSwitcher/component.module.css +5 -0
package/template/src/components/LanguageSwitcher/default.server.tsx +45 -0
package/template/src/components/LanguageSwitcher/definition.cnd +1 -0
package/template/src/pages/Layout.tsx +24 -0
package/template/src/pages/basic.server.tsx +16 -0
package/template/src/pages/global.css +11 -0
package/template/src/types.d.ts +1 -0
package/template/static/arrows/bottom.svg +1 -0
package/template/static/arrows/left.svg +1 -0
package/template/static/illustrations/code.svg +1 -0
package/template/static/illustrations/coffee.svg +1 -0
package/template/static/illustrations/interface.svg +1 -0
package/template/static/illustrations/read.svg +1 -0
package/template/static/illustrations/write.svg +1 -0
package/template/tsconfig.json +19 -0
package/template/vite.config.mjs +29 -0
package/.eslintrc.cjs +0 -28
package/.github/ISSUE_TEMPLATE/bug.yml +0 -45
package/.github/ISSUE_TEMPLATE/config.yml +0 -8
package/.github/ISSUE_TEMPLATE/epic.md +0 -26
package/.github/ISSUE_TEMPLATE/other.md +0 -8
package/.github/ISSUE_TEMPLATE/release.md +0 -74
package/.github/ISSUE_TEMPLATE/spike.md +0 -19
package/.github/ISSUE_TEMPLATE/story.md +0 -27
package/.github/ISSUE_TEMPLATE/support.yml +0 -40
package/.github/ISSUE_TEMPLATE/tech-day.md +0 -93
package/.github/dependabot.yml +0 -15
package/.github/release.yml +0 -24
package/.github/workflows/delivery-issue-chores.yml +0 -12
package/.github/workflows/on-code-change.yml +0 -50
package/.github/workflows/publish-release.yml +0 -22
package/.yarn/releases/yarn-4.6.0.cjs +0 -934
package/.yarnrc.yml +0 -3
package/babel.config.cjs +0 -6
package/template/.babelrc +0 -9
package/template/.yarn/releases/yarn-4.3.1.cjs +0 -894
package/template/.yarnrc.yml +0 -3
package/template/doteslintrc.cjs +0 -30
package/template/dotgitignore +0 -21
package/template/dotnpmignore +0 -10
package/template/settings/content-types-icons/MODULE_NAMESPACE_simpleContent.png +0 -0
package/template/settings/locales/de.json +0 -5
package/template/settings/resources/MODULE_NAME.properties +0 -3
package/template/settings/resources/MODULE_NAME_fr.properties +0 -3
package/template/src/client/index.jsx +0 -5
package/template/src/server/components/index.js +0 -1
package/template/src/server/index.js +0 -6
package/template/src/server/templates/index.js +0 -1
package/template/src/server/templates/page/PageHome.jsx +0 -32
package/template/src/server/templates/page/index.js +0 -1
package/template/src/server/views/index.js +0 -1
package/template/src/server/views/simpleContent/SimpleContentDefault.jsx +0 -19
package/template/src/server/views/simpleContent/index.js +0 -1
package/template/static/css/styles.css +0 -8
package/template/webpack.config.js +0 -225
package/tests/create-templatesSet-project.test.js +0 -124

package/template/.yarnrc.yml DELETED Viewed

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

package/template/doteslintrc.cjs DELETED Viewed

@@ -1,30 +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', 'css', 'javascript'],
-    rules: {
-        'react/prop-types': 'off'
-    }
-};

package/template/dotgitignore DELETED Viewed

@@ -1,21 +0,0 @@
-# Intellij
-.idea
-*.iml
-*.ipr
-# Node
-dist
-node_modules
-#Yarn
-.yarn/*
-!.yarn/cache
-!.yarn/patches
-!.yarn/plugins
-!.yarn/releases
-!.yarn/sdks
-!.yarn/versions
-yarn-error.log
-# generated .tgz file
-$$MODULE_NAME$$-*.tgz

package/template/dotnpmignore DELETED Viewed

@@ -1,10 +0,0 @@
-.env
-.eslintrc.cjs
-.idea
-*.tgz
-.yarn
-.vscode
-webpack.config.js
-README.md
-settings/README.md
-src

package/template/settings/content-types-icons/MODULE_NAMESPACE_simpleContent.png DELETED Viewed

Binary file

package/template/settings/locales/de.json DELETED Viewed

@@ -1,5 +0,0 @@
-{
-  "greeting": "Hallo !",
-  "welcomeTitle" : "Willkommen bei Jahia!",
-  "homeTitle": "Startvorlage"
-}

package/template/settings/resources/MODULE_NAME.properties DELETED Viewed

@@ -1,3 +0,0 @@
-$$MODULE_NAMESPACE$$mix_$$MODULE_NAMESPACE$$Components = $$MODULE_NAMESPACE$$ Components
-$$MODULE_NAMESPACE$$_simpleContent=Simple Content
-$$MODULE_NAMESPACE$$_simpleContent.title=Title

package/template/settings/resources/MODULE_NAME_fr.properties DELETED Viewed

@@ -1,3 +0,0 @@
-$$MODULE_NAMESPACE$$mix_$$MODULE_NAMESPACE$$Components = Composants $$MODULE_NAMESPACE$$
-$$MODULE_NAMESPACE$$_simpleContent=Contenu simple
-$$MODULE_NAMESPACE$$_simpleContent.title=Titre

package/template/src/client/index.jsx DELETED Viewed

@@ -1,5 +0,0 @@
-// PublicPath is used to make webpack able to download the chunks and assets from the correct location
-// 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/`;

package/template/src/server/components/index.js DELETED Viewed

	@@ -1 +0,0 @@
1	- // Export here any components that were added to this directory

package/template/src/server/index.js DELETED Viewed

@@ -1,6 +0,0 @@
-import * as jahiaTemplates from './templates';
-import * as jahiaViews from './views';
-import {registerJahiaComponents} from '@jahia/javascript-modules-library';
-registerJahiaComponents(jahiaTemplates);
-registerJahiaComponents(jahiaViews);

package/template/src/server/templates/index.js DELETED Viewed

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

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

@@ -1,32 +0,0 @@
-import React from 'react';
-import {AddResources, Area, defineJahiaComponent, useServerContext, useUrlBuilder} from '@jahia/javascript-modules-library';
-import {useTranslation} from 'react-i18next';
-export const PageHome = () => {
-    const {t} = useTranslation();
-    const {currentResource} = useServerContext();
-    const {buildStaticUrl} = useUrlBuilder();
-    const lang = currentResource.getLocale().getLanguage();
-    return (
-        <html lang={lang}>
-            <head>
-                <AddResources type="css" resources={buildStaticUrl({assetPath: 'css/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',
-    name: 'home',
-    displayName: 'Home page',
-    componentType: 'template'
-});

package/template/src/server/templates/page/index.js DELETED Viewed

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

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

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

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

@@ -1,19 +0,0 @@
-import React from 'react';
-import {useServerContext, getNodeProps, defineJahiaComponent} from '@jahia/javascript-modules-library';
-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 DELETED Viewed

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

package/template/static/css/styles.css DELETED Viewed

@@ -1,8 +0,0 @@
-body {
-    font-family: 'Helvetica Neue', Arial, sans-serif;
-    margin: 0;
-    padding: 40px;
-    background-color: #f5f5f5;
-    color: #333;
-    line-height: 1.6;
-}

package/template/webpack.config.js DELETED Viewed

@@ -1,225 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-const CopyWebpackPlugin = require('copy-webpack-plugin');
-const ModuleFederationPlugin = require('webpack/lib/container/ModuleFederationPlugin');
-const WebpackShellPluginNext = require('webpack-shell-plugin-next');
-const ExtraWatchWebpackPlugin = require('extra-watch-webpack-plugin');
-const TerserPlugin = require('terser-webpack-plugin');
-const deps = require('./package.json').dependencies;
-// Read all files in the client components directory in order to expose them with webpack module federation more easily
-// Those components are exposed in order to be hydrate/rendered client side
-const componentsDir = './src/client';
-const exposes = {};
-fs.readdirSync(componentsDir).forEach(file => {
-    if (file !== 'index.js') {
-        const componentName = path.basename(file, path.extname(file));
-        exposes[componentName] = path.resolve(componentsDir, file);
-    }
-});
-const moduleName = '$$MODULE_NAME$$';
-const buildOutput = path.resolve(__dirname, 'dist/build');
-const filesToCopyAsIs = ['static/', 'settings/', 'package.json', 'yarn.lock'];
-const copyAsIsPatterns = filesToCopyAsIs.map(dir => ({
-    from: dir,
-    to: path.join(buildOutput, dir)
-}));
-module.exports = (env, argv) => {
-    const isDevelopment = argv.mode === 'development';
-    const mode = isDevelopment ? 'development' : 'production';
-    console.log('Building in', mode, 'mode...');
-    let optimization = isDevelopment ? {} : {
-        minimizer: [
-            // This is required to make hydration working, as its implementation relies on the class name of the React component.
-            // See InBrowser.jsx in javascript-modules-library for details
-            new TerserPlugin({
-                terserOptions: {
-                    // eslint-disable-next-line camelcase
-                    keep_classnames: true,
-                    // eslint-disable-next-line camelcase
-                    keep_fnames: true
-                }
-            })
-        ]
-    };
-    let configs = [
-        // Config for jahia's client-side components (HydrateInBrowser or RenderInBrowser)
-        // This config can be removed if the module doesn't contain client-side components
-        // More info here : https://academy.jahia.com/documentation/jahia/jahia-8/developer/javascript-module-development/client-side-javascript
-        {
-            name: 'client',
-            entry: {
-                [moduleName]: path.resolve(__dirname, './src/client/index')
-            },
-            output: {
-                path: path.join(buildOutput, 'javascript/client')
-            },
-            resolve: {
-                mainFields: ['module', 'main'],
-                extensions: ['.mjs', '.js', '.jsx']
-            },
-            module: {
-                rules: [
-                    {
-                        test: /\.jsx$/,
-                        include: [path.join(__dirname, 'src/client')],
-                        use: {
-                            loader: 'babel-loader',
-                            options: {
-                                presets: [
-                                    ['@babel/preset-env', {modules: false, targets: {safari: '7', ie: '10'}}],
-                                    '@babel/preset-react'
-                                ],
-                                plugins: [
-                                    'styled-jsx/babel',
-                                    !isDevelopment && 'transform-react-remove-prop-types'
-                                ].filter(Boolean)
-                            }
-                        }
-                    }
-                ]
-            },
-            devtool: isDevelopment ? 'inline-source-map' : 'source-map',
-            plugins: [
-                // This plugin allows a build to provide or consume modules with other independent builds at runtime.
-                new ModuleFederationPlugin({
-                    name: moduleName,
-                    library: {type: 'assign', name: `window.appShell = (typeof appShell === "undefined" ? {} : appShell); window.appShell['${moduleName}']`},
-                    filename: '../client/remote.js',
-                    exposes: exposes,
-                    shared: {
-                        react: {
-                            requiredVersion: deps.react,
-                            singleton: true
-                        },
-                        'react-i18next': {},
-                        i18next: {}
-                    }
-                })
-            ]
-        },
-        {
-            name: 'copy-as-is',
-            plugins: [
-                new CopyWebpackPlugin({
-                    patterns: copyAsIsPatterns
-                })
-            ]
-        },
-        // Config for jahia's server-side components (using SSR) and source code
-        // 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)
-        {
-            name: 'server',
-            entry: {
-                main: path.resolve(__dirname, 'src/server')
-            },
-            output: {
-                path: buildOutput
-            },
-            externals: {
-                // Those libraries are supplied to webpack at runtime (by the npm-module-engine project), and are not packaged in the output bundle
-                '@jahia/javascript-modules-library': 'javascriptModulesLibraryBuilder.getLibrary()',
-                react: 'javascriptModulesLibraryBuilder.getSharedLibrary(\'react\')',
-                'react-i18next': 'javascriptModulesLibraryBuilder.getSharedLibrary(\'react-i18next\')',
-                i18next: 'javascriptModulesLibraryBuilder.getSharedLibrary(\'i18next\')',
-                'styled-jsx/style': 'javascriptModulesLibraryBuilder.getSharedLibrary(\'styled-jsx\')'
-            },
-            resolve: {
-                mainFields: ['module', 'main'],
-                extensions: ['.mjs', '.js', '.jsx']
-            },
-            module: {
-                rules: [
-                    {
-                        test: /\.jsx$/,
-                        include: [
-                            path.join(__dirname, 'src/server'),
-                            path.join(__dirname, 'src/client')
-                        ],
-                        use: {
-                            loader: 'babel-loader',
-                            options: {
-                                presets: [
-                                    ['@babel/preset-env', {modules: false, targets: {safari: '7', ie: '10'}}],
-                                    '@babel/preset-react'
-                                ],
-                                plugins: [
-                                    'styled-jsx/babel',
-                                    !isDevelopment && 'transform-react-remove-prop-types'
-                                ].filter(Boolean)
-                            }
-                        }
-                    },
-                    {
-                        test: /\.s[ac]ss$/i,
-                        use: [
-                            'style-loader',
-                            {
-                                loader: 'css-loader',
-                                options: {
-                                    modules: true
-                                }
-                            },
-                            'sass-loader'
-                        ]
-                    }
-                ]
-            },
-            devtool: isDevelopment ? 'inline-source-map' : 'source-map',
-            optimization: optimization
-        }
-    ];
-    // In case of watch we add a final config that will do automatic shell commands to trigger the pack and deploy scripts
-    // 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 (argv.watch) {
-        // Sleep time in seconds, can be adjusted
-        const sleepTime = 5;
-        configs.push({
-            name: 'watch',
-            dependencies: ['client', 'server', 'copy-as-is'], // Wait for all webpack configs to be done
-            entry: {},
-            output: {},
-            plugins: [
-                new ExtraWatchWebpackPlugin({
-                    // This is an extra list of files to watch for changes,
-                    // It should include all files that are not already part of any webpack build
-                    // Also do not watch for webpack generated files places, it can cause infinite loops of watch triggers
-                    // for example, if your css is generated by webpack compiling scss, then:
-                    // - do not add extra watch for 'dist/build/static/css/**/*' -> it's the output of webpack scss build
-                    // - do not add extra watch for 'src/scss/**/*' either, as it's already watched by webpack related config.
-                    files: [
-                    ]
-                }),
-                new WebpackShellPluginNext({
-                    onAfterDone: {
-                        scripts: [
-                            'yarn jahia-pack',
-                            'yarn jahia-deploy',
-                            process.platform === 'win32' ? 'timeout ' + sleepTime : 'sleep ' + sleepTime
-                        ],
-                        blocking: true,
-                        parallel: false
-                    }
-                })
-            ]
-        });
-    }
-    configs.forEach(config => {
-        // Ensure no default entry points are used
-        if (!config.entry) {
-            config.entry = {};
-        }
-        // Set the mode development/production
-        config.mode = mode;
-    });
-    return configs;
-};

package/tests/create-templatesSet-project.test.js DELETED Viewed

@@ -1,124 +0,0 @@
-import {execSync} from 'child_process';
-import fs from 'fs';
-import os from 'os';
-import path from 'path';
-import * as tar from 'tar';
-import each from 'jest-each';
-let tempFolder;
-beforeAll(() => {
-    // Create a temporary directory
-    tempFolder = fs.mkdtempSync(os.tmpdir());
-    console.log('Using temp folder ', tempFolder);
-});
-afterAll(() => {
-    // Remove the temporary directory
-    fs.rmSync(tempFolder, {recursive: true, force: true});
-    console.log(`Temp folder ${tempFolder} removed.`);
-});
-describe('npx @jahia/create-module', () => {
-    each([
-        ['test-project', 'testProject', 'templatesSet'],
-        ['otherSampleProject', 'otherSampleProject', 'module'],
-        ['foo', 'foo', '']
-    ]).it('Project creation using archetype (\'%s\'/\'%s\' with moduleType \'%s\')', async (projectName, projectNameSanitized, moduleType) => {
-        // Create a temporary directory
-        const tempDir = fs.mkdtempSync(path.join(tempFolder, projectNameSanitized));
-        console.log('tempDir', tempDir);
-        const parentFolder = path.dirname(__dirname);
-        const indexFile = path.join(parentFolder, 'index.js');
-        const isTemplatesSet = moduleType === 'templatesSet';
-        // Create a new test-project from within the temp directory
-        process.chdir(tempDir);
-        console.log(execSync(`node ${indexFile} ${projectName} ${moduleType}`).toString());
-        const projectPath = path.join(tempDir, projectName);
-        expect(fs.existsSync(projectPath)).toBe(true);
-        // TODO check the replacement of the markers in the files
-        // Validate the generated project structure
-        const expectedFiles = [
-            // Make sure the dot files have been renamed
-            '.gitignore',
-            '.npmignore',
-            '.env',
-            '.eslintrc.cjs',
-            // Make sure the renaming with MODULE_NAME is correct
-            `settings/resources/${projectName}.properties`,
-            `settings/resources/${projectName}_fr.properties`,
-            `settings/content-types-icons/${projectNameSanitized}_simpleContent.png`,
-            // Make sure the static and config folders exist
-            'static/css',
-            'static/images',
-            'static/javascript',
-            'settings/configurations',
-            'settings/content-editor-forms/forms',
-            'settings/content-editor-forms/fieldsets',
-            'yarn.lock'
-        ];
-        if (moduleType === 'templatesSet') {
-            // This file should only exist for templates set
-            expectedFiles.push('settings/template-thumbnail.png');
-        }
-        expectedFiles.forEach(file => {
-            console.log(`Testing that ${file} exists...`);
-            expect(fs.existsSync(path.join(projectPath, file))).toBe(true);
-        });
-        // Install & build the project
-        process.chdir(projectPath);
-        // YARN_ENABLE_IMMUTABLE_INSTALLS=false is used as the yarn.lock file gets updated
-        // Without this flag, the following error is encountered: "The lockfile would have been created by this install, which is explicitly forbidden."
-        console.log(execSync('YARN_ENABLE_IMMUTABLE_INSTALLS=false yarn install').toString());
-        console.log(execSync('yarn build').toString());
-        // Make sure the tgz file is created in the dist/ folder
-        const tgzFilePath = path.join(projectPath, 'dist', `${projectName}-v0.1.0-SNAPSHOT.tgz`);
-        expect(fs.existsSync(tgzFilePath)).toBe(true);
-        // Check the contents of the tgz file
-        const expectedFilesInArchive = [
-            'javascript/client/remote.js',
-            'javascript/client/remote.js.map',
-            `settings/content-types-icons/${projectNameSanitized}_simpleContent.png`,
-            'settings/locales/de.json',
-            'settings/locales/en.json',
-            'settings/locales/fr.json',
-            `settings/resources/${projectName}.properties`,
-            `settings/resources/${projectName}_fr.properties`,
-            'settings/definitions.cnd',
-            'settings/import.xml',
-            'settings/README.md',
-            isTemplatesSet && 'settings/template-thumbnail.png',
-            'static/css/styles.css',
-            'main.js',
-            'main.js.map',
-            'package.json'
-        ].filter(Boolean);
-        const entries = [];
-        await tar.list({
-            file: tgzFilePath,
-            onReadEntry: entry => {
-                entries.push(entry.path);
-            }
-        }).then(() => {
-            expectedFilesInArchive.forEach(file => {
-                console.log(`Testing that ${file} exists in the archive...`);
-                expect(entries.includes(`package/${file}`)).toBe(true);
-            });
-            expect(entries.length).toBe(expectedFilesInArchive.length);
-        });
-        // Make sure the package.json contains the dependency @jahia/javascript-modules-library
-        const packageJson = JSON.parse(fs.readFileSync(path.join(projectPath, 'package.json'), 'utf8'));
-        expect(packageJson.dependencies['@jahia/javascript-modules-library']).toBeDefined();
-    }
-    );
-});