Skip to content
Custom spelling tool
Shell Perl
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
LICENSE.md adding MIT license file Oct 16, 2017
README.md Reference GitHub action Feb 16, 2020
b Initial public version May 24, 2017
chore-spelling add chore-spelling Mar 6, 2018
convertpatch-to convertpatch-to: try to avoid edge case Feb 2, 2020
d d: add general calling syntax comment Sep 4, 2017
dchurn Adding fchurn/dchurn May 26, 2017
dn regularizing perl shbang lines (path and -w) Oct 15, 2017
dn-b regularizing perl shbang lines (path and -w) Oct 15, 2017
f f: support using hg files Jan 15, 2020
fchurn Update fchurn based on changes to how f works Feb 26, 2020
g g/ge: suppress warnings from grep Feb 25, 2020
ge g/ge: suppress warnings from grep Feb 25, 2020
gl Initial public version May 24, 2017
gl.pl regularizing perl shbang lines (path and -w) Oct 15, 2017
hesort hesort: try to improve documentation Aug 29, 2018
hgfileexts Initial public version May 24, 2017
hgfilesample Initial public version May 24, 2017
hgmv hgmv: handle renaming directories Mar 28, 2018
hgrmjunk hgrmjunk: add psd Feb 2, 2020
prerequisites.md Split README into multiple files Feb 12, 2020
r Update second line usage commentsfor r, rediff, wreview Jun 26, 2018
rediff Update second line usage commentsfor r, rediff, wreview Jun 26, 2018
rs rs: fix find null termination param Feb 12, 2020
s Initial public version May 24, 2017
signed-off-by signed-off-by: provide help Jan 21, 2019
splitter splitter: for breaking up a patch Jan 16, 2020
tools.md tools.md: convert to anchored sections Feb 26, 2020
w w: recognize I've Mar 23, 2020
wdiff wdiff: compare misspellings in two files Dec 28, 2018
workflows.md Split README into multiple files Feb 12, 2020
wreview Update second line usage commentsfor r, rediff, wreview Jun 26, 2018

README.md

Spelling tools

Overview

Everyone makes typos. This includes people writing documentation and comments, but it also includes programmers naming variables, functions, apis, classes, and filenames.

Often, programmers will use InitialCapitalization, camelCase, ALL_CAPS, or IDLCase when naming their things. When they do this, it makes it much harder for naive spelling tools to recognize misspellings, and as such, with a really high false-positive rate, people don't tend to enable spellchecking at all.

This repository's tools are capable of tolerating all of those variations. Specifically, w understands enough about how programmers name things that it can split the above conventions into word-like things for checking against a dictionary.

See workflows for how these tools are usually used together. See tools for a description of each tool and sample usage.

Path Overview

These tools are designed to live in ~/bin, I haven't spent the time to have them fish for their own locations. I'm not a huge fan of bash and would rather use either portable sh or perl.

They're built on top of hg, but you could probably make an hg script / symlink that runs git w/ minimal effort.

Prerequisites

See prerequisites

CI Integration

It is possible to integrate this with your favorite CI. I'm slowly working on this.

I've published a GitHub Action:

check spelling logo Spell checking

My initial work was done for the checkstyle project (see the Travis hook).

License

MIT

You can’t perform that action at this time.