@ives_xxz/packages 1.0.0

package/PNG Auto Compress/config-manager.js

@@ -0,0 +1,72 @@
+const Fs = require('fs');
+const Path = require('path');
+
+/** 配置文件保存目录 */
+const configFileDir = 'local';
+
+/** 配置文件名 */
+const configFileName = 'ccc-png-auto-compress.json';
+
+/** 默认配置 */
+const defaultConfig = {
+    enabled: false,
+    minQuality: 40,
+    maxQuality: 80,
+    colors: 256,
+    speed: 3,
+    excludeFolders: [],
+    excludeFiles: [],
+};
+
+/** 配置管理器 */
+const ConfigManager = {
+
+    /**
+     * 获取配置
+     * @returns {object}
+     */
+    get() {
+        const projectPath = Editor.Project.path || Editor.projectPath,
+            configFilePath = Path.join(projectPath, configFileDir, configFileName);
+        let config = null;
+        if (Fs.existsSync(configFilePath)) {
+            config = JSON.parse(Fs.readFileSync(configFilePath, 'utf8'));
+        } else {
+            config = { ...defaultConfig };
+        }
+        return config;
+    },
+
+    /**
+     * 保存配置
+     * @param {object} config 配置
+     * @returns {string}
+     */
+    set(config) {
+        // 查找目录
+        const projectPath = Editor.Project.path || Editor.projectPath,
+            configDirPath = Path.join(projectPath, configFileDir);
+        if (!Fs.existsSync(configDirPath)) {
+            Fs.mkdirSync(configDirPath);
+        }
+        const configFilePath = Path.join(projectPath, configFileDir, configFileName);
+        // 读取本地配置
+        let object = Object.create(null);
+        if (Fs.existsSync(configFilePath)) {
+            object = JSON.parse(Fs.readFileSync(configFilePath, 'utf8'));
+        }
+        // 写入配置
+        for (const key in config) {
+            let value = config[key];
+            if (Array.isArray(value)) {
+                value = value.filter(_value => _value !== '');
+            }
+            object[key] = value;
+        }
+        Fs.writeFileSync(configFilePath, JSON.stringify(object, null, 2));
+        return configFilePath;
+    },
+
+}
+
+module.exports = ConfigManager;

package/PNG Auto Compress/i18n/en.js

@@ -0,0 +1,14 @@
+module.exports = {
+    'name': 'PNG Auto Compress',
+    'setting': 'Setting',
+    // main
+    'configSaved': 'Config saved',
+    'willCompress': 'PNG resources will be compressed automatically after the build is completed...',
+    'prepareCompress': 'Prepare to compress...',
+    'notSupport': 'Does not support the current system platform!',
+    'startCompress': 'Compress...',
+    'compressDir': 'Asset path',
+    // setting panel
+    'repository': '· Git repository of this extension: [ccc-png-auto-compress](https://gitee.com/ifaswind/ccc-png-auto-compress)',
+    'apply': 'Apply',
+};

package/PNG Auto Compress/i18n/zh.js

@@ -0,0 +1,14 @@
+module.exports = {
+    'name': '自动压缩 PNG 资源',
+    'setting': '设置',
+    // main
+    'configSaved': '配置已保存',
+    'willCompress': '将在构建完成后自动压缩 PNG 资源...',
+    'prepareCompress': '准备压缩 PNG 资源...',
+    'notSupport': '不支持当前系统平台',
+    'startCompress': '开始压缩 PNG 资源，请勿进行其他操作！',
+    'compressDir': '资源目录',
+    // setting panel
+    'repository': '· 本扩展的 Git 仓库：[ccc-png-auto-compress](https://gitee.com/ifaswind/ccc-png-auto-compress)',
+    'apply': '应用',
+};

package/PNG Auto Compress/jsconfig.json

@@ -0,0 +1 @@
+{}

package/PNG Auto Compress/main.js

@@ -0,0 +1,377 @@
+const Fs = require('fs');
+const Path = require('path');
+const Os = require('os');
+const { exec } = require('child_process');
+const ConfigManager = require('./config-manager');
+const FileUtils = require('./utils/file-utils');
+
+/** 包名 */
+const PACKAGE_NAME = require('./package.json').name;
+
+/**
+ * i18n
+ * @param {string} key
+ * @returns {string}
+ */
+const translate = (key) => Editor.T(`${PACKAGE_NAME}.${key}`);
+
+/** 扩展名 */
+const EXTENSION_NAME = translate('name');
+
+/** 内置资源目录 */
+const internalPath = Path.normalize('assets/internal/');
+
+module.exports = {
+
+  /**
+   * 项目路径
+   * @type {string}
+   */
+  projectPath: null,
+
+  /**
+   * 资源根目录路径
+   * @type {string}
+   */
+  assetsPath: null,
+
+  /**
+   * 压缩引擎路径
+   * @type {string}
+   */
+  pngquantPath: null,
+
+  /**
+   * 日志
+   * @type {{ successCount: number, failedCount: number, successInfo: string, failedInfo: string }}
+   */
+  logger: null,
+
+  /**
+   * 需要排除的文件夹
+   * @type {string[]}
+   */
+  excludeFolders: null,
+
+  /**
+   * 需要排除的文件
+   * @type {string[]}
+   */
+  excludeFiles: null,
+
+  /**
+   * 扩展消息
+   * @type {{ [key: string]: Function }}
+   */
+  messages: {
+
+    /**
+     * 打开设置面板
+     */
+    'open-setting-panel'() {
+      Editor.Panel.open(`${PACKAGE_NAME}.setting`);
+    },
+
+    /**
+     * 读取配置
+     * @param {any} event 
+     */
+    'read-config'(event) {
+      const config = ConfigManager.get();
+      event.reply(null, config);
+    },
+
+    /**
+     * 保存配置
+     * @param {any} event 
+     * @param {any} config 
+     */
+    'save-config'(event, config) {
+      const configFilePath = ConfigManager.set(config);
+      Editor.log(`[${EXTENSION_NAME}]`, translate('configSaved'), configFilePath);
+      event.reply(null, true);
+    },
+
+  },
+
+  /**
+   * 生命周期：加载
+   */
+  load() {
+    // 绑定 this
+    this.onBuildStart = this.onBuildStart.bind(this);
+    this.onBuildFinished = this.onBuildFinished.bind(this);
+    // 监听事件
+    Editor.Builder.on('build-start', this.onBuildStart);
+    Editor.Builder.on('build-finished', this.onBuildFinished);
+  },
+
+  /**
+   * 生命周期：加载
+   */
+  unload() {
+    // 取消事件监听
+    Editor.Builder.removeListener('build-start', this.onBuildStart);
+    Editor.Builder.removeListener('build-finished', this.onBuildFinished);
+  },
+
+  /**
+  * 构建开始回调
+  * @param {BuildOptions} options 
+  * @param {Function} callback 
+  */
+  onBuildStart(options, callback) {
+    const config = ConfigManager.get();
+    if (config && config.enabled) {
+      Editor.log(`[${EXTENSION_NAME}]`, translate('willCompress'));
+      // 取消编辑器资源选中（解除占用）
+      Editor.Selection.clear('asset');
+    }
+    // Done
+    callback();
+  },
+
+  /**
+   * 构建完成回调
+   * @param {BuildOptions} options 
+   * @param {Function} callback 
+   */
+  async onBuildFinished(options, callback) {
+    const config = ConfigManager.get();
+
+    // 未开启直接跳过
+    if (!config || !config.enabled) {
+      callback();
+      return;
+    }
+
+    // 获取项目路径
+    this.projectPath = Editor.Project.path || Editor.projectPath;
+    this.assetsPath = Path.join(this.projectPath, 'assets');
+
+    // 获取压缩引擎路径
+    const platform = Os.platform(),
+      pngquantPath = this.pngquantPath = Path.join(__dirname, enginePathMap[platform]);
+    // 设置引擎文件的执行权限（仅 macOS）
+    if (pngquantPath && platform === 'darwin') {
+      if (Fs.statSync(pngquantPath).mode != 33261) {
+        // 默认为 33188
+        Fs.chmodSync(pngquantPath, 33261);
+      }
+    }
+
+    // 压缩引擎路径
+    if (!pngquantPath) {
+      Editor.log(`[${EXTENSION_NAME}]`, translate('notSupport'), platform);
+      callback();
+      return;
+    }
+
+    // 准备
+    Editor.log(`[${EXTENSION_NAME}]`, translate('prepareCompress'));
+
+    // 组装压缩命令
+    const qualityParam = `--quality ${config.minQuality}-${config.maxQuality}`,
+      speedParam = `--speed ${config.speed}`,
+      skipParam = '--skip-if-larger',
+      outputParam = '--ext=.png',
+      writeParam = '--force',
+      // colorsParam = config.colors,
+      // compressOptions = `${qualityParam} ${speedParam} ${skipParam} ${outputParam} ${writeParam} ${colorsParam}`;
+      compressOptions = `${qualityParam} ${speedParam} ${skipParam} ${outputParam} ${writeParam}`;
+
+    // 需要排除的文件夹
+    this.excludeFolders = config.excludeFolders ? config.excludeFolders.map(value => Path.normalize(value)) : [];
+    // 需要排除的文件
+    this.excludeFiles = config.excludeFiles ? config.excludeFiles.map(value => Path.normalize(value)) : [];
+
+    // 重置日志
+    this.logger = {
+      successCount: 0,
+      failedCount: 0,
+      successInfo: '',
+      failedInfo: ''
+    };
+
+    // 开始压缩
+    Editor.log(`[${EXTENSION_NAME}]`, translate('startCompress'));
+
+    // 遍历项目资源
+    const dest = options.dest,
+      dirs = ['res', 'assets', 'subpackages', 'remote'];
+    for (let i = 0; i < dirs.length; i++) {
+      const dirPath = Path.join(dest, dirs[i]);
+      if (!Fs.existsSync(dirPath)) {
+        continue;
+      }
+      Editor.log(`[${EXTENSION_NAME}]`, translate('compressDir'), dirPath);
+      // 压缩并记录结果
+      await this.compress(dirPath, compressOptions);
+    }
+
+    // 打印压缩结果
+    this.printResults();
+
+    // Done
+    callback();
+  },
+
+  /**
+   * 压缩
+   * @param {string} srcPath 文件路径
+   * @param {object} options 压缩参数
+   */
+  async compress(srcPath, options) {
+    const pngquantPath = this.pngquantPath,
+      tasks = [];
+    const handler = (filePath, stats) => {
+      // 过滤文件
+      if (!this.filter(filePath)) {
+        return;
+      }
+      // 加入压缩队列
+      tasks.push(new Promise(res => {
+        const sizeBefore = stats.size / 1024,
+          command = `"${pngquantPath}" ${options} -- "${filePath}"`;
+        // pngquant $OPTIONS -- "$FILE"
+        exec(command, (error, stdout, stderr) => {
+          this.recordResult(error, sizeBefore, filePath);
+          res();
+        });
+      }));
+    };
+    FileUtils.map(srcPath, handler);
+    await Promise.all(tasks);
+  },
+
+  /**
+   * 判断资源是否可以进行压缩
+   * @param {string} path 路径
+   */
+  filter(path) {
+    // 排除非 png 资源和内置资源
+    if (!path.endsWith('.png') || path.includes(internalPath)) {
+      return false;
+    }
+
+  // 获取资源的原始路径
+  const basename = Path.basename(path);
+  const uuid = basename.slice(0, basename.indexOf('.'));
+  const sourcePath = Editor.assetdb.uuidToFspath(uuid);
+  
+  if (sourcePath) {
+    // 检查原始资源目录中是否存在spine相关文件
+    const sourceDir = Path.dirname(sourcePath);
+    const sourceBasename = Path.basename(sourcePath, '.png');
+    
+    // 检查同目录下是否存在spine相关文件
+    const spineFiles = [
+      Path.join(sourceDir, sourceBasename + '.json'),
+      Path.join(sourceDir, sourceBasename + '.atlas'),
+      Path.join(sourceDir, sourceBasename + '.skel')
+    ];
+    
+    for (const spineFile of spineFiles) {
+      if (Fs.existsSync(spineFile)) {
+        Editor.log("找到spine文件图片:",sourceDir+sourceBasename);
+        return false;
+      }
+    }
+  }
+
+    // 排除指定文件夹和文件
+    const assetPath = this.getAssetPath(path);
+    if (assetPath) {
+      const excludeFolders = this.excludeFolders,
+        excludeFiles = this.excludeFiles;
+      // 文件夹
+      for (let i = 0, l = excludeFolders.length; i < l; i++) {
+        if (assetPath.startsWith(excludeFolders[i])) {
+          return false;
+        }
+      }
+      // 文件
+      for (let i = 0, l = excludeFiles.length; i < l; i++) {
+        if (assetPath.startsWith(excludeFiles[i])) {
+          return false;
+        }
+      }
+    }
+    // 测试通过
+    return true;
+  },
+
+  /**
+   * 获取资源源路径
+   * @param {string} filePath 
+   * @return {string} 
+   */
+  getAssetPath(filePath) {
+    // 获取源路径（图像在项目中的实际路径）
+    const basename = Path.basename(filePath),
+      uuid = basename.slice(0, basename.indexOf('.')),
+      sourcePath = Editor.assetdb.uuidToFspath(uuid);
+    if (!sourcePath) {
+      // 图集资源
+      // 暂时还没有找到办法处理
+      return null;
+    }
+    return Path.relative(this.assetsPath, sourcePath);
+  },
+
+  /**
+   * 记录结果
+   * @param {object} error 错误
+   * @param {number} sizeBefore 压缩前尺寸
+   * @param {string} filePath 文件路径
+   */
+  recordResult(error, sizeBefore, filePath) {
+    const log = this.logger;
+    if (!error) {
+      // 成功
+      const fileName = Path.basename(filePath),
+        sizeAfter = Fs.statSync(filePath).size / 1024,
+        savedSize = sizeBefore - sizeAfter,
+        savedRatio = savedSize / sizeBefore * 100;
+      log.successCount++;
+      log.successInfo += `\n + ${'Successful'.padEnd(13, ' ')} | ${fileName.padEnd(50, ' ')} | ${(sizeBefore.toFixed(2) + ' KB').padEnd(13, ' ')} ->   ${(sizeAfter.toFixed(2) + ' KB').padEnd(13, ' ')} | ${(savedSize.toFixed(2) + ' KB').padEnd(13, ' ')} | ${(savedRatio.toFixed(2) + '%').padEnd(20, ' ')}`;
+    } else {
+      // 失败
+      log.failedCount++;
+      log.failedInfo += `\n - ${'Failed'.padEnd(13, ' ')} | ${filePath.replace(this.projectPath, '')}`;
+      switch (error.code) {
+        case 98:
+          log.failedInfo += `\n ${' '.repeat(10)} - 失败原因：压缩后体积增大（已经不能再压缩了）`;
+          break;
+        case 99:
+          log.failedInfo += `\n ${' '.repeat(10)} - 失败原因：压缩后质量低于已配置最低质量`;
+          break;
+        case 127:
+          log.failedInfo += `\n ${' '.repeat(10)} - 失败原因：压缩引擎没有执行权限`;
+          break;
+        default:
+          log.failedInfo += `\n ${' '.repeat(10)} - 失败原因：code ${error.code}`;
+          break;
+      }
+    }
+  },
+
+  /**
+   * 打印结果
+   */
+  printResults() {
+    const log = this.logger,
+      header = `\n # ${'Result'.padEnd(13, ' ')} | ${'Name / Path'.padEnd(50, ' ')} | ${'Size Before'.padEnd(13, ' ')} ->   ${'Size After'.padEnd(13, ' ')} | ${'Saved Size'.padEnd(13, ' ')} | ${'Compressibility'.padEnd(20, ' ')}`;
+    Editor.log('[PAC]', `压缩完成（${log.successCount} 张成功 | ${log.failedCount} 张失败）`);
+    Editor.log('[PAC]', '压缩日志 >>>' + header + log.successInfo + log.failedInfo);
+  },
+
+}
+
+/** 压缩引擎路径表 */
+const enginePathMap = {
+  /** macOS */
+  'darwin': 'pngquant/macos/pngquant',
+  /** Windows */
+  'win32': 'pngquant/windows/pngquant'
+}

package/PNG Auto Compress/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "ccc-png-auto-compress",
+  "version": "1.2.0.20210527",
+  "description": "项目构建完成之后自动压缩 PNG 资源",
+  "author": "ifaswind（陈皮皮）",
+  "author-info": {
+    "wechat": "im_chenpipi",
+    "email": "952157129@qq.com",
+    "git-home": "https://gitee.com/ifaswind",
+    "official-account": "公众号「菜鸟小栈」"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://gitee.com/ifaswind/ccc-png-auto-compress"
+  },
+  "main": "main.js",
+  "main-menu": {
+    "i18n:MAIN_MENU.package.title/i18n:ccc-png-auto-compress.name/i18n:ccc-png-auto-compress.setting": {
+      "message": "ccc-png-auto-compress:open-setting-panel",
+      "icon": "/images/setting.png"
+    }
+  },
+  "panel.setting": {
+    "main": "panel.setting/index.js",
+    "type": "fixed-size",
+    "title": "i18n:ccc-png-auto-compress.name",
+    "width": 500,
+    "height": 625
+  },
+  "reload": {
+    "renderer": [
+      "panel.setting/**/*"
+    ],
+    "ignore": [
+      "CHANGELOG.md",
+      "README.md",
+      "README.en.md"
+    ]
+  },
+  "_storeId": "a58eb676ce095a2722e6592149b3443e"
+}

package/PNG Auto Compress/panel.setting/index.css

@@ -0,0 +1,13 @@
+:host {
+    padding-left: 10px;
+    padding-right: 10px;
+}
+
+.main {
+    height: 100%;
+    overflow-y: auto;
+}
+
+.tip {
+    height: 60px;
+}

package/PNG Auto Compress/panel.setting/index.html

@@ -0,0 +1,51 @@
+<div class="main">
+    <!-- 标题 -->
+    <h2>{{titleLabel}}</h2>
+    <ui-box-container class="layout vertical left">
+        <div>
+            <ui-prop name="启用" type="boolean" v-value="enabled" tooltip="· 项目构建完成后自动压缩 PNG 资源"></ui-prop>
+            <!-- <ui-prop name="配置保存目录" tooltip="· 相对于项目根目录的路径">
+                <ui-select class="flex-1" v-value="configSaveDir">
+                    <option value="local">local（默认不参与 Git 同步）</option>
+                    <option value="settings">settings（默认参与 Git 同步）</option>
+                </ui-select>
+            </ui-prop> -->
+            <hr />
+            <ui-prop name="最低质量（%）" type="number" v-value="minQuality" tooltip="· 最低图像质量"></ui-prop>
+            <ui-prop name="最高质量（%）" type="number" v-value="maxQuality" tooltip="· 最高图像质量"></ui-prop>
+            <!-- <ui-prop name="色彩" type="number" v-value="colors" tooltip="· 图像色彩"></ui-prop> -->
+            <ui-prop slide name="速度" type="number" v-value="speed" min="1" max="10" step="1" precision="0"
+                tooltip="· 压缩速度与质量的权重，默认值为 3。&#10;· 10 档可能会降低 5％ 的质量，但压缩速度比 3 档快 8 倍。">
+            </ui-prop>
+            <hr />
+            <ui-prop name="需要排除的文件夹" tooltip="· 相对于 assets/ 目录的路径&#10;· 多个值之间必须用 ',' 隔开" auto-height>
+                <ui-text-area class="flex-1" type="string" size="big" v-value="excludeFolders"
+                    placeholder="textures/aaa/,&#10;textures/bbb/">
+                </ui-text-area>
+            </ui-prop>
+            <ui-prop name="需要排除的文件" tooltip="· 相对于 assets/ 目录的路径&#10;· 多个值之间必须用 ',' 隔开" auto-height>
+                <ui-text-area class="flex-1" type="string" size="big" v-value="excludeFiles"
+                    placeholder="textures/abc.png,&#10;textures/123.png">
+                </ui-text-area>
+            </ui-prop>
+            <hr />
+            <ui-hint style="line-height: 19px;">
+                💡 小贴士：如果 Spine Skeleton 或 DragonBones 的纹理在压缩后出现透明度丢失的情况，可以参考以下两种解决方案（二选一）：
+                <br>
+                - 自行勾选 Spine Skeleton 或 DragonBones 纹理的 Premultiply Alpha（预乘）属性
+                <br>
+                - 在配置面板中配置排除 Spine Skeleton 或 DragonBones 的纹理，不进行压缩
+            </ui-hint>
+            <hr />
+            <!-- Git 仓库 -->
+            <ui-hint class="tip" style="margin-top: 5px;">
+                <ui-markdown style="height: 48px;" v-value="repositoryLabel"></ui-markdown>
+            </ui-hint>
+            <hr />
+        </div>
+        <!-- 应用按钮 -->
+        <ui-button class="button blue big" @click="onApplyBtnClick" v-disabled="isProcessing">{{applyLabel}}
+        </ui-button>
+    </ui-box-container>
+    <br>
+</div>