gm-printer 10.11.5-beta2 → 10.11.5

package/.eslintcache

@@ -1 +1 @@
-[{"/Users/yer/work/gm-printer/src/index.js":"1","/Users/yer/work/gm-printer/src/components/index.js":"2","/Users/yer/work/gm-printer/src/editor/editor.js":"3","/Users/yer/work/gm-printer/src/editor_purchase/editor.js":"4","/Users/yer/work/gm-printer/src/printer/store.js":"5","/Users/yer/work/gm-printer/src/printer/page_summary.js":"6","/Users/yer/work/gm-printer/src/editor_purchase/context_menu.js":"7","/Users/yer/work/gm-printer/src/editor_purchase/store.js":"8"},{"size":1075,"mtime":1622789490427,"results":"9","hashOfConfig":"10"},{"size":373,"mtime":1623031671270,"results":"11","hashOfConfig":"10"},{"size":3785,"mtime":1623031580743,"results":"12","hashOfConfig":"10"},{"size":2304,"mtime":1624446682289,"results":"13","hashOfConfig":"14"},{"size":8399,"mtime":1624871710378,"results":"15","hashOfConfig":"14"},{"size":1992,"mtime":1624870298395,"results":"16","hashOfConfig":"14"},{"size":2398,"mtime":1624870292478,"results":"17","hashOfConfig":"14"},{"size":2590,"mtime":1625105487523,"results":"18","hashOfConfig":"14"},{"filePath":"19","messages":"20","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"17rt15u",{"filePath":"21","messages":"22","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"23","messages":"24","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"25","messages":"26","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"y8fpip",{"filePath":"27","messages":"28","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"29","messages":"30","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"31","messages":"32","errorCount":14,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0,"source":null},{"filePath":"33","messages":"34","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"/Users/yer/work/gm-printer/src/index.js",[],"/Users/yer/work/gm-printer/src/components/index.js",[],"/Users/yer/work/gm-printer/src/editor/editor.js",[],"/Users/yer/work/gm-printer/src/editor_purchase/editor.js",[],"/Users/yer/work/gm-printer/src/printer/store.js",[],"/Users/yer/work/gm-printer/src/printer/page_summary.js",[],"/Users/yer/work/gm-printer/src/editor_purchase/context_menu.js",["35","36","37","38","39","40","41","42","43","44","45","46","47","48"],"/Users/yer/work/gm-printer/src/editor_purchase/store.js",[],{"ruleId":"49","severity":2,"message":"50","line":25,"column":34,"nodeType":"51","endLine":25,"endColumn":43},{"ruleId":"49","severity":2,"message":"52","line":25,"column":44,"nodeType":"51","endLine":25,"endColumn":50},{"ruleId":"49","severity":2,"message":"53","line":25,"column":51,"nodeType":"51","endLine":25,"endColumn":59},{"ruleId":"49","severity":2,"message":"50","line":32,"column":13,"nodeType":"54","endLine":32,"endColumn":22},{"ruleId":"49","severity":2,"message":"55","line":34,"column":15,"nodeType":"51","endLine":34,"endColumn":33},{"ruleId":"49","severity":2,"message":"50","line":43,"column":36,"nodeType":"51","endLine":43,"endColumn":45},{"ruleId":"49","severity":2,"message":"52","line":43,"column":46,"nodeType":"51","endLine":43,"endColumn":52},{"ruleId":"49","severity":2,"message":"53","line":43,"column":53,"nodeType":"51","endLine":43,"endColumn":61},{"ruleId":"49","severity":2,"message":"50","line":68,"column":13,"nodeType":"54","endLine":68,"endColumn":22},{"ruleId":"49","severity":2,"message":"56","line":68,"column":24,"nodeType":"54","endLine":68,"endColumn":32},{"ruleId":"49","severity":2,"message":"57","line":76,"column":26,"nodeType":"51","endLine":76,"endColumn":44},{"ruleId":"49","severity":2,"message":"58","line":77,"column":31,"nodeType":"51","endLine":77,"endColumn":39},{"ruleId":"49","severity":2,"message":"59","line":78,"column":37,"nodeType":"51","endLine":78,"endColumn":51},{"ruleId":"49","severity":2,"message":"52","line":79,"column":29,"nodeType":"51","endLine":79,"endColumn":35},"react/prop-types","'editStore' is missing in props validation","Identifier","'editStore.config' is missing in props validation","'editStore.config.contents' is missing in props validation","Property","'editStore.changeTableDataKey' is missing in props validation","'mockData' is missing in props validation","'editStore.computedPrinterKey' is missing in props validation","'editStore.selected' is missing in props validation","'editStore.selectedRegion' is missing in props validation"]
+[{"/Users/yancheng/gm/gm-open-source/gm-printer/src/printer/table.js":"1","/Users/yancheng/gm/gm-open-source/gm-printer/src/printer/store.js":"2","/Users/yancheng/gm/gm-open-source/gm-printer/src/editor/editor.js":"3","/Users/yancheng/gm/gm-open-source/gm-printer/src/editor/context_menu.js":"4","/Users/yancheng/gm/gm-open-source/gm-printer/src/components/tooltip/index.js":"5","/Users/yancheng/gm/gm-open-source/gm-printer/src/common/common_context_menu.js":"6","/Users/yancheng/gm/gm-open-source/gm-printer/src/util.js":"7","/Users/yancheng/gm/gm-open-source/gm-printer/src/printer/printer.js":"8"},{"size":8814,"mtime":1633276961204,"results":"9","hashOfConfig":"10"},{"size":11105,"mtime":1632648482981,"results":"11","hashOfConfig":"10"},{"size":4066,"mtime":1621236648877,"results":"12","hashOfConfig":"10"},{"size":3192,"mtime":1621238473815,"results":"13","hashOfConfig":"10"},{"size":616,"mtime":1621235314060,"results":"14","hashOfConfig":"10"},{"size":9693,"mtime":1621242097206,"results":"15","hashOfConfig":"10"},{"size":5968,"mtime":1632644668974,"results":"16","hashOfConfig":"10"},{"size":8724,"mtime":1631266134763,"results":"17","hashOfConfig":"10"},{"filePath":"18","messages":"19","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"175njjo",{"filePath":"20","messages":"21","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"22","messages":"23","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"24","messages":"25","errorCount":17,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0,"source":null},{"filePath":"26","messages":"27","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"28","messages":"29","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"30","messages":"31","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"32","messages":"33","errorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"/Users/yancheng/gm/gm-open-source/gm-printer/src/printer/table.js",[],"/Users/yancheng/gm/gm-open-source/gm-printer/src/printer/store.js",[],"/Users/yancheng/gm/gm-open-source/gm-printer/src/editor/editor.js",[],"/Users/yancheng/gm/gm-open-source/gm-printer/src/editor/context_menu.js",["34","35","36","37","38","39","40","41","42","43","44","45","46","47","48","49","50"],"/Users/yancheng/gm/gm-open-source/gm-printer/src/components/tooltip/index.js",[],"/Users/yancheng/gm/gm-open-source/gm-printer/src/common/common_context_menu.js",[],"/Users/yancheng/gm/gm-open-source/gm-printer/src/util.js",[],"/Users/yancheng/gm/gm-open-source/gm-printer/src/printer/printer.js",[],{"ruleId":"51","severity":2,"message":"52","line":7,"column":10,"nodeType":"53","endLine":7,"endColumn":38},{"ruleId":"54","severity":2,"message":"55","line":38,"column":34,"nodeType":"53","endLine":38,"endColumn":43},{"ruleId":"54","severity":2,"message":"56","line":38,"column":44,"nodeType":"53","endLine":38,"endColumn":50},{"ruleId":"54","severity":2,"message":"57","line":38,"column":51,"nodeType":"53","endLine":38,"endColumn":59},{"ruleId":"54","severity":2,"message":"55","line":44,"column":13,"nodeType":"58","endLine":44,"endColumn":22},{"ruleId":"54","severity":2,"message":"59","line":46,"column":15,"nodeType":"53","endLine":46,"endColumn":33},{"ruleId":"54","severity":2,"message":"55","line":50,"column":13,"nodeType":"58","endLine":50,"endColumn":22},{"ruleId":"54","severity":2,"message":"60","line":52,"column":15,"nodeType":"53","endLine":52,"endColumn":30},{"ruleId":"54","severity":2,"message":"55","line":62,"column":46,"nodeType":"53","endLine":62,"endColumn":55},{"ruleId":"54","severity":2,"message":"56","line":62,"column":56,"nodeType":"53","endLine":62,"endColumn":62},{"ruleId":"54","severity":2,"message":"57","line":62,"column":63,"nodeType":"53","endLine":62,"endColumn":71},{"ruleId":"54","severity":2,"message":"55","line":94,"column":13,"nodeType":"58","endLine":94,"endColumn":22},{"ruleId":"54","severity":2,"message":"61","line":94,"column":24,"nodeType":"58","endLine":94,"endColumn":32},{"ruleId":"54","severity":2,"message":"62","line":101,"column":26,"nodeType":"53","endLine":101,"endColumn":44},{"ruleId":"54","severity":2,"message":"63","line":102,"column":31,"nodeType":"53","endLine":102,"endColumn":39},{"ruleId":"54","severity":2,"message":"64","line":103,"column":37,"nodeType":"53","endLine":103,"endColumn":51},{"ruleId":"54","severity":2,"message":"56","line":104,"column":29,"nodeType":"53","endLine":104,"endColumn":35},"no-unused-vars","'noSubtotalBtnTableDataKeySet' is defined but never used.","Identifier","react/prop-types","'editStore' is missing in props validation","'editStore.config' is missing in props validation","'editStore.config.contents' is missing in props validation","Property","'editStore.changeTableDataKey' is missing in props validation","'editStore.setSubtotalShow' is missing in props validation","'mockData' is missing in props validation","'editStore.computedPrinterKey' is missing in props validation","'editStore.selected' is missing in props validation","'editStore.selectedRegion' is missing in props validation"]

package/README.md

@@ -1,20 +1,77 @@
 # gm-printer 
+    
+gm-printer是一个实现开发者自定义网页打印的人类高质量开源库，你可以根据业务需要自定义打印字段配置(<a href='#template_config'>配置详情</a>)，完成高质量网页打印功能。
+    
 
-## 目录简要
+## <div id='development'>开发指南</div>
+以下操作将帮助你在本地机器上安装和运行该项目，进行开发
+```bash
+# 先安装依赖
+yarn
+# 项目启动
+yarn start
+# 项目构建(基本不怎么使用)
+yarn build 
+```
+## <div id='usage'>安装使用指南</div>
+```bash
+# npm
+npm i gm-printer
+# 或使用 yarn
+yarn add gm-printer
+```
+
+## <div id='simple_categroy'>配置目录简述</div>
 ```bash
 ├── src
-│   ├── config.js # 一些printer配置信息
-│   ├── data_to_key # 原始数据转换成打印数据
-│   ├── editor # 右侧打印编辑界面
 │   ├── index.js 
+│   ├── add_fields # 右侧对应的字段配置
+│   ├── data_to_key # 原始数据转换成打印数据
 │   ├── mock_data # 模拟数据
 │   ├── printer # 打印区域
-│   ├── template_config # 打印模板配置文件
-│   └── util.js 
+│   └── template_config # 打印模板配置文件
+│       └── config.js # 一些printer配置信息
 ├── locales # 多语言文件
 ```
 
-## 模板文件(template_config)
+## 版本管理
+所有的版本都有 3 个数字：x.y.z。  
+  * 第一个数字是主版本。  
+  * 第二个数字是次版本。  
+  * 第三个数字是补丁版本。   
+
+当发布新的版本时，不仅仅是随心所欲地增加数字，还要遵循以下规则： 
+  * 当进行不兼容的 API 更改时，则升级主版本。
+  * 当以向后兼容的方式添加功能时，则升级次版本。
+  * 当进行向后兼容的缺陷修复时，则升级补丁版本。  
+
+该约定在所有编程语言中均被采用，每个 npm 软件包都必须遵守该约定，这一点非常重要，因为整个系统都依赖于此。
+
+## 版本发布  [<font size=2.5>参考链接</font>](https://eminoda.github.io/2021/01/29/npm-semver-strategy/)
+一般版本发布分为如下几个版：
+  * 内测版本(alpha)
+  * 公测版本(beta)
+  * 正式版本的候选版本(rc: release candiate)
+  * 正式版本
+
+发布操作如下：  
+
+  前情提要：
+  * 发布重大版本或版本改动较大时，先发布alpha、beta、rc等先行版本。
+  * 将`pageage.json`中的`version`修改为`X.X.X-beta.0`，或者运行 `npm version X.X.X-beta.0`来更新`package.json`，同时创建一个 git 标签[参考](https://docs.npmjs.com/cli/version)。
+```bash
+npm login # 输入用户名和密码
+
+# 之后发布你要发布的测试版本
+npm publish --tag (alpha | beta)
+
+# 或发布正式版用
+npm publish
+```
+
+上述操作在自己的分支上进行发布版本即可，发完后，将分支合并到 master 上！！！
+
+## <div id='template_config'>模板文件(template_config)</div>
 config主要是有下面6大部分组成
 ```js
 export default {
@@ -133,4 +190,42 @@ export default {
 }
 ```
 
+## addFields
+
+右侧的添加字段数据
+
+```js
+├── commonFields # 块区域的添加字段
+├── summaryFields # 合计汇总字段
+├── tableFields # 表格区域的添加字段
+```
+
+## data 数据
+```json
+  {
+    common: object, // 非表格数据
+    _origin: object, // 原始数据
+    _counter: object, //
+    _table: { // 表格数据（根据模板的不同，进行整理数据）
+      orders: kOrders, // 普通
+      orders_multi: kOrdersMulti, // 双栏
+      orders_multi_vertical: kOrdersMultiVertical, // 双栏（纵向）
+      orders_category: kCategory, // 分类
+      orders_category_multi: kCategoryMulti, // 分类 + 双栏
+      orders_category_multi_vertical: kCategoryMultiVertical, // 分类+双栏（纵向）
+      ...
+    },
+  }
+```
+
+## 区域表示
+
+```js
+header
+header.block.0
+contents.panel.0 //区域块
+contents.panel.0.block.0 //区域块的每一个块
+contents.table.0 //区域表格
+contents.table.0.column.0 // 区域表格的每一个表格
+```