https://github.com/textlint/editor
textlint editor project.
https://github.com/textlint/editor
Last synced: about 1 year ago
JSON representation
textlint editor project.
- Host: GitHub
- URL: https://github.com/textlint/editor
- Owner: textlint
- License: mit
- Created: 2020-07-26T08:23:28.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-12-10T23:43:55.000Z (over 1 year ago)
- Last Synced: 2025-05-01T04:39:53.107Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://textlint-editor.netlify.app/
- Size: 3.45 MB
- Stars: 136
- Watchers: 7
- Forks: 10
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @textlint/editor
textlint editor is privacy first linting tool on your browser.
## Usage
1. Install Web Extensions
- [x] Chrome:
- [x] ~Firefox: ~ See [#61](https://github.com/textlint/editor/issues/61)
2. Install your favorites textlint worker scripts
- Example textlint worker scripts:
-
-
-
3. Finally, you can linting any supported textarea with your textlint worker script
: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 .
## Supports textarea
- [x] textarea
- [ ] contenteditable
- [ ] Google Docs
- [ ] Twitter
- [ ] Medium
- [ ] Wordpress
- [ ] CodeMirror
- [ ] ACE
If you want to support new textarea, please create an issues or pull request
to [textchecker-element](./packages/textchecker-element).
## Purpose
- Privacy first
- Offline works
- Create own textlint that is bundled with own configuration
- Optimize your needs
- [@textlint/script-compiler](packages/@textlint/script-compiler) is code generator
[Grammarly](https://grammarly.com/) and [Microsoft Editor](https://www.microsoft.com/microsoft-365/microsoft-editor) is
useful and high-quality linting tools, but these require network access, and you must pass your text to their server.
[textlint](https://github.com/textlint/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](packages/@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](packages/@textlint/script-compiler), and use it for linting.
So, we can focus on the compiler and frontend of editor.
## Develop
Install with yarn and build before editing files.
yarn install
yarn run build
cd packages/you want to edit
### Develop web extension
yarn install
yarn run build
cd packages/webextension
yarn dev chrome # yarn dev firefox
## Architecture
- FrontEnd
- [textchecker-element](packages/textchecker-element) is general web component implementation.
- Injectable code
- View
- multiple implementations
- For VSCode, TextArea, Google Docs
- BackEnd
- Web Extension: background.js
- Server: API server
- Web Worker: thread
- spellchecker backend api
FrontEnd and BackEnd is separated.
### WebComponent
Avoid side-effect on website.
- TextChecker
- Controller
- Portal Overlay
### Compiler target
[@textlint/script-compiler](packages/@textlint/script-compiler) generate bundled JavaScript code.
Compiler compilertextlint + rule + textlintrc into a single library code.
- Chrome Extension code
- chrome.storage.local for cache
- libraryTarget:
- Web Worker code
- kvstorage cache
- libraryTarget: self
- Main Thread code(just web)
- kvstorage cache
- libraryTarget: web
Also, We can provide [@textlint/script-compiler](packages/@textlint/script-compiler) as a service
using [codesandbox](https://codesandbox.io)
### API
The library has some API
- update(config): Promise
- dynamic update textlintrc config
- lint({text:string}): { range: [number, number], message: string, suggestions: suggesionItem[] };
- fix({ range: [number,number] }): string;
- suggest({ range: [number, numbe })`
- missing parts of textlint
- `ignore({ word:string }): Promise`
- [textlint-filter-rule-allowlist](https://github.com/textlint/textlint-filter-rule-allowlist) configuration?
## Changelog
See [Releases page](https://github.com/textlint/editor/releases).
## Running tests
Install devDependencies and Run `npm test`:
npm test
## Contributing
Pull requests and stars are always welcome.
For bugs and feature requests, [please create an issue](https://github.com/textlint/editor/issues).
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D
## Author
- [github/azu](https://github.com/azu)
- [twitter/azu_re](https://twitter.com/azu_re)
## License
MIT © azu