@iam-com/snack-scripts 1.0.0

package/utils/fs.js

@@ -0,0 +1,169 @@
+const fs = require('fs-extra');
+const nPath = require('path');
+
+/* 获取目录或文件信息 null 为不存在 */
+const Stat = function (path) {
+    return new Promise((resolve, reject) => {
+        fs.stat(path, (err, info) => {
+            if (err) return resolve(null);
+            return resolve(info);
+        });
+    });
+};
+
+/* 是否文件夹 null 为不存在 */
+const IsDirectory = async function (path) {
+    const info = await $stat(path);
+    if (!info) return null;
+    return info.isDirectory();
+};
+
+/* 是否文件 null 为不存在 */
+const IsFile = async function (path) {
+    const info = await $stat(path);
+    if (!info) return null;
+    return !info.isDirectory();
+};
+
+/* 遍历目录 */
+const Readdir = function (path) {
+    return new Promise((resolve, reject) => {
+        fs.readdir(path, (err, menu) => {
+            if (err) return resolve(null);
+            return resolve(menu);
+        });
+    });
+};
+const ReadFiles = async function (dirPath) {
+    return new Promise(async (resolve, reject) => {
+        const walk = async (path, callback) => {
+            const files = await $readdir(path); //返回目录名和文件名的字符串数组
+            if (!files) return resolve([]);
+            files.forEach(async function (file) {
+                const stat = await $stat(nPath.join(path, file));
+                if (stat && stat.isFile()) {
+                    const name = nPath.join(path, file).replace(dirPath, '');
+                    callback({
+                        name,
+                        size: stat.size,
+                        lastModified: stat.mtime.toLocaleString()
+                    });
+                } else {
+                    walk(path + '/' + file, callback); //判断文件夹，继续递归
+                }
+            });
+        };
+        let timeout, list = [];
+        walk(dirPath, function (file) {
+            list.push(file);
+            if (timeout) clearTimeout(timeout);
+            timeout = setTimeout(() => resolve(list), 200);
+        });
+    });
+};
+
+/* 创建目录 */
+const Mkdir = function (path) {
+    return new Promise((resolve, reject) => {
+        fs.ensureDir(path, (err) => {
+            if (err) return reject(err);
+            resolve(true);
+        });
+        /*fs.mkdir(path, 0x0755, function (err) {
+            if (err) {
+                return resolve(err.message.indexOf('file already exists, mkdir') !== -1);
+            }
+            return resolve(true);
+        })*/
+    });
+};
+
+/* 读取文件 */
+const ReadFile = function (path, ops = {}) {
+    if (ops.encoding === undefined) ops.encoding = 'utf8';
+    return new Promise((resolve, reject) => {
+        fs.readFile(path, ops.encoding, (err, bytes) => {
+            try {
+                if (err) return reject(err);
+                bytes = bytes.toString();
+                if (ops.json)
+                    bytes = JSON.parse(bytes);
+                return resolve(bytes);
+            } catch (e) {
+                return resolve(null);
+            }
+        });
+    });
+};
+const ReadStream = function (path, ops = {}) {
+    return new Promise(async (resolve, reject) => {
+        if (await $isFile(path)) {
+            const stream = fs.createReadStream(path);
+            stream.on('error', (err) => {$WARN('$readStream', err);});
+            resolve(stream);
+        } else {
+            reject(new Error('file does not exist'));
+        }
+    });
+};
+
+/* 写入文件 */
+const WriteFile = function (path, data) {
+    return new Promise((resolve, reject) => {
+        if ($getType(data) === 'object')
+            data = JSON.stringify(data, null, 4);
+        fs.outputFile(path, data, (err) => {
+            if (err) return reject(err);
+            return resolve(true);
+        });
+    });
+};
+
+/* 复制文件 */
+const CcopyFile = function (inPath, outPath) {
+    return new Promise((resolve, reject) => {
+        fs.copy(inPath, outPath, err => {
+            if (err) return reject(err);
+            resolve(true);
+        });
+    });
+};
+
+/* 删除文件 */
+const Unlink = function (path) {
+    return new Promise((resolve, reject) => {
+        fs.remove(path, (err) => {
+            if (err) return reject(err);
+            return resolve(true);
+        });
+    });
+};
+
+const Rmdir = function (path) {
+    return new Promise((resolve, reject) => {
+        fs.remove(path, (err) => {
+            if (err) return reject(err);
+            return resolve(true);
+        });
+    });
+};
+
+module.exports = {
+    Stat,
+    IsFile,
+    IsDirectory,
+    Readdir,
+    ReadFiles,
+    Mkdir,
+    ReadFile,
+    ReadStream,
+    WriteFile,
+    CopyFile,
+    Unlink,
+    Rmdir,
+    fs
+};
+
+function $getType(obj) {
+    return Object.prototype.toString.call(obj).match(/^\[.*?\s+(.*?)\]$/)[1].toLocaleLowerCase();
+};

package/utils/package.js

@@ -0,0 +1,198 @@
+const fs = require('fs-extra');
+const path = require('path');
+// 获取snack包列表
+let ignoreDir = ['.DS_Store']; // ignore package filename
+const safeParse = (str, key1, key2) => {
+    try {
+        const strJson = JSON.parse(str);
+        if(key1 || key2) return strJson[key1] || strJson[key2];
+        return strJson;
+    } catch (err) {
+        return str
+    }
+}
+module.exports.safeParse = safeParse;
+
+module.exports.GetPackageList = (projectPath) => {
+    const isProduction = process.env.RUN_MODE === 'production';
+    const isDevelopment = process.env.RUN_MODE === 'development';
+    const packageJson = JSON.parse(process.env.PROJECT_PACKAGE_JSON);
+    const snackConfig = packageJson.snack || {};
+    // build 过滤打包
+    if (isProduction && snackConfig.buildIgnore instanceof Array) {
+        ignoreDir = [...ignoreDir, ...snackConfig.buildIgnore];
+    }
+    const list = fs.readdirSync(projectPath);
+    if (!list) return [];
+    const newList = [];
+    for (let i = 0, l = list.length; i < l; i++) {
+        const dirName = list[i];
+        if (ignoreDir.indexOf(dirName) !== -1) continue; // 忽略打包
+        // 开发模式下指定启动的模块，配置必须数组长度 > 1
+        if (isDevelopment && snackConfig.devPackage instanceof Array && snackConfig.devPackage.length > 0 && snackConfig.devPackage.indexOf(dirName) === -1) continue;
+        const snackPath = path.resolve(projectPath, dirName);
+        const stat = fs.statSync(snackPath);
+        if (!stat.isDirectory()) continue; // filter file
+        let snackJson;
+        try {
+            snackJson = fs.readJsonSync(path.resolve(snackPath, 'snack.json'));
+            // package.json "name" = snackType
+            snackJson.type = packageJson.name;
+            snackJson.id = dirName.toLocaleLowerCase();
+        } catch (e) {
+            throw new Error(`Package(${dirName}) "snack.json" is missing`);
+        }
+        if(process.env.RUN_MODE === 'development') {
+            snackJson.name = safeParse(snackJson.name, 'zh', 'zh-CN') ;
+            snackJson.description = safeParse(snackJson.description, 'zh', 'zh-CN');
+        }
+        /* check snack.json */
+        if (!snackJson.name) {
+            throw new Error(`Package(${dirName}) "snack.json" "name" is required`);
+        }
+        if (!snackJson.version) {
+            throw new Error(`Package(${dirName}) "snack.json" "version" is required`);
+        } else {
+            const spiltVer = snackJson.version.split('.');
+            if (spiltVer.length !== 4) {
+                throw new Error(`Package(${dirName}) "snack.json" "version" must be "x.x.x.x" `);
+            }
+            if (isNaN(spiltVer.join(''))) {
+                throw new Error(`Package(${dirName}) "snack.json" "version" must be number `);
+            }
+        }
+        /* check entry */
+        const entry = path.resolve(snackPath, 'index.ts');
+        const entryExists = fs.existsSync(entry);
+        if (!entryExists) throw new Error(`Package(${dirName}) entry "${entryExists}" is missing`);
+        const runtimeEntry = path.resolve(snackPath, 'src', 'index.tsx');
+        const runtimeEntryExists = fs.existsSync(runtimeEntry);
+        if (!runtimeEntryExists) throw new Error(`Package(${dirName}) entry "${runtimeEntry}" is missing`);
+        newList.push({
+            name: dirName.toLocaleLowerCase(),
+            dirName,
+            info: snackJson,
+            entry: entry.replace(/\\/g, () => {
+                return '\\/';
+            }), // 总入口
+            runtimeEntry: runtimeEntry.replace(/\\/g, () => {
+                return '\\/';
+            }) // 运行时入口
+        });
+    }
+    return newList;
+};
+// replace requrie "define" function to "snackdefine"
+module.exports.SnackPlugin = class SnackPlugin {
+    // 在构造函数中获取用户给该插件传入的配置
+    constructor(options) {
+    }
+
+    // Webpack 会调用 BasicPlugin 实例的 apply 方法给插件实例传入 compiler 对象
+    apply(compiler) {
+        const packageJson = JSON.parse(process.env.PROJECT_PACKAGE_JSON);
+        const packageList = JSON.parse(process.env.PROJECT_PACKAGE_LIST);
+        compiler.hooks.emit.tapAsync('MyExampleWebpackPlugin', (compilation, callback) => {
+            Object.keys(compilation.assets).forEach((key) => {
+                const item = compilation.assets[key];
+                const ops = {
+                    name: key.split('/')[0], packageJson, packageList
+                };
+                if (typeof item._cachedSource === 'string') {
+                    item._cachedSource = replaceStr(item._cachedSource, ops);
+                } else if (typeof item._valueAsString === 'string') {
+                    item._valueAsString = replaceStr(item._valueAsString, ops);
+                } else if (item._source && item._source._children && item._source._children[1] && typeof item._source._children[1]._value === 'string') {
+                    item._source._children[1]._value = replaceStr(item._source._children[1]._value, ops);
+                }
+            });
+            callback();
+        });
+    }
+};
+
+function replaceStr(str, ops) {
+    //key.split('/')[0]
+    const getInfo = (name) => {
+        for (let i = 0, l = ops.packageList.length; i < l; i++) {
+            const item = ops.packageList[i];
+            if (item.name === name) return {
+                dirName: item.dirName, ...item.info
+            };
+        }
+    };
+    const info = getInfo(ops.name);
+    if (!info) return str;
+    const snackPath = `window["__snack_static_${process.env.PROJECT_TYPE}__"] ? window["__snack_static_${process.env.PROJECT_TYPE}__"] : ""`;
+    str = str
+        .replace(/\bdefine\b/g, 'snackdefine')
+        .replace('"{__snack_static__}"', snackPath);
+
+    let infoName = safeParse(info.name, 'zh', 'zh-CN');
+    let pkgName = safeParse(ops.packageJson.name, 'zh', 'zh-CN')
+    // 添加console输出
+    str += `
+    (function(){
+        try{
+            console.groupCollapsed(
+            "%c SnackModule: ${infoName}(${info.dirName}) %c v${info.version}",
+            "color: white; background: forestgreen;line-height: 20px;height:20px;border: 1px solid forestgreen;border-right: none;border-radius: 3px 0 0 3px;",
+            "color: forestgreen; background: white; font-weight: 700;line-height: 20px;height:20px;border: 1px solid forestgreen;border-left: none;border-radius: 0 3px 3px 0;padding-right: 10px;padding-left: 4px"
+            );
+            console.log("@iam-com/snack-scripts: v${process.env.SNACK_CLI_VERSION}");
+            console.log("Project: v${ops.packageJson.version}");
+            console.log("Type: ${pkgName}");
+            console.log("Author: ${info.author}");
+            console.log("buildTime: ${new Date().toLocaleString()}");
+            console.groupEnd();
+        } catch (e){
+            console.log("SnackModule: ${infoName}(${info.dirName}) v${info.version}");
+        }
+    })();`;
+    return str;
+}
+
+module.exports.injectIndexFile = (templatePath, hook) => {
+    const snackConfig = JSON.parse(process.env.PROJECT_SNACK_CONFIG);
+    const filePath = path.join(templatePath, 'index.tsx');
+    let jsFile = fs.readFileSync(filePath, {encoding: 'utf8'});
+    if (snackConfig.plugin) {
+        // 外挂文件
+        const pluginJs = snackConfig.plugin.js;
+        const pluginCss = snackConfig.plugin.css;
+        // 外部自定义样式
+        if (pluginJs) {
+            const p = `../../../${pluginJs.replace(/^(\/|\.\/)/, '')}`;
+            jsFile = jsFile.replace('/** import plugin js **/', `import '${p}'`);
+            console.log('外挂JS: ', path.resolve(templatePath, p));
+        }
+        if (pluginCss) {
+            const p = `../../../${pluginCss.replace(/^(\/|\.\/)/, '')}`;
+            jsFile = jsFile.replace('/** import plugin css **/', `import '${p}'`);
+            console.log('外挂CSS: ', path.resolve(templatePath, p));
+        }
+    }
+    if (typeof hook === 'function') jsFile = hook(jsFile);
+    fs.outputFileSync(filePath, jsFile);
+};
+
+module.exports.createExternals = (packageJson, packagePath) => {
+    const externals = packageJson.snack && packageJson.snack.externals || {};
+    if (externals['@para-ui'] === 'all') {
+        const corePath = path.join(packagePath, 'node_modules/@iam-com/ui-core');
+        const coreList = fs.readdirSync(corePath);
+        for (let i = 0, l = coreList.length; i < l; i++) {
+            const name = coreList[i];
+            if (!fs.statSync(path.join(corePath, name)).isDirectory()) continue;
+            externals[`@iam-com/ui-core/${name}`] = `@iam-com/ui-core/${name}`;
+        }
+        const iconsPath = path.join(packagePath, 'node_modules/@para-ui/icons');
+        const iconsList = fs.readdirSync(iconsPath);
+        for (let i = 0, l = iconsList.length; i < l; i++) {
+            const name = iconsList[i];
+            if (!fs.statSync(path.join(iconsPath, name)).isDirectory()) continue;
+            externals[`@para-ui/icons/${name}`] = `@para-ui/icons/${name}`;
+        }
+    }
+    return externals;
+}