开发自己的Bob插件从openai-polisher源码学习TypeScript实战技巧【免费下载链接】bob-plugin-openai-polisher使用 OpenAI API 给文本进行润色和语法纠错的 Bob 插件完美代替 GrammarlyLicensed under CC BY-NC-SA 4.0项目地址: https://gitcode.com/gh_mirrors/bo/bob-plugin-openai-polisherBob是一款强大的翻译工具而openai-polisher插件则利用OpenAI API为文本提供润色和语法纠错功能是替代Grammarly的理想选择。本文将从该插件源码出发为你揭示开发Bob插件的TypeScript实战技巧帮助你快速上手插件开发。插件项目结构解析一个规范的Bob插件项目结构清晰便于维护和扩展。openai-polisher的项目结构如下src/核心代码目录包含插件的主要实现const.ts常量定义文件存放默认提示词等固定数据lang.ts语言相关配置定义支持的语言列表main.ts插件入口文件实现核心功能逻辑types.ts类型定义文件规范数据结构utils.ts工具函数集合提供通用辅助功能public/公共资源目录存放插件图标和信息文件package.json项目配置文件管理依赖和脚本这种结构遵循了模块化设计原则将不同功能的代码分离到不同文件提高了代码的可读性和可维护性。TypeScript类型定义实战在TypeScript开发中良好的类型定义是保证代码质量的关键。openai-polisher插件在types.ts中定义了多个接口规范了数据结构。例如定义了ChatCompletionMessage接口来描述聊天消息的结构export interface ChatCompletionMessage { role: system | user | assistant; content: string; }还定义了ChatCompletion接口来规范API返回结果export interface ChatCompletion { id: string; object: string; created: number; model: string; choices: Array{ index: number; message: ChatCompletionMessage; finish_reason: string; }; usage: { prompt_tokens: number; completion_tokens: number; total_tokens: number; }; }这些接口的定义使得代码具有更强的类型检查能力减少了运行时错误同时也提高了代码的可读性和可维护性。工具函数设计与实现在utils.ts中插件封装了多个实用的工具函数体现了代码复用的思想。1. API请求头构建function buildHeader(isAzureServiceProvider: boolean, apiKey: string): { [key: string]: string } { const header: { [key: string]: string } { Content-Type: application/json, }; if (isAzureServiceProvider) { header[api-key] apiKey; } else { header[Authorization] Bearer ${apiKey}; } return header; }这个函数根据是否为Azure服务提供商构建不同的请求头体现了适配不同服务的灵活性。2. URL处理function ensureHttpsAndNoTrailingSlash(url: string): string { let processedUrl url.trim(); if (!processedUrl.startsWith(http://) !processedUrl.startsWith(https://)) { processedUrl https://${processedUrl}; } return processedUrl.replace(/\/$/, ); }该函数确保URL以https开头并且没有末尾的斜杠避免了因URL格式问题导致的请求错误。3. 错误处理插件还实现了完善的错误处理机制如utils.ts中的handleGeneralError和handleValidateError函数分别处理一般错误和验证错误提供了友好的错误提示。插件核心逻辑实现main.ts是插件的入口文件包含了插件的核心逻辑。1. 插件验证const pluginValidate: PluginValidate (completion) { const { apiKeys, apiUrl, deploymentName } $option; if (!apiKeys) { handleValidateError(completion, { type: secretKey, message: 配置错误 - 请确保您在插件配置中填入了正确的 API Keys, addition: 请在插件配置中填写正确的 API Keys, troubleshootingLink: https://bobtranslate.com/service/translate/openai.html }); return; } // 更多验证逻辑... };pluginValidate函数负责验证插件配置是否正确如检查API密钥是否存在确保插件能够正常工作。2. 构建请求体const buildRequestBody ( model: string, query: TextTranslateQuery ) { const { customSystemPrompt, customUserPrompt, polishingMode } $option; const systemPrompt generateSystemPrompt( replacePromptKeywords(customSystemPrompt, query), polishingMode as PolishingMode, query ); const userPrompt customUserPrompt ? ${replacePromptKeywords(customUserPrompt, query)}:\n\n${query.text} : query.text; return { model: model, temperature: 0.2, max_tokens: 1000, messages: [ { role: system, content: systemPrompt, }, { role: user, content: userPrompt, }, ], }; };buildRequestBody函数根据用户配置和查询参数构建发送给OpenAI API的请求体体现了插件的核心功能逻辑。开发步骤与环境配置1. 准备工作首先确保你已经安装了Node.js和pnpm。然后克隆openai-polisher插件仓库git clone https://gitcode.com/gh_mirrors/bo/bob-plugin-openai-polisher cd bob-plugin-openai-polisher pnpm install2. 项目配置查看package.json文件了解项目的依赖和脚本配置。其中rollup.config.ts是Rollup的配置文件用于打包插件代码。3. 开发与测试在开发过程中可以使用pnpm run dev命令启动开发模式实时编译代码。完成开发后使用pnpm run build命令打包插件生成可用于Bob的插件文件。总结通过分析openai-polisher插件的源码我们学习了Bob插件开发的TypeScript实战技巧包括项目结构设计、类型定义、工具函数实现和核心逻辑开发等方面。这些技巧不仅适用于Bob插件开发也可以应用于其他TypeScript项目中。希望本文能够帮助你快速掌握Bob插件开发的方法开发出属于自己的实用插件如果你想深入了解更多细节可以查看项目中的docs/目录那里可能包含更详细的文档。【免费下载链接】bob-plugin-openai-polisher使用 OpenAI API 给文本进行润色和语法纠错的 Bob 插件完美代替 GrammarlyLicensed under CC BY-NC-SA 4.0项目地址: https://gitcode.com/gh_mirrors/bo/bob-plugin-openai-polisher创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考