Project Icon

editor

隐私优先的浏览器文本校对工具

@textlint/editor 是一款基于浏览器的隐私优先文本校对工具,支持离线工作和自定义配置。该项目利用 Web 扩展和 textlint worker 脚本,为多种文本编辑环境提供灵活的检查功能。它优化了 textlint 的使用体验,无需将文本传输至服务器即可完成校对。

@textlint/editor

textlint编辑器是一款在浏览器上运行的隐私优先的语言检查工具。

使用方法

  1. 安装Web扩展
  2. 安装你喜欢的textlint worker脚本
  3. 最后,你可以使用你的textlint worker脚本对任何支持的文本区域进行语言检查

:memo: @textlint/editor网页扩展会拦截对https://*/*/textlint-worker.js的访问。如果你访问https://*/*/textlint-worker.js,网页扩展会打开类似Greasemonkey扩展的安装对话框。

:memo: 如果你想使用自定义规则,请使用https://github.com/textlint/editor-script-template

支持的文本区域

  • textarea
  • contenteditable
  • Google文档
  • Twitter
  • Medium
  • Wordpress
  • CodeMirror
  • ACE

如果你想支持新的文本区域,请在textchecker-element创建问题或提交拉取请求。

目的

  • 隐私优先
    • 离线工作
  • 创建bundled自己配置的textlint

GrammarlyMicrosoft Editor是有用且高质量的语言检查工具,但它们需要网络访问,你必须将文本传输到它们的服务器。

textlint可以离线工作。因为textlint是用JavaScript编写的,textlint规则也是用JavaScript编写的。

然而,textlint是一个可插拔的语言检查工具,textlint无法提供推荐/默认的规则集。

@textlint/editor项目使用@textlint/script-compiler解决了这个问题,它可以根据你的textlint配置生成优化的代码。

架构

例如,WebExtension下载由@textlint/script-compiler生成的优化textlint代码,并用于语言检查。

因此,我们可以专注于编译器和编辑器前端。

开发

使用yarn安装并在编辑文件前构建。

yarn install
yarn run build
cd packages/你想编辑的包

开发网页扩展

yarn install
yarn run build
cd packages/webextension
yarn dev chrome # yarn dev firefox

架构

  • 前端
    • textchecker-element是通用的Web组件实现。
    • 可注入代码
    • 视图
    • 多种实现
    • 适用于VSCode、文本区域、Google文档
  • 后端
    • Web扩展: background.js
    • 服务器: API服务器
    • Web Worker: 线程
    • 拼写检查器后端API

前端和后端是分离的。

Web组件

避免对网站产生副作用。

  • TextChecker
  • Controller
  • Portal Overlay

编译目标

@textlint/script-compiler生成打包的JavaScript代码。

编译器将textlint + 规则 + textlintrc编译成一个单一的库代码。

  • Chrome扩展代码
    • 使用chrome.storage.local进行缓存
    • libraryTarget:
  • Web Worker代码
    • kvstorage缓存
    • libraryTarget: self
  • 主线程代码(仅网页)
    • kvstorage缓存
    • libraryTarget: web

此外,我们可以使用codesandbox@textlint/script-compiler作为服务提供。

API

该库有一些API

  • update(config): Promise
    • 动态更新textlintrc配置
  • lint({text:string}): { range: [number, number], message: string, suggestions: suggesionItem[] };
  • fix({ range: [number,number] }): string;
  • suggest({ range: [number, numbe })`
    • textlint的缺失部分
  • ignore({ word:string }): Promise<void>

更新日志

查看发布页面

运行测试

安装开发依赖并运行npm test:

npm test

贡献

欢迎提交拉取请求和标星。

对于错误和功能请求,请创建一个问题

  1. Fork它!
  2. 创建你的特性分支:git checkout -b my-new-feature
  3. 提交你的更改:git commit -am 'Add some feature'
  4. 推送到分支:git push origin my-new-feature
  5. 提交一个拉取请求 :D

作者

许可证

MIT © azu

项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型,免费访问各种图像生成与AI训练工具,从Stable Diffusion等基础模型开始,轻松实现创新图像生成。体验前沿的AI技术,推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器,它将改变您观看视频的方式!SubCat结合了先进的人工智能技术,为您提供即时视频字幕翻译,无论是本地视频还是网络流媒体,让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台,利用前沿AI技术,为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图,再到文案生成,美间让创意设计更简单、更高效。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号