clipboard-parser

clipboard-parser

支持解析@RequestParam/@ApiModelProperty 接口定义代码、Word、Excel 以及其他表格类数据

完整文档请查阅： API 完整文档

安装

# 通过npm安装
npm install -S clipboard-parser

# 或者通过yarn安装
yarn add clipboard-parser

使用

# vue页面
<template>
    <textarea @paste="handlePaste"></textarea>
</template>
<script>
import clipboardParser from 'clipboard-parser'
export default {
    methods: {
        handlePaste(e) {
            const result = clipboardParser(e)
            // ...
        }
    }
}
</script>

示例

1. 解析@RequestParam 格式代码

输入

@RequestParam("rowCount")
@ApiParam(required = false, name = "rowCount", value = "每页容量大小",defaultValue = 10)
    String rowCount,
@RequestParam(value = "current")
@ApiParam(required = false, name = "current", value = "开始页",defaultValue = 1)
    String current,

返回结果

[
    {
        "type": "String",
        "required": true,
        "name": "rowCount",
        "defaultValue": 10,
        "description": "每页容量大小"
    },
    {
        "type": "String",
        "required": true,
        "name": "current",
        "defaultValue": 1,
        "description": "开始页"
    }
]

2. 解析@ApiModelProperty 格式代码

输入

@ApiModelProperty(value = "id主键", required = true)
    private String id;
@ApiModelProperty(value = "名称")
    private String name;

返回结果

[
    {
        "required": true,
        "type": "String",
        "description": "id主键",
        "defaultValue": "",
        "name": "id"
    },
    {
        "required": true,
        "type": "String",
        "description": "名称",
        "defaultValue": "",
        "name": "name"
    }
]

3. 解析 word/excel/网页 table 等表格类数据

输入

参数	说明	类型	可选值	必填	默认
type	分支类型	String	feature/bugfix/support	false	当前分支类型
name	分支名称	String	-	false	当前分支名称

返回结果

[
    {
        "name": "type",
        "type": "String",
        "required": false,
        "defaultValue": "",
        "description": "分支类型"
    },
    {
        "name": "name",
        "type": "String",
        "required": false,
        "defaultValue": "",
        "description": "分支名称"
    }
]

Changelog

2021.09.05 v2.0.0

1. refactor the code with typescript.
2. change the first parameter passed to event: clipboardParser(window.clipboardData || event.clipboardData) to clipboardParser(e)
3. use rollup to build cmd, umd
4. change tsdoc to generate API documentation