【插件开发】插件开发命令行工具(Lite) —— .mnaddon Lite Helper #Ver.1.0.1#

简介

:warning: 部分命令只支持 Mac,并且需要安装 Mac 版的 MN。推荐使用 Mac 进行开发。

该工具主要用于快速开发一两百行代码的简单插件,并且使用 JavaScript 进行开发,我将其称之为 Lite 版插件。这是为了区别于 OhMyMN 那种使用 TypeScript 开发,需要编译,有控制面板的插件。

一个 Lite 版插件通常只有三个文件:

  1. logo.png
  2. main.js
  3. mnaddon.json

该工具主要有以下命令

  1. create: 使用模板创建新的插件项目。
  2. resize: 调整 logo 大小为 44x44,这是 MN 插件要求的大小。
  3. watch: 监听文件修改,并且将修改后的文件同步到 MN 插件目录。如果插件未安装,会自动安装。
  4. restart: 每次修改代码后,需要重启 MN 才会生效。该命令还可以自动跳过未签名的警告。
  5. dev: 打开 MN 和控制台,开始监听文件修改。
  6. build: 打包成插件。
  7. unpack: 解包插件。

不管是监听文件变化还是最终打包成插件,都只会处理 png,js,json 这三类文件。另外,请不要使用子文件夹,否则不会被监听或者打包。

对于 Lite 版插件,仍然可以查看旧版的 插件开发指南(预览版)。基于 OhMyMN 的开发文档还在施工中。另外还可以查看 OhMyMN 正在使用的 TypeScript 版的 API,包含最新的 API,并且更加简单易懂,文档正在编写中。

安装

npm i mnaddon-lite -g
# Or Yarn
yarn add mnaddon-lite -g
# Or Pnpm
pnpm add mnaddon-lite -g

使用

上面已经介绍了每个命令的作用,你还可以使用 mnaddon-lite help 或者 mnaddon-lite help restart 来查看每个命令具体的使用方法。 <project-name> 表示必填,[output-name] 表示可选。

Usage: mnaddon-lite command [options]
  $ mnaddon-lite create template
  $ mnaddon-lite resize ./logo.png -o new
  $ mnaddon-lite watch
  $ mnaddon-lite restart
  $ mnaddon-lite dev
  $ mnaddon-lite build
  $ mnaddon-lite unpack ./template.mnaddon -o output

Options:
  -v, --version                    output the current version
  -h, --help                       display help for command

Commands:
  create <project-name>            create a simple mnaddon project
  resize [options] <png-path>      resize logo to 44x44, which is required by MarginNote
  watch                            watch the file changes and copy changed file to the MarginNote extensition foler
  restart [options]                restart MarginNote and skip the unsign alert
  dev                              open MarginNote and Console, and then watch file changes
  build [output-name]              build a mnaddon file
  unpack [options] <mnaddon-path>  unpack a mnaddon file
  help [command]                   display help for command

对于重启 MN,建议使用 Karabiner-Elements 设置快捷键来执行命令。