• Stars
    star
    333
  • Rank 126,599 (Top 3 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created about 10 years ago
  • Updated over 6 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Simple text proofreader based on 'write-good' (hemingway-app-like suggestions) and 'nodehun' (spelling).

Proofreader Build Status npm version

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

Output: Console output

  • 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
  • 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)

More Repositories

1

betwixt

⚑ Web Debugging Proxy based on Chrome DevTools Network panel.
JavaScript
4,533
star
2

SnappySnippet

Chrome extension that allows easy extraction of CSS and HTML from selected element.
CSS
1,082
star
3

JS-OCR-demo

JavaScript optical character recognition demo
JavaScript
479
star
4

progress-bar-animation

Making a Doughnut Progress Bar - research notes
JavaScript
306
star
5

DOMListenerExtension

Chrome extension that allows you to monitor, browse and filter all DOM changes.
JavaScript
234
star
6

CSS-Diff

Chrome extension that allows to easily compare CSS of two HTML elements.
JavaScript
200
star
7

Context

Chrome extension that allows to sort other extensions into groups and easily switch between them.
JavaScript
173
star
8

JS-face-tracking-demo

JavaScript face tracking demo.
JavaScript
159
star
9

Look-alike

Visual regression testing tool.
JavaScript
33
star
10

Redmine-Issues-Checker

Chrome extension that helps you to keep track of your Redmine issues.
JavaScript
25
star
11

dailyjs-survey-sankey-diagrams

Daily JS survey results visualised with Sankey diagrams
CSS
23
star
12

DevToolsVoiceCommands

Experimental extension that allows inspecting and modifying websites using voice commands.
JavaScript
18
star
13

git-style-image-diff

Compare images line by line using git-like diffing algo
JavaScript
11
star
14

eZDebugHelper

Chrome extension for eZPublish developers.
JavaScript
8
star
15

AllGitHubTraffic

Plot data from all your GitHub repositories on one chart.
JavaScript
7
star
16

fp

Researching browser fingerprinting protection…
JavaScript
4
star
17

TheMoleGame

The Amazing Mole - JavaScript game for the js13kgames.com competition 2014
JavaScript
4
star
18

CriticalCSS

[WIP] chrome extension that offers one-click critical CSS extraction
JavaScript
4
star
19

web-privacy-pterodactyl

Web Privacy Pterodactyl disapproves trackers
4
star
20

jQueryAir

Looking for something to rewrite in your favourite MV* framework? Why not jQueryAir?
JavaScript
3
star
21

snailbook

The slooowest website on the Internet
JavaScript
3
star
22

MasonryTimeline

jQuery plugin - vertical list of posts with interactive timeline
JavaScript
3
star
23

GDEExtensionsWorkshop

Chrome Extensions Workshop for GDEs
3
star
24

MWPresentationTemplate

Making Waves presentation template based on html5slides project
JavaScript
2
star
25

schema-org-wip

JavaScript
2
star
26

fisheye-slow

Particularly bad implementation of the fisheye effect 🐌 For YOU to optimize πŸš€
JavaScript
2
star
27

HybridAppsPresentation

JavaScript
2
star
28

initiator-graph

Graph of top third party domains found on the web connected by their top initiators.
JavaScript
2
star
29

VersusExtension

Chrome extension that allows you to quickly compare number of Google results for multiple queries.
JavaScript
1
star
30

ChromeExtensionsWorkshop

Chrome Extensions Workshop Materials
1
star
31

TheBadLuckGame

JavaScript game for the js13kgames.com contest 2013
JavaScript
1
star
32

DevToolsPresentation

"5 common web development problems and how to solve them with Chrome Developer Tools"
1
star
33

MockieTalkie

JavaScript
1
star
34

CSS3AnimationPresentation

Lets get rid of GIFs and Flash!
JavaScript
1
star