From efd5d9e9455886ee5eb198a65bc48483c02ac0e1 Mon Sep 17 00:00:00 2001 From: frostime Date: Fri, 19 May 2023 22:38:08 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=E4=BA=86=20py=20=E8=84=9A?= =?UTF-8?q?=E6=9C=AC=E7=9A=84=E7=94=A8=E6=B3=95=EF=BC=8C=E6=89=93=E5=8C=85?= =?UTF-8?q?=20exe=EF=BC=8C=E5=B9=B6=E6=9B=B4=E6=96=B0=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README_zh_CN.md | 32 +++++++++++------ scripts/.gitignore | 5 +++ scripts/make_dev_link.py | 76 +++++++++++++++++++++------------------- scripts/py2exe.bat | 4 +++ 4 files changed, 70 insertions(+), 47 deletions(-) create mode 100644 scripts/.gitignore create mode 100644 scripts/py2exe.bat diff --git a/README_zh_CN.md b/README_zh_CN.md index b78da14..47abcd6 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -3,7 +3,7 @@ # 使用 vite + svelte 的思源笔记插件示例 1. 使用 vite 打包 -2. 使用软链接、而不是把项目放到插件目录下的模式进行开发 +2. 使用符号链接、而不是把项目放到插件目录下的模式进行开发 3. 内置对 svelte 框架的支持 4. 提供一个github action 模板，能自动生成package.zip并上传到新版本中 @@ -12,19 +12,29 @@ 1. 通过 Use this template 按钮将该库文件复制到你自己的库中，请注意库名必须和插件名称一致，默认分支必须为 `main` 2. 将你的库克隆到本地开发文件夹中 * 注意: 同 `plugin-sample` 不同, 本样例并不推荐直接把代码下载到 `{workspace}/data/plugins/` -3. 创建开发需要的软链接 - - 推荐使用软链接来链接你的工作目录和插件目录 - - 如果你的设备安装了 python 环境，运行 `python scripts/make_dev_link.py ` 命令，``是插件目录的绝对路径，示例: +3. 创建开发需要的符号链接 + - 推荐使用符号链接来链接你的工作目录和插件目录 + - 如果你的设备安装了 python 环境，运行 `python scripts/make_dev_link.py` 命令，然后输入插件目录的绝对路径，示例: ```powershell - >>> sudo python . \scripts\make_dev_link.py "H:\SiYuanDevSpace\data\plugins" - Symlink created: H:\SiYuanDevSpace\data\plugins\plugin-sample + >>> python make_dev_link.py + Please input the directory of siyuan/data/plugins: H:\临时文件夹\SiYuanDevSpace\data\plugins + Symlink created: H:\临时文件夹\SiYuanDevSpace\data\plugins\plugin-sample-vite-svelte ``` - - 可能需要使用管理员身份来运行这个命令。对 windows 用户来讲可以首先使用管理员身份打开控制台，然后再运行脚本。如果你的 windows 设备上安装了 scoop 等软件，可以安装 `scoop install sudo` 然后使用 sudo 命令来运行上面的程序 - - 如果您的开发环境下没有安装 python，也可以自己手动创建软链接 + - 如果您没有安装 python 环境但是是 unix 用户，可以直接使用 ln 命令创建符号链接 + ```sh + ln -s ./dev "/" + ``` + - 注意：要确保符号链接的名称 `plugin_name` 和 plugin.json 中的 name 字段保持一致 + - 如果您没有安装 python 环境，而且是 windows 用户 + - 您可以直接下载我们提供的 `make_dev_link.exe` 放在根目录下, 以管理员方式运行 + - 如果您没有安装 python 环境，而且是 windows 用户, 而且对外来的 exe 不信任，你也可以手动创建符号链接 - 首先手动在工作目录下创建 dev 目录 - - windows 用户请使用 [mklink](https://learn.microsoft.com/windows-server/administration/windows-commands/mklink) 命令; unix 用户使用 ln 命令 - - 注意：要确保软链接的名称和 plugin.json 中的 name 字段保持一致 - 由于生成的软链接和 plugin name 相同，所以不要把工程目录放在 plugins 下（这一点和 plugin-sample 模板相反） + - windows 用户请在**管理员** cmd 环境下 使用 [mklink](https://learn.microsoft.com/windows-server/administration/windows-commands/mklink) 命令, 注意要使用绝对路径 + ```cmd + mklink /d "\" "\dev" + ``` + - 可能需要使用**管理员身份来运行**上面的命令。unix 用户可以直接 sudo 运行, windows 用户可以首先使用管理员身份打开控制台，然后再运行命令 + - 注意: 由于生成的符号链接和 plugin name 相同，所以不要把工程目录放在 plugins 下（这一点和 plugin-sample 模板相反） 4. 安装 [NodeJS](https://nodejs.org/en/download) 和 [pnpm](https://pnpm.io/installation)，然后在开发文件夹下执行 `pnpm i` 5. 执行 `pnpm run dev` 进行实时编译 diff --git a/scripts/.gitignore b/scripts/.gitignore new file mode 100644 index 0000000..82fa0dc --- /dev/null +++ b/scripts/.gitignore @@ -0,0 +1,5 @@ +.venv +build +dist +*.exe +*.spec diff --git a/scripts/make_dev_link.py b/scripts/make_dev_link.py index 0f24086..e45e495 100644 --- a/scripts/make_dev_link.py +++ b/scripts/make_dev_link.py @@ -2,44 +2,48 @@ import os import sys import json -# check path, must be in root folder -if not os.path.exists('plugin.json'): - os.chdir('..') +def run(): + # check path, must be in root folder if not os.path.exists('plugin.json'): - print('plugin.json not found, exit') - sys.exit() + os.chdir('..') + if not os.path.exists('plugin.json'): + print('plugin.json not found, exit') + return -# 1. Read plugin_dir -plugin_dir = '' -if len(sys.argv) > 1: - plugin_dir = sys.argv[1] -while not os.path.exists(plugin_dir): - plugin_dir = input('Please input the directory of siyuan/data/plugins: ') - if plugin_dir == 'exit' or plugin_dir == 'quit' or plugin_dir == 'q': - sys.exit() - if not os.path.exists(plugin_dir): - print('plugin_dir not found!') - continue + # 1. Read plugin_dir + plugin_dir = '' + if len(sys.argv) > 1: + plugin_dir = sys.argv[1] + while not os.path.exists(plugin_dir): + plugin_dir = input('Please input the directory of siyuan/data/plugins: ') + if plugin_dir == 'exit' or plugin_dir == 'quit' or plugin_dir == 'q': + return + if not os.path.exists(plugin_dir): + print('plugin_dir not found!') + continue -# 2. Read name in plugin.json -with open('plugin.json', 'r', encoding='utf-8') as f: - content = json.load(f) -name = content.get('name') + # 2. Read name in plugin.json + with open('plugin.json', 'r', encoding='utf-8') as f: + content = json.load(f) + name = content.get('name') -# ...error if name not found -if not name or name == '': - print('"name" in plugin.json not found, exit') - sys.exit() - -dev_dir = os.path.abspath('dev') -if not os.path.exists(dev_dir): - os.mkdir(dev_dir) + # ...error if name not found + if not name or name == '': + print('"name" in plugin.json not found, exit') + return + + dev_dir = os.path.abspath('dev') + if not os.path.exists(dev_dir): + os.mkdir(dev_dir) -# 3. Create symlink -if not os.path.exists(os.path.join(plugin_dir, name)): - link = os.path.join(plugin_dir, name) - os.symlink(dev_dir, link) - print('Symlink created:', link) -else: - print('Folder already exists, exit') - sys.exit() + # 3. Create symlink + if not os.path.exists(os.path.join(plugin_dir, name)): + link = os.path.join(plugin_dir, name) + os.symlink(dev_dir, link) + print('Symlink created:', link) + else: + print('Folder already exists, exit') + return + +run() +os.system('pause') diff --git a/scripts/py2exe.bat b/scripts/py2exe.bat new file mode 100644 index 0000000..4d1224d --- /dev/null +++ b/scripts/py2exe.bat @@ -0,0 +1,4 @@ +.venv/Script/activate +pyinstaller --noconfirm --onefile --console "./make_dev_link.py" +rm ./make_dev_link.exe +mv ./dist/make_dev_link.exe .