{"id":18008398,"url":"https://github.com/kdzwinel/proofreader","last_synced_at":"2025-04-06T16:10:45.793Z","repository":{"id":24342217,"uuid":"27739988","full_name":"kdzwinel/Proofreader","owner":"kdzwinel","description":"Simple text proofreader based on 'write-good' (hemingway-app-like suggestions) and 'nodehun' (spelling).","archived":false,"fork":false,"pushed_at":"2018-04-06T09:48:00.000Z","size":768,"stargazers_count":334,"open_issues_count":8,"forks_count":20,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-03-30T15:11:12.849Z","etag":null,"topics":["proofreader","spellcheck"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kdzwinel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-12-08T23:17:19.000Z","updated_at":"2025-01-02T09:01:55.000Z","dependencies_parsed_at":"2022-07-21T02:49:20.497Z","dependency_job_id":null,"html_url":"https://github.com/kdzwinel/Proofreader","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kdzwinel%2FProofreader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kdzwinel%2FProofreader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kdzwinel%2FProofreader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kdzwinel%2FProofreader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kdzwinel","download_url":"https://codeload.github.com/kdzwinel/Proofreader/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247509221,"owners_count":20950232,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["proofreader","spellcheck"],"created_at":"2024-10-30T01:18:29.962Z","updated_at":"2025-04-06T16:10:45.772Z","avatar_url":"https://github.com/kdzwinel.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Proofreader [![Build Status](https://travis-ci.org/kdzwinel/Proofreader.svg)](https://travis-ci.org/kdzwinel/Proofreader) [![npm version](https://badge.fury.io/js/proofreader.svg)](http://badge.fury.io/js/proofreader)\n===========\n\nProofreader takes a website, or a local file, and tries to proofread it using [write-good](https://github.com/btford/write-good) and [nodehun](https://github.com/nathanjsweet/nodehun).\n\n## Installation\n    npm install proofreader -g\n\n## Examples\n\n    proofreader -u https://raw.githubusercontent.com/GoogleChrome/devtools-docs/master/docs/memory-analysis-101.html\n    proofreader -f ../devtools-docs/docs/commandline-api.md\n    proofreader -l list-of-files.txt\n    proofreader -c custom-config.json -f file.html\n\nOutput:\n![Console output](https://i.imgur.com/IfUw2W9.png)\n\n- blue suggestions come from write-good\n- magenta suggestions come from nodehun\n\n## Options\nProofreader can handle both HTML and Markdown files. It distinguishes between these two using MIME types.\n\n### --url (-u)\nDownloads and processes single remote file from given URL.\n\n### --file (-f)\nProcesses single local file from given path.\n\n### --file-list (-l)\nProcesses all sources listed in the provided file. Sample list file:\n\n```\n../docs/file.html\n/home/developer/otherfile.md\nhttp://localhost/remote-file.md\n```\n\n### --config-file (-c)\nPath to a custom configuration file (default one is in `settings.json`). This file has to be a valid JSON. Sample configuration:\n\n```\n{\n  \"dictionaries\": {\n    \"build-in\": [\"en_US\", \"en_GB\"],\n    \"custom\": [\"devtools-docs.dic\"]\n  },\n  \"selectors\": {\n    \"whitelist\": \"p, li, h1, h2, h3, h4, th, td, dl, figcaption\",\n    \"blacklist\": \"pre, code\"\n  },\n  \"write-good\": {\n    \"weasel\": false\n  }\n}\n```\n\n- **dictionaries**\n  - **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.\n  - **custom** - list of custom dictionaries\n- **selectors**\n  - **whitelist** - CSS selector that specifies all elements that should be processed. This also applies to Markdown which is compiled to HTML before processing.\n  - **blacklist** - All elements that match this CSS selector will be *removed* before proofreading.\n  - **write-good** - Additional settings for write-good (more details [here](https://github.com/btford/write-good#checks)).\n\n## Notes\nPlease note that this project was:\n\n- optimized for [Chrome DevTools docs](https://github.com/GoogleChrome/devtools-docs)\n- optimized for HTML and Markdown\n- optimized for English\n- by default does not process all the tags, only whitelisted ones (e.g. P, LI, H1, H2, H3)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkdzwinel%2Fproofreader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkdzwinel%2Fproofreader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkdzwinel%2Fproofreader/lists"}