generated from LiteLoaderQQNT/Plugin-Template
-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
merge: feat: Better logger for Renderer Process.
Feature: - Better `console` log for _Renderer Process_. - Persist log into log file. - `ElementCapture` feature. - Checkout `docs/debugging.md` for more info. - Update Settings Page to include Github repo info. Fix: - Fix the issue that enabling this plugins will cause `QQNT` to create several unused system process and which won't be closed after `QQNT` shutdown.
- Loading branch information
Showing
14 changed files
with
367 additions
and
90 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,4 +5,5 @@ settings.json | |
|
|
||
| # ignore dist/ | ||
| dist | ||
| log | ||
| release.zip | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| 部分情况下，您可能需要获取本插件的调试信息。 | ||
|
|
||
| # 确保已开启调试输出 | ||
|
|
||
| 首先，请确保您已经开启本插件的调试信息输出功能，包括 `控制台输出` 以及 `日志文件输出` 。 | ||
|
|
||
|  | ||
|
|
||
| ## 开启元素抓取 | ||
|
|
||
| 部分情况下，开发者可能需要相关的元素调试信息来定位问题，您可以开启本插件设置中的 `启用元素调试` 功能。 | ||
|
|
||
|  | ||
|
|
||
|
|
||
| 启用该功能后，当您发送的消息包含：\`--mdit-debug-capture-element\` 时（需包含\`符号，该标志将会被渲染为`code`元素），该消息会被作为调试用消息进行抓取，并将相关信息保存到日志文件中。**在本功能启用时，请确保您发送的调试消息不包含任何您不想让其他人看到的敏感信息。** 请看下例： | ||
|
|
||
| - 消息框中输入的消息 | ||
|
|
||
|  | ||
|
|
||
| - 消息渲染结果 | ||
|
|
||
|  | ||
|
|
||
| 为保证隐私性，只有自己发送的消息才能被标记为调试消息。 | ||
|
|
||
|
|
||
| # 进入日志文件目录 | ||
|
|
||
| 首先进入 `LiteLoaderQQNT` 插件设置页面，进入数据目录。 | ||
|
|
||
|  | ||
|
|
||
| 随后依次进入 `plugins -> markdown_it -> log`，便能看到所有日志文件。 | ||
|
|
||
| > 如果目录不存在，一般是由于之前从未开启过日志文件输出功能。在完成上一步开启调试输出后，重启QQ即可。 | ||
| # 提供文件给开发者 | ||
|
|
||
| 您可以直接将文件发送给相关的开发者，也可以选择用文本编辑工具打开 `.log` 文件并复制其内容进行分享。如果目录内存在多个文件，一般情况下请提供最新的文件。 | ||
|
|
||
| # 清理日志文件 | ||
|
|
||
| 您可以在 `QQNT` 未启动的情况下，直接删除日志文件中的所有日志。 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,58 +1,26 @@ | ||
| // 运行在 Electron 主进程 下的插件入口 | ||
| const { shell, ipcMain } = require("electron"); | ||
| const fs = require('fs/promises'); | ||
| const { ipcMain } = require("electron"); | ||
| import { generateMainProcessLogerWriter, LogPathHelper } from '@/utils/logger_main'; | ||
|
|
||
| const plugin_path = LiteLoader.plugins["markdown_it"].path.plugin; | ||
| const loggerWriter = generateMainProcessLogerWriter(); | ||
|
|
||
| // import { shell, ipcMain } from "electron"; | ||
|
|
||
| const setttingsJsonFilePath = `${plugin_path}/settings.json`; | ||
|
|
||
| async function getSettings(key) { | ||
| var json = JSON.parse(await fs.readFile(setttingsJsonFilePath)); | ||
| return json[key]; | ||
| } | ||
|
|
||
| async function updateSettings({ name, value }) { | ||
| var json = {}; | ||
| try { json = JSON.parse(await fs.readFile(setttingsJsonFilePath)); } catch (e) { | ||
| ; | ||
| function onBrowserWindowCreated() { | ||
| try { onLoad(); } catch (e) { | ||
| console.error('[markdown-it]', e); | ||
| } | ||
| json[name] = value; | ||
| await fs.writeFile(setttingsJsonFilePath, JSON.stringify(json)); | ||
| } | ||
|
|
||
| async function removeSettings(key) { | ||
| var json = JSON.parse(await fs.readFile(setttingsJsonFilePath)); | ||
| json[key] = undefined; | ||
| await fs.writeFile(setttingsJsonFilePath, JSON.stringify(json)); | ||
| } | ||
|
|
||
| onLoad(); | ||
|
|
||
| // 加载插件时触发 | ||
| function onLoad() { | ||
| ipcMain.handle("LiteLoader.markdown_it.open_link", (event, content) => { | ||
| if (content.indexOf("http") != 0) { | ||
| content = "http://" + content; | ||
| } | ||
| return shell.openExternal(content); | ||
| }); | ||
|
|
||
| ipcMain.handle('LiteLoader.markdown_it.get_settings', (e, key) => { | ||
| return getSettings(key); | ||
| }); | ||
|
|
||
| ipcMain.handle('LiteLoader.markdown_it.update_settings', (e, { name, value }) => { | ||
| return updateSettings({ name, value }); | ||
| ipcMain.handle('LiteLoader.markdown_it.log', (e, consoleMode, ...args) => { | ||
| loggerWriter(consoleMode, ...args); | ||
| }); | ||
|
|
||
| ipcMain.handle('LiteLoader.markdown_it.remove_settings', (e, key) => { | ||
| return removeSettings(key); | ||
| }) | ||
| ipcMain.handle('LiteLoader.markdown_it.get_log_path', (e) => LogPathHelper.getLogFolderPath()); | ||
| } | ||
|
|
||
| // 这两个函数都是可选的 | ||
| module.exports = { | ||
| onLoad, | ||
| export { | ||
| onBrowserWindowCreated, | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.