kdzwinel / Proofreader
Licence: mit
Simple text proofreader based on 'write-good' (hemingway-app-like suggestions) and 'nodehun' (spelling).
Stars: ✭ 285
Programming Languages
javascript
184084 projects - #8 most used programming language
Labels
Projects that are alternatives of or similar to Proofreader
Php Spellchecker
🐘🎓📝 PHP Library providing an easy way to spellcheck multiple sources of text by many spellcheckers
Stars: ✭ 213 (-25.26%)
Mutual labels: spellcheck
LinSpell
Fast approximate strings search & spelling correction
Stars: ✭ 52 (-81.75%)
Mutual labels: spellcheck
Emacs-LanguageTool.el
LanguageTool suggestions integrated within Emacs
Stars: ✭ 44 (-84.56%)
Mutual labels: spellcheck
flake8-spellcheck
❄️ Spellcheck variables, classnames, comments, docstrings etc
Stars: ✭ 71 (-75.09%)
Mutual labels: spellcheck
identypo
identypo is a Go static analysis tool to find typos in identifiers (functions, function calls, variables, constants, type declarations, packages, labels).
Stars: ✭ 26 (-90.88%)
Mutual labels: spellcheck
Hunspell Dict Ko
Korean spellchecking dictionary for Hunspell
Stars: ✭ 187 (-34.39%)
Mutual labels: spellcheck
cyberdic
An auxiliary spellcheck dictionary that corresponds with the Bishop Fox Cybersecurity Style Guide
Stars: ✭ 63 (-77.89%)
Mutual labels: spellcheck
spellchecker-wasm
SpellcheckerWasm is an extrememly fast spellchecker for WebAssembly based on SymSpell
Stars: ✭ 46 (-83.86%)
Mutual labels: spellcheck
spell
Spelling correction and string segmentation written in Go
Stars: ✭ 24 (-91.58%)
Mutual labels: spellcheck
WordSegmentationDP
Word Segmentation with Dynamic Programming
Stars: ✭ 18 (-93.68%)
Mutual labels: spellcheck
contextualSpellCheck
✔️Contextual word checker for better suggestions
Stars: ✭ 274 (-3.86%)
Mutual labels: spellcheck
Nodehun
The Hunspell binding for NodeJS that exposes as much of Hunspell as possible and also adds new features. Hunspell is a first class spellcheck library used by Google, Apple, and Mozilla.
Stars: ✭ 229 (-19.65%)
Mutual labels: spellcheck
wellspell.addin
R Package - Quick Spellcheck Addin for RStudio
Stars: ✭ 22 (-92.28%)
Mutual labels: spellcheck
hanspell
(주)다음과 부산대학교 인공지능연구실/(주)나라인포테크의 웹 서비스를 이용한 한글 맞춤법 검사기.
Stars: ✭ 72 (-74.74%)
Mutual labels: spellcheck
SymSpellCppPy
Fast SymSpell written in c++ and exposes to python via pybind11
Stars: ✭ 28 (-90.18%)
Mutual labels: spellcheck
Proofreader
Proofreader takes a website, or a local file, and tries to proofread it using write-good and nodehun.
Installation
npm install proofreader -g
Examples
proofreader -u https://raw.githubusercontent.com/GoogleChrome/devtools-docs/master/docs/memory-analysis-101.html
proofreader -f ../devtools-docs/docs/commandline-api.md
proofreader -l list-of-files.txt
proofreader -c custom-config.json -f file.html
- blue suggestions come from write-good
- magenta suggestions come from nodehun
Options
Proofreader can handle both HTML and Markdown files. It distinguishes between these two using MIME types.
--url (-u)
Downloads and processes single remote file from given URL.
--file (-f)
Processes single local file from given path.
--file-list (-l)
Processes all sources listed in the provided file. Sample list file:
../docs/file.html
/home/developer/otherfile.md
http://localhost/remote-file.md
--config-file (-c)
Path to a custom configuration file (default one is in settings.json
). This file has to be a valid JSON. Sample configuration:
{
"dictionaries": {
"build-in": ["en_US", "en_GB"],
"custom": ["devtools-docs.dic"]
},
"selectors": {
"whitelist": "p, li, h1, h2, h3, h4, th, td, dl, figcaption",
"blacklist": "pre, code"
},
"write-good": {
"weasel": false
}
}
-
dictionaries
-
build-in - one or two of build in dictionaries (
eng_GB
,eng_US
). E.g. when both American English and British English are allowed,["en_US", "en_GB"]
should be specified. - custom - list of custom dictionaries
-
build-in - one or two of build in dictionaries (
-
selectors
- whitelist - CSS selector that specifies all elements that should be processed. This also applies to Markdown which is compiled to HTML before processing.
- blacklist - All elements that match this CSS selector will be removed before proofreading.
- write-good - Additional settings for write-good (more details here).
Notes
Please note that this project was:
- optimized for Chrome DevTools docs
- optimized for HTML and Markdown
- optimized for English
- by default does not process all the tags, only whitelisted ones (e.g. P, LI, H1, H2, H3)
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].