typo: 代码注释

lib/settings.js

@@ -59,12 +59,17 @@ class Setting {
 
   // 配置对象分析 用于锅巴插件界面设置
   analysis(config) {
-    for (let key of Object.keys(config)) {
+    for (const key of Object.keys(config)) {
       this.setConfig(key, config[key]);
     }
   }
 
-  // 获取对应模块数据文件
+  /**
+   * 获取对应模块数据文件
+   * @param {string} filepath
+   * @param {string} filename
+   * @returns {object | false}
+   */
   getData(filepath, filename) {
     filename = `${filename}.yaml`;
     filepath = path.join(this.dataPath, filepath);
@@ -79,7 +84,13 @@ class Setting {
     }
   }
 
-  // 写入对应模块数据文件
+  /**
+   * 写入对应模块数据文件
+   * @param {string} filepath
+   * @param {string} filename
+   * @param {object} data
+   * @returns {boolean}
+   */
   setData(filepath, filename, data) {
     filename = `${filename}.yaml`;
     filepath = path.join(this.dataPath, filepath);
@@ -93,24 +104,38 @@ class Setting {
         YAML.stringify(data),
         'utf8'
       );
+      return true;
     } catch (error) {
       logger.error(`[${pluginName}] [${filename}] 写入失败 ${error}`);
       return false;
     }
   }
 
-  // 获取对应模块默认配置
+  /**
+   * 获取对应模块默认配置
+   * @param {'atlas'|'config'|'gacha'|'panel'} app
+   * @returns {object}
+   */
   getdefSet(app) {
     return this.getYaml(app, 'defSet');
   }
 
-  // 获取对应模块用户配置
+  /**
+   * 获取对应模块用户配置（配置文件名）
+   * @param {'atlas'|'config'|'gacha'|'panel'} app
+   * @returns {object}
+   */
   getConfig(app) {
     return { ...this.getdefSet(app), ...this.getYaml(app, 'config') };
     // return this.mergeConfigObjectArray({...this.getdefSet(app)},{...this.getYaml(app, 'config')});
   }
 
-  //合并两个对象 相同的数组对象 主要用于yml的列表属性合并 并去重  先备份一下方法
+  /**
+   * 合并两个对象 相同的数组对象 主要用于yml的列表属性合并 并去重  先备份一下方法
+   * @param {object} obj1
+   * @param {object} obj2
+   * @returns {object}
+   */
   mergeConfigObjectArray(obj1, obj2) {
     for (const key in obj2) {
       if (Array.isArray(obj2[key]) && Array.isArray(obj1[key])) {
@@ -126,9 +151,14 @@ class Setting {
     return obj1;
   }
 
-  // 设置对应模块用户配置
-  setConfig(app, Object) {
-    return this.setYaml(app, 'config', { ...this.getdefSet(app), ...Object });
+  /**
+   * 设置对应模块用户配置
+   * @param {'atlas'|'config'|'gacha'|'panel'} app
+   * @param {object} obj
+   * @returns
+   */
+  setConfig(app, obj) {
+    return this.setYaml(app, 'config', { ...this.getdefSet(app), ...obj });
   }
 
   // 将对象写入YAML文件