基础依赖描述添加

index.js

@@ -1,8 +1,14 @@
-import FieldCheck from "./fieldCheck";
-import FormItem from "./formData";
+/**
+ * @module kind-form-verify
+ */
 
 
-export default {
-    FieldCheck,
-    FormItem
-}
+export FormItem from "./lib/formData";
+
+
+export FieldCheck from "./lib/fieldCheck";
+// 示例
+/**
+ * @example
+ * import {FormItem,FieldCheck} from "kind-form-verify"
+ */

formData.js → lib/formData.js

@@ -21,7 +21,7 @@ function hasOwn (obj, key) {
 
 
 /**
- * @class FormItem
+ * @class FormItem 表单验证类
  * @description 表单项
  * @param {object} object 表单项数据
  * @param {FieldCheck} [fieldCheck] 字段验证对象

package.json

@@ -1,8 +1,11 @@
 {
-  "name": "kindFormData",
+  "name": "kind-form-verify",
   "version": "1.0.1",
   "description": "表单规则验证工具库",
   "main": "index.js",
   "author": "kindring",
+  "scripts": {
+    "docs": "jsdoc2md lib/*.js > api.md"
+  },
   "license": "MIT"
 }