translime-plugin-bangumi-logs 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021-2025 slime7 contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/icon.svg

@@ -0,0 +1,49 @@
+<svg width="256" height="256" viewBox="0 0 256 256" fill="none" xmlns="http://www.w3.org/2000/svg">
+  <!-- Gradient definitions -->
+  <defs>
+    <linearGradient id="tvPink" x1="0" y1="0" x2="256" y2="256" gradientUnits="userSpaceOnUse">
+      <stop stop-color="#FF7CAC"/>
+      <stop offset="1" stop-color="#F09199"/>
+    </linearGradient>
+    <filter id="softGlow" x="-20%" y="-20%" width="140%" height="140%">
+      <feGaussianBlur stdDeviation="6" result="blur" />
+      <feComposite in="SourceGraphic" in2="blur" operator="over" />
+    </filter>
+  </defs>
+
+  <!-- Background Base (Rounded Square) -->
+  <rect width="256" height="256" rx="64" fill="url(#tvPink)" />
+  
+  <!-- Subtle Highlight -->
+  <rect x="20" y="20" width="216" height="216" rx="54" stroke="white" stroke-opacity="0.2" stroke-width="2" />
+
+  <!-- The TV Body -->
+  <g filter="url(#softGlow)" transform="translate(48, 70)">
+    <!-- Antennae -->
+    <path d="M50 0L70 30" stroke="white" stroke-width="12" stroke-linecap="round" />
+    <path d="M110 0L90 30" stroke="white" stroke-width="12" stroke-linecap="round" />
+    <circle cx="50" cy="0" r="10" fill="white" />
+    <circle cx="110" cy="0" r="10" fill="white" />
+
+    <!-- TV Box (Main) -->
+    <rect x="0" y="30" width="160" height="120" rx="24" fill="white" />
+    
+    <!-- Screen / Face Area -->
+    <rect x="15" y="45" width="130" height="90" rx="16" fill="#F09199" fill-opacity="0.1" />
+
+    <!-- Face (The 'Little TV' Expression) -->
+    <!-- Eyes -->
+    <circle cx="55" cy="85" r="8" fill="#F09199" />
+    <circle cx="105" cy="85" r="8" fill="#F09199" />
+    
+    <!-- Mouth (Cute curve) -->
+    <path d="M65 110C65 110 75 120 80 120C85 120 95 110 95 110" stroke="#F09199" stroke-width="8" stroke-linecap="round" />
+    
+    <!-- TV Legs -->
+    <rect x="35" y="150" width="20" height="15" rx="8" fill="white" />
+    <rect x="105" y="150" width="20" height="15" rx="8" fill="white" />
+  </g>
+
+  <!-- Modern Glass Reflection -->
+  <path d="M192 48C216 48 240 72 240 96V64C240 32 224 16 192 16H160C184 16 192 32 192 48Z" fill="white" fill-opacity="0.15" />
+</svg>

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "translime-plugin-bangumi-logs",
+  "version": "1.0.0",
+  "description": "Bangumi Logs plugin",
+  "license": "MIT",
+  "keywords": [
+    "translime",
+    "translime-plugin"
+  ],
+  "main": "./dist/index.cjs.js",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs.js"
+    }
+  },
+  "files": [
+    "dist",
+    "icon.svg"
+  ],
+  "devDependencies": {
+    "@vitejs/plugin-vue": "^6.0.0",
+    "eslint": "~9.24.0",
+    "eslint-config-airbnb-extended": "^3.0.1",
+    "eslint-import-resolver-alias": "^1.1.2",
+    "eslint-plugin-vue": "^10.0.0",
+    "vite": "^8.0.0",
+    "vite-plugin-css-injected-by-js": "^3.4.0",
+    "vite-plugin-vuetify": "^2.1.1",
+    "vitest": "^4.0.17",
+    "vue": "^3.5.13",
+    "vuetify": "^3.11.6",
+    "translime-sdk": "1.0.2"
+  },
+  "peerDependencies": {
+    "vue": "^3.5.13",
+    "vuetify": "^3.11.6"
+  },
+  "plugin": {
+    "title": "Bangumi Logs",
+    "description": "Bangumi Logs",
+    "icon": "./icon.svg",
+    "//windowUrl": "dist/ui/index.html",
+    "ui": "dist/ui.esm.js"
+  },
+  "dependencies": {
+    "@tailwindcss/vite": "^4.1.18",
+    "axios": "^1.8.4",
+    "tailwindcss": "^4.2.2"
+  },
+  "scripts": {
+    "dev": "vite build -c ui.vite.config.mjs --watch",
+    "preview:ui": "vite -c ui.vite.config.mjs --mode preview",
+    "build:plugin": "vite build",
+    "build:ui": "vite build -c ui.vite.config.mjs",
+    "build": "pnpm run build:plugin && pnpm run build:ui",
+    "test": "pnpm exec vitest run -c vitest.config.mjs"
+  }
+}

package/readme.md

@@ -0,0 +1,88 @@
+# Translime 插件开发指北
+本指北将介绍如何开发和调试 Translime 插件。
+## 本地开发测试
+利用 `link` 命令将本地插件包添加到 Translime 的开发目录中进行测试。
+> [!IMPORTANT]
+> 请统一使用同一种包管理器（建议使用 `pnpm`），避免混用导致依赖冲突。
+### 方式一：直接链接本地路径（推荐）
+1. 在项目主目录下的 `plugins_dev` 目录中打开终端。
+2. 运行以下命令：
+   ```
+   pnpm link <插件包的绝对路径>
+   ```
+
+### 方式二：通过全局链接
+
+1. 在插件包根目录中运行：
+   ```
+   pnpm link --global
+   ```
+2. 在项目主目录的 `plugins_dev` 目录下运行：
+   ```
+   pnpm link --global <package.json 中的 name>
+   ```
+
+### 启用开发插件
+打开 Translime 客户端，在 **设置** 中开启 **"显示开发中插件"** 选项。完成后，在插件管理界面即可看到并启用你的本地插件。
+---
+
+## 插件元数据配置 (`package.json`)
+
+插件的入口信息和展示信息需要在 `package.json` 的 `plugin` 字段中定义。
+```json5
+{
+  "name": "your-plugin-name",
+  "version": "1.0.0",
+  "main": "./dist/index.cjs.js",
+  "plugin": {
+    "title": "插件标题",
+    "description": "插件的功能描述",
+    "icon": "src/icon.svg",
+    "ui": "dist/ui.esm.js",
+    "windowUrl": "dist/index.html",
+    "windowUrl.dev": "http://localhost:3000"
+  }
+}
+```
+
+---
+
+## 插件后端逻辑 (`index.js`)
+
+插件的后端逻辑需通过 `export` 导出特定的配置和钩子。
+
+### 1. 设置菜单 (`settingMenu`)
+
+如果你希望在插件详情页提供配置项，可以导出 `settingMenu` 数组。
+
+### 2. 生命周期钩子
+
+- `pluginDidLoad`: 插件启用或应用加载完成后执行。
+- `pluginWillUnload`: 插件禁用或应用关闭前执行。
+- `pluginSettingSaved`: 插件设置在 UI 界面保存后触发。
+
+### 3. IPC 通信 (`ipcHandlers`)
+
+插件可以通过 `ipcHandlers` 定义与前端 UI 交互的接口。
+
+### 4. 额外菜单 (`pluginMenu`)
+
+你可以在 Translime 的部分位置添加自定义菜单。
+
+---
+
+## 使用 Translime SDK
+
+推荐通过 `translime-sdk` 访问插件配置、IPC、窗口控制和 UI 组件能力。
+
+---
+
+## 初始化补充说明
+
+创建或接手一个插件包后，建议立刻补齐下面这些基础项：
+
+1. 首次可用发布默认从 `1.0.0` 开始；只有在明确延续旧版本线时才保留原版本号。
+2. 如果插件带 Web UI，需要同时补齐 `preview:ui` 的 mock 数据和交互，保证浏览器里可以直接调试主要流程。
+3. 把功能性逻辑拆到单独模块，避免全部堆在 `index.js` 或 `ui.vue` 中。
+4. 为包内补上 `test` 脚本和单元测试，至少覆盖关键的数据转换、请求参数构造和错误处理。
+5. 完成构建后，分别验证 `build`、`test` 和 `preview:ui` 三条链路。