cuxml 1.0.4 → 1.0.5

package/README.md

@@ -72,10 +72,6 @@ function onthing(ctrl){
     ```
     or
     ```bash
-    cuxml # if install cuxml global
-    ```
-    or
-    ```bash
     node ./node_modules/cuxml/index.js # last choice……
     ``` 
 > 更多命令行参数请查看 --help 选项.
@@ -85,11 +81,22 @@ function onthing(ctrl){
 
 **输出结果到文件时，保险起见，最好输出到临时文件，避免覆盖你已经写好的文件。**
 
-## Issues
-
-UBW， 😄
-
-1. [cuxml issues]()
+## 最新更新
+
+1. check， 仅输出有'问题'的 Element。
+2. callback :
+    + id 为空的 Element 会被忽略。
+    + 匹配属性的回调函数返回值类型，在注释中标明。
+    + JS 函数的注释中，添加了回调函数对应的 XML 元素属性。
+    + 生成的 JS 函数只有一个参数，即 RibbonUI 对象。**不必添加多余的参数，目前 WPS Office Client 传参数时只有一个！**
+        ```js
+        // RibbonUI 对象成员大概如下：
+        {
+            Id: "test1", // 当前元素的 id 属性
+            content:{...},
+            Tag: "",// 如果你在 XML 中设置了 tag 属性，这里就会有值。
+        }
+        ```
 
 ## Bug
 
@@ -130,10 +137,4 @@ UBW， 😄
     <group id="test1" getVisible="new nothing"></group>
     ```
 
-    ```js
-    myRibbon.nothing(ctrl); // myRibbon={nothing:function(ctrl){}};
-    a.b.c.nothing(ctrl); // a.b.c={nothing:function(ctrl){}};
-    new nothing(ctrl); // class nothing{constructor(ctrl){}};
-    ```
-
     所以……如果你需要将 XML 中的诸如以上的回调函数转换为 JS 函数，也许你得自己写一些代码了。

package/cbfTypes.json

@@ -1,7 +1,7 @@
 [
     {
         "n": "getVisible",
-        "t": "string"
+        "t": "boolean"
     },
     {
         "n": "getDescription",
@@ -9,7 +9,7 @@
     },
     {
         "n": "getEnabled",
-        "t": "string"
+        "t": "boolean"
     },
     {
         "n": "getImage",
@@ -29,15 +29,15 @@
     },
     {
         "n": "getShowImage",
-        "t": "string"
+        "t": "boolean"
     },
     {
         "n": "getShowLabel",
-        "t": "string"
+        "t": "boolean"
     },
     {
         "n": "getSize",
-        "t": "string"
+        "t": "number"
     },
     {
         "n": "getSupertip",
@@ -45,15 +45,15 @@
     },
     {
         "n": "onAction",
-        "t": "string"
+        "t": "void"
     },
     {
         "n": "getPressed",
-        "t": "string"
+        "t": "boolean"
     },
     {
         "n": "getItemCount",
-        "t": "string"
+        "t": "number"
     },
     {
         "n": "getItemID",
@@ -81,7 +81,7 @@
     },
     {
         "n": "onChange",
-        "t": "string"
+        "t": "void"
     },
     {
         "n": "loadImage",
@@ -89,7 +89,7 @@
     },
     {
         "n": "onLoad",
-        "t": "string"
+        "t": "void"
     },
     {
         "n": "getSelectedItemID",
@@ -97,7 +97,7 @@
     },
     {
         "n": "getSelectedItemIndex",
-        "t": "string"
+        "t": "number"
     },
     {
         "n": "getContent",
@@ -105,11 +105,11 @@
     },
     {
         "n": "getItemHeight",
-        "t": "string"
+        "t": "number"
     },
     {
         "n": "getItemWidth",
-        "t": "string"
+        "t": "number"
     },
     {
         "n": "getTitle",

package/check.js

@@ -39,7 +39,6 @@ const clash = require('./clashAttributes.json').crashs;
  *  - `unknownAttribute {array|undefined}`  - unknown attributes.
  *  - `duplicateAttributes {array|undefined}` - duplicate attributes.
  *  - `hasClashAttributes {array|undefined}`  - clash attributes.
- *  - `unInvokeAttributes {array|undefined}` - unInvoke attributes.
  *  - `emptyValueOfAttributes {array|undefined}` - emptty value of attributes.
  */
 function customUI_Ribbon_xml_node_Check(xmlObj) {

package/cxml_w.js

@@ -5,7 +5,7 @@ const chokidar = require('chokidar');
 const xmljs = require('xml-js');
 
 module.exports = (arg1, arg2, opt) => {
-    if (!arg1.endsWith('.xml')) throw new Error('The first argument must be a XML file');
+    if (!arg1.endsWith('.xml')) throw new Error('缺少 XML 文件！');
     let xmlContent;
     try {
         xmlContent = fs.readFileSync(arg1, 'utf-8');
@@ -13,7 +13,7 @@ module.exports = (arg1, arg2, opt) => {
         throw new Error(e);
     }
     // 空文件不处理，且不监听的话，直接返回
-    if(xmlContent.trim() === ""&&!opt.watch) return;
+    if (xmlContent.trim() === "" && !opt.watch) return;
     let xml2jsonContent = xmljs.xml2js(xmlContent, { compact: false, spaces: 4 }, (err, res) => {
         if (err) {
             console.error(err);
@@ -23,11 +23,24 @@ module.exports = (arg1, arg2, opt) => {
     });
 
     let xmlFlattenRes = xmlFlatten(xml2jsonContent);
-
-    let realFile = fs.existsSync(arg2);
-
-    function doit(){
-        if(!realFile){
+    
+    let realFile;
+    console.log([arg1,arg2,opt])
+    if (arg2!==undefined) {
+        try {
+            realFile = fs.existsSync(arg2);
+            if (!realFile) {
+                fs.writeFileSync(arg2, '');
+            }
+        } catch (e) {
+            throw new Error(e);
+        }
+    }else{realFile = false}
+    
+    function doit() {
+        if(xmlFlattenRes.length === 0) return;
+        // 清空文件
+        if (realFile) {
             fs.writeFileSync(arg2, '');
         }
         xmlFlattenRes.forEach(o => {
@@ -37,18 +50,29 @@ module.exports = (arg1, arg2, opt) => {
                 oItem_attributes = o.attributes;
             }
             let iTemCheckResult = checker({ name: oItem_name, attributes: oItem_attributes, xmlpath: o.xmlpath });
-            if(realFile){
-                console.log(iTemCheckResult);
-                fs.writeFileSync(arg2, JSON.stringify(iTemCheckResult)+'\n',{flag:'a'});
-            }else{
-                console.log(iTemCheckResult);
+            let isOk = [
+                "unKnownElement",
+                "unknownAttribute",
+                "duplicateAttributes",
+                "hasClashAttributes",
+                "emptyValueOfAttributes"].some(e => Object.keys(iTemCheckResult).includes(e))
+            if (isOk){
+                if (realFile) {
+                    
+                    fs.writeFileSync(arg2, JSON.stringify(iTemCheckResult) + '\n', { flag: 'a' });
+                    console.log(iTemCheckResult);
+                } else {
+                    console.log(iTemCheckResult);
+                }
             }
-        })
+        });
     };
-    if(opt.watch){
+    // Need Watch XML?
+    if (opt.watch) {
         let wcer = chokidar.watch(arg1);
+        console.log('watching...')
         wcer.on('change', doit);
-    }else{
+    } else {
         doit();
     }
 }

package/index.js

@@ -9,21 +9,21 @@ program
     .description(pkg.description)
     .version(pkg.version);
 program.command('check')
-    .description('Check XML file against a schema')
-    .argument('<xmlFile>', 'XML file to check')
-    .argument('[outFile]', 'Output file')
-    .option('-w, --watch', 'Watch the file for changes')
+    .description('检查 XML 文件是否符合规范（CustomUI for MS Office 2006/2007……）仅输出有问题的 Element。')
+    .argument('<xmlFile>', '要检查的 XML 文件')
+    .argument('[outFile]', '输出检查结果到文件 [outFile]')
+    .option('-w, --watch', '监视 <xmlFile> 文件')
     .action((xmlFile, outFile, options) => {
-        //console.log(JSON.stringify([options, xmlFile, outFile]));
+        console.log(JSON.stringify([options, xmlFile, outFile]));
         require('./cxml_w.js')(xmlFile, outFile, options)
     });
 program.command('callback')
-    .description('Add a callbackFunction to the <jsFile>')
-    .argument('<xmlFile>', 'XML file to load')
-    .argument('<jsFile>', 'JavaScript file to Append the callbackFunction')
-    .option('-w, --write', 'Rewrite the file <jsFile>')
-    .option('-a, --append', 'Append the file <jsFile>')
-    .option('-watch, --watch', 'Watch the <xmlFile> file for changes')
+    .description('生成 XML 中 CustomUI 元素设置的回调属性为 JavaScript Function 并写入 <jsFile>')
+    .argument('<xmlFile>', 'customUI XML 文件')
+    .argument('<jsFile>', '要写入的 JavaScript 文件')
+    .option('-w, --write', '写入方式: 覆盖 JS 文件 <jsFile>')
+    .option('-a, --append', '写入方式: 追加到 <jsFile> 文件末尾')
+    .option('-watch, --watch', '监视 <xmlFile> 文件')
     .action((xmlFile, jsFile, options) => {
         //console.log(JSON.stringify([options, xmlFile, jsFile]));
         if(options.watch){

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cuxml",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "A tool to help use ribbon UI for your WPS Office Client JS add-in project.",
   "keywords": [
     "wps office",

package/xml2cbFn.js

@@ -6,11 +6,12 @@ const clashes = require('./clashAttributes.json').crashs;
 const SDT = require('./StDelegate.json');
 const chokidar = require('chokidar');
 const xmljs = require('xml-js');
+const callbackType = require('./cbfTypes.json');
 
 module.exports = (arg1, arg2, flag) => {
-    if (!arg1.endsWith('.xml')) throw new Error('The first argument must be a XML file');
-    if (!arg2.endsWith('.js')) throw new Error('The second argument must be a JS file');
-    if (fs.existsSync(arg1) === false) throw new Error('The first argument file does not exist');
+    if (!arg1.endsWith('.xml')) throw new Error('The first argument must be a XML file!');
+    if (!arg2.endsWith('.js')) throw new Error('The second argument must be a JS file!');
+    if (fs.existsSync(arg1) === false) throw new Error('The XML file does not exist');
 
     let xmlContent = fs.readFileSync(arg1, 'utf-8');
     if (xmlContent.trim() === "") {
@@ -48,6 +49,7 @@ module.exports = (arg1, arg2, flag) => {
         }
     });
     attrs = lodash.compact(attrs);
+    if(attrs.length === 0) return;
     // 提取出所有的回调函数名
     let callbackFunctionNames = attrs.map(o => {
         let attrNames = Object.keys(o.a);
@@ -60,14 +62,15 @@ module.exports = (arg1, arg2, flag) => {
     callbackFunctionNames = lodash.flattenDeep(callbackFunctionNames);
     // 去重
     callbackFunctionNames = lodash.uniq(callbackFunctionNames);
+    if(callbackFunctionNames.length === 0) return;
     // console.log(callbackFunctionNames);
     // 用回调函数名获取 attrs 对象；
     let attrsObj = callbackFunctionNames.map(cb => {
         let z = lodash.map(attrs, o => {
             let s = [];
             Object.keys(o.a).forEach(k => {
-                if (o.a[k] === cb) {
-                    s.push ({fn:cb,xmlPath:o.p,id:o.a.id})
+                if (o.a[k] === cb && o.a.id !== "") {
+                    s.push ({fn:cb,xmlPath:o.p,id:o.a.id,cbAttr:k})
                 }
             });
             return s;
@@ -75,9 +78,10 @@ module.exports = (arg1, arg2, flag) => {
         return lodash.compact(z);
     });
     attrsObj = lodash.flattenDeep(attrsObj);
+    if(attrsObj.length===0) return;
     //console.log(attrsObj);
     let fnGroup = lodash.groupBy(attrsObj, 'fn'); // 按照回调函数名分组
-    console.log(fnGroup);
+    // console.log(fnGroup);
     // console.log(callbackFunctionNames);
     // console.log(callbackFunctionNames);
     // 检查JS文件是否存在,不存在就创建。
@@ -99,34 +103,26 @@ module.exports = (arg1, arg2, flag) => {
         }
     });
     function cbTemplete(attrValue) {
+        if(!fnGroup[attrValue]) return;
         let infos = fnGroup[attrValue];
-        let cases = infos.map(o =>`// xmlPath: ${o.xmlPath}\n        case "${o.id}":\n            break;`);
+        let cases = infos.map(o =>infos.length>1?`// xmlPath: ${o.xmlPath}\n        case "${o.id}":\n            break;` : `// xmlPath: ${o.xmlPath}[id=${o.id}]\n`);
+        // 回调函数的属性名
+        let callbackAttr= infos[0].cbAttr;
+        // 回调函数的类型
+        let cbType = lodash.filter(callbackType, ['n', callbackAttr])[0].t;
+        let spaceReapts = (len)=>" ".repeat(len);
         return `
 /**
-* @param {RibbonUI} ctrl 你不需要关心这个参数，它代表一个菜单控件元素对象。比如 button、group 等。
-* @note 
-*  - 这是控件的回调函数，你不应该在其他 JS 文件中调用这个函数。
-*  - 通用模版而已，你可以根据需要自行修改。
-*  - 这里的回调函数都是异步的，你不应该在这里写长耗时同步的代码，否则可能会导致 UI 卡死。(AI 说的)
-*  
+* Callback function for ${callbackAttr}
+* @param {RibbonUI} ctrl 菜单控件对象
+* @returns {${cbType}}
+*
 *  Time: ${new Date()}
 */
 function ${attrValue}(ctrl){
-
-    // 以下代码只是通用模版，你可以根据需要自行修改
-    // 通过 ctrl.Id 来判断当前元素
-    // use ctrl.Id to judge the current element
-
-    switch(ctrl.Id){
-        ${cases.join('\n')}
-        default:
-            break;
-    };
-
-    // 避免 UI 报错，总是返回 true
-    // Need return value of true
-
-    return true;
+    // 目前，所有回调都只支持一个参数，多出来的一律 undefined。ctrl 的成员如下👇🏻:
+    // ctrl={Id:'string', content:{...}, Tag:'string'}
+    ${cases.length > 1 ? `switch(ctrl.Id){\n${spaceReapts(8)}${cases.join('\n')}\ndefault:\n${spaceReapts(8)}break;\n${cbType=='void'?`${spaceReapts(8)}return true;//动作、事件类回调需要返回 true};`:``}` : `${cases.join('\n')}\n//根据回调属性返回准确的类型`}
 }`;
     }
 }