美文网首页
utools插件开发

utools插件开发

作者: 望北8261 | 来源:发表于2020-10-19 00:32 被阅读0次

    utools 是突然间发现的一个个人感觉非常好用的小工具,其实它是一个插件平台,它提供的功能都是以插件的形式提供的,官方自己写了很多常用的插件,都是写小插件。如果你发现没有找到你想要的插件,你还可以自己开发插件,这也是我推荐utools的一个重要原因。这篇文章就是介绍我怎么开发的一个非常非常小的插件。

    utools官网:https://u.tools/

    插件功能和使用场景

    功能:复制纯文本,不带任何格式。

    不使用插件的效果,看图:
    image
    使用插件的效果,看图:

    选中文本,呼出utools的超级面板,选择 复制纯文本 即可。

    image

    PS:上面的动图是用KK录像机录的mp4,用utools的一个插件转成gif的。

    plugin.json

    新建一个目录,作为插件的项目目录。在目录下创建一个json文件 plugin.json ,这个是插件的配置文件,如下:

    {
        "pluginName": "复制纯文本",
        "description": "复制纯文本,不带任何格式。",
        "logo": "img/logo.png",
        "preload": "preload.js",
        "version": "1.0.0",
        "author": "林泉",
        "homepage": "https://www.jianshu.com/u/d62037f3ab47",
        "features": [{
            "code": "copy_text",
            "explain": "复制纯文本",
            "cmds": [{
                "type": "regex",
                "label": "复制纯文本",
                "match": "/(.*)/"
            }]
        }],
        "pluginSetting": {
            "single": true
        }
    }
    

    这个是utools中此插件的介绍截图,对应着上面的配置文件。那个详情介绍里面是一个Markdowm文件,是在项目根目录下的README.md文件。

    • preload 插件的入口
    • homepage 是一个链接,在用户点击author的时候,会跳转到这个链接
    • features 是这个插件提供的功能列表,这里只有一个功能
    • features.code 功能的唯一标识
    • features.cmds 功能的触发条件,这里只有一个,就是通过正则表达式匹配任意字符串

    preload.js

    这个是上面的配置中配的入口文件。

    window.exports = {
        // 注意:键对应的是 plugin.json 中的 features.code
        "copy_text": {
            // 用于无需 UI 显示,执行一些简单的代码
            // 除此之外,utools还提供了列表、文档等模式
            mode: "none",
            args: {
                enter: (action) => {
                    // action = { code, type, payload }
                    utools.copyText(action.payload)
                    utools.outPlugin()
                    utools.hideMainWindow()
                    utools.showNotification('已复制')
                }
            }
        }
    }
    

    最后

    上面两个文件就是整个插件的主要代码,超级简单的一个小插件。
    源代码:https://github.com/audientlin/utools-plugin-copy-text

    相关文章

      网友评论

          本文标题:utools插件开发

          本文链接:https://www.haomeiwen.com/subject/hxihmktx.html