create-module-federation 0.0.0-1737428758075

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-present hanric(2heal1)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1 @@
+# `create-module-federation`

package/dist/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-present hanric(2heal1)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.js

@@ -0,0 +1,342 @@
+import * as __WEBPACK_EXTERNAL_MODULE_path__ from "path";
+import * as __WEBPACK_EXTERNAL_MODULE_fs__ from "fs";
+import * as __WEBPACK_EXTERNAL_MODULE__clack_prompts_3cae1695__ from "@clack/prompts";
+import * as __WEBPACK_EXTERNAL_MODULE_minimist__ from "minimist";
+import * as __WEBPACK_EXTERNAL_MODULE_rslog__ from "rslog";
+import * as __WEBPACK_EXTERNAL_MODULE_glob__ from "glob";
+import * as __WEBPACK_EXTERNAL_MODULE_fs_extra_ce68a66b__ from "fs-extra";
+import * as __WEBPACK_EXTERNAL_MODULE_handlebars__ from "handlebars";
+const IMAGE_EXT_LIST = [
+    '.jpg',
+    '.jpeg',
+    '.png',
+    '.gif',
+    '.bmp',
+    '.ico',
+    '.icon',
+    '.mpt',
+    '.psd',
+    '.wmf'
+];
+const FS_RESOURCE = '_mf_fs_resource';
+class FsResource {
+    constructor(filePath, resourceKey){
+        this._type = FS_RESOURCE;
+        this.filePath = filePath;
+        this.resourceKey = resourceKey;
+    }
+    async value() {
+        const resourceFileExt = __WEBPACK_EXTERNAL_MODULE_path__["default"].extname(this.filePath);
+        if (IMAGE_EXT_LIST.includes(resourceFileExt)) {
+            const buffer = await __WEBPACK_EXTERNAL_MODULE_fs_extra_ce68a66b__["default"].readFile(__WEBPACK_EXTERNAL_MODULE_path__["default"].resolve(this.filePath));
+            return {
+                content: buffer
+            };
+        }
+        const text = await __WEBPACK_EXTERNAL_MODULE_fs_extra_ce68a66b__["default"].readFile(__WEBPACK_EXTERNAL_MODULE_path__["default"].resolve(this.filePath), 'utf8');
+        return {
+            content: text
+        };
+    }
+}
+const promisifyGlob = (pattern, options)=>new Promise((resolve, reject)=>{
+        (0, __WEBPACK_EXTERNAL_MODULE_glob__["default"])(pattern, options, (err, files)=>null === err ? resolve(files) : reject(err));
+    });
+class FsMaterial {
+    constructor(basePath){
+        this.basePath = basePath;
+    }
+    get(resourceKey) {
+        return new FsResource(__WEBPACK_EXTERNAL_MODULE_path__["default"].resolve(this.basePath, resourceKey), resourceKey);
+    }
+    async find(globStr, options) {
+        const matches = await promisifyGlob(globStr, {
+            cwd: __WEBPACK_EXTERNAL_MODULE_path__["default"].resolve(this.basePath),
+            nodir: options?.nodir,
+            dot: options?.dot,
+            ignore: options?.ignore
+        });
+        return matches.reduce((pre, cur)=>{
+            pre[cur] = new FsResource(__WEBPACK_EXTERNAL_MODULE_path__["default"].resolve(this.basePath, cur), cur);
+            return pre;
+        }, {});
+    }
+}
+function renderString(template, fullData) {
+    return __WEBPACK_EXTERNAL_MODULE_handlebars__["default"].compile(template)(fullData) || '';
+}
+async function outputFs(file, content, outputPath, options) {
+    const filePath = __WEBPACK_EXTERNAL_MODULE_path__["default"].resolve(outputPath, file.toString());
+    await __WEBPACK_EXTERNAL_MODULE_fs_extra_ce68a66b__["default"].mkdirp(__WEBPACK_EXTERNAL_MODULE_path__["default"].dirname(filePath));
+    await __WEBPACK_EXTERNAL_MODULE_fs_extra_ce68a66b__["default"].writeFile(filePath, content, options);
+}
+class HandlebarsAPI {
+    async renderTemplate(templateResource, target, outputFilePath, parameters = {}) {
+        if (templateResource._type !== FS_RESOURCE) throw new Error('resource not match');
+        const resourceValue = await templateResource.value();
+        if ('string' != typeof resourceValue.content) throw new Error(`resource.value is not string, resourceValue=${resourceValue}`);
+        await outputFs(target, renderString(resourceValue.content, parameters), outputFilePath, {
+            encoding: 'utf-8'
+        });
+    }
+    async renderTemplateDir(material, findGlob, target, outputFilePath, options) {
+        const resourceMap = await material.find(findGlob, {
+            nodir: true,
+            ...options
+        });
+        await Promise.all(Object.keys(resourceMap).map(async (resourceKey)=>{
+            await this.renderTemplate(material.get(resourceKey), target(resourceKey), outputFilePath, options?.parameters);
+        }));
+    }
+}
+function upperFirst(str) {
+    return str.charAt(0).toUpperCase() + str.slice(1);
+}
+function logHelpMessage(name, templates) {
+    __WEBPACK_EXTERNAL_MODULE_rslog__.logger.log(`
+   Usage: create-${name} [options]
+
+   Options:
+
+     -h, --help       display help for command
+     -d, --dir        create project in specified directory
+     -t, --template   specify the template to use
+     --override       override files in target directory
+
+   Templates:
+
+     ${templates.join(', ')}
+`);
+}
+function pkgFromUserAgent(userAgent) {
+    if (!userAgent) return;
+    const pkgSpec = userAgent.split(' ')[0];
+    const pkgSpecArr = pkgSpec.split('/');
+    return {
+        name: pkgSpecArr[0],
+        version: pkgSpecArr[1]
+    };
+}
+function cancelAndExit() {
+    (0, __WEBPACK_EXTERNAL_MODULE__clack_prompts_3cae1695__.cancel)('Operation cancelled.');
+    process.exit(0);
+}
+function checkCancel(value) {
+    if ((0, __WEBPACK_EXTERNAL_MODULE__clack_prompts_3cae1695__.isCancel)(value)) cancelAndExit();
+    return value;
+}
+function formatDir(input) {
+    return {
+        targetDir: input.trim().replace(/\/+$/g, '')
+    };
+}
+function isEmptyDir(path) {
+    const files = __WEBPACK_EXTERNAL_MODULE_fs__["default"].readdirSync(path);
+    return 0 === files.length || 1 === files.length && '.git' === files[0];
+}
+async function getAppTemplateName({ roleType, framework }, { template }) {
+    if (template) return `${template}-ts`;
+    let providerInfo = {
+        name: '',
+        entry: ''
+    };
+    if ('consumer' === roleType) {
+        const providerName = checkCancel(await (0, __WEBPACK_EXTERNAL_MODULE__clack_prompts_3cae1695__.text)({
+            message: 'Please input your provider name (You can skip by press "enter"):',
+            defaultValue: ''
+        }));
+        if (providerName) {
+            providerInfo.name = providerName;
+            const providerEntry = checkCancel(await (0, __WEBPACK_EXTERNAL_MODULE__clack_prompts_3cae1695__.text)({
+                message: `Please input your provider("${providerName}") entry:`,
+                validate (value) {
+                    if (0 === value.length) return 'Entry is required';
+                }
+            }));
+            providerInfo.entry = providerEntry;
+        }
+    }
+    return `${roleType}-${framework}-ts`;
+}
+async function getLibTemplateName({ template }) {
+    if (template) return `${template}-ts`;
+    const templateName = checkCancel(await (0, __WEBPACK_EXTERNAL_MODULE__clack_prompts_3cae1695__.select)({
+        message: 'Select template',
+        options: [
+            {
+                value: 'rslib',
+                label: 'Rslib'
+            }
+        ]
+    }));
+    const tools = checkCancel(await (0, __WEBPACK_EXTERNAL_MODULE__clack_prompts_3cae1695__.multiselect)({
+        message: 'Select development tools (Use <space> to select, <enter> to continue)',
+        required: false,
+        options: [
+            {
+                value: 'storybook',
+                label: 'Storybook'
+            }
+        ].filter(Boolean)
+    }));
+    const roleType = 'provider';
+    if (!tools || !Object.keys(tools).length) return `${roleType}-${templateName}-ts`;
+    return `${roleType}-${templateName}-[${Object.keys(tools)}]-ts`;
+}
+function getTemplateName({ projectType, roleType, framework }, args) {
+    if ('app' === projectType) return getAppTemplateName({
+        roleType,
+        framework
+    }, args);
+    return getLibTemplateName(args);
+}
+function getTemplateDir(templateName) {
+    return `templates/${templateName}/`;
+}
+async function forgeTemplate({ projectType, argv, templateParameters, distFolder }) {
+    let framework = 'modern';
+    let roleType = 'provider';
+    if ('app' === projectType) {
+        framework = checkCancel(await (0, __WEBPACK_EXTERNAL_MODULE__clack_prompts_3cae1695__.select)({
+            message: 'Select template',
+            options: [
+                {
+                    value: 'modern',
+                    label: 'Modern.js Framework'
+                },
+                {
+                    value: 'rsbuild',
+                    label: 'Rsbuild'
+                }
+            ]
+        }));
+        roleType = checkCancel(await (0, __WEBPACK_EXTERNAL_MODULE__clack_prompts_3cae1695__.select)({
+            message: 'Please select the role of project you want to create:',
+            initialValue: 'provider',
+            options: [
+                {
+                    value: 'consumer',
+                    label: 'Consumer'
+                },
+                {
+                    value: 'provider',
+                    label: 'Provider'
+                }
+            ]
+        }));
+    }
+    const templateName = await getTemplateName({
+        projectType,
+        framework,
+        roleType
+    }, argv);
+    const material = new FsMaterial(__dirname);
+    const renderTemplate = async (templateDir)=>{
+        const templatePattern = `${templateDir}**/*`;
+        const resourceMap = await material.find(templatePattern, {
+            nodir: true,
+            dot: true
+        });
+        const parameters = {
+            ...templateParameters
+        };
+        await Promise.all(Object.keys(resourceMap).map(async (resourceKey)=>{
+            const target = resourceKey.replace(templateDir, "").replace('.handlebars', "");
+            const handlebarsAPI = new HandlebarsAPI();
+            await handlebarsAPI.renderTemplate(material.get(resourceKey), target, distFolder, {
+                ...parameters
+            });
+        }));
+    };
+    const templateDir = getTemplateDir(templateName);
+    let commonTemplateDir = '';
+    commonTemplateDir = 'lib' === projectType ? 'templates/lib-common/' : `templates/${framework}-common/`;
+    await renderTemplate(commonTemplateDir);
+    await renderTemplate(templateDir);
+}
+async function create({ name, templates }) {
+    const argv = (0, __WEBPACK_EXTERNAL_MODULE_minimist__["default"])(process.argv.slice(2), {
+        alias: {
+            h: 'help',
+            d: 'dir',
+            t: 'template'
+        }
+    });
+    console.log('');
+    __WEBPACK_EXTERNAL_MODULE_rslog__.logger.greet(`◆  Create ${upperFirst(name)} Project`);
+    if (argv.help) {
+        logHelpMessage(name, templates);
+        return;
+    }
+    const cwd = process.cwd();
+    const pkgInfo = pkgFromUserAgent(process.env['npm_config_user_agent']);
+    const pkgManager = pkgInfo ? pkgInfo.name : 'npm';
+    const mfName = argv.dir ?? checkCancel(await (0, __WEBPACK_EXTERNAL_MODULE__clack_prompts_3cae1695__.text)({
+        message: 'Please input Module Federation name:',
+        placeholder: 'mf-project-name',
+        defaultValue: 'mf-project-name',
+        validate (value) {
+            if (0 === value.length) return 'Name is required';
+        }
+    }));
+    const dir = argv.dir || 'mf-project';
+    const { targetDir } = formatDir(dir);
+    const distFolder = __WEBPACK_EXTERNAL_MODULE_path__["default"].isAbsolute(targetDir) ? targetDir : __WEBPACK_EXTERNAL_MODULE_path__["default"].join(cwd, targetDir);
+    if (!argv.override && __WEBPACK_EXTERNAL_MODULE_fs__["default"].existsSync(distFolder) && !isEmptyDir(distFolder)) {
+        const option = checkCancel(await (0, __WEBPACK_EXTERNAL_MODULE__clack_prompts_3cae1695__.select)({
+            message: `"${targetDir}" is not empty, please choose:`,
+            options: [
+                {
+                    value: 'yes',
+                    label: 'Continue and override files'
+                },
+                {
+                    value: 'no',
+                    label: 'Cancel operation'
+                }
+            ]
+        }));
+        if ('no' === option) cancelAndExit();
+    }
+    const projectType = checkCancel(await (0, __WEBPACK_EXTERNAL_MODULE__clack_prompts_3cae1695__.select)({
+        message: 'Please select the type of project you want to create:',
+        options: [
+            {
+                value: 'app',
+                label: 'Application'
+            },
+            {
+                value: 'lib',
+                label: 'Lib'
+            }
+        ]
+    }));
+    await forgeTemplate({
+        projectType,
+        argv,
+        templateParameters: {
+            mfName
+        },
+        distFolder
+    });
+    const nextSteps = [
+        `cd ${targetDir}`,
+        `${pkgManager} install`,
+        `${pkgManager} run dev`
+    ];
+    (0, __WEBPACK_EXTERNAL_MODULE__clack_prompts_3cae1695__.note)(nextSteps.join('\n'), 'Next steps');
+    (0, __WEBPACK_EXTERNAL_MODULE__clack_prompts_3cae1695__.outro)('Done.');
+}
+const TEMPLATES = [
+    'provider-modern',
+    'consumer-modern',
+    'provider-rsbuild',
+    'consumer-rsbuild',
+    'rslib',
+    'rslib-storybook'
+];
+create({
+    name: 'Module Federation',
+    templates: TEMPLATES
+});
+export { TEMPLATES };

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "create-module-federation",
+  "description": "Create a new Module Federation project",
+  "public": true,
+  "sideEffects": false,
+  "version": "0.0.0-1737428758075",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/module-federation/core/",
+    "directory": "packages/create-module-federation"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "scripts": {
+    "build": "rslib build"
+  },
+  "main": "./dist/index.js",
+  "bin": {
+    "create-module-federation": "./dist/index.js"
+  },
+  "files": [
+    "template",
+    "dist"
+  ],
+  "dependencies": {
+    "@clack/prompts": "^0.8.2",
+    "execa": "5.1.1",
+    "fs-extra": "9.1.0",
+    "minimist": "^1.2.8",
+    "rslog": "^1.2.3",
+    "glob": "7.2.0",
+    "handlebars": "4.7.7"
+  },
+  "devDependencies": {
+    "@types/glob": "7.2.0",
+    "@types/minimist": "^1.2.5",
+    "@types/fs-extra": "9.0.6",
+    "@rslib/core": "^0.3.1",
+    "rsbuild-plugin-publint": "^0.2.1"
+  }
+}