textlint editor is privacy first linting tool on your browser.
:memo: @textlint/editor web extension hook the access of https://*/*/textlint-worker.js
. If you navigate
to https://*/*/textlint-worker.js
, the web extension open installation dialog like Greasemonkey Extension.
:memo: You want to use your customized rule, please use https://github.com/textlint/editor-script-template.
If you want to support new textarea, please create an issues or pull request to textchecker-element.
Grammarly and Microsoft Editor is useful and high-quality linting tools, but these require network access, and you must pass your text to their server.
textlint can be works at offline. Because, textlint is written by JavaScript, textlint rules are also written by JavaScript.
However, textlint is pluggable linting tools and textlint can not provide recommended/default ruleset.
@textlint/editor project resolve this issue using @textlint/script-compiler that generate optimized code from your textlint configuration.
For example, WebExtension download own optimized textlint that is generated code @textlint/script-compiler, and use it for linting.
So, we can focus on the compiler and frontend of editor.
Install with yarn and build before editing files.
yarn install
yarn run build
cd packages/you want to edit
yarn install
yarn run build
cd packages/webextension
yarn dev chrome # yarn dev firefox
FrontEnd and BackEnd is separated.
Avoid side-effect on website.
@textlint/script-compiler generate bundled JavaScript code.
Compiler compilertextlint + rule + textlintrc into a single library code.
Also, We can provide @textlint/script-compiler as a service using codesandbox
The library has some API
ignore({ word:string }): Promise<void>
See Releases page.
Install devDependencies and Run npm test
:
npm test
Pull requests and stars are always welcome.
For bugs and feature requests, please create an issue.
git checkout -b my-new-feature
git commit -am 'Add some feature'
git push origin my-new-feature
MIT © azu