editor

editor

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

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

textlint浏览器文本检查隐私优先WebExtensionGithub开源项目

@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配置生成优化的代码。

架构

<!-- https://excalidraw.com/#json=5173529272123392,zEJpgAvspIPHh-IExwh69w -->

例如,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<void>
    • 动态更新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

编辑推荐精选

商汤小浣熊

商汤小浣熊

最强AI数据分析助手

小浣熊家族Raccoon,您的AI智能助手,致力于通过先进的人工智能技术,为用户提供高效、便捷的智能服务。无论是日常咨询还是专业问题解答,小浣熊都能以快速、准确的响应满足您的需求,让您的生活更加智能便捷。

imini AI

imini AI

像人一样思考的AI智能体

imini 是一款超级AI智能体,能根据人类指令,自主思考、自主完成、并且交付结果的AI智能体。

Keevx

Keevx

AI数字人视频创作平台

Keevx 一款开箱即用的AI数字人视频创作平台,广泛适用于电商广告、企业培训与社媒宣传,让全球企业与个人创作者无需拍摄剪辑,就能快速生成多语言、高质量的专业视频。

即梦AI

即梦AI

一站式AI创作平台

提供 AI 驱动的图片、视频生成及数字人等功能,助力创意创作

扣子-AI办公

扣子-AI办公

AI办公助手,复杂任务高效处理

AI办公助手,复杂任务高效处理。办公效率低?扣子空间AI助手支持播客生成、PPT制作、网页开发及报告写作,覆盖科研、商业、舆情等领域的专家Agent 7x24小时响应,生活工作无缝切换,提升50%效率!

TRAE编程

TRAE编程

AI辅助编程,代码自动修复

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
蛙蛙写作

蛙蛙写作

AI小说写作助手,一站式润色、改写、扩写

蛙蛙写作—国内先进的AI写作平台,涵盖小说、学术、社交媒体等多场景。提供续写、改写、润色等功能,助力创作者高效优化写作流程。界面简洁,功能全面,适合各类写作者提升内容品质和工作效率。

AI辅助写作AI工具蛙蛙写作AI写作工具学术助手办公助手营销助手AI助手
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
下拉加载更多